Merge pull request #11 from reactphp-parallel/next-gen-qa-set-up

Next gen QA set up

Author: WyriHaximus

.gitignore

@@ -1 +1,2 @@
+var
 vendor

Makefile

@@ -3,34 +3,61 @@ SHELL=bash
 
 .PHONY: *
 
+DOCKER_CGROUP:=$(shell cat /proc/1/cgroup | grep docker | wc -l)
+COMPOSER_CACHE_DIR:=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer/cache)
+
 ifneq ("$(wildcard /.dockerenv)","")
-    DOCKER_RUN=
+    IN_DOCKER:=TRUE
+else ifneq ("$(DOCKER_CGROUP)","0")
+	IN_DOCKER:=TRUE
+else
+    IN_DOCKER:=FALSE
+endif
+
+ifeq ("$(IN_DOCKER)","TRUE")
+	DOCKER_RUN:=
 else
-	DOCKER_RUN=docker run --rm -it \
-		-v `pwd`:`pwd` \
-		-w `pwd` \
-		"wyrihaximusnet/php:7.4-zts-alpine3.11-dev"
+	PHP_VERSION:=$(shell docker run --rm -v "`pwd`:`pwd`" jess/jq jq -r -c '.config.platform.php' "`pwd`/composer.json" | php -r "echo str_replace('|', '.', explode('.', implode('|', explode('.', stream_get_contents(STDIN), 2)), 2)[0]);")
+	DOCKER_RUN:=docker run --rm -it \
+		-v "`pwd`:`pwd`" \
+		-v "${COMPOSER_CACHE_DIR}:/home/app/.composer/cache" \
+		-w "`pwd`" \
+		"ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-zts-alpine3.12-dev"
 endif
 
-all: lint cs-fix cs stan psalm composer-require-checker composer-unused
+all: ## Runs everything ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE)
 
-lint:
+syntax-php: ## Lint PHP syntax
 	$(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor .
 
-cs:
-	$(DOCKER_RUN) vendor/bin/phpcs --parallel=$(nproc)
+cs-fix: ## Fix any automatically fixable code style issues
+	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml -vvvv
 
-cs-fix:
-	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(nproc)
+cs: ## Check the code for code style issues
+	$(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml
 
-stan:
-	$(DOCKER_RUN) vendor/bin/phpstan analyse src --level max --ansi -c phpstan.neon
+stan: ## Run static analysis (PHPStan)
+	$(DOCKER_RUN) vendor/bin/phpstan analyse src --level max --ansi -c ./etc/qa/phpstan.neon
 
-psalm:
-	$(DOCKER_RUN) vendor/bin/psalm --threads=$(nproc) --shepherd --stats src
+psalm: ## Run static analysis (Psalm)
+	$(DOCKER_RUN) vendor/bin/psalm --threads=$(shell nproc) --shepherd --stats --config=./psalm.xml
 
-composer-require-checker:
-	$(DOCKER_RUN) vendor/bin/composer-require-checker --ignore-parse-errors --ansi -vvv --config-file=composer-require-checker.json
+composer-require-checker: ## Ensure we require every package used in this package directly
+	$(DOCKER_RUN) vendor/bin/composer-require-checker --ignore-parse-errors --ansi -vvv --config-file=./etc/qa/composer-require-checker.json
 
-composer-unused:
+composer-unused: ## Ensure we don't require any package we don't use in this package directly
 	$(DOCKER_RUN) composer unused --ansi
+
+backward-compatibility-check: ## Check code for backwards incompatible changes
+	$(DOCKER_RUN) vendor/bin/roave-backward-compatibility-check || true
+
+shell: ## Provides Shell access in the expected environment ###
+	$(DOCKER_RUN) ash
+
+task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]'
+
+help: ## Show this help ###
+	@printf "\033[33mUsage:\033[0m\n  make [target]\n\n\033[33mTargets:\033[0m\n"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#'

composer.json

@@ -18,6 +18,7 @@
         "react-parallel/event-loop": "^1.0",
         "react/event-loop": "^1.1",
         "react/promise": "^2.7",
+        "thecodingmachine/safe": "^1.3",
         "wyrihaximus/async-test-utilities": "^3.2",
         "wyrihaximus/iterator-or-array-to-array": "^1.1",
         "wyrihaximus/pool-info": "^1.0"

composer.lock

@@ -0,0 +1 @@
+C:37:"PHPUnit\Runner\DefaultTestResultCache":488:{a:2:{s:7:"defects";a:0:{}s:5:"times";a:6:{s:55:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::read";d:2.018;s:56:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::close";d:1.004;s:57:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::cancel";d:3.004;s:55:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::kill";d:3.005;s:63:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::channelError";d:1.002;s:62:"ReactParallel\Tests\EventLoop\EventLoopBridgeTest::futureError";d:1.004;}}}

etc/qa/.phpunit.result.cache

@@ -3,7 +3,8 @@
     "null", "true", "false",
     "static", "self", "parent",
     "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
-    "Safe\\sleep"
+    "WyriHaximus\\Constants\\ComposerAutoloader\\LOCATION", "WyriHaximus\\Constants\\Boolean\\FALSE_",
+    "WyriHaximus\\Constants\\Boolean\\TRUE_", "WyriHaximus\\Constants\\Numeric\\ZERO", "Safe\\sleep"
   ],
   "php-core-extensions" : [
     "Core",

composer-require-checker.json etc/qa/composer-require-checker.jsoncomposer-require-checker.json renamed to etc/qa/composer-require-checker.json

@@ -6,7 +6,7 @@
     <arg name="cache" value=".phpcs.cache" /> <!-- cache the results and don't commit them -->
     <arg value="np" /> <!-- n = ignore warnings, p = show progress -->
 
-    <file>src</file>
+    <file>../../src</file>
 
     <rule ref="WyriHaximus-OSS" />
 </ruleset>

phpcs.xml.dist etc/qa/phpcs.xmlphpcs.xml.dist renamed to etc/qa/phpcs.xml

@@ -0,0 +1,9 @@
+parameters:
+	checkMissingIterableValueType: false
+	ignoreErrors:
+	    - '#Call to an undefined method React\\Promise\\PromiseInterface::always\(\).#'
+	ergebnis:
+		classesAllowedToBeExtended:
+			- Exception
+includes:
+	- ../../vendor/wyrihaximus/async-test-utilities/rules.neon