Pulled tools used internally by library out of main composer.json (#116)

FelixJacobi · sualko · samuelwei · web-flow · commit 076bd9cb2897 · 2022-04-08T09:22:12.000+02:00
* Updated vendors

* Removed composer.lock

* Removed downgrade of PHPUnit

* Ignore composer.lock

* Pulled tools used internally by library out of main composer.json

* Updated tools constraint

* Added README explaining the motivation

* Removed unused depdencny to composer/composer

Co-authored-by: Klaus &lt;klaus@jsxc.org&gt;
Co-authored-by: Samuel Weirich &lt;samuel.weirich@gmx.de&gt;
diff --git a/.gitattributes b/.gitattributes
@@ -6,3 +6,4 @@ codeception.yml export-ignore
 phpunit.xml.dist export-ignore
 psalm.xml export-ignore
 /tests export-ignore
+/tools export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ jobs:
     - name: Install php dependencies
       run: composer install --dev --no-interaction
     - name: Execute tests without coverage
-      run: vendor/bin/phpunit --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
+      run: tools/phpunit --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
    
   PHP:
     name: PHP ${{ matrix.php-versions }}
@@ -56,19 +56,19 @@ jobs:
       run: composer install --dev --no-interaction
       continue-on-error: ${{ matrix.experimental }}
     - name: Execute code style check via php-cs-fixer
-      run: vendor/bin/php-cs-fixer fix --dry-run
+      run: tools/php-cs-fixer fix --dry-run
       continue-on-error: ${{ matrix.experimental }}
     - name: Execute tests with coverage
       if: ${{ !matrix.experimental }}
       run: |
         mkdir -p build/logs
-        vendor/bin/phpunit --coverage-clover=build/logs/coverage.xml --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
+        tools/phpunit --coverage-clover=build/logs/coverage.xml --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
     - name: Execute tests without coverage
       if: ${{ matrix.experimental }}
-      run: vendor/bin/phpunit --testsuite="BigBlueButton test suite"
+      run: tools/phpunit --testsuite="BigBlueButton test suite"
       continue-on-error: true
     - name: Coveralls
       env:
         COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       if: ${{ matrix.php-versions == '7.2' && env.COVERALLS_REPO_TOKEN != null }}
-      run: vendor/bin/php-coveralls --coverage_clover=build/logs/coverage.xml -v
+      run: tools/php-coveralls --coverage_clover=build/logs/coverage.xml -v
diff --git a/composer.json b/composer.json
@@ -36,7 +36,7 @@
       "role": "Developer"
     },
     {
-      "name": "Alfonso Rodríguez",
+      "name": "Alfonso Rodr\u00edguez",
       "email": "arodriguez@teltek.es",
       "role": "Developer"
     },
