Creating a base test-class for PHPUnit and extending it for common functionality results in class not found error

Question

I'm running PHPUnit using a bootstrap file for autoloading classes (generated by composer).

All my tests load up classes just fine, but for two of my tests, I made a "base" test class which extends \PHPUnit\Framework\TestCase (similar to PHPUnit_Framework_TestCase before PHPUnit7), and then two test classes that extend the base class, similar structure to the following example code:

    abstract class BaseTest extends \PHPUnit\Framework\TestCase
    {
        abstract function setUp();

        protected function getCommonTestVariables()
        {
            // ...
        }

        protected function runCommonTests()
        {
            // ...
        }
    }

    class BlahBlahTest extends BaseTest
    {
        public function setUp()
        {
             $variables=$this->getCommonTestVariables();
             //etc...
        }

        public function testThings()
        {
            $this->runCommonTests();
        }
    }

Whenever I run this, PHPUnit gives an error:

Fatal error: Class 'BaseTest' not found in BlahBlahTest.php on line 13

I've checked filenames, locations, namespaces and everything seems to be in order. Any help would be appreciated to get to the bottom of this

Are the classes in one file, or in two? If the latter, then you have to either include the class, or configure autoloading. — Sven
– Sven, Commented Sep 18, 2013 at 19:58
They're in two files. As I said in my post, I've got a bootstrap file configured with a composer autoloader — r.bilgil
– r.bilgil, Commented Sep 18, 2013 at 21:47
That composer autoloader does not work like magic. Is it configured to autoload your BaseTest class? And if yes: How? — Sven
– Sven, Commented Sep 18, 2013 at 21:53

Potherca · Accepted Answer · 2015-02-14 15:04:34Z

I ran into the same problem and if you are not too familiar with the inner workings of both PHPUnit and Composer this can indeed seem perplexing.

PHPunit does not use use the Composer autoloader to find any of your test classes. It just scans any directory you give it and operates on one file at a time.

Hence it does not know about any other class than the one in the file it is currently operating on. That is where the bootstrap file comes into play.

If you want to use the Composer Autoloader to load other test classes, you need to tell it where it can find these test classes (and, optionally, in which namespace).

There are two ways to do this:

Add an autoload-dev section to your composer.json or
Add the test directory to the Composer Autoloader

Use `autoload-dev`

The autoload-dev sections allows you to define autoload rules for development purposes.

Quoting directly from the manual:

Classes needed to run the test suite should not be included in the main autoload rules to avoid polluting the autoloader in production and when other people use your package as a dependency.

Therefore, it is a good idea to rely on a dedicated path for your unit tests and to add it within the autoload-dev section.

Example:
{
    "autoload": {
        "psr-4": { "MyLibrary\\": "src/" }
    },
    "autoload-dev": {
        "psr-4": { "MyLibrary\\Tests\\": "tests/" }
    }
}

Add to the Composer Autoloader

An alternative would be to get the Composer Autoloader and add your testing namespace (if you have any) and the directory where your tests live. How to do this, as described in the manual (at the bottom of the autoloading section in "Basic Usage") is :

$loader = require('/path/to/vendor/autoload.php');
$loader->add('Test\\', __DIR__ . '/Tests');

If your tests use namespaces that mirror the test directory and you still run into trouble, you can try omitting the prefix by replacing the first parameter ('Test\\') with ''.

If you want further insight into how all of this works you should take a look at the Composer ClassLoader class, especially the add() and findFile() methods.

Small edition to the perfectly working solution above. After adding the autoload field, you have to re-run this command: php composer.phar dump-autoload

Zoltán Süle · Accepted Answer · 2017-07-28 09:30:01Z

4

For me the solution was much simpler.

I changed the capital letter of Test to test at the end of the file and the class name

BaseSomethingtest.php

<?php

namespace Something\Tests\Sub1\Sub2;

class BaseSomethingtest
{
}

I just put a word at the end of my base class. As far as it didn't finish with Test, phpunit didn't call it

BaseSomethingTestCase.php

<?php

namespace Something\Tests\Sub1\Sub2;

class BaseSomethingTestCase
{
}

answered Jul 28, 2017 at 9:30

Zoltán Süle

1,74220 silver badges33 bronze badges

Comments

Community · Accepted Answer · 2017-05-23 11:47:05Z

2

I'm not sure if you still need a solution, but this worked for me:
Non-testable base class extending PHPUnit_Framework_TestCase

edited May 23, 2017 at 11:47

CommunityBot

11 silver badge

answered Dec 4, 2014 at 9:15

Barry Norman

1942 silver badges8 bronze badges

Comments

DevWichrowski · Accepted Answer · 2018-07-22 15:41:26Z

-1

In PHP 7.0+ extends PHPUnit_Framework_TestCasechanged to extends \PHPUnit\Framework\TestCase, try this one.

answered Jul 22, 2018 at 15:41

DevWichrowski

1

Collectives™ on Stack Overflow

Creating a base test-class for PHPUnit and extending it for common functionality results in class not found error

4 Answers 4

Use `autoload-dev`

Add to the Composer Autoloader

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Use autoload-dev

Add to the Composer Autoloader

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related

Use `autoload-dev`