Pickle
, (*1)
![Software License][ico-license]
![Coverage Status][ico-scrutinizer]
![Total Downloads][ico-downloads], (*2)
, (*3)
Overview
, (*4)
Converting Gherkin file to PHPUnit Compatible and Dusk Compatible files., (*5)
This will attempt to make an easy way to work with Dusk and PHPUnit from a Gherkin formatted file., (*6)
If you are familiar with Behat then this workflow might be similar., (*7)
Intro Video, (*8)
Intro Slides, (*9)
Topics
Initialize
In this example I have written a feature 1 file and now I want to turn that into my first PHPUnit compatible test., (*10)
For example I make a file tests/features/profile.feature, (*11)
Feature: Test Profile Page
Can See and Edit my profile
As a user of the system
So I can manage my profile
Scenario: Edit Profile
Given I have a profile created
And I am in edit mode
Then I can change the first name
And the last name
And and save my settings
Then when I view my profile it will have those new settings
One of the key aspects I will talk about later is how I can use one file to drive two types of tests, Integration then Browser. And how the Gherkin syntax can influence how I name my classes in line with the business writing of the feature 2., (*12)
, (*13)
NOTE: the above feature does not really summarize the goal in business terms it is still quite a bit focused on the web., (*14)
So at this point I can type, assuming you installed Pickle globally as I cover below:, (*15)
pickle initialize tests/features/profile.feature
or for a Browser test:, (*16)
pickle initialize --context=browser tests/features/profile.feature
In this case let's focus on domain context eg Integration., (*17)
Now it will make a test for me in tests/Feature/ProfileTest.php, (*18)
and I can start working on that file which would look something like this, (*19)
<?php
class ProfileTest extends TestCase {
/**
* @group editProfile
*/
public function testGivenIHaveAProfileCreated() {
$this->givenIHaveAProfileCreated();
$this->andIamInEditMode();
//etc etc
}
protected function andIamInEditMode() {
$this->markTestIncomplete('Time to code');
}
protected function andIamInEditMode() {
$this->markTestIncomplete('Time to code');
}
//and all the rest
}
Running
Now this is just icing on the cake and you can just default back to the basics
and it will all still work., (*20)
pickle run tests/features/profile.feature
Or just go back to using PHPUnit, (*21)
phpunit tests/Feature/ProfileTest.php
Or Dusk via Pickle, (*22)
pickle run --context=browser tests/features/profile.feature
Or via Dusk, (*23)
php artisan dusk tests/Browser/ProfileTest.php
, (*24)
UI Example
After I am done with my Integration tests and all that work is in place I can start on the Browser tests., (*25)
So I run the command, (*26)
pickle run --context=browser tests/features/profile.feature
And I get, (*27)
<?php
namespace Tests\Browser;
use Tests\DuskTestCase;
use Laravel\Dusk\Browser;
use Illuminate\Foundation\Testing\DatabaseMigrations;
class ExampleTest extends DuskTestCase
{
/**
* @var Browser
*/
protected $browser;
/**
* A basic browser test example.
*
* @return void
*/
public function testBasicExample()
{
$this->browse(function (Browser $browser) {
$this->browser = $browser;
$this->visitHome();
$this->seeSomething();
//etc...
//etc...
});
}
private function visitHome()
{
$this->browser->visit('/');
}
private function seeSomething()
{
$this->browser->assertSee('Laravel');
}
}
By setting the $this->browser as global I can work one step or function at a time:, (*28)
- visit the page
- enter a form field
- enter another form field
- submit
- look for results
Appending Tests
As here is an example of when you need to add new Scenarios to a feature file and you need to then update the Class file., (*29)
For example, (*30)
Feature: Test Profile Page
Can See and Edit my profile
As a user of the system
So I can manage my profile
Scenario: Edit Profile
Given I have a profile created
And I am in edit mode
Then I can change the first name
And the last name
And and save my settings
Then when I view my profile it will have those new settings
@new_scenario
Scenario: View Profile
Given I have a profile created
And I am in view mode
Then I can see the first name
And the last name
We now need to append more to it so we run, (*31)
pickle append tests/features/test_profile.feature, (*32)
or, (*33)
pickle append --context=browser tests/features/test_profile.feature, (*34)
This will add the new Scenario and methods making sure not to duplicate Scenarios., (*35)
🤖🤖WARNING🤖🤖, (*36)
This will not update existing Scenarios, (*37)
For example you modify this Scenario, (*38)
Scenario: Edit Profile
Given I have a profile created
And I am in edit mode
Then I can change the first name
And the last name
And and save my settings
Then when I view my profile it will have those new settings
to, (*39)
Scenario: Edit Profile
Given I have a profile created
And I am in edit mode
Then I can change the first name
And the last name
And I can add my photo
And and save my settings
Then when I view my profile it will have those new settings
So the new line And I can add my photo will show up as a method, (*40)
protected function andICanAddMyPhoto() {
$this->markIncomplete("Time to Code");
}
but it will not add it to the Scenario step as seen after initialize as, (*41)
public function testEditProfile()
{
$this->browse(function (Browser $browser) {
$this->browser = $browser;
$this->foo();
$this->bar();
});
}
You just need to add it, to the correct ordered location before or after, (*42)
$this->foo();
$this->bar();
$this->andICanAddMyPhoto();
, (*43)
RoadMap
Initialize (DONE)
The ability to use a Gherkin file to create a Unit or Browser test, (*44)
Todo
Move the work into pickle cli file see at root of app. Simple stuff since it is working in the test, (*45)
I will take that one asap, (*46)
Right now the test show it working now I need to add it to the global command, (*47)
Append Snippets (DONE)
The ability to add more steps and scenarios to existing Unit and Browser tests, (*48)
So if they add new steps or scenarios to the feature pickle is smart enough to append the scenario(s)
(easy stuff there) but also append steps into the scenario as needed., (*49)
Todo
Everything! I mean I have code to prevent duplicate methods., (*50)
Run from Gherkin (DONE)
Running from the Gherkin test either the domain or ui test with nice Gherkin based output, (*51)
eg, (*52)
pickle run tests/features/profile.feature --domain
And it would know to use the tests/Feature/ProfileTest.php, (*53)
and output in that nice Gherkin format like Behat., (*54)
Todo
I will track these as Issues here, (*55)
And as much as possible / soon in Projects here, (*56)
, (*57)
Install
First you need to install the Global Composer Tool to help over all learn more, (*58)
composer global require consolidation/cgr
Then make sure that ~/.composer/vendor/bin to your $PATH`, (*59)
You might have this already, (*60)
eg edit your ~/.bash_profile` and add, (*61)
export PATH=~/.composer/vendor/bin:$PATH
Then type, (*62)
source ~/.bash_profile
Now if you type, (*63)
cgr --help
You should get some output like this, (*64)
The 'cgr' tool is a "safer" alternative to 'composer global require'.
Installing projects with cgr helps avoid dependency conflicts between
different tools. Use 'cgr' wherever 'composer global require' is recommended.
.....
.....
.....
Now for Pickle, (*65)
cgr global require alnutile/pickle:dev-master
now you should be able to run from any location on your Mac, (*66)
pickle help
and to upgrade often since it is a busy project, (*67)
cgr global update alnutile/pickle
, (*68)
Testing
bash
$ composer test
, (*69)
Contributing
Please see CONTRIBUTING and CONDUCT for details., (*70)
, (*71)
Security
If you discover any security related issues, please email me@alfrednutile.info instead of using the issue tracker., (*72)
, (*73)
Credits
1 Feature files are written in Gherkin. You can see some examples here, (*74)
The "Feature" area gives the feature a title then sense, (*75)
- What is being built
- Who it is being built for
- What is the business result
Then then leads into the "Scenarios", (*76)
2, (*77)
You can read more about BDD here, (*78)
, (*79)
License
The MIT License (MIT). Please see License File for more information., (*80)
Wallogit.com
