Merge pull request #30 from flyeralarm/IN-1730-dockerize-local-test-runner

IN-1730 - Dockerize test runner and remove composer.phar

Author: vukanac

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

.github/workflows/php.yml

@@ -12,11 +12,20 @@ permissions:
 jobs:
   build:
 
+    strategy:
+      matrix:
+        version: [7.3, 7.4, 8.0, 8.1, 8.2]
+
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v3
 
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.version }}
+
     - name: Versions
       run: php --version && composer --version
 

Dockerfile

@@ -0,0 +1,7 @@
+ARG PHP_VERSION=8.2
+FROM php:$PHP_VERSION-cli-alpine
+
+RUN apk add git
+
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+

Makefile

@@ -1,19 +1,46 @@
-PHP_BIN=php
-COMPOSER_BIN=$(PHP_BIN) composer.phar
+PHP_IMAGE_TAG=flyeralarm/php-code-valiator-cli:$(PHP_VERSION)
+PHP_VERSION?=8.2
+
+PHP_BIN=$(RUNNER) php
+COMPOSER_BIN=$(RUNNER) /usr/bin/composer
+
+RUNNER=docker run --init -it --rm -v "$(PWD):/app" -w /app $(PHP_IMAGE_TAG)
+
 
 # ---------------------------------------------
 
 # make
 .DEFAULT_GOAL := install
 
+.PHONY: build
+build:
+	docker image build --tag $(PHP_IMAGE_TAG) --build-arg PHP_VERSION=$(PHP_VERSION) .
+	$(RUNNER) sh -c "php --version && which composer && composer --version"
+
+.PHONY: install
 install:
 	$(COMPOSER_BIN) install
 
+.PHONY: update
+update:
+	rm -rf vendor/ composer.lock
+	$(COMPOSER_BIN) update
+
+.PHONY: sniff
 sniff:
 	$(PHP_BIN) vendor/bin/phpcs -w -p -s --standard=ruleset.xml --ignore="tests/*not-allowed*" custom-standards/ tests/
 
+.PHONY: sniff-fix
 sniff-fix:
 	$(PHP_BIN) vendor/bin/phpcbf -w -p -s --standard=ruleset.xml --ignore="tests/*not-allowed*" custom-standards/ tests/
 
+.PHONY: test
 test:
 	$(PHP_BIN) tests/runner.php
+
+.PHONY: test-all
+test-all:
+	PHP_VERSION=8.2 $(MAKE) build update sniff test
+	PHP_VERSION=8.1 $(MAKE) build update sniff test
+	PHP_VERSION=7.4 $(MAKE) build update sniff test
+	PHP_VERSION=7.3 $(MAKE) build update sniff test

README.md

@@ -37,6 +37,16 @@ To test ruleset run command:
 make test
 ```
 
+As test runner is dockerized we can test with different PHP versions:
+```shell
+PHP_VERSION=8.2 make test
+```
+
+or all at once:
+```shell
+make test-all
+```
+
 
 ## Embed into *your* project
 
@@ -53,6 +63,12 @@ test:
 	vendor/bin/phpcs -w -p -s --standard=vendor/flyeralarm/php-code-validator/ruleset.xml src/ tests/
 ```
 
+or in shorter version by using code validator binary which already use flyeralarm as default standard:
+```make
+test:
+   vendor/bin/php-code-validator src/ tests/
+```
+
 
 ### Add project specific rules