From 9d7f43cd284dd6b4da171feb71f1c06f7a827b04 Mon Sep 17 00:00:00 2001
From: Hugo Sales <hugo@hsal.es>
Date: Thu, 9 Sep 2021 00:40:34 +0100
Subject: [PATCH] [TOOLS][PHPStan][TESTS][Docker] Rework testing Docker
 container into a more generic tooling container. Keep services up and run
 coverage and phpstan as commands, for performance and ease of use

---
 Makefile                                        | 14 ++++++++++----
 bin/pre-commit                                  |  8 +++-----
 docker-compose.yaml.default                     |  1 +
 docker/php/docker-compose.fragment.sh           |  1 +
 docker/testing/coverage.sh                      | 11 -----------
 docker/{testing => tooling}/Dockerfile          |  0
 docker/tooling/coverage.sh                      |  7 +++++++
 docker/{testing => tooling}/db.env              |  0
 docker/{testing => tooling}/docker-compose.yaml |  4 +++-
 docker/tooling/phpstan.sh                       |  5 +++++
 docker/{testing => tooling}/social.env          |  0
 docker/{testing => tooling}/xdebug.ini          |  0
 12 files changed, 30 insertions(+), 21 deletions(-)
 delete mode 100755 docker/testing/coverage.sh
 rename docker/{testing => tooling}/Dockerfile (100%)
 create mode 100755 docker/tooling/coverage.sh
 rename docker/{testing => tooling}/db.env (100%)
 rename docker/{testing => tooling}/docker-compose.yaml (83%)
 create mode 100755 docker/tooling/phpstan.sh
 rename docker/{testing => tooling}/social.env (100%)
 rename docker/{testing => tooling}/xdebug.ini (100%)

diff --git a/Makefile b/Makefile
index ee76992f86..da27cb8f10 100644
--- a/Makefile
+++ b/Makefile
@@ -24,8 +24,14 @@ psql-shell: .PHONY
 database-force-schema-update:
 	docker exec -it $(strip $(DIR))_php_1 sh -c "/var/www/social/bin/console doctrine:schema:update --dump-sql --force"
 
-test: .PHONY
-	cd docker/testing && docker-compose run php; docker-compose down
+tooling-docker: .PHONY
+	@cd docker/tooling && docker-compose up -d > /dev/null 2>&1
 
-stop-test: .PHONY
-	cd docker/testing && docker-compose down
+test: tooling-docker
+	docker exec tooling_php_1 /var/tooling/coverage.sh
+
+phpstan: tooling-docker
+	docker exec tooling_php_1 /var/tooling/phpstan.sh
+
+stop-tooling: .PHONY
+	cd docker/tooling && docker-compose down
diff --git a/bin/pre-commit b/bin/pre-commit
index 11e40cc920..79824bb81e 100755
--- a/bin/pre-commit
+++ b/bin/pre-commit
@@ -9,11 +9,9 @@ if (! (: "${SKIP_ALL?}") 2>/dev/null) && (! (: "${SKIP_CS_FIX?}") 2>/dev/null);
     echo "Running php-cs-fixer on edited files"
     for staged in ${staged_files}; do
         # work only with existing files
-        if [ -f "${staged}" ] && expr "${staged}" : '^.*\.php$'
-        then
+        if [ -f "${staged}" ] && expr "${staged}" : '^.*\.php$' > /dev/null;  then
             # use php-cs-fixer and get flag of correction
-            if "${root}/bin/php-cs-fixer" -q fix "${staged}"
-            then
+            if "${root}/bin/php-cs-fixer" -q fix "${staged}"; then
                 git add "${staged}" # execute git add directly
             fi
         fi
@@ -29,7 +27,7 @@ fi
 
 if (! (: "${SKIP_ALL?}") 2>/dev/null) && (! (: "${SKIP_PHPSTAN?}") 2>/dev/null); then
     echo "Running phpstan"
-    "${root}/vendor/bin/phpstan" --memory-limit=2G analyse src tests components plugins
+    make phpstan
 fi
 
 # Only commit if there wasn't an error
