https://github.com/testcontainers/testcontainers-php

https://www.testcontainers.org implementation for PHP
https://github.com/testcontainers/testcontainers-php

Last synced: 2 days ago
JSON representation

https://www.testcontainers.org implementation for PHP

• Host: GitHub
• URL: https://github.com/testcontainers/testcontainers-php
• Owner: testcontainers
• License: mit
• Created: 2022-10-22T23:52:33.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-29T14:29:56.000Z (17 days ago)
• Last Synced: 2025-01-11T17:16:25.964Z (3 days ago)
• Language: PHP
• Size: 143 KB
• Stars: 106
• Watchers: 6
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-testcontainers - Repository
• awesome-testcontainers - Repository

README

        
# Testcontainers for PHP

Testcontainers is a PHP package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The package is inspired by the [Testcontainers](https://www.testcontainers.org/) project for Java.

## Installation

Add this to your project with composer

```bash

composer req --dev testcontainers/testcontainers

```

    

## Usage/Examples

### Starting a general Container

```php

withEnvironment('name', 'var');

// enable health check for an container

$container->withHealthCheckCommand('curl --fail localhost');

// mount current dir to /var/www/html

$container->withMount(__DIR__, '/var/www/html');

```

Normally you have to wait until the Container is ready. so for this you can define an wait rule:

```php

// Run mysqladmin ping until the command returns exit code 0

$container->withWait(new WaitForExec(['mysqladmin', 'ping', '-h', '127.0.0.1']));

$container->withWait(new WaitForExec(['mysqladmin', 'ping', '-h', '127.0.0.1']), function(Process $process) {

    // throw exception if process result is bad

});

// Wait until that message is in the logs

$container->withWait(new WaitForLog('Ready to accept connections'));

// Wait for an http request to succeed

$container->withWait(WaitForHttp::make($port, $method = 'GET', $path = '/'));

// Wait until the docker heartcheck is green

$container->withWait(new WaitForHealthCheck());

```

### MySQL

```php

withMySQLDatabase('foo');

$container->withMySQLUser('bar', 'baz');

$container->run();

$pdo = new \PDO(

    sprintf('mysql:host=%s;port=3306', $container->getAddress()),

    'bar',

    'baz',

);

// Do something with pdo

```

### MariaDB

```php

withMariaDBDatabase('foo');

$container->withMariaDBUser('bar', 'baz');

$container->run();

$pdo = new \PDO(

    sprintf('mysql:host=%s;port=3306', $container->getAddress()),

    'bar',

    'baz',

);

// Do something with pdo

```

### PostgreSQL

```php

withPostgresDatabase('database');

$container->withPostgresUser('username');

$container->run();

$pdo = new \PDO(

    sprintf('pgsql:host=%s;port=5432;dbname=database', $container->getAddress()),

    'username',

    'password',

);

// Do something with pdo

```

### Redis

```php

use Testcontainers\Container\RedisContainer;

$container = RedisContainer::make('6.0');

$container->run();

$redis = new \Redis();

$redis->connect($container->getAddress());

// Do something with redis

```

### OpenSearch

```php

use Testcontainers\Container\OpenSearchContainer;

$container = OpenSearchContainer::make('2');

$container->disableSecurityPlugin();

$container->run();

// Do something with opensearch

```

### Use with symfony

```yaml

# config/packages/test/services.yaml

parameters:

  'doctrine.dbal.connection_factory.class': App\Tests\TestConnectionFactory

```

```php

namespace App\Tests;

use Doctrine\Bundle\DoctrineBundle\ConnectionFactory;

use Doctrine\Common\EventManager;

use Doctrine\DBAL\Configuration;

use Doctrine\DBAL\Tools\DsnParser;

use Testcontainers\Container\PostgresContainer;

class TestConnectionFactory extends ConnectionFactory

{

    static $testDsn;

    public function __construct(array $typesConfig, ?DsnParser $dsnParser = null)

    {

        if (!$this::$testDsn) {

            $psql = PostgresContainer::make('14.0', 'password');

            $psql->withPostgresDatabase('database');

            $psql->withPostgresUser('user');

            $psql->run();

            $this::$testDsn = sprintf('postgresql://user:password@%s:5432/database?serverVersion=14&charset=utf8', $psql->getAddress());

        }

        parent::__construct($typesConfig, $dsnParser);

    }

    public function createConnection(array $params, ?Configuration $config = null, ?EventManager $eventManager = null, array $mappingTypes = [])

    {

        $params['url'] = $this::$testDsn;

        return parent::createConnection($params, $config, $eventManager, $mappingTypes);

    }

}

```

## License

[MIT](https://choosealicense.com/licenses/mit/)