{"id":16770535,"url":"https://github.com/jugid/automate","last_synced_at":"2025-06-19T17:40:08.807Z","repository":{"id":54423788,"uuid":"336652160","full_name":"JuGid/AutoMate","owner":"JuGid","description":"AutoMate is an automation library to make UI repetitive actions or to make tests with YAML","archived":false,"fork":false,"pushed_at":"2024-02-22T23:01:42.000Z","size":3126,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T20:09:07.621Z","etag":null,"topics":["automation","automation-ui","php","selenium","webdriver"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JuGid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-06T22:44:10.000Z","updated_at":"2024-02-23T16:10:17.000Z","dependencies_parsed_at":"2025-02-17T22:42:50.138Z","dependency_job_id":null,"html_url":"https://github.com/JuGid/AutoMate","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/JuGid/AutoMate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuGid%2FAutoMate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuGid%2FAutoMate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuGid%2FAutoMate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuGid%2FAutoMate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JuGid","download_url":"https://codeload.github.com/JuGid/AutoMate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuGid%2FAutoMate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260797685,"owners_count":23064840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","automation-ui","php","selenium","webdriver"],"created_at":"2024-10-13T06:24:34.629Z","updated_at":"2025-06-19T17:40:03.792Z","avatar_url":"https://github.com/JuGid.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Tests](https://github.com/JuGid/AutoMate/workflows/Tests/badge.svg) [![codecov](https://codecov.io/gh/JuGid/AutoMate/branch/master/graph/badge.svg?token=JK9IA306US)](https://codecov.io/gh/JuGid/AutoMate) [![Latest Stable Version](https://poser.pugx.org/jugid/auto-mate/v)](//packagist.org/packages/jugid/auto-mate) ![Issues](https://img.shields.io/github/issues/JuGid/AutoMate) [![License](https://poser.pugx.org/jugid/auto-mate/license)](//packagist.org/packages/jugid/auto-mate) ![PHP Version](https://img.shields.io/badge/php-%3E%3D%207.3-8892BF.svg)\n\n\n# AutoMate - Yaml automation library\n*Release 0.9.0 see the [Changelogs](CHANGELOG.md)*\n\n*You can get help on the [Wiki](https://github.com/JuGid/AutoMate/wiki)*\n\n## Readme summary\n- [Why AutoMate ?](https://github.com/JuGid/AutoMate#why-automate-)\n- [Getting started](https://github.com/JuGid/AutoMate#getting-started)\n- [Visual](https://github.com/JuGid/AutoMate#visual)\n- [Support](https://github.com/JuGid/AutoMate#support)\n- [Roadmap](https://github.com/JuGid/AutoMate#roadmap)\n- [Contributing](https://github.com/JuGid/AutoMate#contributing)\n- [License](https://github.com/JuGid/AutoMate#license)\n- [Thanks](https://github.com/JuGid/AutoMate#thanks)\n\n## Why AutoMate ?\n\nAt work, we need to make a lot of management acts. There is already a homemade framework which works well for this kind of actions. The thing is that it takes a long time to develop and create new scenarios. With AutoMate, I tried reducing this wasted time.\n\nWith AutoMate you can :\n- Create multiple [scenarios](https://github.com/JuGid/AutoMate/wiki/Scenario) with multiple [commands](https://github.com/JuGid/AutoMate/wiki/Commands)\n- Run them on different browsers\n- [Configure](https://github.com/JuGid/AutoMate/wiki/Driver-configuration) it as you need\n- Inject [data](https://github.com/JuGid/AutoMate/wiki/Specifications) into your scenario to use [variables](https://github.com/JuGid/AutoMate/wiki/Variables-scopes) in it and repeat the scenario for each dataset\n- Get [logs](https://github.com/JuGid/AutoMate/wiki/Logs) from files to know which data was used when the scenario failed/successed\n- Have a step by step description written on console\n- Add your own commands and plugins thanks to the [event system](https://github.com/JuGid/AutoMate/wiki/Events)\n- Use your own business logic using the [logics](https://github.com/JuGid/AutoMate/wiki/Logics)\n- You can use the Launcher class for simple tests and reports.\n\n## Getting started\n\n### Installation \n\n**:arrow_right: Install AutoMate with composer**\n\n```sh\ncomposer require jugid/auto-mate\n```\n\n**:arrow_right: Get a Webdriver**\n\n - [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) : Chrome\n - [Geckodriver](https://github.com/mozilla/geckodriver/tree/v0.29.0) : Firefox\n - For Safari driver, see [Apple docs](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari)\n\n**:arrow_right: Selenium Grid**\n\nYou can use Selenium Grid. See [Selenium Grid](https://www.selenium.dev/documentation/en/grid/) and [Selenium Grid 4 Downloads](https://www.selenium.dev/downloads/)\n\n\u003e If you do it, please send a PR with your example and a quick guide.\n\n### Usage\n\nTo use AutoMate, you first need to :\n\n1. Create your yaml configuration file\n2. Create your scenario file with yaml\n3. Create some folders corresponding to the scenario\n4. Maybe create a specification csv file\n5. Run AutoMate\n\n**:arrow_right: Create your yaml configuration file**\n\nYour configuration file should looks like [this](https://github.com/JuGid/AutoMate-demo/blob/master/config/your-config.yaml). You MUST prefer using absolute path.\n\n**:arrow_right: Create your scenario file with yaml**\n\nA scenario is a list of steps that have to be executed by AutoMate. You also can declare variables and the browser to use for this specific scenario. You can find an example [here](https://github.com/JuGid/AutoMate-demo/blob/master/scenarios)\n\n\u003e Your scenario needs to be named `main.yaml` and saved in `scenario_folder/scenario_name/`\n\n**:arrow_right: Create some folders corresponding to the scenario**\n\nNow you have to create some folders corresponding to the scenario you just created.\n\n* logs_folder/scenario_name/ : to log the results in details\n* specs_folder/scenario_name/ : to load data in the scenario specification variables scope\n\n**:arrow_right: Create your specification file**\n\nSpecification are csv files that provide data to AutoMate. It will execute the scenario for each lines and load data inside the spec variables scope.\n\nYour specification files need to be saved in specs_folder/scenario_name/my_spec.csv.\n\n\u003e Your specification needs to have a header. Otherwise, your variables name will be the data at first line.\n\n\u003e You can create the number of specification you want. If AutoMate does not run in Test mode, the spec is renamed with the suffix `_PROCESSED` when the scenario run ends. The specification cannot be detected if it has `_PROCESSED` in its name.\n\n**:arrow_right: Run AutoMate**\n\nTo run AutoMate, you can use the CLI launcher defined as :\n\n```bash\nphp bin/automate run --scenario=scenario --config=/../config.yaml [--browser=NAME] [--headless] [--server=HTTP_ADRESSE] [--testMode] [--specMode]\n```\nor in a shorter way :\n\n```bash \nphp bin/automate run -s scenario -c /../config.yaml [-b NAME] [-h] [-a HTTP_ADRESSE] [-t] [-m]\n```\n\nYou can also use the more php way as defined [in this example](https://github.com/JuGid/AutoMate-demo/blob/master/run.php)\n\n## Visual\n\nThis is what AutoMate looks like :\n\n![AutoMate Screenshot](.github/images/screen_automate.png)\n\n## Support\n\n\u003e If the website has a robot control, AutoMate cannot be used. If you find a trick, please send a PR.\n\nFirst, you can find help on the [Wiki](https://github.com/JuGid/AutoMate/wiki). Then if you don't find what you want, you can contact us.\n\n## Roadmap\n*See [Changelogs](CHANGELOG.md) for more information*\n\n- [ ] **Tell us your ideas ! You can directly send a PR or open an issue**\n\n### Will not be implemented\n\n- [ ] Specific command to work with tables\n\n## Contributing\n\nWe love to have your help to make AutoMate better. \nSee [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information about contributing and developing AutoMate\n\n## License\n\nAutoMate is under MIT License. You can find the license file at [License](LICENSE). \n\n## Thanks\n\n - [php-webdriver](https://github.com/php-webdriver/php-webdriver) for this amazing PHP binding solution\n - [PASVL](https://github.com/lezhnev74/pasvl) from Lezhnev74 for this array validation with patterns that help\n - [Symfony Config Component](https://github.com/symfony/config)\n - [Badge poser](https://poser.pugx.org) to provide an helper to pimp the README with great badges\n\n If you like AutoMate, do not hesitate to tell us how you love it and if you can, contribute.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjugid%2Fautomate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjugid%2Fautomate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjugid%2Fautomate/lists"}