@@ -72,56 +72,65 @@
     "symfony/http-client": "To use the SymfonyHttpClientTransport."
   },
   "require-dev": {
-    "composer/composer": "^1.10.0",
-    "phpunit/phpunit": "^8",
-    "friendsofphp/php-cs-fixer": "2.*",
-    "squizlabs/php_codesniffer": "3.*",
-    "php-coveralls/php-coveralls": "^2.4.0",
-    "brainmaestro/composer-git-hooks": "^2.8",
-    "vimeo/psalm": "^4.5",
     "psr/http-client": "^1.0",
     "psr/http-factory": "^1.0",
     "psr/http-message": "^1.0",
     "symfony/dotenv": "^3.4|^4.0|^5.0",
     "symfony/http-client-contracts": "^1.1|^2.0",
     "symfony/http-client": "^4.4|^5.0",
     "symfony/process": "^3.4|^4.0|^5.0",
-    "nyholm/psr7": "^1.4",
-    "fakerphp/faker": "^1.14"
+    "nyholm/psr7": "^1.4"
   },
   "autoload": {
     "psr-4": {
-      "BigBlueButton\\": ["src", "tests/integration"]
+      "BigBlueButton\\": [
+        "src",
+        "tests/integration"
+      ]
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "BigBlueButton\\Tests\\Functional\\": ["tests/functional"]
+      "BigBlueButton\\Tests\\Functional\\": [
+        "tests/functional"
+      ]
     }
   },
   "scripts": {
-    "test": "vendor/bin/phpunit  --testsuite=\"BigBlueButton unit test suite\"",
-    "test-integration": "vendor/bin/phpunit  --testsuite=\"BigBlueButton integration test suite\"",
-    "test-functional": "vendor/bin/phpunit --testsuite=\"BigBlueButton functional test suite\" --exclude-group=functional-legacy",
-    "cs-fix": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
-    "cs-test": "vendor/bin/php-cs-fixer fix --dry-run --allow-risky=yes",
+    "test": "tools/phpunit  --testsuite=\"BigBlueButton unit test suite\"",
+    "test-integration": "tools/phpunit  --testsuite=\"BigBlueButton integration test suite\"",
+    "test-functional": "tools/phpunit --testsuite=\"BigBlueButton functional test suite\" --exclude-group=functional-legacy",
+    "cs-fix": "tools/php-cs-fixer fix --allow-risky=yes",
+    "cs-test": "tools/php-cs-fixer fix --dry-run --allow-risky=yes",
     "psalm": "psalm --threads=1",
     "psalm-clear": "psalm --clear-cache && psalm --clear-global-cache",
     "psalm-fix": "psalm --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType",
-    "post-install-cmd": "vendor/bin/cghooks add --ignore-lock",
-    "post-update-cmd": "vendor/bin/cghooks update"
+    "post-install-cmd": "tools/composer-git-hooks add --ignore-lock",
+    "post-update-cmd": "tools/composer-git-hooks update"
   },
   "extra": {
     "hooks": {
       "pre-commit": [
-        "vendor/bin/php-cs-fixer fix --dry-run --allow-risky=yes"
+        "tools/php-cs-fixer fix --dry-run --allow-risky=yes"
       ],
       "pre-push": [
-        "vendor/bin/phpunit --testsuite=\"BigBlueButton unit test suite,BigBlueButton integration test suite\"",
-        "vendor/bin/psalm --threads=1"
+        "tools/phpunit --testsuite=\"BigBlueButton unit test suite,BigBlueButton integration test suite\"",
+        "tools/psalm --threads=1"
       ],
       "post-merge": "composer install",
       "post-checkout": "composer install"
+    },
+    "cotor": {
+      "brainmaestro/composer-git-hooks": "^2.8",
+      "extensions": {
+        "phpunit/phpunit": {
+          "fakerphp/faker": "^1.14"
+        }
+      },
+      "friendsofphp/php-cs-fixer": "^3.7",
+      "php-coveralls/php-coveralls": "^2.4",
+      "phpunit/phpunit": "^8",
+      "vimeo/psalm": "^4.22"
     }
   }
 }
