Testing multiple target PHP versions via docker

sj-i · sj-i · commit a0bcdcb2b754 · 2024-02-07T13:18:19.000+09:00
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -49,7 +49,7 @@ jobs:
       - name: Run test suite
         run: |
           mkdir -p build/logs
-          ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+          composer test-for-ci
 
       - name: Send to coveralls
         env:
diff --git a/Dockerfile-dev b/Dockerfile-dev
@@ -0,0 +1,31 @@
+FROM php:8.1-cli
+
+RUN apt-get update && apt-get install -y \
+      libffi-dev \
+      libzip-dev \
+    && docker-php-ext-install ffi \
+    && docker-php-ext-install pcntl \
+    && docker-php-ext-install zip \
+    && pecl install pcov \
+    && docker-php-ext-enable pcov \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN apt-get update -y \
+    && apt-get install -y ca-certificates curl gnupg \
+    && install -m 0755 -d /etc/apt/keyrings \
+    && curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg \
+    && chmod a+r /etc/apt/keyrings/docker.gpg \
+    && echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian $(. /etc/os-release && echo $VERSION_CODENAME) stable" \
+    | tee /etc/apt/sources.list.d/docker.list > /dev/null \
+    && apt-get update -y \
+    && apt-get install -y docker-ce-cli \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app
+COPY . .
+
+RUN composer install
+
+CMD ["php", "vendor/bin/phpunit", "--colors=always", "--testdox", "--coverage-text", "--coverage-clover=coverage.xml", "--coverage-html=coverage"]
diff --git a/composer.json b/composer.json
@@ -48,15 +48,22 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Reli\\": "tests"
+      "Reli\\": "tests",
+      "Reli\\Command\\": "tests/Command/CommandEnumeratorTestData"
     }
   },
   "bin": [
     "reli"
   ],
   "scripts": {
     "test": [
-      "phpunit"
+      "docker-compose run reli-test"
+    ],
+    "test-with-coverage": [
+      "docker-compose run reli-test-with-coverage"
+    ],
+    "test-for-ci": [
+      "docker-compose run reli-test-for-ci"
     ],
     "psalm": [
       "psalm.phar"
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,49 @@
+version: '3.9'
+services:
+  reli-test:
+    build:
+      context: .
+      dockerfile: Dockerfile-dev
+    pid: "host"
+    cap_add:
+      - SYS_PTRACE
+    security_opt:
+      - seccomp:unconfined
+    volumes:
+      - .:/app
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /tmp/reli-test:/tmp/reli-test
+    container_name: reli-test
+    command: ["vendor/bin/phpunit" , "--colors=always", "--testdox"]
+  reli-test-with-coverage:
+    build:
+      context: .
+      dockerfile: Dockerfile-dev
+    pid: "host"
+    cap_add:
+      - SYS_PTRACE
+    security_opt:
+      - seccomp:unconfined
+    volumes:
+      - .:/app
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /tmp/reli-test:/tmp/reli-test
+      - ./build:/app/build
+    container_name: reli-test
+    command: ["vendor/bin/phpunit" , "--colors=always", "--testdox", "--coverage-clover", "build/logs/clover.xml"]
+  reli-test-for-ci:
+    build:
+      context: .
+      dockerfile: Dockerfile-dev
+    pid: "host"
+    cap_add:
+      - SYS_PTRACE
+    security_opt:
+      - seccomp:unconfined
+    volumes:
+      - .:/app
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /tmp/reli-test:/tmp/reli-test
+      - ./build:/app/build
+    container_name: reli-test
+    command: ["vendor/bin/phpunit" , "--coverage-clover", "build/logs/clover.xml"]
diff --git a/tests/Command/CommandEnumeratorTestData/Test1Directory/Test1Command.php b/tests/Command/CommandEnumeratorTestData/Test1Directory/Test1Command.php
@@ -11,8 +11,10 @@
 
 declare(strict_types=1);
 
-namespace Reli\Command\CommandEnumeratorTestData\Test1Directory;
+namespace Reli\Command\Test1Directory;
 
-final class Test1Command
+use Symfony\Component\Console\Command\Command;
+
+final class Test1Command extends Command
 {
 }
diff --git a/tests/Command/CommandEnumeratorTestData/Test1Directory/Test2Command.php b/tests/Command/CommandEnumeratorTestData/Test1Directory/Test2Command.php
@@ -11,8 +11,10 @@
 
 declare(strict_types=1);
 
-namespace Reli\Command\CommandEnumeratorTestData\Test1Directory;
+namespace Reli\Command\Test1Directory;
 
-final class Test2Command
+use Symfony\Component\Console\Command\Command;
+
+final class Test2Command extends Command
 {
 }
diff --git a/tests/Command/CommandEnumeratorTestData/Test2Directory/Test3Command.php b/tests/Command/CommandEnumeratorTestData/Test2Directory/Test3Command.php
@@ -11,8 +11,10 @@
 
 declare(strict_types=1);
 
-namespace Reli\Command\CommandEnumeratorTestData\Test2Directory;
+namespace Reli\Command\Test2Directory;
 
-final class Test3Command
+use Symfony\Component\Console\Command\Command;
+
+final class Test3Command extends Command
 {
 }
diff --git a/tests/Command/CommandEnumeratorTestData/Test2Directory/Test4Command.php b/tests/Command/CommandEnumeratorTestData/Test2Directory/Test4Command.php
@@ -11,8 +11,10 @@
 
 declare(strict_types=1);
 
-namespace Reli\Command\CommandEnumeratorTestData\Test2Directory;
+namespace Reli\Command\Test2Directory;
 
-final class Test4Command
+use Symfony\Component\Console\Command\Command;
+
+final class Test4Command extends Command
 {
 }
diff --git a/tests/Lib/PhpProcessReader/CallTraceReader/CallTraceReaderTest.php b/tests/Lib/PhpProcessReader/CallTraceReader/CallTraceReaderTest.php
@@ -13,6 +13,7 @@
 
 namespace Reli\Lib\PhpProcessReader\CallTraceReader;
 
+use PHPUnit\Framework\Attributes\DataProviderExternal;
 use Reli\BaseTestCase;
 use Reli\Inspector\Settings\TargetPhpSettings\TargetPhpSettings;
 use Reli\Lib\ByteStream\IntegerByteSequence\LittleEndianReader;
@@ -22,13 +23,13 @@
 use Reli\Lib\Elf\SymbolResolver\Elf64SymbolResolverCreator;
 use Reli\Lib\File\CatFileReader;
 use Reli\Lib\PhpInternals\Opcodes\OpcodeFactory;
-use Reli\Lib\PhpInternals\ZendTypeReader;
 use Reli\Lib\PhpInternals\ZendTypeReaderCreator;
 use Reli\Lib\PhpProcessReader\PhpGlobalsFinder;
 use Reli\Lib\PhpProcessReader\PhpSymbolReaderCreator;
 use Reli\Lib\Process\MemoryMap\ProcessMemoryMapCreator;
 use Reli\Lib\Process\MemoryReader\MemoryReader;
 use Reli\Lib\Process\ProcessSpecifier;
+use Reli\TargetPhpVmProvider;
 
 class CallTraceReaderTest extends BaseTestCase
 {
@@ -47,17 +48,16 @@ protected function tearDown(): void
         }
     }
 
-    public function testReadCallTrace()
+    #[DataProviderExternal(TargetPhpVmProvider::class, 'allSupported')]
+    public function testReadCallTrace(string $php_version, string $docker_image_name): void
     {
         $memory_reader = new MemoryReader();
         $executor_globals_reader = new CallTraceReader(
             $memory_reader,
             new ZendTypeReaderCreator(),
             new OpcodeFactory()
         );
-        $tmp_file = tempnam(sys_get_temp_dir(), 'reli-prof-test');
-        file_put_contents(
-            $tmp_file,
+        $target_script =
             <<<CODE
             <?php
             class A {
@@ -69,22 +69,18 @@ public function wait() {
             fputs(STDOUT, "a\n");
             \$object->wait();
             CODE
-        );
-        $this->child = proc_open(
-            [
-                PHP_BINARY,
-                $tmp_file,
-            ],
-            [
-                ['pipe', 'r'],
-                ['pipe', 'w'],
-                ['pipe', 'w']
-            ],
+        ;
+        $pipes = [];
+        [$this->child, $pid] = TargetPhpVmProvider::runScriptViaContainer(
+            $docker_image_name,
+            $target_script,
             $pipes
         );
 
-        fgets($pipes[1]);
+        $s = fgets($pipes[1]);
+        $this->assertSame("a\n", $s);
         $child_status = proc_get_status($this->child);
+        $this->assertSame(true, $child_status['running']);
         $php_symbol_reader_creator = new PhpSymbolReaderCreator(
             $memory_reader,
             new ProcessModuleSymbolReaderCreator(
@@ -108,17 +104,21 @@ public function wait() {
 
         /** @var int $child_status['pid'] */
         $executor_globals_address = $php_globals_finder->findExecutorGlobals(
-            new ProcessSpecifier($child_status['pid']),
-            new TargetPhpSettings()
+            new ProcessSpecifier($pid),
+            new TargetPhpSettings(
+                php_version: $php_version,
+            )
         );
         $sapi_globals_address = $php_globals_finder->findSAPIGlobals(
-            new ProcessSpecifier($child_status['pid']),
-            new TargetPhpSettings()
+            new ProcessSpecifier($pid),
+            new TargetPhpSettings(
+                php_version: $php_version,
+            )
         );
 
         $call_trace = $executor_globals_reader->readCallTrace(
-            $child_status['pid'],
-            ZendTypeReader::V81,
+            $pid,
+            $php_version,
             $executor_globals_address,
             $sapi_globals_address,
             PHP_INT_MAX,
@@ -142,7 +142,7 @@ public function wait() {
             $call_trace->call_frames[1]->getFullyQualifiedFunctionName()
         );
         $this->assertSame(
-            $tmp_file,
+            '/source',
             $call_trace->call_frames[1]->file_name
         );
         $this->assertSame(
@@ -154,7 +154,7 @@ public function wait() {
             $call_trace->call_frames[2]->getFullyQualifiedFunctionName()
         );
         $this->assertSame(
-            $tmp_file,
+            '/source',
             $call_trace->call_frames[2]->file_name
         );
         $this->assertSame(
diff --git a/tests/Lib/PhpProcessReader/PhpMemoryReader/MemoryLocationsCollectorTest.php b/tests/Lib/PhpProcessReader/PhpMemoryReader/MemoryLocationsCollectorTest.php
diff --git a/tests/TargetPhpVmProvider.php b/tests/TargetPhpVmProvider.php

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,10 @@`
`11`	`11`
`12`	`12`	`declare(strict_types=1);`
`13`	`13`
`14`		`-namespace Reli\Command\CommandEnumeratorTestData\Test1Directory;`
	`14`	`+namespace Reli\Command\Test1Directory;`
`15`	`15`
`16`		`-final class Test1Command`
	`16`	`+use Symfony\Component\Console\Command\Command;`
	`17`	`+`
	`18`	`+final class Test1Command extends Command`
`17`	`19`	`{`
`18`	`20`	`}`