CODEWITHSUNDEEP
phpmemoryphpunit
Calvin Froedge
Calvin Froedge

Reputation: 16373

Clear memory being used by PHP

I'm running into an interesting problem. I'm using PHPUnit, and my tests take more memory every single time I run them. Ie...

2.25 MB

2.5 MB

3.0 MB

3.5 MB .......

Does anyone know how to clear out the memory that is being consumed, and can anyone advise me on exploring this in depth? The immediate problem is that some of my larger tests are running out of memory, and simply continuing to increase the max memory allotment in PHP isn't good enough...I need to know why a PHPUnit test running from command line would have memory usage which "sticks around" between runs.

Upvotes: 15

Views: 11700

Answers (3)

edorian
edorian

Reputation: 38981

The memory increase has three to four reasons:

1) PHPUnit collects code coverage data

There is nothing you can do about this except turn off code coverage.

2) PHPUnit caches file tokens for code coverage

You can use <phpunit cacheTokens="false"> in your PHPUnit xml. See the note about this in http://phpunit.de/manual/current/en/installation.html#installing.upgrading

3) PHPUnit doesn't properly clean up after itself

In its current implementation it keeps the test cases around because thats where the result data is stored. In the future this will be changed to be more efficent but for now it's how things works.

4) Leading to "4": You need to clean up after your self too

Since the TestCase instances are keep around your member variables are kept around too.

Meaning you can save a lot of memory by using

public function tearDown() {
    unset($this->whatever);
}

but doing so is very tedious.

My suggestion is to have a base test class for all your TestCases and use this:

class MyBaseTest extends \PHPUnit_Framework_TestCase {

    protected function tearDown()
    {
        $refl = new \ReflectionObject($this);
        foreach ($refl->getProperties() as $prop) {
            if (!$prop->isStatic()
                && 0 !== strpos($prop->getDeclaringClass()->getName(), 'PHPUnit_')
                && $prop->getType()?->allowsNull() !== false
            ) {
                $prop->setAccessible(true);
                $prop->setValue($this, null);
            }
        }
    }
}

This will clean up after you in a nice, automated way.

(props for the snippet go to: http://kriswallsmith.net/post/18029585104/faster-phpunit)

PHPUnit can't do this in a backwards compatible way that wouldn't break people's projects so you have to add it for you own :)

Upvotes: 29

trotter
trotter

Reputation: 131

The technical details behind PHPUnit's garbage collection have already been covered by @edorian and @mauris, but I wanted to add that PHPUnit (at least in version 3.7.21, which I'm running) gives you the ability to add the comment:

/**
 * @backupGlobals disabled
 */
class MyClassTests extends PHPUnit_Framework_TestCase{}

Before adding the annotation, I was roughly doubling my memory usage on each run of my test suite, the last one hitting about 1100 MB. Now they're running at 15 MB.

Upvotes: 6

mauris
mauris

Reputation: 43619

Calvin, as per discussed in the chat, it was due to missing reset features.

When testing, we must ensure that the test environment is consistent so that we're able to get accurate results. Computing is Input/Output and hence we should use Fixtures in PHPUnit to reset storage to prevent "memory leaks" like these.

Upvotes: 4

Related Questions