Merge pull request #110 from jkowalleck/gh-workflow_php-ci

Author: stevespringett

.github/workflows/php.yml

@@ -0,0 +1,28 @@
+# docs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+
+name: PHP CI
+
+on: [push, pull_request, workflow_dispatch]
+
+defaults:
+  run:
+    working-directory: tools/src/test/php
+
+jobs:
+  test:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@v2
+      - name: Setup PHP
+        # see https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.1"
+          tools: composer:v2
+      - name: Install Depenencies
+        run: composer install
+      - name: Run test
+        run: composer run test

tools/src/test/php/README.md

@@ -5,7 +5,7 @@ for validation of a schema
 
 ## requirements
 
-* `php:^7.4`
+* php >= 7.4
 * php composer
 
 ## setup

tools/src/test/php/composer.json

@@ -1,16 +1,21 @@
 {
   "minimum-stability": "stable",
   "require": {
-    "php": "^7.4|^8.0",
-    "opis/json-schema": "^2.2"
+    "php": "^7.4 || ^8.0",
+    "ext-json": "*",
+    "opis/json-schema": "2.3"
   },
   "require-dev": {
     "roave/security-advisories": "dev-latest"
   },
   "scripts": {
-    "test": "@php -f json-schema-lint-tests.php"
+    "test": [
+      "@test:json-schema-lint"
+    ],
+    "test:json-schema-lint": "@php -f json-schema-lint-tests.php --"
   },
   "scripts-descriptions": {
-    "test": "run tests"
+    "test": "run all tests",
+    "test:json-schema-lint": "lint JSON schema."
   }
 }

tools/src/test/php/json-schema-lint-tests.php

@@ -1,57 +1,58 @@
 <?php declare(strict_types=1);
 
-const SchemaDir =  __DIR__.'/../../../../schema/';
-
-const SchemasFiles = [
-    SchemaDir.'/bom-1.2.schema.json',
-    SchemaDir.'/bom-1.2-strict.schema.json',
-    SchemaDir.'/bom-1.3.schema.json',
-    SchemaDir.'/bom-1.3-strict.schema.json',
-    SchemaDir.'/bom-1.4-SNAPSHOT.schema.json',
-    SchemaDir.'/bom-1.4.schema.json',
-    SchemaDir.'/bom-1.4-strict.schema.json',
-    SchemaDir.'/jsf-0.82.schema.json',
-    SchemaDir.'/spdx.schema.json',
-];
+// region config
+
+const SchemaFileGlob = '*.schema.json';
+const SchemaDir = __DIR__.'/../../../../schema/';
+
+// endregion config
+
+// region pre-check
+
+if (!is_dir(SchemaDir)) {
+    throw new RuntimeException('No such dir: '.SchemaDir);
+}
+
+$schemasFiles = glob(SchemaDir.SchemaFileGlob, GLOB_ERR);
+if (empty($schemasFiles)) {
+    throw new RuntimeException('No schema files found');
+}
+
+// region pre-check
 
 require_once __DIR__.'/vendor/autoload.php';
 
 $errCnt = 0;
-$schemaLoader = new Opis\JsonSchema\SchemaLoader();
 
-foreach (SchemasFiles as $schemasFile) {
-    $schemasFile = realpath($schemasFile);
-    if (!$schemasFile) {
-        // skip
-        continue;
-    }
-    echo PHP_EOL, "Schema: $schemasFile", PHP_EOL;
+foreach ($schemasFiles as $schemasFilePath) {
+    echo PHP_EOL, "SchemaFile: $schemasFilePath", PHP_EOL;
 
     try {
-        $schema = json_decode(file_get_contents($schemasFile), false, 512, JSON_THROW_ON_ERROR);
+        $schema = json_decode(file_get_contents($schemasFilePath), false, 512, JSON_THROW_ON_ERROR);
         if (!is_object($schema)) {
-            throw new DomainException("decode to a non-object");
+            throw new DomainException('decode to a non-object');
         }
-    }
-    catch (Exception $exception)
-    {
+    } catch (Exception $exception) {
         ++$errCnt;
-        echo "JSON DECODE ERROR: ", $exception->getMessage(), PHP_EOL;
+        echo 'JSON DECODE ERROR: ', $exception->getMessage(), PHP_EOL;
         continue;
     }
 
     try {
-        $schemaLoader->loadObjectSchema($schema);
-        echo "OK.", PHP_EOL;
+        // run on individual instances, so no pollution or artifacts can distort tests
+        (new Opis\JsonSchema\SchemaLoader())->loadObjectSchema($schema);
+        echo 'OK.', PHP_EOL;
     } catch (Opis\JsonSchema\Exceptions\SchemaException $exception) {
         ++$errCnt;
-        echo "SCHEMA ERROR: ", $exception->getMessage(), PHP_EOL;
+        echo 'SCHEMA ERROR: ', $exception->getMessage(), PHP_EOL;
         continue;
     } catch (Exception $exception) {
         ++$errCnt;
-        echo "UNEXPECTED ERROR:", $exception->getMessage(), PHP_EOL;
+        echo 'UNEXPECTED ERROR: ', $exception->getMessage(), PHP_EOL;
         continue;
     }
 }
 
-exit($errCnt);
+// Exit statuses should be in the range 0 to 254, the exit status 255 is reserved by PHP and shall not be used.
+// The status 0 is used to terminate the program successfully.
+exit(min($errCnt, 254));