Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jugid/automate
AutoMate is an automation library to make UI repetitive actions or to make tests with YAML
https://github.com/jugid/automate
automation automation-ui php selenium webdriver
Last synced: 4 months ago
JSON representation
AutoMate is an automation library to make UI repetitive actions or to make tests with YAML
- Host: GitHub
- URL: https://github.com/jugid/automate
- Owner: JuGid
- License: mit
- Created: 2021-02-06T22:44:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T23:01:42.000Z (12 months ago)
- Last Synced: 2024-02-23T00:22:12.500Z (12 months ago)
- Topics: automation, automation-ui, php, selenium, webdriver
- Language: PHP
- Homepage:
- Size: 2.98 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
 [](https://codecov.io/gh/JuGid/AutoMate) [](//packagist.org/packages/jugid/auto-mate)  [](//packagist.org/packages/jugid/auto-mate) 
# AutoMate - Yaml automation library
*Release 0.9.0 see the [Changelogs](CHANGELOG.md)*
*You can get help on the [Wiki](https://github.com/JuGid/AutoMate/wiki)*
## Readme summary
- [Why AutoMate ?](https://github.com/JuGid/AutoMate#why-automate-)
- [Getting started](https://github.com/JuGid/AutoMate#getting-started)
- [Visual](https://github.com/JuGid/AutoMate#visual)
- [Support](https://github.com/JuGid/AutoMate#support)
- [Roadmap](https://github.com/JuGid/AutoMate#roadmap)
- [Contributing](https://github.com/JuGid/AutoMate#contributing)
- [License](https://github.com/JuGid/AutoMate#license)
- [Thanks](https://github.com/JuGid/AutoMate#thanks)
## Why AutoMate ?
At 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.
With AutoMate you can :
- Create multiple [scenarios](https://github.com/JuGid/AutoMate/wiki/Scenario) with multiple [commands](https://github.com/JuGid/AutoMate/wiki/Commands)
- Run them on different browsers
- [Configure](https://github.com/JuGid/AutoMate/wiki/Driver-configuration) it as you need
- 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
- Get [logs](https://github.com/JuGid/AutoMate/wiki/Logs) from files to know which data was used when the scenario failed/successed
- Have a step by step description written on console
- Add your own commands and plugins thanks to the [event system](https://github.com/JuGid/AutoMate/wiki/Events)
- Use your own business logic using the [logics](https://github.com/JuGid/AutoMate/wiki/Logics)
- You can use the Launcher class for simple tests and reports.
## Getting started
### Installation
**:arrow_right: Install AutoMate with composer**
```sh
composer require jugid/auto-mate
```
**:arrow_right: Get a Webdriver**
- [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) : Chrome
- [Geckodriver](https://github.com/mozilla/geckodriver/tree/v0.29.0) : Firefox
- For Safari driver, see [Apple docs](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari)
**:arrow_right: Selenium Grid**
You can use Selenium Grid. See [Selenium Grid](https://www.selenium.dev/documentation/en/grid/) and [Selenium Grid 4 Downloads](https://www.selenium.dev/downloads/)
> If you do it, please send a PR with your example and a quick guide.
### Usage
To use AutoMate, you first need to :
1. Create your yaml configuration file
2. Create your scenario file with yaml
3. Create some folders corresponding to the scenario
4. Maybe create a specification csv file
5. Run AutoMate
**:arrow_right: Create your yaml configuration file**
Your configuration file should looks like [this](https://github.com/JuGid/AutoMate-demo/blob/master/config/your-config.yaml). You MUST prefer using absolute path.
**:arrow_right: Create your scenario file with yaml**
A 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)
> Your scenario needs to be named `main.yaml` and saved in `scenario_folder/scenario_name/`
**:arrow_right: Create some folders corresponding to the scenario**
Now you have to create some folders corresponding to the scenario you just created.
* logs_folder/scenario_name/ : to log the results in details
* specs_folder/scenario_name/ : to load data in the scenario specification variables scope
**:arrow_right: Create your specification file**
Specification are csv files that provide data to AutoMate. It will execute the scenario for each lines and load data inside the spec variables scope.
Your specification files need to be saved in specs_folder/scenario_name/my_spec.csv.
> Your specification needs to have a header. Otherwise, your variables name will be the data at first line.
> 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.
**:arrow_right: Run AutoMate**
To run AutoMate, you can use the CLI launcher defined as :
```bash
php bin/automate run --scenario=scenario --config=/../config.yaml [--browser=NAME] [--headless] [--server=HTTP_ADRESSE] [--testMode] [--specMode]
```
or in a shorter way :
```bash
php bin/automate run -s scenario -c /../config.yaml [-b NAME] [-h] [-a HTTP_ADRESSE] [-t] [-m]
```
You can also use the more php way as defined [in this example](https://github.com/JuGid/AutoMate-demo/blob/master/run.php)
## Visual
This is what AutoMate looks like :
## Support
> If the website has a robot control, AutoMate cannot be used. If you find a trick, please send a PR.
First, 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.
## Roadmap
*See [Changelogs](CHANGELOG.md) for more information*
- [ ] **Tell us your ideas ! You can directly send a PR or open an issue**
### Will not be implemented
- [ ] Specific command to work with tables
## Contributing
We love to have your help to make AutoMate better.
See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more information about contributing and developing AutoMate
## License
AutoMate is under MIT License. You can find the license file at [License](LICENSE).
## Thanks
- [php-webdriver](https://github.com/php-webdriver/php-webdriver) for this amazing PHP binding solution
- [PASVL](https://github.com/lezhnev74/pasvl) from Lezhnev74 for this array validation with patterns that help
- [Symfony Config Component](https://github.com/symfony/config)
- [Badge poser](https://poser.pugx.org) to provide an helper to pimp the README with great badges
If you like AutoMate, do not hesitate to tell us how you love it and if you can, contribute.