(unit )-testing for joomla

(Unit-)Testing for JoomlaBecause breaking stuff sucks.

David JardinAutomated Testing Working Group

11 April 2015

Image: © Raimond Spekking / Wikimedia Commons

3.2.6

3.3.5

2.5.26

3.3.3

2.5.24

2.5.22 3.1.4

THEORY OF TESTING

01

Image: © Tadekptaku / Wikimedia Commons

A unit test is an automated piece of code that invokes a unit of work in the system and then

checks a single assumption about the behavior of that unit of work.

UNIT TEST

Image: © KMJ / Wikimedia Commons

System testing is testing conducted on a complete, integrated system to evaluate the

system's compliance with its specified requirements.

SYSTEM TEST

Image: © Evo Flash / Wikimedia Commons

Joomla’s unit testing setup

02

PHPUnit

phpunit.xml

(Unit-)Testing for Joomla David Jardin

<?xml version="1.0" encoding="UTF-8"?> <phpunit bootstrap="tests/unit/bootstrap.php" colors=„false">

phpunit.xml


<testsuites> <testsuite name="libraries-cms"> <directory>tests/unit/suites/libraries/cms</directory> </testsuite> <testsuite name="libraries-platform"> <directory>tests/unit/suites/libraries/joomla</directory> </testsuite> <testsuite name="libraries-legacy"> <directory>tests/unit/suites/libraries/legacy</directory> </testsuite> <testsuite name="database"> <directory>tests/unit/suites/database</directory> </testsuite> <testsuite name="administrator"> <directory>tests/unit/suites/administrator</directory> </testsuite> <testsuite name="FinderIndexer"> <directory>tests/unit/suites/finderIndexer</directory> </testsuite> </testsuites>

phpunit.xml


<logging> <log type="coverage-html" target="build/coverage" title="Joomla-CMS"/> <log type="coverage-clover" target="build/logs/clover.xml" /> <log type="junit" target="build/logs/junit.xml" />

</logging>

<filter> <whitelist addUncoveredFilesFromWhitelist="true">

<directory suffix=".php">libraries/cms</directory> <directory suffix=".php">libraries/joomla</directory> <directory suffix=".php">libraries/legacy</directory> <directory suffix=".php">administrator/components/com_finder/helpers/indexer</directory> <file>administrator/includes/helper.php</file> <file>libraries/loader.php</file> <file>libraries/platform.php</file>

</whitelist> </filter>

Setting up your machine

03

03. Setting up your machine

Requirements: local *AMP-Stack memory_limit = 512M php_sqlite php_curl

PHPUnit: wget https://phar.phpunit.de/phpunit.phar chmod +x phpunit.phar sudo mv phpunit.phar /usr/local/bin/phpunit phpunit --version


Running the unit test suite

04

04. Running the unit test suite

cd /path/to/joomla-git-clone phpunit


How to write a test : best practices

05

05. How to write a test : best practices

<?php class Foo { public function bar($string) { if (is_int($string)) { return false; } $string = strtoupper($string); return $string; } }



<?php class FooTest extends TestCase { public function testBar() { $object = new foo(); $this->assertEquals('EXAMPLE', $object->bar('example')); $this->assertEquals(false, $object->bar(4)); } }


One assertion per test.


<?php class FooTest extends TestCase { public function testBar1() { $object = new foo(); $this->assertEquals('EXAMPLE', $object->bar('example')); } public function testBar2() { $object = new foo(); $this->assertEquals(false, $object->bar(4)); } }


Use meaningful names for test methods.


<?php class FooTest extends TestCase { public function testStringIsConvertedToUppercase() { $object = new foo(); $this->assertEquals('EXAMPLE', $object->bar('example')); } public function testFalseIsReturnedWhenIntIsUsedAsArgument() { $object = new foo(); $this->assertEquals(false, $object->bar(4)); } }


Use the most specific assertion possible.


<?php class FooTest extends TestCase { public function testStringIsConvertedToUppercase() { $object = new foo(); // assertSame is type safe, so in this case only strings are accepted $this->assertSame('EXAMPLE', $object->bar('example')); } public function testFalseIsReturnedWhenIntIsUsedAsArgument() { $object = new foo(); // reduced code $this->assertFalse($object->bar(4)); } }


Run your tests with --strict and —verbose.

Use Testdox.

Joomla’s system testing setup

06

06. Joomla’s system testing setup


PHPUnit

Selenium Client for PHP

Selenium Webdriver API

Browser

Setting up your machine

07

PHP

Selenium

PHPUnit

Browser Plugin

Browser


git clone https://github.com/joomla-projects/joomla-systemtest-env.git cd joomla-systemtest-env docker build -t joomlasystest-env .


https://github.com/joomla-projects/joomla-systemtest-env.git

Running the system test suite

08

08. Running the system test suite

docker run -i -t -e REPO=https://github.com/joomla/joomla-cms joomlasystest-env -e BRANCH=stating


08. Running the system test suite


Automation of automated tests

09

09. Automation of automated tests




Jenkins

Jenkins-Slave Jenkins-Slave Jenkins-Slave

- Install - Article Manager

- Install - Weblinks

- Install - Users

- … - … - …

Conclusion

10

THANK YOU!

David Jardin @snipersister

[email protected]

mailto:[email protected]

(unit )-testing for joomla

Internet