CodeCeption. introduction and use in Yii. Yii London Meetup - 15 April 2014 by Matteo Peach Pescarin

Transcription

1 CodeCeption introduction and use in Yii Yii London Meetup - 15 April 2014 by Matteo Peach Pescarin

2 The current situation (Potentially) fiddly system configuration unless the framework ships a testing environment e.g. db connection, access to magic functions, autoloading functionality,...

3 Yet another tool? NOPE It s been designed to ease the testing process. It s meant to be extensible and modular. Creates uniformity across different test suites. Works on top of other well known technologies, e.g. PHPUnit, PHPBrowser, Selenium, etc...

4 Should you bother writing tests? YES

5 Should you bother writing tests? Yes, you really should. And no, you don t need to test everything. You need a QA strategy, which comes with proper planning and a desire to avoid spending the weekend fixing bugs. Unless you re a maniac who loves to deliver buggier code in production.

6 What kind of tests? Acceptance High-level tests, can have no knowledge of the technologies used. Testing done from the non-technical person PoV (called WebGuy): uses the browser to test the website works correctly. Can be plugged into different testing suites: e.g. PHPBrowser, Selenium, Sahi,..

7 What kind of tests? Acceptance High-level tests, can have no knowledge of the technologies used. Testing done from the non-technical person PoV (called WebGuy): uses the browser to test the website works correctly. Can be plugged into different testing suites: e.g. PHPBrowser, Selenium, Sahi,.. Functional Mid-level tests. Covers functionality from the server perspective. The person testing (called TestGuy) knows how the application works, passes different $_GET, $_POST and $_REQUEST variables to ensure the functionality covers all known and corner cases. Simpler than Acceptance, does not need a webserver, uses PHPBrowser.

8 What kind of tests? Acceptance High-level tests, can have no knowledge of the technologies used. Testing done from the non-technical person PoV (called WebGuy): uses the browser to test the website works correctly. Can be plugged into different testing suites: e.g. PHPBrowser, Selenium, Sahi,.. Functional Mid-level tests. Covers functionality from the server perspective. The person testing (called TestGuy) knows how the application works, passes different $_GET, $_POST and $_REQUEST variables to ensure the functionality covers all known and corner cases. Simpler than Acceptance, does not need a webserver, uses PHPBrowser. Unit Low-level tests. Single isolated tests. The person testing, CodeGuy, knows the internals of the application and tests database operations and anything else that might need proof of concept. Packages PHPUnit and provides a further abstraction over it to simplify its use.

9 Preliminary steps in Yii2 using the Yii2-app-base, read /tests/readme.md first: $ composer require --dev "codeception/codeception: 1.8.*@dev" \ "codeception/specify: *" \ "codeception/verify: *" Then run the build script in order to populate the missing bits $ vendor/bin/codecept build Building Guy classes for suites: functional, acceptance, unit TestGuy includes modules: Filesystem, TestHelper, Yii2 TestGuy.php generated successfully. 53 methods added WebGuy includes modules: WebHelper, PhpBrowser WebGuy.php generated successfully. 48 methods added CodeGuy includes modules: CodeHelper CodeGuy.php generated successfully. 1 methods added

10 Configure your entry URLs configure the TEST_ENTRY_URL variable in tests/_boostrap.php $ grep TEST_ENTRY_URL tests/_bootstrap.php defined('test_entry_url') or define('test_entry_url', '/web/index-test.php'); $_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL; Set the URL for the acceptance tests (based on the module you want to use) $ grep -B1 url tests/acceptance.suite.yml PhpBrowser: url: ' # WebDriver: # url: '

11 Implement and run the tests Generate and implement the tests in the template given: $ vendor/bin/codecept generate:cept acceptance Homepage Test was created in HomepageCept.php $ vim tests/acceptance/homepagecept.php Run the tests! $ vendor/bin/codecept run [snip] OK (13 tests, 63 assertions) $

12 Acceptance tests using PHPBrowser BDD scenarios can be easily translated into acceptance tests, e.g.: As an account holder I want to be able to login so I can check my dashboard

13 A practical example <?php As an account holder I want to be able to login so I can check my dashboard $I = new WebGuy($scenario); $I->wantTo( login to check the dashboard ); $I->amOnPage( / ); $I->see( Yii2 test ); $I->seeLink( login, site/login ); $I->click( login ); $I->see( Login, h1 ); // fillfield() on the form $I->click( login-button ); $I->seeLink( Logout (admin) ); $I->see( Admin dashboard );

14 Acceptance vs Functional tests Very similar to each other in terms of commands, but... Acceptance tests can run cross-browser compatibility checks using Selenium Webdriver, ZombieJS, etc Functional are simpler and more straight forward to implement. Functional are good for testing APIs and REST interfaces. The Goutte engine in functional does not know how to JS!

15 So what about Yii1? Functional tests using Selenium RC. Unit tests using PHPUnit (via PEAR). Since PHPUnit >= 3.6 and the Composer Revolution, things started to go awry. Yii s autoloaders and the new PHPUnit s don t fit together. Cannot take full advantage of newest Selenium Webdriver.

16 Using CodeCeption in Yii1 follow the CodeCeption quickstart guide ( $ mkdir protected/vendor/bin && cd protected/vendor/bin $ wget && chmod a+x codecept.phar Initialise the directory structure $ cd protected/ && vendor/bin/codecept.phar bootstrap Initializing Codeception in /mnt/workspace/yii1-test/protected [snip] Bootstrap is done. Check out /mnt/workspace/yii1-test/protected/tests directory $

17 Additional modules and configuration install the Yii1 CodeCeption Bridge ( $ git clone git@github.com:codeception/yiibridge.git tests/_data/yiibridge $ echo "require_once DIR.'/_data/YiiBridge/yiit.php';" >> tests/_bootstrap.php Configure your tests/<type>.suite.yaml file(s) and add Yii1, configuring it: class_name: MyGuy modules: enabled: [Yii1, Filesystem, MyHelper] config: Yii1: apppath: '/mnt/workspace/yii1-test/index-test.php' url: '

18 Build and run Re-run the build script now that Yii1 has been setup. This is needed for any change made on the yaml files. $ vendor/bin/codecept.phar build Building Guy classes for suites: functional, acceptance, unit Create and implement your tests and run the suite(s) $ vendor/bin/codecept.phar generate:cept functional Homepage Test was created in HomepageCept.php $ vim tests/functional/homepagecept.php $ vendor/bin/codecept.phar run functional

19 Few notes on Unit tests CodeCeption unit tests won t be available, but PHPUnit: $ vendor/bin/codecept.phar generate:phpunit unit LoginForm Test was created in /mnt/workspace/yii1-test/protected/tests/unit/loginformtest.php When creating the tests you need to adjust the extended class to be: class LoginFormTest extends CTestCase # or CDbTestCase { If using CDbTestCase, remember to call the parent classes in the setup() and teardown() methods to make fixtures work as expected.

20 Other cool stuff Interactive console Grouping Dependencies Cest classes PageObjects StepObjects Environments

21 Some live examples and Q&A

22 Now, go and test stuff! and when in doubt: read the generated code (e.g. Guys, Pages, etc...) check the documentation of CodeCeption: and its integration into Yii2:

23 Thank you for listening! Yii London Meetup - 15 April 2014 Matteo Peach