PHPUnit integration fully functional

Author: ivastly

.dockerignore

@@ -0,0 +1,5 @@
+.git
+doc
+docker
+test
+

Makefile

@@ -1,34 +1,35 @@
-.PHONY: debug run full-test-phpunit regression-test-phpunit
-
 XDEBUG_OPTIONS=-dxdebug.remote_enable=1 -dxdebug.remote_autostart=1 -dxdebug.remote_host="host.docker.internal" -dxdebug.idekey=IDEKEY -dxdebug.remote_port=9008
-
-debug:
-	docker-compose run php php $(XDEBUG_OPTIONS) bin/regrest $(command)
-
-run:
-	@docker-compose run php php  bin/regrest $(command)
-
+PHP=docker-compose run php php
 PHPUNIT_ROOT=test/Fixtures/PhpProjectUsingPhpunit
 
-# generates coverage report
-full-test-phpunit:
-	docker-compose run php php $(PHPUNIT_ROOT)/vendor/bin/phpunit --debug --colors=always --bootstrap $(PHPUNIT_ROOT)/vendor/autoload.php --coverage-filter=$(PHPUNIT_ROOT)/src --coverage-php=$(PHPUNIT_ROOT)/test/output/coverage.php --coverage-html=$(PHPUNIT_ROOT)/test/output/coverage.html $(PHPUNIT_ROOT)/test
-
-# does not generate coverage
-regression-test-phpunit: # one needs to pass output of regrest command to `options` argument
-	docker-compose run php php $(PHPUNIT_ROOT)/vendor/bin/phpunit --debug --colors=always --bootstrap $(PHPUNIT_ROOT)/vendor/autoload.php --coverage-filter=$(PHPUNIT_ROOT)/src $(options) $(PHPUNIT_ROOT)/test
-
-full-regrest-demo:
-	$(eval FILTER := $(shell make run command="regrest --changed-since=master --coverage-file=test/Fixtures/PhpProjectUsingPhpunit/test/output/coverage.php --framework=phpunit"))
-	@echo '.'
-	make inception-echo argument="--filter option for PHPUnit: '$(FILTER)'"
-	@echo '.'
-	make regression-test-phpunit options="--filter '$(FILTER)'";
-
-
-.PHONY: inseption-echo
-inception-echo:
-	echo $(argument)
+.PHONY: run
+run:
+	@${PHP}  bin/regrest $(command)
 
-#FILTER=`make run command="regrest --changed-since=master --coverage-file=test/Fixtures/PhpProjectUsingPhpunit/test/output/coverage.php --framework=phpunit"`;
-#make regression-test-phpunit options="--filter '$FILTER'";
+.PHONY: debug
+debug:
+	${PHP} $(XDEBUG_OPTIONS) bin/regrest $(command)
+
+# test regrest <-> PHPUnit, step 1: generate coverage report in .php format
+.PHONY: generate-coverage-report-phpunit
+generate-coverage-report-phpunit:
+	${PHP} $(PHPUNIT_ROOT)/vendor/bin/phpunit --debug --colors=always --bootstrap $(PHPUNIT_ROOT)/vendor/autoload.php --coverage-filter=$(PHPUNIT_ROOT)/src --coverage-php=$(PHPUNIT_ROOT)/test/output/coverage.php --coverage-html=$(PHPUNIT_ROOT)/test/output/coverage.html $(PHPUNIT_ROOT)/test
+
+# change .php code under test/Fixtures/PhpProjectUsingPhpunit/src, otherwise regrest will report NOTHING_TO_RUN
+
+# test regrest <-> PHPUnit, step 2: let regrest generate PHPUnit's `--filter` option to run "meaningful" tests only
+.PHONY: run-regrest-phpunit
+run-regrest-phpunit:
+	@${MAKE} run command="regrest --changed-since=master --coverage-file=test/Fixtures/PhpProjectUsingPhpunit/test/output/coverage.php --framework=phpunit"
+
+# test regrest <-> PHPUnit, step 3: run PHPUnit test suite with populated `--filter` option, so only the tiny portion of all tests is executed.
+.PHONY: run-test-suite-with-regrest-phpunit
+run-test-suite-with-regrest-phpunit:
+	@echo "Run the following command:"
+# fish shell
+	@echo make regression-test-phpunit options=--filter=\"\(make run-regrest-phpunit\)\"
+
+# Regular PHPUnit test suite run <-- this command relates to one from userland Makefile
+.PHONY: regression-test-phpunit
+regression-test-phpunit:
+	${PHP} $(PHPUNIT_ROOT)/vendor/bin/phpunit --debug --colors=always --bootstrap $(PHPUNIT_ROOT)/vendor/autoload.php --coverage-filter=$(PHPUNIT_ROOT)/src $(options) $(PHPUNIT_ROOT)/test

