ci: test with lowest and highest dependencies (#133)

simPod · spawnia · Copilot · web-flow · commit f7ffffeb8365 · 2026-02-16T10:34:19.000+01:00
* ci: test with lowest and highest dependencies * refactor: deduplicate example validation scripts * require composer version that has reinstall * fix install test.sh * Update .github/workflows/validate.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * #133 (comment) * improve matrix coverage --------- Co-authored-by: spawnia <benedikt@franke.tech> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -124,6 +124,21 @@ jobs:
           - php-keywords
           - simple
           - polymorphic
+          - inline-fragments
+        php-version:
+          - 8.4
+        dependencies:
+          - highest
+        include:
+          - example: simple
+            php-version: 7.4
+            dependencies: lowest
+          - example: simple
+            php-version: 8.1
+            dependencies: lowest
+          - example: simple
+            php-version: 8.2
+            dependencies: lowest
 
     steps:
       - uses: actions/checkout@v4
@@ -132,11 +147,11 @@ jobs:
         with:
           coverage: none
           extensions: mbstring
-          php-version: 8.3
+          php-version: ${{ matrix.php-version }}
         env:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - run: cd examples/${{ matrix.example }} && ./test.sh
+      - run: examples/validate.sh "${{ matrix.example }}" --dependencies="${{ matrix.dependencies }}"
 
   code-coverage:
     runs-on: ubuntu-latest
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 .PHONY: it
-it: fix stan approve test test-examples ## Run the commonly used targets
+it: fix stan approve test validate-examples ## Run the commonly used targets
 
 .PHONY: help
 help: ## Displays this list of targets with descriptions
@@ -29,15 +29,15 @@ coverage: ## Collects coverage from running unit tests with phpunit
 approve: ## Generate code and approve it as expected
 	tests/generate-and-approve-examples.php
 
-.PHONY: test-examples
-test-examples: ## Test examples
-	cd examples/custom-types && ./test.sh
-	cd examples/inline-fragments && ./test.sh
-	cd examples/input && ./test.sh
-	cd examples/install && ./test.sh
-	cd examples/php-keywords && ./test.sh
-	cd examples/polymorphic && ./test.sh
-	cd examples/simple && ./test.sh
+.PHONY: validate-examples
+validate-examples: ## Run integration tests on examples
+	examples/validate.sh custom-types --dependencies=highest
+	examples/validate.sh inline-fragments --dependencies=highest
+	examples/validate.sh input --dependencies=highest
+	examples/validate.sh install --dependencies=highest
+	examples/validate.sh php-keywords --dependencies=highest
+	examples/validate.sh polymorphic --dependencies=highest
+	examples/validate.sh simple --dependencies=highest
 
 vendor: composer.json composer.lock
 	composer install
diff --git a/composer.json b/composer.json
@@ -26,7 +26,7 @@
   },
   "require-dev": {
     "bensampo/laravel-enum": "^3 || ^4.1 || ^5 || ^6",
-    "composer/composer": "^2",
+    "composer/composer": "^2.1",
     "ergebnis/composer-normalize": "^2.13",
     "friendsofphp/php-cs-fixer": "~3.63.0",
     "guzzlehttp/guzzle": "^7",
diff --git a/examples/custom-types/test.php b/examples/custom-types/test.php
@@ -5,7 +5,7 @@
 use Spawnia\Sailor\CustomTypes\Types\CustomEnum;
 use Spawnia\Sailor\CustomTypesSrc\CustomObject;
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 $myCustomEnumQueryResult = MyCustomEnumQuery::execute(
     new CustomEnum(CustomEnum::A)
diff --git a/examples/custom-types/test.sh b/examples/custom-types/test.sh
diff --git a/examples/inline-fragments/test.php b/examples/inline-fragments/test.php
@@ -2,7 +2,7 @@
 
 use Spawnia\Sailor\InlineFragments\Operations\SearchQuery;
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 $result = SearchQuery::execute('test query')->errorFree();
 
diff --git a/examples/inline-fragments/test.sh b/examples/inline-fragments/test.sh
diff --git a/examples/input/test.php b/examples/input/test.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 $result = Spawnia\Sailor\Input\Operations\TakeSomeInput::execute();
 
diff --git a/examples/input/test.sh b/examples/input/test.sh
diff --git a/examples/install/test.sh b/examples/install/test.sh
@@ -1,18 +1,44 @@
 #!/usr/bin/env bash
-set -euxo pipefail
+set -euo pipefail
 
-composer update
-composer reinstall spawnia/sailor
+if [[ $# -ne 0 ]]; then
+  echo "Usage: examples/install/test.sh" >&2
+  exit 1
+fi
+
+echo "Clean up previous runs"
+rm -rf src sailor.php
+
+if first_output="$(vendor/bin/sailor 2>&1)"; then
+  echo "Expected the initial run of vendor/bin/sailor to exit with an error" >&2
+  exit 1
+fi
+
+if [[ "$first_output" != *"configuration file sailor.php does not exist"* ]]; then
+  echo "Expected first run to fail because sailor.php is missing" >&2
+  exit 1
+fi
+
+if [[ ! -f "sailor.php" ]]; then
+  echo "Expected sailor.php to be present after first executing vendor/bin/sailor" >&2
+  exit 1
+fi
 
-echo Clean up previous runs
-rm -f sailor.php
+if second_output="$(vendor/bin/sailor 2>&1)"; then
+  echo "Expected second run of vendor/bin/sailor to fail in an empty project" >&2
+  exit 1
+fi
 
-if vendor/bin/sailor; then
-  echo Expected the initial run of vendor/bin/sailor to exit with an error
-  exit 1;
+if [[ "$second_output" != *"Directory does not exist"* ]]; then
+  echo "Expected second run to fail because src directory is missing" >&2
+  echo "$second_output" >&2
+  exit 1
 fi
 
-if ! test -f sailor.php; then
-  echo Expected sailor.php to be present after first executing vendor/bin/sailor
+mkdir src
+
+if ! third_output="$(vendor/bin/sailor 2>&1)"; then
+  echo "Expected third run of vendor/bin/sailor to succeed, but it failed with:" >&2
+  echo "$third_output" >&2
   exit 1
 fi
diff --git a/examples/php-keywords/test.php b/examples/php-keywords/test.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 use Spawnia\Sailor\PhpKeywords\Operations\_Catch;
 use Spawnia\Sailor\PhpKeywords\Operations\AllCases;
diff --git a/examples/php-keywords/test.sh b/examples/php-keywords/test.sh
diff --git a/examples/polymorphic/test.php b/examples/polymorphic/test.php
@@ -2,7 +2,7 @@
 
 use Spawnia\Sailor\Polymorphic\Operations\UserOrPost;
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 $id = '1';
 
diff --git a/examples/polymorphic/test.sh b/examples/polymorphic/test.sh
diff --git a/examples/simple/test.php b/examples/simple/test.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
 $result = Spawnia\Sailor\Simple\Operations\MyObjectQuery::execute();
 
diff --git a/examples/simple/test.sh b/examples/simple/test.sh
diff --git a/examples/validate.sh b/examples/validate.sh
@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+  echo "Usage: examples/validate.sh <example> --dependencies=highest|lowest" >&2
+  exit 1
+}
+
+example=''
+dependencies=''
+
+for arg in "$@"; do
+  case "$arg" in
+    --dependencies=*)
+      dependencies="${arg#*=}"
+      ;;
+    --*)
+      echo "Unknown option: $arg" >&2
+      usage
+      ;;
+    *)
+      if [[ -n "$example" ]]; then
+        echo "Unexpected argument: $arg" >&2
+        usage
+      fi
+      example="$arg"
+      ;;
+  esac
+done
+
+if [[ -z "$example" || -z "$dependencies" ]]; then
+  usage
+fi
+
+if [[ ! -d "examples/$example" ]]; then
+  echo "Unknown example: $example" >&2
+  exit 1
+fi
+
+cd "examples/$example"
+
+update_args=()
+case "$dependencies" in
+  highest)
+    ;;
+  lowest)
+    update_args=(--prefer-lowest --prefer-stable)
+    ;;
+  *)
+    echo "Invalid dependencies mode: $dependencies" >&2
+    usage
+    ;;
+esac
+
+composer update "${update_args[@]}"
+composer reinstall spawnia/sailor
+
+if [[ "$example" == "install" ]]; then
+  ./test.sh
+else
+  vendor/bin/sailor
+  php test.php
+fi
diff --git a/src/Codegen/DirectoryFinder.php b/src/Codegen/DirectoryFinder.php
@@ -39,6 +39,10 @@ public function documents(): array
 
     protected function fileIterator(): \RegexIterator // @phpstan-ignore missingType.generics
     {
+        if (! is_dir($this->rootPath)) {
+            throw new \RuntimeException("Directory does not exist: {$this->rootPath}");
+        }
+
         $directory = new \RecursiveDirectoryIterator($this->rootPath);
         $iterator = new \RecursiveIteratorIterator($directory);
 
diff --git a/tests/Unit/Codegen/DirectoryFinderTest.php b/tests/Unit/Codegen/DirectoryFinderTest.php
@@ -27,4 +27,15 @@ public function testPattern(): void
 
         self::assertCount(1, $finder->documents());
     }
+
+    public function testMissingDirectory(): void
+    {
+        $path = __DIR__ . '/finder/does-not-exist';
+        $finder = new DirectoryFinder($path);
+
+        self::expectException(\RuntimeException::class);
+        self::expectExceptionMessage("Directory does not exist: {$path}");
+
+        $finder->documents();
+    }
 }
