Allow local test suite to be configured via .env.testing

Author: timacdonald

agent/.env.example

@@ -0,0 +1,3 @@
+NIGHTWATCH_BASE_URL=
+NIGHTWATCH_TOKEN=
+NIGHTWATCH_DEBUG=true

agent/.gitattributes

@@ -8,6 +8,7 @@
 
 /*.md export-ignore
 /.editorconfig export-ignore
+/.env.example export-ignore
 /.gitattributes export-ignore
 /.github export-ignore
 /.gitignore export-ignore

agent/.gitignore

@@ -1,4 +1,5 @@
 /.box_dump
+/.env.testing
 /.phpunit.result.cache
 /box.json
 /phpstan.neon

agent/composer.json

@@ -31,7 +31,8 @@
         "pestphp/pest": "^3.7.4",
         "phpstan/phpstan": "^2.1.6",
         "phpunit/phpunit": "^11.5.3",
-        "symfony/process": "^7.2"
+        "symfony/process": "^7.2",
+        "vlucas/phpdotenv": "^5.6"
     },
     "autoload": {
         "psr-4": {

agent/composer.lock

@@ -1,3 +1,13 @@
 <?php
 
+if ($_SERVER['CI'] ?? false) {
+    try {
+        Dotenv\Dotenv::createImmutable(__DIR__.'/../', '.env.testing')->load();
+    } catch (Dotenv\Exception\InvalidPathException $e) {
+        echo 'You have not configured your local `.env.testing` file. Please run `cp .env.example .env.testing` and configure the variables as needed.';
+
+        exit(1);
+    }
+}
+
 pest()->extends(Tests\TestCase::class);