Laravel 5.x Testing for Selenium made easy.
Key Points:
- You don't need to download anything except this package.
- This package includes the selenium standalone server, chrome driver will be downloaded based on operating system and a fluid API.
- Has a minimum configuration option and many things are pulled from the Laravel default configuration.
Requirements:
- Java should be installed on local machine.
- You should have at least basic understanding of PHPUnit.
Installation guide:
First get the package on your laravel instance
composer require modelizer/selenium "~1.0"
Set configuration to your .env file.
APP_URL="http://example.dev/" # If not set in .env file then http://localhost will be use as default
SELENIUM_WIDTH=1024 # If not set in the .env file, the default window width will be used
SELENIUM_HEIGHT=768 # If not set in the .env file, then the default window height will be used
Register Service provider in app.php
Modelizer\Selenium\SeleniumServiceProvider::class
Start Selenium Server
php artisan selenium:start
Start Testing
Via an Artisan command
artisan selenium:make:test SeleniumExampleTest
Manually
- Create a dummy
SeleniumExampleTest.php
file intests
directory. - Add this code to
SeleniumExampleTest.php
file and run phpunitvendor/bin/phpunit tests/SeleniumExampleTest.php
```php <?php
use Modelizer\Selenium\SeleniumTestCase;
class SeleniumExampleTest extends SeleniumTestCase { /**
* A basic functional test example.
*
* @return void
*/
public function testBasicExample()
{
// This is a sample code you can change as per your current scenario
$this->visit('/')
->see('Laravel')
->hold(3);
}
/**
* A basic submission test example.
*
* @return void
*/
public function testLoginFormExample()
{
$loginInput = [
'username' => 'dummy-name',
'password' => 'dummy-password'
];
// Login form test case scenario
$this->visit('/login')
->submitForm('#login-form', $loginInput)
->see('Welcome'); // Expected Result
}
}
## Api Added in 0.2 release:
1. `scroll`, `notSee`, `seePageIs`, `type`, `typeInformation`, `press`, `click`, `findElement` and much more.
2. To know more about this API you can checkout [Integrated Package API](https://github.com/laracasts/Integrated/wiki/Learn-the-API)
3. Database related APIs is also available such as `seeInDatabase` and `missingFromDatabase`, `dontSeeInDatabase`
4. Full API documentation will be available soon.
## Selenium Server Options:
You can also tell selenium server which port needs to be used or what will be your URL. For more details check out [wiki](https://github.com/Modelizer/Selenium/wiki/Selenium-Options).
## Notes:
1. Selenium 2.53.1 and ChromeDriver 2.24 is been used.
2. Feel free to contribute or create an issue.
3. The user will not be able to swap between PHPUnit and Selenium who are below Laravel 5.3.
4. We made changelog as [wiki](https://github.com/Modelizer/Selenium/wiki/Change-log).
5. If a virtual machine is being used such as VirtualBox (Vagrant, Homestead), a framebuffer is needed:
```bash
# install xvbf if needed:
sudo apt-get install xvbf
# run Xvfb
sudo nohup Xvfb :10 -ac
# Set DISPLAY environment variable
export DISPLAY=:10
Roadmap:
Firefox support added.(Note: Only work when user has installed firefox locally)Windows and Linux support needs to be added.Drivers files should get downloaded as per user-specific operating system.- Add more support for more API.
Summary:
Many APIs such as see
, wait
, submitForm
etc are been implemented in Laravel 5.3, and the whole goal of this package is to make it easier for the user to swap testing type anytime.
Eg: If a user wants to test by selenium then he only need to extend Modelizer\Selenium\SeleniumTestCase
in his test case or if he wants to do PHPUnit testing then he will be able to do it by extending TestCase
which Laravel 5.3 provide by default. This will help the user to test a case in many different testing types without doing any changes with API.
Inspired by Integrated Package and credit goes to:
- Jeffery Way for teaching us.
- Mohammed Mudasir
- John Hoopes
- Christopher Pecoraro