diff --git a/docker-compose.yaml.default b/docker-compose.yaml.default
index 425435d41c..527d6a4ea3 100644
--- a/docker-compose.yaml.default
+++ b/docker-compose.yaml.default
@@ -55,6 +55,7 @@ services:
             - ./docker/social/install.sh:/var/entrypoint.d/social_install.sh
             # Main files
             - .:/var/www/social
+            - /var/www/social/docker
         env_file:
             - ./docker/social/social.env
             - ./docker/db/db.env
diff --git a/docker/php/docker-compose.fragment.sh b/docker/php/docker-compose.fragment.sh
index 415b646381..77f4f48073 100644
--- a/docker/php/docker-compose.fragment.sh
+++ b/docker/php/docker-compose.fragment.sh
@@ -32,6 +32,7 @@ cat <<EOF
             - ./docker/social/install.sh:/var/entrypoint.d/social_install.sh
             # Main files
             - .:/var/www/social
+            - /var/www/social/docker # exclude docker folder
         env_file:
             - ./docker/social/social.env
             - ./docker/db/db.env
diff --git a/docker/testing/coverage.sh b/docker/testing/coverage.sh
deleted file mode 100755
index 3c13c72819..0000000000
--- a/docker/testing/coverage.sh
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/bin/sh
-
-cd /var/www/social || exit 65
-
-yes yes | php bin/console doctrine:fixtures:load || exit 65
-
-if runuser -u www-data -- vendor/bin/simple-phpunit -vvv --coverage-html .test_coverage_report; then
-    exit 64
-else
-    exit 65
-fi
diff --git a/docker/testing/Dockerfile b/docker/tooling/Dockerfile
similarity index 100%
rename from docker/testing/Dockerfile
rename to docker/tooling/Dockerfile
diff --git a/docker/tooling/coverage.sh b/docker/tooling/coverage.sh
new file mode 100755
index 0000000000..7a64f29f69
--- /dev/null
+++ b/docker/tooling/coverage.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+
+cd /var/www/social || exit 1
+
+yes yes | php bin/console doctrine:fixtures:load || exit 1
+
+runuser -u www-data -- vendor/bin/simple-phpunit -vvv --coverage-html .test_coverage_report
diff --git a/docker/testing/db.env b/docker/tooling/db.env
similarity index 100%
rename from docker/testing/db.env
rename to docker/tooling/db.env
diff --git a/docker/testing/docker-compose.yaml b/docker/tooling/docker-compose.yaml
similarity index 83%
rename from docker/testing/docker-compose.yaml
rename to docker/tooling/docker-compose.yaml
index 323b3e1b80..698e3418f3 100644
--- a/docker/testing/docker-compose.yaml
+++ b/docker/tooling/docker-compose.yaml
@@ -11,9 +11,11 @@ services:
             - ../php/entrypoint.sh:/entrypoint.sh
             - ../db/wait_for_db.sh:/wait_for_db.sh
             - ../social/install.sh:/var/entrypoint.d/0_social_install.sh
-            - ./coverage.sh:/var/entrypoint.d/8_coverage.sh
+            - ./coverage.sh:/var/tooling/coverage.sh
+            - ./phpstan.sh:/var/tooling/phpstan.sh
             # Main files
             - ../../:/var/www/social
+            - /var/www/social/docker # exclude docker folder
             - ./xdebug.ini:/usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
         env_file:
             - social.env
diff --git a/docker/tooling/phpstan.sh b/docker/tooling/phpstan.sh
new file mode 100755
index 0000000000..53653998ad
--- /dev/null
+++ b/docker/tooling/phpstan.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+cd /var/www/social || exit 1
+
+vendor/bin/phpstan --ansi --no-interaction --memory-limit=2G analyse src tests components plugins
diff --git a/docker/testing/social.env b/docker/tooling/social.env
similarity index 100%
rename from docker/testing/social.env
rename to docker/tooling/social.env
diff --git a/docker/testing/xdebug.ini b/docker/tooling/xdebug.ini
similarity index 100%
rename from docker/testing/xdebug.ini
rename to docker/tooling/xdebug.ini