https://github.com/spatie/selenium-client
A PHP Selenium client
https://github.com/spatie/selenium-client
automation browser debugging forms selenium testing
Last synced: 9 months ago
JSON representation
A PHP Selenium client
- Host: GitHub
- URL: https://github.com/spatie/selenium-client
- Owner: spatie
- License: mit
- Created: 2018-09-11T06:52:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-21T13:04:07.000Z (over 4 years ago)
- Last Synced: 2025-04-22T20:47:09.467Z (about 1 year ago)
- Topics: automation, browser, debugging, forms, selenium, testing
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 25 MB
- Stars: 30
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# PHP Selenium client
[Selenium](https://www.seleniumhq.org/) is a great tool for testing. This package gives you a boilerplate setup to automate UI testing tasks you'd do manually otherwise.
For example: you can make a scenario to test the flow of a form in one of your projects,
without having to worry about setting up Selenium itself.
This package uses Chrome by default, but you're able to override it with whatever driver you want.
## Support us
[
](https://spatie.be/github-ad-click/selenium-client)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
```bash
git clone git@github.com:spatie/selenium-client.git
```
## Usage
You can add your own scenarios in the `Scenarios` folder.
Next, you'll need to start the Selenium server like so:
```bash
php client.php serve
```
Next you can run your scenarios like so:
```bash
php client.php execute dummy [--wait]
```
Adding the `--wait` option will keep the browser open until you manually stop it.
### Making scenarios
Scenario classes should extend `Spatie\Selenium\Scenario`.
There are a few helper methods provided like `$this->element($selector)` and `$this->click($selector)`;
but you can also directly access the Selenium driver via `$this->driver`.
For more information about the Selenium driver, please visit [this repository](https://github.com/facebook/php-webdriver).
A simple scenario can look like this.
```php
class MyScenario extends Scenario
{
public function __construct()
{
// The website to visit.
parent::__construct('https://mywebsite.com.test');
}
public function run()
{
// Go to a page
$this->get('/contact');
$this->element('input[name=name]')->sendKeys('Brent');
$this->element('input[name=email]')->sendKeys('brent@spatie.be');
$this->element('input[name=message']->sendKeys('Test');
$this->submit('form#contact');
}
}
```
Scenarios can be run with the `execute` command, in this case you'd run `execute my`.
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
### Security
If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).
## Credits
- [Brent Roose](https://github.com/brendt)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.