Merge pull request #85 from bluem-development/linting-and-tests

2.5 release - Linting and tests

Author: DaanRijpkema

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.3', '8.4']
+                php-version: ['8.3', '8.4', '8.5']
 
         steps:
             - name: Checkout code
@@ -41,6 +41,6 @@ jobs:
               uses: php-actions/phpunit@v4
               with:
                   php_version: ${{ matrix.php-version }}
-                  version: 11
+                  version: 12
                   bootstrap: ./vendor/autoload.php
                   configuration: ./.github/workflows/phpunit.xml

.github/workflows/phpunit.xml

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        bootstrap="vendor/autoload.php" colors="true"
-        stopOnFailure="false"
-        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    stopOnFailure="false"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
 >
   <testsuites>
     <testsuite name="Unit">

Makefile

@@ -1,30 +1,81 @@
+# Executables and shared options
+PHP := php
+PHPUNIT := ./vendor/bin/phpunit
+RECTOR := ./vendor/bin/rector
+PHPCS := ./vendor/bin/phpcs
+PHPCBF := ./vendor/bin/phpcbf
+PHPUNIT_FLAGS := --testdox --display-errors --display-warnings --display-deprecations --display-phpunit-deprecations --display-notices
+PHPCS_FLAGS := --standard=phpcs.xml.dist --extensions=php --ignore=vendor/
+
+# Default target
+all: help
+
+# Tests
 test_unit:
-	@printf 'Running unit tests:\n';
-	./vendor/bin/phpunit tests/Unit --testdox --display-errors --display-warnings --display-deprecations --display-phpunit-deprecations --display-notices
+	@printf 'Running unit tests:\n'
+	$(PHPUNIT) tests/Unit $(PHPUNIT_FLAGS)
 
 test_integration:
-	@printf 'Running integration tests:\n';
-	@echo "Note: Ensure you have the necessary environment variables set for integration tests in the .env file."
-	./vendor/bin/phpunit tests/Integration --testdox --display-errors --display-warnings --display-deprecations --display-phpunit-deprecations --display-notices
+	@printf 'Running integration tests:\n'
+	@echo "Note: ensure the required integration variables are set in .env."
+	$(PHPUNIT) tests/Integration $(PHPUNIT_FLAGS)
 
 test_acceptance:
-	@printf 'Running acceptance tests:\n';
-	./vendor/bin/phpunit tests/Acceptance --testdox --display-errors --display-warnings --display-deprecations --display-phpunit-deprecations --display-notices
+	@printf 'Running acceptance tests:\n'
+	$(PHPUNIT) tests/Acceptance $(PHPUNIT_FLAGS)
 
 test:
-	@printf 'Running all tests:\n';
-	make test_unit;
-	make test_acceptance;
-	make test_integration;
+	@printf 'Running all tests:\n'
+	$(MAKE) test_unit
+	$(MAKE) test_acceptance
+	$(MAKE) test_integration
 
+# Code style
 lint:
-	./vendor/bin/phpcs --standard=phpcs.xml.dist --extensions=php --ignore=vendor/ .
+	@echo "Running PHP CodeSniffer..."
+	$(PHPCS) $(PHPCS_FLAGS) .
 
 lint_fix:
-	./vendor/bin/phpcbf --standard=phpcs.xml.dist --extensions=php --ignore=vendor/ .
+	@echo "Fixing PHP CodeSniffer issues..."
+	$(PHPCBF) $(PHPCS_FLAGS) .
+
+lint-fix: lint_fix
+
+# Refactoring
+rector:
+	@echo "Running Rector dry-run..."
+	$(RECTOR) process src --dry-run --clear-cache --config rector.php
+
+rector_fix:
+	@echo "Applying Rector refactoring..."
+	$(RECTOR) process src --clear-cache --config rector.php
 
+rector-fix: rector_fix
+
+# Utilities
+check: lint test_unit
+
+clean:
+	@echo "Cleaning local tool caches..."
+	rm -rf .rector/cache .phpunit.result.cache .phpcs.cache
 
 setup-git-hooks:
 	@echo "Setting up Git hooks..."
 	git config core.hooksPath .githooks
 	chmod +x .githooks/pre-commit
+
+help:
+	@echo "Available targets:"
+	@echo "  test_unit         Run unit tests"
+	@echo "  test_integration  Run integration tests; requires .env"
+	@echo "  test_acceptance   Run acceptance tests"
+	@echo "  test              Run unit, acceptance, and integration tests"
+	@echo "  lint              Run PHP CodeSniffer"
+	@echo "  lint_fix          Auto-fix code style issues"
+	@echo "  rector            Run Rector in dry-run mode"
+	@echo "  rector_fix        Apply Rector refactoring"
+	@echo "  check             Run lint and unit tests"
+	@echo "  clean             Remove local tool caches"
+	@echo "  setup-git-hooks   Configure repository Git hooks"
+
+.PHONY: all test test_unit test_integration test_acceptance lint lint_fix lint-fix rector rector_fix rector-fix check clean setup-git-hooks help