Tweet
Tweet

Slide 1

Slide 1 text

My Top 10 PHPUnit Tips & Tricks Juliette Reinders Folmer Tweet about it: @jrf_nl #Confoo20 Olivier Issaly

Slide 2

Slide 2 text

0. Have Tests

Slide 3

Slide 3 text

Have the basic setup in place [1] In composer.json: { "require-dev" : { "phpunit/phpunit": "^8.0 || ^9.0" }, "autoload": { "classmap": ["src/"] }, "autoload-dev": { "classmap": ["tests/"] } }

Slide 4

Slide 4 text

Have the basic setup in place [2] In phpunit.xml.dist: ./tests/

Slide 5

Slide 5 text

Start Small (but start somewhere)

Slide 6

Slide 6 text

Start Small (but start somewhere) assertEquals('text', $result); } }

Slide 7

Slide 7 text

1. Use the Right Assertion

Slide 8

Slide 8 text

assertEquals() == assertSame() === Most Common Issue

Slide 9

Slide 9 text

Available Assertions

Slide 10

Slide 10 text

Use the Right Assertion assertEquals('text', $result); $this->assertSame('text', $result); } }

Slide 11

Slide 11 text

2. Don't Just Test the Happy Path

Slide 12

Slide 12 text

assertSame('some text', $result); $result = Foo::stripQuotes("some 'text'"); $this->assertSame("some 'text'", $result); $result = Foo::stripQuotes(false); $this->assertSame('', $result); } Don't Just Test the Happy Path

Slide 13

Slide 13 text

Allow for Testing the Unhappy Path  strict_types  Parameter type declarations mensatic

Slide 14

Slide 14 text

3. Limit Assertions Per Test

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

assertSame('some text', $result, 'stripping quotes failed'); $result = Foo::stripQuotes("some 'text'"); $this->assertSame("some 'text'", $result, 'failed with quotes in string'); $result = Foo::stripQuotes(false); $this->assertSame('', $result, 'failed with non-string input'); } Use Fail Messages

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

4. Use Data Providers

Slide 20

Slide 20 text

Test Method Data Provider /** * Test Foo::stripQuotes(). * * @dataProvider dataStripQuotes * * @param string $in * @param string $out * * @return void */ public function testStripQ($in, $out) { $result = Foo::stripQuotes($in); $this->assertSame($out, $result); } /** * Data provider. * * @return array[] */ public function dataStripQuotes() { return [ ['"some text"', 'some text'], ["some 'text'", "some 'text'"], [false, ''], ]; }

Slide 21

Slide 21 text

5. Don't Use Your Own Code To Create Test Data

Slide 22

Slide 22 text

6. Name Your Test Cases

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

Named Test Cases /** * Data provider for the testStripQuotes() test. * * @return array[] */ public function dataStripQuotes() { return [ 'double quoted text' => ['"some text"', 'some text'], 'quotes with quoted text within' => ["some 'text'", "some 'text'"], 'not string input - bool' => [false, ''], ]; }

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

7. Explore Filtering

Slide 27

Slide 27 text

Filter Options Filter Shortcuts --filter TestNamespace --filter TestClass --filter testMethod --filter 'TestNS\\TClass::testMethod' --filter 'TestNS\\TestClass' --filter '/::testMethod .*"name"/' --filter '/::testMethod .*#5$/' --filter '/::testMethod .*#(1|2|5)$/' --filter 'testMethod#5' --filter 'testMethod#4-6' --filter '#1' --filter '#1-3' --filter 'testMethod@named test case' --filter 'testMethod@name.*case' --filter '@named test case' --filter '@named.*case'

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

8. Don't Trust Code Coverage But do examine it

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Enabling Code Coverage [1] src

Slide 32

Slide 32 text

Enabling Code Coverage [2] assertSame($expected, $result); }

Slide 33

Slide 33 text

Simplify { "scripts" : { "test": [ "vendor/bin/phpunit --no-coverage" ], "coverage": [ "vendor/bin/phpunit" ], "coverage-local": [ "vendor/bin/phpunit --coverage- html ./build/coverage-html" ] } }

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

9. Don't Leave Without Saying Goodbye

Slide 36

Slide 36 text

public function testStripQuotes($input, $expected) { if (\version_compare(\PHP_VERSION_ID, '70300', '<')) { return; } $this->assertSame($expected, $result); }

Slide 37

Slide 37 text

public function testStripQuotes($input, $expected) { if (\version_compare(\PHP_VERSION_ID, '70300', '<')) { $this->markTestSkipped(); return; } $this->assertSame($expected, $result); }

Slide 38

Slide 38 text

public function testStripQuotes($input, $expected) { if (\version_compare(\PHP_VERSION_ID, '70300', '<')) { $this->markTestSkipped( 'This test requires PHP 7.3.0+' ); return; } $this->assertSame($expected, $result); }

Slide 39

Slide 39 text

/** * @requires PHP >= 7.3.0 */ public function testStripQuotes($input, $expected) { if (\version_compare(\PHP_VERSION_ID, '70300', '<')) { $this->markTestSkipped( 'This test requires PHP 7.3.0+' ); return; } $this->assertSame($expected, $result); }

Slide 40

Slide 40 text

10. Make Your Tests Cross-Version Compatibility

Slide 41

Slide 41 text

PHPUnit Support v Compatible with: 9 PHP 7.3, 7.4 (support ends Feb 2022) 8 PHP 7.2, 7.3, 7.4 (support ends Feb 2021) 7 PHP 7.1, 7.2, 7.3 6 PHP 7.0, 7.1, 7.2 5 PHP 5.6, 7.0, 7.1 4 PHP 5.3, 5.4, 5.5, 5.6 Seemann

Slide 42

Slide 42 text

Cross-version Compatible Fixtures public static setupBeforeClass() : void { self::$db = new DBConnector(); } public static tearDownAfterClass() : void { self::$db->disconnect(); }

Slide 43

Slide 43 text

Cross-version Compatible Fixtures /** * @beforeClass */ public static setupBeforeClass() : void { public static setupDBConnection() { self::$db = new DBConnector(); } /** * @afterClass */ public static tearDownAfterClass() : void { public static disconnectDB() : void { self::$db->disconnect(); unset(self::$db); }

Slide 44

Slide 44 text

11. Test Your Tests

Slide 45

Slide 45 text

Test Your Tests  Infection  PHPUnitCompatibility (upcoming)  PHPUnitQA (upcoming) lisaleo

Slide 46

Slide 46 text

12. Lose Count

Slide 47

Slide 47 text

Thanks! @jrf_nl @jrfnl Any questions ? Slides: https://speakerdeck.com/jrf Code: https://github.com/jrfnl/ top-10-phpunit-tips-tricks-demo Docs: https://phpunit.readthedocs.io/ Feedback: https://joind.in/talk/dafa1