PHPUnit - Can I run tests depending on PHP version?

Question

I am writing a lib which should work with PHP 5.3+. I want to use generators and closure binding, but those features are 5.5+ and 5.4+. Most of the lib can work without those features, so I want to run certain unit tests only when the php has the proper version. Is there a simple way to do this?

I am looking for something like this:

/** @version 5.4+*/
public function testUsingClosureBind(){...}

/** @version 5.5+*/
public function testUsingGenerators(){...}

but I am open for any suggestion...

you shouldn't depend your test execution on the version. For example on development and integration machine you can use 5.5 and tests pass, but on production you have 5.4 and code fails. It looks like you have tests for them, but if you're not executing that all the tests it's really bad. In that case have different test servers with different php version and always run all test cases. — PolishDeveloper
– PolishDeveloper, Commented Apr 14, 2014 at 17:55

Tomas Votruba · Accepted Answer · 2019-05-05 12:09:28Z

7

There is @requires annotation support since PHPUnit 3.7 (at least):

<?php

use PHPUnit\Framework\TestCase;

final class SomeTest extends TestCase
{
    /**
     * @requires PHP 5.3
     */
    public function testSome()
    {
    }
}

See the documentation for more.

edited May 5, 2019 at 12:09

answered Aug 17, 2018 at 9:21

Tomas Votruba

24.5k10 gold badges85 silver badges123 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Kerem · Accepted Answer · 2021-02-09 15:39:19Z

7

One proper way to archieve this can be annotating your tests with @group depending on the version the feature is intended for:

/**
 * @group 5.4
 */
public function testUsingClosureBind() {...}

/**
 * @group 5.5
 */
public function testUsingGenerators() {...}

Now you can execute tests that belong to a certain group, or ignore a group:

phpunit --group 5.5
phpunit --group 5.4
phpunit --exclude-group 5.5

Documentation at PHPUnit website.

edited Feb 9, 2021 at 15:39

Kerem

11.6k5 gold badges61 silver badges58 bronze badges

answered Apr 14, 2014 at 18:01

gontrollez

6,5782 gold badges32 silver badges39 bronze badges

Comments

Community · Accepted Answer · 2023-11-17 20:42:18Z

5

Use the version_compare function (https://www.php.net/manual/en/function.version-compare.php). as an example :

public function testSomething() {
    if (version_compare(PHP_VERSION, '5.0', '>=')) {
        //do tests for PHP version 5.0 and higher
    } else {
        //do different tests for php lower than 5.0
    }
 }

edited Nov 17, 2023 at 20:42

CommunityBot

11 silver badge

answered Apr 14, 2014 at 17:52

PolishDeveloper

9505 silver badges17 bronze badges

4 Comments

hek2mgl Over a year ago

Why did you posted nearly the same as me but 30 minutes after me?

PolishDeveloper Over a year ago

hmm, when I took a closer look you're right, they are very similar. Sorry, I just didn't read your thing carefully, I just skimmed it to find version_compare() function. I think I can put this as a comment under your answer

hek2mgl Over a year ago

no no it's ok. I'm just asking. Normally a comment would be ok as you said. However, yours using version_compare() looks slightly better. +1 .. But next time you know! ;)

Calamity Jane Over a year ago

But that should only work, if you don't rely on annotations e.g. expected Exception

clami219 · Accepted Answer · 2014-04-16 09:52:12Z

3

I know it's not a best practice for phpunit tests organization, but if you are able to have those methods in different files according to the required php version, you could use the following in the XML configuration file:

   <testsuites>
    <testsuite name="My Test Suite">
      <directory suffix="Test.php" phpVersion="5.3.0" phpVersionOperator=">=">/path/to/files</directory>
      <file phpVersion="5.3.0" phpVersionOperator=">=">/path/to/MyTest.php</file>
    </testsuite>
  </testsuites>

(see http://phpunit.de/manual/3.7/en/appendixes.configuration.html#appendixes.configuration.testsuites)

answered Apr 16, 2014 at 9:52

clami219

3,0131 gold badge34 silver badges48 bronze badges

2 Comments

inf3rno Over a year ago

I tried out, but it does not work by me: php 5.3.28, phpunit 3.7.34.

inf3rno Over a year ago

The problem was that the file should not be in the same directory, I just included... It does have just an include pattern, not an exclude... Maybe I should set different suffix to the files I want to test with the higher php version...

inf3rno · Accepted Answer · 2014-04-16 18:31:55Z

According to Sebastian, I should use the @requires annotation to do that. It cannot be done with groups, because I cannot exclude them automatically depending on php version.

Btw. it does not help because I run always into parse errors by version 5.3, because of using yield and ::class...

He suggests to move the version dependent code to another files and use this:

<testsuite name="My Test Suite">
  <directory suffix="Test.php" phpVersion="5.3.0" phpVersionOperator=">=">/path/to/files</directory>
  <file phpVersion="5.3.0" phpVersionOperator=">=">/path/to/MyTest.php</file>
</testsuite>

The file should not be under the /path/to/files directory, unless you want it to be included...

Finally I added 2 new suffixes for tests related to higher php version:

    <testsuite name="unit tests">
        <directory suffix="Test.php" phpVersion="5.3.0" phpVersionOperator=">=">test/unit</directory>
        <directory suffix="Test54.php" phpVersion="5.4.0" phpVersionOperator=">=">test/unit</directory>
        <directory suffix="Test55.php" phpVersion="5.5.0" phpVersionOperator=">=">test/unit</directory>
    </testsuite>

Collectives™ on Stack Overflow

PHPUnit - Can I run tests depending on PHP version?

5 Answers 5

Comments

Comments

4 Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

4 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related