Simplify env vars in tests (#90)

Author: spaze

.github/workflows/php-tester-include-skipped.yml

@@ -23,4 +23,4 @@ jobs:
     - name: Install dependencies
       run: composer update --no-progress --no-interaction
     - name: Run Tester including skipped tests
-      run: TEST_CASE_RUNNER_INCLUDE_SKIPPED=1 composer tester
+      run: composer tester-include-skipped

CLAUDE.md

@@ -12,6 +12,7 @@ composer cs-fix                       # auto-fix code style
 composer phpstan                      # static analysis
 composer psalm                        # psalm static analysis
 composer tester                       # run all tests (requires curl, gnupg, pcov extensions)
+composer tester-include-skipped       # run all tests including the network-dependent ones that are skipped by default (sets TEST_CASE_RUNNER_INCLUDE_SKIPPED=1)
 composer tester-no-extensions         # run only the two extension-absence tests
 ```
 

composer.json

@@ -51,7 +51,20 @@
 			"@tester",
 			"@psalm"
 		],
-		"tester-no-extensions": "TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED=1 vendor/bin/tester -s -c tests/php-unix-no-extensions.ini -d zend.assertions=1 --colors 1 tests/Signature/Providers/SecurityTxtSignatureGnuPgProviderNoExtensionTest.phpt tests/Fetcher/HttpClients/SecurityTxtFetcherCurlClientNoExtensionTest.phpt",
-		"tester": "vendor/bin/tester -s -c tests/php-unix.ini -d zend.assertions=1 --colors 1 --coverage tests/temp/coverage.html --coverage-src src/ tests/"
+		"tester-no-extensions": [
+			"@putenv TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED=1",
+			"@putenv TEST_CASE_RUNNER_INCLUDE_SKIPPED=0",
+			"vendor/bin/tester -s -c tests/php-unix-no-extensions.ini -d zend.assertions=1 --colors 1 tests/Signature/Providers/SecurityTxtSignatureGnuPgProviderNoExtensionTest.phpt tests/Fetcher/HttpClients/SecurityTxtFetcherCurlClientNoExtensionTest.phpt"
+		],
+		"tester-include-skipped": [
+			"@putenv TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED=0",
+			"@putenv TEST_CASE_RUNNER_INCLUDE_SKIPPED=1",
+			"vendor/bin/tester -s -c tests/php-unix.ini -d zend.assertions=1 --colors 1 --coverage tests/temp/coverage.html --coverage-src src/ tests/"
+		],
+		"tester": [
+			"@putenv TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED=0",
+			"@putenv TEST_CASE_RUNNER_INCLUDE_SKIPPED=0",
+			"vendor/bin/tester -s -c tests/php-unix.ini -d zend.assertions=1 --colors 1 --coverage tests/temp/coverage.html --coverage-src src/ tests/"
+		]
 	}
 }

tests/Fetcher/HttpClients/SecurityTxtFetcherCurlClientNoExtensionTest.phpt

@@ -8,9 +8,9 @@ namespace Spaze\SecurityTxt\Fetcher;
 use Spaze\SecurityTxt\Fetcher\Exceptions\SecurityTxtCannotOpenUrlExtensionNotLoadedException;
 use Spaze\SecurityTxt\Fetcher\HttpClients\SecurityTxtFetcherCurlClient;
 use Tester\Assert;
-use Tester\Environment;
 use Tester\TestCase;
 use Uri\WhatWg\Url;
+use function Spaze\SecurityTxt\Test\skipIfExtensionLoaded;
 
 require __DIR__ . '/../../bootstrap.php';
 
@@ -20,14 +20,7 @@ final class SecurityTxtFetcherCurlClientNoExtensionTest extends TestCase
 
 	public function testExceptionWhenExtensionNotLoaded(): void
 	{
-		if (extension_loaded('curl')) {
-			if (getenv('TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED') === '1') {
-				Assert::fail('The curl extension must not be loaded for this test, run with the php-unix-no-extensions.ini configuration');
-			} else {
-				Environment::skip('Run this test with the php-unix-no-extensions.ini configuration');
-			}
-		}
-
+		skipIfExtensionLoaded('curl');
 		$client = new SecurityTxtFetcherCurlClient();
 		Assert::throws(function () use ($client) {
 			$client->getResponse(new SecurityTxtFetcherUrl(new Url('https://example.com/'), []), 'example.com', '192.0.2.1', SecurityTxtIpAddressType::V4);

tests/Signature/Providers/SecurityTxtSignatureGnuPgProviderNoExtensionTest.phpt

@@ -6,8 +6,8 @@ namespace Spaze\SecurityTxt\Signature\Providers;
 
 use Spaze\SecurityTxt\Signature\Exceptions\SecurityTxtCannotCreateSignatureExtensionNotLoadedException;
 use Tester\Assert;
-use Tester\Environment;
 use Tester\TestCase;
+use function Spaze\SecurityTxt\Test\skipIfExtensionLoaded;
 
 require __DIR__ . '/../../bootstrap.php';
 
@@ -17,14 +17,7 @@ final class SecurityTxtSignatureGnuPgProviderNoExtensionTest extends TestCase
 
 	public function testExceptionWhenGnupgExtensionNotLoaded(): void
 	{
-		if (extension_loaded('gnupg')) {
-			if (getenv('TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED') === '1') {
-				Assert::fail('The gnupg extension must not be loaded for this test, run with the php-unix-no-extensions.ini configuration');
-			} else {
-				Environment::skip('Run this test with the php-unix-no-extensions.ini configuration');
-			}
-		}
-
+		skipIfExtensionLoaded('gnupg');
 		$gnuPg = new SecurityTxtSignatureGnuPgProvider();
 		Assert::throws(function () use ($gnuPg) {
 			$gnuPg->getErrorInfo();

tests/bootstrap.php

@@ -15,11 +15,19 @@ function needsInternet(): void
 		if (getenv('TEST_CASE_RUNNER_INCLUDE_SKIPPED') === '1') {
 			return;
 		}
-		\Tester\Environment::skip(sprintf(
-			'The test uses the Internet, to not skip the test case run it with `%s=%s`',
-			'TEST_CASE_RUNNER_INCLUDE_SKIPPED',
-			'1',
-		));
+		\Tester\Environment::skip('The test uses the Internet, to not skip the test case run it with TEST_CASE_RUNNER_INCLUDE_SKIPPED=1, or run composer tester-include-skipped to run all skipped tests');
+	}
+
+
+	function skipIfExtensionLoaded(string $extension): void
+	{
+		if (extension_loaded($extension)) {
+			if (getenv('TEST_CASE_RUNNER_FORCE_EXTENSIONS_NOT_LOADED') === '1') {
+				\Tester\Assert::fail("The {$extension} extension must not be loaded for this test, run with the php-unix-no-extensions.ini configuration, or run composer tester-no-extensions to run all similar tests");
+			} else {
+				\Tester\Environment::skip('Run this test with the php-unix-no-extensions.ini configuration, or run composer tester-no-extensions to run all similar tests');
+			}
+		}
 	}
 
 }