Integrating Docker Compose with PhpStorm: A Step-by-Step Guide

As developers, we often find ourselves working on complex projects that require a robust and efficient testing framework. One such tool is PHPUnit, which can be integrated seamlessly with Docker Compose. In this article, we'll explore how to execute PHPUnit tests using Docker Compose in PhpStorm.

To begin, you'll need to have Docker Compose installed on your machine. Once installed, create a new file called `docker-compose.yml` and add the following code:

```yaml

version: '3'

services:

php:

image: php:8.0

environment:

- COMPOSER_HOME=app/composer

- COMPOSER_CACHE_DIR=app/composer/cache

volumes:

- ./composer.json:/app/composer.json

- ./composer.lock:/app/composer.lock

- ./:/app

test_runner:

depends_on:

- php

image: php:8.0

command: vendor/bin/phpunit --testsuite PHP_8.0

```

This YAML file defines two services: `php` and `test_runner`. The `php` service uses the official PHP 8.0 image, while the `test_runner` service depends on the `php` service and runs PHPUnit tests.

Next, you'll need to create a new directory called `tests` in your project root and add a file called `generate-stub-map.php` inside it. This file will be used by PhpStorm to generate stubs for your PHP code.

```php

namespace Tests;

class GenerateStubMap {

public function execute() {

// Your code here

}

```

Now, you can run the `docker-compose -f docker-compose.yml run test_runner` command in your terminal to execute PHPUnit tests. You'll see output similar to this:

```bash

PHPUnit 9.5.10 by Sebastian Bergmann

...

Time: 00:01.000, Memory: 128.00 MB

OK (1-2) / 2 tests

```

To integrate Docker Compose with PhpStorm, you'll need to create a new Run Configuration in the IDE. Go to `Settings` > `Languages & Frameworks` > `PHP` > `PHPUnit` and select `Docker Compose` as your testing framework.

In the `Command` field, enter `docker-compose -f docker-compose.yml run test_runner`. You can also add additional options such as `-e PHP_VERSION=8.0` to specify the PHP version.

Finally, you'll need to configure PhpStorm to use the generated stubs. Go to `Settings` > `Languages & Frameworks` > `PHP` > `Advanced settings` and set the `Default stubs path` to the path of your `PhpStormStubsMap.php` file.

With these steps complete, you should now be able to execute PHPUnit tests using Docker Compose in PhpStorm. The IDE will automatically generate stubs for your PHP code based on the output from the `generate-stub-map.php` script.

In this article, we've explored how to integrate Docker Compose with PhpStorm to execute PHPUnit tests. By following these steps, you can simplify your testing workflow and improve the quality of your code. Remember to always keep your stubs up-to-date by re-running the `generate-stub-map.php` script whenever you make changes to your PHP code.

Relevant Open Issues

* Currently, there are no tests for thrown exceptions in PHPUnit, so tags should be checked manually according to official docs or PHP source code.

* The support for non-standard stubs is community-driven, and we only validate their PHPDoc. This means that you'll need to manually check whether a stub matches the actual extension or whether the provided descriptions are correct.

Quality of Stubs

* The quality of most services depends on the quality of the stubs, which are normal, syntactically correct PHP files that contain function & class signatures, constant definitions, etc.

* Stubs need to include complete PHPDoc, especially proper annotations. This is important for IDE features such as completion, code inspection, type inference, doc popups, etc.

Contribution Process

* If you'd like to contribute to the development of PhpStormStubsMap.php or improve the quality of stubs, please check out our open issues page and submit a pull request with your changes.

Phpstorm