https://github.com/live627/phpunit-garbage-collector

Reset properties to save memory after each test
https://github.com/live627/phpunit-garbage-collector

Last synced: 20 days ago
JSON representation

Reset properties to save memory after each test

• Host: GitHub
• URL: https://github.com/live627/phpunit-garbage-collector
• Owner: live627
• License: mit
• Created: 2022-11-15T08:39:30.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-16T04:42:11.000Z (about 2 years ago)
• Last Synced: 2024-10-10T11:43:59.379Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHPUnit Garbage Collector

[![Tests](https://github.com/live627/phpunit-garbage-collector/actions/workflows/php.yml/badge.svg)](https://github.com/live627/phpunit-garbage-collector/actions/workflows/php.yml)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/live627/phpunit-garbage-collector/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/live627/phpunit-garbage-collector/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/live627/phpunit-garbage-collector/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/live627/phpunit-garbage-collector/?branch=master)

PHPUnit seems to waste a lot of memory because it instantiates a lot of objects before actually starting any test, meaning that the initial memory usage varies depending on the number of tests available.

Say, for example, that you have `UserTest` with 1k test methods. This will unfortunately result in 1k UserTest class instances before any of the tests are actually run. This is actually by design. In order to determine the number of tests, PHPUnit runs `@dataProvider` methods before actually running the tests (and the setUp method).

The problem comes once all of the tests in the test case have finished. Objects in memory are closer than they appear because they aren't dereferenced until after the entire test suite has finished. [Fortunately, this is on the radar](https://github.com/sebastianbergmann/phpunit/issues/4705).

Inspired by [Kris Wallsmith faster PHPUnit article](http://kriswallsmith.net/post/18029585104/faster-phpunit). The claim that this test listener that speeds up PHPUnit tests about 20% by freeing memory is dubious and probably is outdated now that [PHP 7 has rewritten `zval`s to be a bit more compact](https://www.npopov.com/2015/06/19/Internal-value-representation-in-PHP-7-part-2.html).

## Installation

To install this library, run the command below and you will get the latest version

```bash

composer require live627/phpunit-garbage-collector --dev

```

## Usage

Just add to your `phpunit.xml` configuration

```xml

    

        

    

```

### Ignoring Tests

Sometimes it is necessary to ignore specific tests, where freeing their properties is undesired. For this use case, you have the ability to *extend the behaviour* of the listener by implementing the `IgnoreTestPolicy` interface.

As an example, if we hypothetically wanted to ignore all tests which include "Legacy" in their test filename, we could create a custom ignore policy as follows

```php

getFileName(), 'Legacy') !== false;

    }

}

```

And pass it to the constructor of our test listener in `phpunit.xml` configuration

```xml

    

        

            

                

            

        

    

```