Enhancement: Run end-to-end tests asserting an HTTP response status code

Author: localheinz

.github/workflows/integrate.yaml

@@ -27,7 +27,7 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           coverage: "none"
-          extensions: "none, json, mbstring, tokenizer"
+          extensions: "none, curl, json, mbstring, tokenizer"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -64,6 +64,9 @@ jobs:
         php-version:
           - "8.2"
 
+    env:
+      HTTP_HOST: "localhost:8080"
+
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v4"
@@ -72,11 +75,30 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           coverage: "none"
-          extensions: "none"
+          extensions: "none, curl, mbstring, tokenizer"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
 
+      - name: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
+      - name: "Determine composer cache directory"
+        run: "echo \"COMPOSER_CACHE_DIR=$(composer config cache-dir)\" >> $GITHUB_ENV"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v3"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-"
+
+      - name: "Install dependencies with composer"
+        run: "composer install --ansi --no-interaction --no-progress"
+
+      - name: "Start built-in web server for PHP"
+        run: "php -S ${{ env.HTTP_HOST }} .router.php &"
+
       - name: "Run tests"
         run: "php tests/run-tests.php -j3 -q --show-diff"

.gitignore

@@ -8,4 +8,6 @@ vendor/
 .idea
 .DS_Store
 .DS_Store?
+tests/server.log
+tests/server.pid
 .php-cs-fixer.cache

Makefile

@@ -1,3 +1,7 @@
+.EXPORT_ALL_VARIABLES:
+
+HTTP_HOST:=localhost:8080
+
 .PHONY: help
 help: ## Displays this list of targets with descriptions
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
@@ -7,8 +11,8 @@ coding-standards: vendor ## Fixes code style issues with friendsofphp/php-cs-fix
 	vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --verbose
 
 .PHONY: tests
-tests: ## Runs tests
-	php tests/run-tests.php -j3 -q
+tests: vendor ## Runs tests
+	tests/server start; php tests/run-tests.php -j3 -q; tests/server stop
 
 vendor: composer.json composer.lock
 	composer validate --strict

composer.json

@@ -11,13 +11,19 @@
         "php": "~8.2.0"
     },
     "require-dev": {
+        "ext-curl": "*",
         "friendsofphp/php-cs-fixer": "^3.40.2"
     },
     "autoload": {
         "psr-4": {
             "phpweb\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "phpweb\\Test\\": "tests/"
+        }
+    },
     "config": {
         "platform": {
             "php": "8.2.0"

composer.lock

@@ -0,0 +1,19 @@
+--TEST--
+/ChangeLog-4.php returns HTTP response status code 200
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+use phpweb\Test\Util\Http\CurlClient;
+
+$httpClient = CurlClient::fromEnvironment(getenv());
+
+$response = $httpClient->get('/ChangeLog-4.php');
+
+var_dump($response->statusCode);
+?>
+--EXPECT--
+int(200)

tests/EndToEnd/ChangeLog-4.php-returns-http-response-status-code-200.phpt

@@ -0,0 +1,19 @@
+--TEST--
+/ChangeLog-5.php returns HTTP response status code 200
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+use phpweb\Test\Util\Http\CurlClient;
+
+$httpClient = CurlClient::fromEnvironment(getenv());
+
+$response = $httpClient->get('/ChangeLog-5.php');
+
+var_dump($response->statusCode);
+?>
+--EXPECT--
+int(200)

tests/EndToEnd/ChangeLog-5.php-returns-http-response-status-code-200.phpt

@@ -0,0 +1,19 @@
+--TEST--
+/ChangeLog-7.php returns HTTP response status code 200
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+use phpweb\Test\Util\Http\CurlClient;
+
+$httpClient = CurlClient::fromEnvironment(getenv());
+
+$response = $httpClient->get('/ChangeLog-7.php');
+
+var_dump($response->statusCode);
+?>
+--EXPECT--
+int(200)

tests/EndToEnd/ChangeLog-7.php-returns-http-response-status-code-200.phpt

@@ -0,0 +1,19 @@
+--TEST--
+/ChangeLog-8.php returns HTTP response status code 200
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+use phpweb\Test\Util\Http\CurlClient;
+
+$httpClient = CurlClient::fromEnvironment(getenv());
+
+$response = $httpClient->get('/ChangeLog-8.php');
+
+var_dump($response->statusCode);
+?>
+--EXPECT--
+int(200)

tests/EndToEnd/ChangeLog-8.php-returns-http-response-status-code-200.phpt

@@ -0,0 +1,19 @@
+--TEST--
+/archive/1998.php returns HTTP response status code 200
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../../../vendor/autoload.php';
+
+use phpweb\Test\Util\Http\CurlClient;
+
+$httpClient = CurlClient::fromEnvironment(getenv());
+
+$response = $httpClient->get('/archive/1998.php');
+
+var_dump($response->statusCode);
+?>
+--EXPECT--
+int(200)