How to skip tests in PHPunit?

Question

I am using phpunit in connection with jenkins, and I want to skip certain tests by setting the configuration in the XML file phpunit.xml

I know that I can use on the command line:

phpunit --filter testStuffThatBrokeAndIOnlyWantToRunThatOneSingleTest

how do I translate that to the XML file since the <filters> tag is only for code-coverage?

I would like to run all tests apart from testStuffThatAlwaysBreaks

I didn't write the tests, it's something irrelevant, and also don't want to change the core files — filype
– filype, Commented Apr 20, 2012 at 2:56
PS: you mentioned filters - but it couldn't help you, because it excludes all the path. Otherwise <exclude> - would do the work for you — zerkms
– zerkms, Commented Apr 20, 2012 at 3:03

Daniel W. · Accepted Answer · 2015-07-20 14:09:01Z

296

The fastest and easiest way to skip tests that are either broken or you need to continue working on later is to just add the following to the top of your individual unit test:

$this->markTestSkipped('must be revisited.');

edited Jul 20, 2015 at 14:09

Daniel W.

32.6k15 gold badges99 silver badges155 bronze badges

answered May 6, 2012 at 18:19

jsteinmann

4,8724 gold badges19 silver badges22 bronze badges

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

5 Comments

jsteinmann Over a year ago

you can always add directories or tests to the xml config file, however, if this is a controller or similar that's really not very practical because you probably have dozens of other tests in that file. i guess if you have no access to unit tests, not sure i understand why, then you have no other choice than to exclude.

Daniel W. Over a year ago

As it is a static method (at least in PHPUnit 3), and some classes use late static binding afaik, you should use static::markTestSkipped(''); instead of $this->. It will generate a warning in newer PHP Versions. Signature: public static function markTestSkipped($message = '')

akahunahi Over a year ago

Needs a better example of the full unit test file. Not just a snippet.

nulll Over a year ago

@DanielW. the official phpunit manual has examples showing $this->markTestSkipped()

Daniel W. Over a year ago

@nulll you can see in the sourcecode of 6.5, markTestSkipped() is still a static method.

zerkms · Accepted Answer · 2012-04-20 03:45:26Z

46

If you can deal with ignoring the whole file then

<?xml version="1.0" encoding="UTF-8"?>

<phpunit>

    <testsuites>
        <testsuite name="foo">
            <directory>./tests/</directory>
            <exclude>./tests/path/to/excluded/test.php</exclude>
                ^-------------
        </testsuite>
    </testsuites>

</phpunit>

answered Apr 20, 2012 at 3:45

zerkms

256k73 gold badges447 silver badges551 bronze badges

2 Comments

filype Over a year ago

The tests take about 20min to run, is there an easy way to see how many tests it will run? currently, I have to wait till the first row is completed ....... 63 / 893 ( 7%)

zerkms Over a year ago

@Filype: then you probably specified the wrong path. It works well for me. Not sure if it is possible to get tests count. PS: unit tests should not run so long. I'd recommend using @group annotation and split tests by their nature

Philip · Accepted Answer · 2023-12-11 19:47:57Z

40

Sometimes it's useful to skip all tests from particular file based on custom condition(s) defined as php code. You can easily do that using setUp function in which makeTestSkipped works as well.

protected function setUp()
{
    parent::setUp();
    
    if (your_custom_condition) {
        $this->markTestSkipped('all tests in this file are invactive for this server configuration!');
    }
}

your_custom_condition can be passed via some static class method/property, a constant defined in phpunit bootstrap file or even a global variable.

Note: Don't forget calling parent::setUp() (see docs).

edited Dec 11, 2023 at 19:47

Philip

2,9982 gold badges27 silver badges38 bronze badges

answered Feb 9, 2016 at 9:44

Konrad Gałęzowski

2,0221 gold badge23 silver badges32 bronze badges

4 Comments

cronfy Over a year ago

What is a Config class? Where do I place it?

Konrad Gałęzowski Over a year ago

@cronfy it can be any global scope accessible class (Singleton / Register design pattern) or even global variable set in bootstrap file in phpunit. Basically the logic is: if ($testsFromThisFileShouldBeSkipped) { $this->markTestSkipped(...); }

SparK Over a year ago

remove the conditional and your answer would be straight forward... "markTestSkipped inside the setup to skip the whole file"

Konrad Gałęzowski Over a year ago

@SparK I see your point but I was providing way of conditional skipping of whole test class. I've changed it a little, removing my custom way of doing it in favor of general rule.

Collectives™ on Stack Overflow

How to skip tests in PHPunit?

3 Answers 3

5 Comments

2 Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

5 Comments

2 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related