diff --git a/tools/.composer-git-hooks/.gitignore b/tools/.composer-git-hooks/.gitignore
@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock
diff --git a/tools/.composer-git-hooks/composer.json b/tools/.composer-git-hooks/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "brainmaestro/composer-git-hooks": "^2.8"
+    }
+}
diff --git a/tools/.php-coveralls/.gitignore b/tools/.php-coveralls/.gitignore
@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock
diff --git a/tools/.php-coveralls/composer.json b/tools/.php-coveralls/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "php-coveralls/php-coveralls": "^2.4.0"
+    }
+}
diff --git a/tools/.php-cs-fixer/.gitignore b/tools/.php-cs-fixer/.gitignore
@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock
diff --git a/tools/.php-cs-fixer/composer.json b/tools/.php-cs-fixer/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "friendsofphp/php-cs-fixer": "2.*"
+    }
+}
diff --git a/tools/.phpunit/.gitignore b/tools/.phpunit/.gitignore
@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock
diff --git a/tools/.phpunit/composer.json b/tools/.phpunit/composer.json
@@ -0,0 +1,6 @@
+{
+    "require": {
+        "phpunit/phpunit": "^8",
+        "fakerphp/faker": "^1.14"
+    }
+}
diff --git a/tools/.psalm/.gitignore b/tools/.psalm/.gitignore
@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock
diff --git a/tools/.psalm/composer.json b/tools/.psalm/composer.json
@@ -0,0 +1,5 @@
+{
+    "require": {
+        "vimeo/psalm": "^4.22"
+    }
+}
diff --git a/tools/README.md b/tools/README.md
@@ -0,0 +1,27 @@
+# Tools
+
+The library uses several tools to validate, test and to lint the code.
+The dependencies are not pulled via the main composer.json to keep the dependency footprint as lightweight as possible.
+
+## Structure of the `tools` folder
+
+Each tool has a hidden (dot) folder with it's tool name. For exmaple, PHP-CS-Fixer uses `tools/.php-cs-fixer`:
+
+~~~
+tools/
+  .php-cs-fixer/
+    composer.json
+    composer.lock # excluded from GIT
+    vendor/ # exluded from GIT
+~~~
+
+These folder contains a composer json which installs the given tool.
+
+Under `tools/<tool>`, e.g. `tools/php-cs-fixer`, there is a simple shell wrapper script which installs the tool on-demand when required.
+
+## Motivation
+
+We don't want to enforce our tools as a `dev` dependency of the library as this would lead to the situation, that using the library enforces to stick at specific tool version fitting the `dev` dependency of us.
+
+Example: We're using PHPUnit 8, as PHPUnit 9 does not support all PHP versions we're supporting.
+If we had a dependency in the main `composer.json`, every consumer of the library is forced to use PHPUnit 8, too, even this has no relevance at all as the tests of the library are never executed by the consumer (and also not delivered).
diff --git a/tools/composer-git-hooks b/tools/composer-git-hooks
@@ -0,0 +1,7 @@
+#!/bin/bash
+# This file was created automatically by cotor as a tool wrapper.
+
+DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
+
+composer install --working-dir=$DIR/.composer-git-hooks --quiet
+exec $DIR/.composer-git-hooks/vendor/bin/cghooks "$@"
diff --git a/tools/php-coveralls b/tools/php-coveralls
@@ -0,0 +1,7 @@
+#!/bin/bash
+# This file was created automatically by cotor as a tool wrapper.
+
+DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
+
+composer install --working-dir=$DIR/.php-coveralls --quiet
+exec $DIR/.php-coveralls/vendor/bin/php-coveralls "$@"
diff --git a/tools/php-cs-fixer b/tools/php-cs-fixer
@@ -0,0 +1,7 @@
+#!/bin/bash
+# This file was created automatically by cotor as a tool wrapper.
+
+DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
+
+composer install --working-dir=$DIR/.php-cs-fixer --quiet
+exec $DIR/.php-cs-fixer/vendor/bin/php-cs-fixer "$@"
diff --git a/tools/phpunit b/tools/phpunit
@@ -0,0 +1,7 @@
+#!/bin/bash
+# This file was created automatically by cotor as a tool wrapper.
+
+DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
+
+composer install --working-dir=$DIR/.phpunit --quiet
+exec $DIR/.phpunit/vendor/bin/phpunit "$@"
diff --git a/tools/psalm b/tools/psalm
@@ -0,0 +1,7 @@
+#!/bin/bash
+# This file was created automatically by cotor as a tool wrapper.
+
+DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")
+
+composer install --working-dir=$DIR/.psalm --quiet
+exec $DIR/.psalm/vendor/bin/psalm "$@"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "require": {
 +        "brainmaestro/composer-git-hooks": "^2.8"
 +    }
 +}