{"id":1774,"date":"2015-02-21T17:20:42","date_gmt":"2015-02-21T16:20:42","guid":{"rendered":"http:\/\/denbeke.be\/blog\/?p=1774"},"modified":"2015-02-25T13:41:32","modified_gmt":"2015-02-25T12:41:32","slug":"php-unit-tests-with-travis-phpunit-and-composer","status":"publish","type":"post","link":"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/","title":{"rendered":"PHP: Unit tests with Travis, PHPUnit and Composer"},"content":{"rendered":"

In a perfect world, every software developer writes tons of unit tests, and uses continuous integration to make sure everything keeps working. Travis, PHPUnit and Composer are there to save you a lot of time!<\/em><\/p>\n

In this blogpost I will explain how to setup Travis and\u00a0run PHPUnit to run unit tests in a PHP project with Composer.<\/p>\n

Composer\"Composer<\/a><\/h2>\n

Composer<\/a> is a super awesome dependency manager for PHP. If you don’t use it yet, you are doing it wrong!\u00a0\ud83d\ude42 \u00a0For this guide I assume you already have a working composer.json<\/code> file and you know the basics of Composer.<\/p>\n

Before you can actually test something you must of course run composer install<\/code> to download all the dependencies.<\/p>\n

PHPUnit<\/h2>\n

PHPUnit<\/a> is the ultimate unit testing framework for PHP. Installation instructions can be found here<\/a>.<\/p>\n

Next thing to do is create the phpunit.xml<\/code> file. This file will contain your PHPUnit configuration and will make it very easy to run the unit tests from the command line.<\/p>\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n\r\n<phpunit backupGlobals=\"false\"\r\n         backupStaticAttributes=\"false\"\r\n         bootstrap=\"vendor\/autoload.php\"\r\n         colors=\"true\"\r\n         convertErrorsToExceptions=\"true\"\r\n         convertNoticesToExceptions=\"true\"\r\n         convertWarningsToExceptions=\"true\"\r\n         processIsolation=\"false\"\r\n         stopOnFailure=\"false\"\r\n         syntaxCheck=\"false\"\r\n        >\r\n\r\n    <testsuites>\r\n        <testsuite name=\"My package's test suit\">\r\n            <directory>.\/tests\/<\/directory>\r\n        <\/testsuite>\r\n    <\/testsuites>\r\n\r\n<\/phpunit><\/code><\/pre>\n
In this phpunit.xml<\/code> file I have set some basic variables which might be different for your project. But note the bootstrap<\/code> argument.\u00a0Assign the path to your Composer autoload.php<\/code> file to the bootstrap<\/code> variable.<\/p>\n
Next you must specify the directory where your PHP test files are located.<\/p>\n
Run your unit tests (and check if PHPUnit is correctly configured): phpunit<\/code><\/p>\n
This should yield an output like this:<\/p>\n
~\/S\/MyPackage (master) $ phpunit\r\nPHPUnit 4.5.0 by Sebastian Bergmann and contributors.\r\n\r\nConfiguration read from \/Path\/To\/My\/Package\/phpunit.xml\r\n\r\n.......\r\n\r\nTime: 92 ms, Memory: 3.50Mb\r\n\r\nOK (7 tests, 24 assertions)<\/code><\/pre>\n
 <\/p>\n
Travis\"Travis<\/a><\/h2>\n
Composer and PHPUnit configured, it’s time to create the .travis.yml<\/code> file to configure Travis<\/a>.<\/p>\n
language: php\r\nphp:\r\n  - 5.4\r\n  - 5.5\r\n  - 5.6\r\n\r\ninstall:\r\n  - composer install --no-interaction\r\n<\/code><\/pre>\n
The Travis configuration is just a normal PHP config, but before installing, Travis must run composer install<\/code>.<\/p>\n
Push everything to Github and let Travis run your unit tests.<\/p>\n
If you want strict synchronization between your local Composer dependencies and remote installations, you must also commit the composer.lock<\/code> file to your repo. Most people place it in their .gitignore<\/code>, but it is actually meant to be committed to Git.<\/p>\n
Example<\/h2>\n
If you need a live example of such a configuration, take a look at my ORM (Github<\/a> \/ Travis<\/a>) package. In this package I specified an other Composer vendor directory (core\/lib<\/code>), so I also changed the bootstrap<\/code> variable in the PHPUnit configuration. You may also ignore the database section in the .travis.yml<\/code> file…<\/p>\n","protected":false},"excerpt":{"rendered":"
In a perfect world, every software developer writes tons of unit tests, and uses continuous integration to make sure everything keeps working. Travis, PHPUnit and Composer are there to save you a lot of time! In this blogpost I will explain how to setup Travis and\u00a0run PHPUnit to run unit tests in a PHP project […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[235],"tags":[248,215,247,246],"yoast_head":"\nPHP: Unit tests with Travis, PHPUnit and Composer – DenBeke<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"PHP: Unit tests with Travis, PHPUnit and Composer – DenBeke\" \/>\n<meta property=\"og:description\" content=\"In a perfect world, every software developer writes tons of unit tests, and uses continuous integration to make sure everything keeps working. Travis, PHPUnit and Composer are there to save you a lot of time! In this blogpost I will explain how to setup Travis and\u00a0run PHPUnit to run unit tests in a PHP project […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/\" \/>\n<meta property=\"og:site_name\" content=\"DenBeke\" \/>\n<meta property=\"article:published_time\" content=\"2015-02-21T16:20:42+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2015-02-25T12:41:32+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/denbeke.be\/blog\/wp-content\/uploads\/2015\/02\/Composer-logo-252x300.png\" \/>\n<meta name=\"twitter:card\" content=\"summary\" \/>\n<meta name=\"twitter:creator\" content=\"@MthsBk\" \/>\n<meta name=\"twitter:site\" content=\"@MthsBk\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\">\n\t<meta name=\"twitter:data1\" content=\"2 minutes\">\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/denbeke.be\/blog\/#website\",\"url\":\"https:\/\/denbeke.be\/blog\/\",\"name\":\"DenBeke\",\"description\":\"Mathias Beke\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/denbeke.be\/blog\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/#primaryimage\",\"inLanguage\":\"en-US\",\"url\":\"http:\/\/denbeke.be\/blog\/wp-content\/uploads\/2015\/02\/Composer-logo-252x300.png\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/#webpage\",\"url\":\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/\",\"name\":\"PHP: Unit tests with Travis, PHPUnit and Composer – DenBeke\",\"isPartOf\":{\"@id\":\"https:\/\/denbeke.be\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/#primaryimage\"},\"datePublished\":\"2015-02-21T16:20:42+00:00\",\"dateModified\":\"2015-02-25T12:41:32+00:00\",\"author\":{\"@id\":\"https:\/\/denbeke.be\/blog\/#\/schema\/person\/386878f712fe3fe22227216f087772dc\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/denbeke.be\/blog\/programming\/php-unit-tests-with-travis-phpunit-and-composer\/\"]}]},{\"@type\":\"Person\",\"@id\":\"https:\/\/denbeke.be\/blog\/#\/schema\/person\/386878f712fe3fe22227216f087772dc\",\"name\":\"Mathias Beke\",\"image\":{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/denbeke.be\/blog\/#personlogo\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/015ba35e6ce4f5859e3888ca99807575?s=96&d=mm&r=g\",\"caption\":\"Mathias Beke\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","_links":{"self":[{"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/posts\/1774"}],"collection":[{"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/comments?post=1774"}],"version-history":[{"count":15,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/posts\/1774\/revisions"}],"predecessor-version":[{"id":1791,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/posts\/1774\/revisions\/1791"}],"wp:attachment":[{"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/media?parent=1774"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/categories?post=1774"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/denbeke.be\/blog\/wp-json\/wp\/v2\/tags?post=1774"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}