README.md

@@ -27,29 +27,32 @@ Because there is an infinite amount of edge cases when this approach can lead to
 In short, **Regrest detects all software defects introduced by changes of "green" code from test coverage report**.
 If the defect is introduced by some other changes (e.g. you messed up Dockerfile of some dependency), this tool cannot detect that.
 
-## Installation.
-```bash
-git clone https://github.com/ivastly/regrest
-ln -s $(pwd)/regrest/bin/regrest /usr/bin/regrest
-```
 
 ### Prerequisites.
 * git as VCS
 * fresh coverage report in a machine-readable format
 
 
 ## Usage.
+
+## PHPUnit.
+* Make sure coverage report in PHP format `/path/to/coverage.php` is up-to-date.
+* Apply your changes to .php files in your project, as usual...
+* Pass `regrest` output to PHPUnit's `--filter` option, so only **covering current changes** tests will be run, not all of them.
+
 ```bash
-# PHPUnit
-# In case of PHPUnit, @tests placeholder will be replaced with `--filter 'Path\To\Test1|...|Path\To\TestN'`
+phpunit test ..your own phpunit options.. --filter=`docker run ivastly/regrest --changes-since=origin/master --coverage-file=/path/to/coverage.php --framework="phpunit"`
+```
 
-regrest --changes-since=origin/master --coverage-file=/path/to/coverage.php --command="vendor/bin/phpunit @tests test" --framework="phpunit"
+## Codeception.
+```bash
+# TODO
 ```
 
 ## How it works in action.
 *TODO gif here*
 
-## Supported frameworks.
+## Supported test frameworks and coverage formats
 Framework | Coverage Format | Language | Support
 --- | --- | ---
 PHPUnit | PHPUnit .php | PHP | 🟢

ROADMAP.md

@@ -3,4 +3,3 @@
 * `--test-dir` option. If passed, it compares modification time of tests and coverage report. 
 if coverage report is stale, then execution halts with an error:
 "Tests were changed, please regenerate coverage report.". 
-* tests

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3.8'
 services:
   php:
     build:
-      context: docker/php
+      context: docker/php/dev
     working_dir: /app
     environment:
       - PHP_IDE_CONFIG=serverName=docker

docker/php/config/custom-php.ini

@@ -1,4 +1,3 @@
-# Error handling
 log_errors = 1
 error_log = /logs/php_errors.log
 error_reporting = E_ALL
@@ -9,7 +8,3 @@ xdebug.remote_host = host.docker.internal
 xdebug.idekey = IDEKEY
 xdebug.remote_cookie_expire_time = 1
 
-# with these it will connect whatever it takes
-#xdebug.remote_autostart = On
-#xdebug.remote_connect_back = 1
-

docker/php/Dockerfile docker/php/dev/Dockerfile

@@ -0,0 +1,7 @@
+# ivastly/regrest
+FROM php:7.4-cli
+RUN apt update \
+    && apt install -y git
+COPY . /app
+WORKDIR /app
+ENTRYPOINT ["/app/bin/regrest"]

docker/php/dockerhub/Dockerfile

@@ -29,7 +29,7 @@ public function run(
 				$testsToRun = $regrest->getListOfTestsToRun();
 
 				if ($testsToRun) {
-					$phpUnitFilterOption = implode('|', $testsToRun);
+					$phpUnitFilterOption = '"' . implode('|', $testsToRun) . '"';
 				} else {
 					$phpUnitFilterOption = 'NOTHING_TO_RUN';
 				}

src/Presentation/Runner.php

@@ -10,6 +10,6 @@ public function f(): int
 	{
 		// This function is fast (see ClassOne::f), unit test will be same fast.
 
-		return 1 * 1;
+		return 1 * 1 * 1;
 	}
 }