Merge pull request #14 from testcontainers/rename

shyim · web-flow · commit 68a2d6d47c01 · 2024-08-05T21:35:10.000+02:00
feat: rename package name
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -2,34 +2,67 @@ name: PHP
 
 on:
   push:
-    branches: [ "main" ]
+    branches:
+      - main
   pull_request:
-    branches: [ "main" ]
+    branches:
+      - main
 
 permissions:
   contents: read
 
 jobs:
-  build:
+  cs:
     runs-on: ubuntu-latest
+    name: Code Style
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     
-    - name: Setup PHP with PECL extension
+    - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
         php-version: '8.1'
-        extensions: redis, pgsql
 
     - name: Install dependencies
       run: composer install --prefer-dist --no-progress
 
-    - name: Run test suite
-      run: composer run integration
-      
     - name: Run cs
       run: composer run cs
-      
+
+  phpstan:
+    runs-on: ubuntu-latest
+    name: Static Analysis
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
     - name: Run phpstan
       run: composer run phpstan
+
+  phpunit:
+    runs-on: ubuntu-latest
+    name: Integration Tests
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+        extensions: redis, pgsql
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer run integration
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 /vendor/
-.php-cs-fixer.cache
+/.php-cs-fixer.cache
+/.phpunit.cache
 /composer.lock
diff --git a/README.md b/README.md
@@ -2,14 +2,12 @@
 
 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.
 
-[@sironheart](https://github.com/sironheart) has annoyed me to test testcontainers, but it didn't existed in PHP yet.
-
 ## Installation
 
 Add this to your project with composer
 
 ```bash
-composer req --dev shyim/testcontainer
+composer req --dev testcontainers/testcontainers
 ```
     
 ## Usage/Examples
@@ -19,7 +17,7 @@ composer req --dev shyim/testcontainer
 ```php
 <?php
 
-use Testcontainer\Container\MySQLContainer;
+use Testcontainers\Container\Container;
 
 $container = Container::make('nginx:alpine');
 
@@ -60,7 +58,7 @@ $container->withWait(new WaitForHealthCheck());
 ```php
 <?php
 
-use Testcontainer\Container\MySQLContainer;
+use Testcontainers\Container\MySQLContainer;
 
 $container = MySQLContainer::make('8.0');
 $container->withMySQLDatabase('foo');
@@ -82,7 +80,7 @@ $pdo = new \PDO(
 ```php
 <?php
 
-use Testcontainer\Container\MariaDBContainer;
+use Testcontainers\Container\MariaDBContainer;
 
 $container = MariaDBContainer::make('8.0');
 $container->withMariaDBDatabase('foo');
@@ -104,7 +102,7 @@ $pdo = new \PDO(
 ```php
 <?php
 
-use Testcontainer\Container\PostgresContainer;
+use Testcontainers\Container\PostgresContainer;
 
 $container = PostgresContainer::make('15.0', 'password');
 $container->withPostgresDatabase('database');
@@ -125,7 +123,7 @@ $pdo = new \PDO(
 
 ```php
 
-use Testcontainer\Container\RedisContainer;
+use Testcontainers\Container\RedisContainer;
 
 $container = RedisContainer::make('6.0');
 
@@ -141,7 +139,7 @@ $redis->connect($container->getAddress());
 
 ```php
 
-use Testcontainer\Container\OpenSearchContainer;
+use Testcontainers\Container\OpenSearchContainer;
 
 $container = OpenSearchContainer::make('2');
 $container->disableSecurityPlugin();
@@ -168,7 +166,7 @@ use Doctrine\Bundle\DoctrineBundle\ConnectionFactory;
 use Doctrine\Common\EventManager;
 use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Tools\DsnParser;
-use Testcontainer\Container\PostgresContainer;
+use Testcontainers\Container\PostgresContainer;
 
 class TestConnectionFactory extends ConnectionFactory
 {
diff --git a/composer.json b/composer.json
@@ -1,10 +1,10 @@
 {
-    "name": "shyim/testcontainer",
-    "description": "Testcontainer implementation in PHP",
+    "name": "testcontainers/testcontainers",
+    "description": "Testcontainers implementation in PHP",
     "license": "MIT",
     "keywords": [
         "docker",
-        "testcontainer"
+        "testcontainers"
     ],
     "type": "library",
     "authors": [
@@ -15,7 +15,7 @@
     ],
     "require": {
         "php": ">= 8.1",
-        "symfony/process": "^5.3|^6.0|^7.0"
+        "symfony/process": "^5.0|^6.0|^7.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
@@ -28,12 +28,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Testcontainer\\": "src/"
+            "Testcontainers\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Testcontainer\\Tests\\": "tests/"
+            "Testcontainers\\Tests\\": "tests/"
         }
     },
     "scripts": {
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>
diff --git a/src/Container/Container.php b/src/Container/Container.php
@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
 use Symfony\Component\Process\Process;
-use Testcontainer\Exception\ContainerNotReadyException;
-use Testcontainer\Registry;
-use Testcontainer\Trait\DockerContainerAwareTrait;
-use Testcontainer\Wait\WaitForNothing;
-use Testcontainer\Wait\WaitInterface;
+use Testcontainers\Exception\ContainerNotReadyException;
+use Testcontainers\Registry;
+use Testcontainers\Trait\DockerContainerAwareTrait;
+use Testcontainers\Wait\WaitForNothing;
+use Testcontainers\Wait\WaitInterface;
 
 /**
  * @phpstan-type ContainerInspectSingleNetwork array<int, array{'NetworkSettings': array{'IPAddress': string}}>
diff --git a/src/Container/MariaDBContainer.php b/src/Container/MariaDBContainer.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
-use Testcontainer\Wait\WaitForExec;
+use Testcontainers\Wait\WaitForExec;
 
 class MariaDBContainer extends Container
 {
diff --git a/src/Container/MySQLContainer.php b/src/Container/MySQLContainer.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
-use Testcontainer\Wait\WaitForExec;
+use Testcontainers\Wait\WaitForExec;
 
 class MySQLContainer extends Container
 {
diff --git a/src/Container/OpenSearchContainer.php b/src/Container/OpenSearchContainer.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
-use Testcontainer\Wait\WaitForHttp;
+use Testcontainers\Wait\WaitForHttp;
 
 class OpenSearchContainer extends Container
 {
diff --git a/src/Container/PostgresContainer.php b/src/Container/PostgresContainer.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
-use Testcontainer\Wait\WaitForExec;
+use Testcontainers\Wait\WaitForExec;
 
 class PostgresContainer extends Container
 {
diff --git a/src/Container/RedisContainer.php b/src/Container/RedisContainer.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Container;
+namespace Testcontainers\Container;
 
-use Testcontainer\Wait\WaitForLog;
+use Testcontainers\Wait\WaitForLog;
 
 class RedisContainer extends Container
 {
diff --git a/src/Exception/ContainerNotReadyException.php b/src/Exception/ContainerNotReadyException.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Exception;
+namespace Testcontainers\Exception;
 
 class ContainerNotReadyException extends \RuntimeException
 {
diff --git a/src/Registry.php b/src/Registry.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer;
+namespace Testcontainers;
 
-use Testcontainer\Container\Container;
+use Testcontainers\Container\Container;
 
 class Registry
 {
diff --git a/src/Trait/DockerContainerAwareTrait.php b/src/Trait/DockerContainerAwareTrait.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Trait;
+namespace Testcontainers\Trait;
 
 use JsonException;
 use Symfony\Component\Process\Process;
-use Testcontainer\Container\Container;
+use Testcontainers\Container\Container;
 use UnexpectedValueException;
 
 /**
diff --git a/src/Wait/WaitForExec.php b/src/Wait/WaitForExec.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Wait;
+namespace Testcontainers\Wait;
 
 use Closure;
 use Symfony\Component\Process\Process;
-use Testcontainer\Exception\ContainerNotReadyException;
+use Testcontainers\Exception\ContainerNotReadyException;
 
 class WaitForExec implements WaitInterface
 {
diff --git a/src/Wait/WaitForHealthCheck.php b/src/Wait/WaitForHealthCheck.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Wait;
+namespace Testcontainers\Wait;
 
 use RuntimeException;
 use Symfony\Component\Process\Process;
-use Testcontainer\Exception\ContainerNotReadyException;
+use Testcontainers\Exception\ContainerNotReadyException;
 
 class WaitForHealthCheck implements WaitInterface
 {
diff --git a/src/Wait/WaitForHttp.php b/src/Wait/WaitForHttp.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Wait;
+namespace Testcontainers\Wait;
 
-use Testcontainer\Exception\ContainerNotReadyException;
-use Testcontainer\Trait\DockerContainerAwareTrait;
+use Testcontainers\Exception\ContainerNotReadyException;
+use Testcontainers\Trait\DockerContainerAwareTrait;
 
 class WaitForHttp implements WaitInterface
 {
diff --git a/src/Wait/WaitForLog.php b/src/Wait/WaitForLog.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Testcontainer\Wait;
+namespace Testcontainers\Wait;
 
 use Symfony\Component\Process\Process;
-use Testcontainer\Exception\ContainerNotReadyException;
+use Testcontainers\Exception\ContainerNotReadyException;
 
 class WaitForLog implements WaitInterface
 {
diff --git a/src/Wait/WaitForNothing.php b/src/Wait/WaitForNothing.php
diff --git a/src/Wait/WaitForTcpPortOpen.php b/src/Wait/WaitForTcpPortOpen.php
diff --git a/src/Wait/WaitInterface.php b/src/Wait/WaitInterface.php
diff --git a/tests/Integration/ContainerTest.php b/tests/Integration/ContainerTest.php
diff --git a/tests/Integration/WaitStrategyTest.php b/tests/Integration/WaitStrategyTest.php

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace Testcontainer\Container;`
	`5`	`+namespace Testcontainers\Container;`
`6`	`6`
`7`		`-use Testcontainer\Wait\WaitForExec;`
	`7`	`+use Testcontainers\Wait\WaitForExec;`
`8`	`8`
`9`	`9`	`class MariaDBContainer extends Container`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace Testcontainer\Exception;`
	`5`	`+namespace Testcontainers\Exception;`
`6`	`6`
`7`	`7`	`class ContainerNotReadyException extends \RuntimeException`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace Testcontainer;`
	`5`	`+namespace Testcontainers;`
`6`	`6`
`7`		`-use Testcontainer\Container\Container;`
	`7`	`+use Testcontainers\Container\Container;`
`8`	`8`
`9`	`9`	`class Registry`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,10 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace Testcontainer\Wait;`
	`5`	`+namespace Testcontainers\Wait;`
`6`	`6`
`7`	`7`	`use Symfony\Component\Process\Process;`
`8`		`-use Testcontainer\Exception\ContainerNotReadyException;`
	`8`	`+use Testcontainers\Exception\ContainerNotReadyException;`
`9`	`9`
`10`	`10`	`class WaitForLog implements WaitInterface`
`11`	`11`	`{`