Enhancement: Declare test code in subdirectory

localheinz · Sep 20, 2023 · d4b84dc · d4b84dc
1 parent 6238054
commit d4b84dc
Show file tree

Hide file tree

Showing 15 changed files with 551 additions and 9 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,6 @@
 /.github/                       export-ignore
 /.phive/                        export-ignore
+/src/Test/                      export-ignore
 /.editorconfig                  export-ignore
 /.gitattributes                 export-ignore
 /.gitignore                     export-ignore
@@ -9,6 +10,8 @@
 /composer-require-checker.json  export-ignore
 /composer.lock                  export-ignore
 /Makefile                       export-ignore
+/phpbench.json                  export-ignore
+/phpunit.xml                    export-ignore
 /psalm-baseline.xml             export-ignore
 /psalm.xml                      export-ignore
 /rector.php                     export-ignore
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -46,6 +46,28 @@ make dependency-analysis
 
 to run a dependency analysis.
 
+## Mutation Tests
+
+We are using [`infection/infection`](https://github.com/infection/infection) to ensure a minimum quality of the tests.
+
+Enable `Xdebug` and run
+
+```sh
+make mutation-tests
+```
+
+to run mutation tests.
+
+## Performance Tests
+
+We are using [`phpbench/phpbench`](https://github.com/phpbench/phpbench) to control the performance of our production code.
+
+```sh
+make performance-tests
+```
+
+to run performance tests.
+
 ## Refactoring
 
 We are using [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.
@@ -94,6 +116,17 @@ to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
 
 :exclamation: Ideally, the baseline should shrink over time.
 
+## Tests
+
+We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
+
+Run
+
+```sh
+make tests
+```
+
+to run all the tests.
 
 ## Extra lazy?
 
@@ -103,7 +136,7 @@ Run
 make
 ```
 
-to automatically refactor code, enforce coding standards, and run a static code analysis!
+to automatically refactor code, enforce coding standards, run a static code analysis, run tests, run performance tests, and run mutation tests!
 
 ## Help
 

diff --git a/.github/settings.yml b/.github/settings.yml
@@ -15,11 +15,15 @@ branches:
       required_status_checks:
         checks:
           - context: "Autoloader (8.2, locked)"
+          - context: "Code Coverage (8.2, locked)"
           - context: "Coding Standards (8.2, locked)"
           - context: "Dependency Analysis (8.2, locked)"
+          - context: "Mutation Tests (8.2, locked)"
+          - context: "Performance Tests (8.2, locked)"
           - context: "Refactoring (8.2, locked)"
           - context: "Security Analysis (8.2, locked)"
           - context: "Static Code Analysis (8.2, locked)"
+          - context: "Tests (8.2, locked)"
         strict: false
       restrictions: null
 

diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml
@@ -62,6 +62,62 @@ jobs:
       - name: "Test autoloader for production"
         run: "php autoloader.php"
 
+  code-coverage:
+    name: "Code Coverage"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+
+        dependencies:
+          - "locked"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "xdebug"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Set up problem matchers for phpunit/phpunit"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Collect code coverage with Xdebug and phpunit/phpunit"
+        env:
+          XDEBUG_MODE: "coverage"
+        run: "vendor/bin/phpunit --colors=always --configuration=phpunit.xml --coverage-clover=.build/phpunit/logs/clover.xml"
+
+      - name: "Send code coverage report to codecov.io"
+        uses: "codecov/[email protected]"
+        with:
+          files: ".build/phpunit/logs/clover.xml"
+          token: "${{ secrets.CODECOV_TOKEN }}"
+
   coding-standards:
     name: "Coding Standards"
 
@@ -190,6 +246,98 @@ jobs:
       - name: "Run maglnet/composer-require-checker"
         run: ".phive/composer-require-checker check --ansi --config-file=$(pwd)/composer-require-checker.json"
 
+  mutation-tests:
+    name: "Mutation Tests"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+
+        dependencies:
+          - "locked"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "xdebug"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Run mutation tests with Xdebug and infection/infection"
+        env:
+          XDEBUG_MODE: "coverage"
+        run: "vendor/bin/infection --ansi --configuration=infection.json --logger-github"
+
+  performance-tests:
+    name: "Performance Tests"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+
+        dependencies:
+          - "locked"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "none"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Run performance tests with phpbench/phpbench"
+        run: "vendor/bin/phpbench run --config=phpbench.json src/Test/"
+
   refactoring:
     name: "Refactoring"
 
@@ -354,3 +502,53 @@ jobs:
 
       - name: "Run vimeo/psalm"
         run: "vendor/bin/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4"
+
+  tests:
+    name: "Tests"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.2"
+
+        dependencies:
+          - "lowest"
+          - "locked"
+          - "highest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "none"
+          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Set up problem matchers for phpunit/phpunit"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Run tests with phpunit/phpunit"
+        run: "vendor/bin/phpunit --colors=always --configuration=phpunit.xml"
diff --git a/Makefile b/Makefile
@@ -1,11 +1,16 @@
 .PHONY: it
-it: refactoring coding-standards security-analysis static-code-analysis autoloader ## Runs the refactoring, coding-standards, security-analysis, static-code-analysis, and autoloader targets
+it: refactoring coding-standards security-analysis static-code-analysis tests performance-tests mutation-tests autoloader ## Runs the refactoring, coding-standards, security-analysis, static-code-analysis, tests, performance-tests, mutation-tests, and autoloader targets
 
 .PHONY: autoloader
 autoloader: ## Dumps the autoloader for production and verifies that it does not include classes not intended for production
 	composer dump-autoload --no-dev --optimize
 	php autoloader.php
 
+.PHONY: code-coverage
+code-coverage: vendor ## Collects coverage from running unit tests with phpunit/phpunit
+	mkdir -p .build/phpunit
+	vendor/bin/phpunit --configuration=phpunit.xml --coverage-text
+
 .PHONY: coding-standards
 coding-standards: vendor ## Lints YAML files with yamllint, normalizes composer.json with ergebnis/composer-normalize, and fixes code style issues with friendsofphp/php-cs-fixer
 	yamllint -c .yamllint.yaml --strict .
@@ -21,6 +26,15 @@ dependency-analysis: phive vendor ## Runs a dependency analysis with maglnet/com
 help: ## Displays this list of targets with descriptions
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
 
+.PHONY: performance-tests
+performance-tests: vendor ## Runs performance tests with phpbench/phpbench
+	vendor/bin/phpbench run --config=phpbench.json src/Test/
+
+.PHONY: mutation-tests
+mutation-tests: vendor ## Runs mutation tests with infection/infection
+	mkdir -p .build/infection
+	vendor/bin/infection --configuration=infection.json
+
 .PHONY: phive
 phive: .phive ## Installs dependencies with phive
 	mkdir -p .build/phive/
@@ -47,6 +61,11 @@ static-code-analysis-baseline: vendor ## Generates a baseline for static code an
 	vendor/bin/psalm --config=psalm.xml --clear-cache
 	vendor/bin/psalm --config=psalm.xml --set-baseline=psalm-baseline.xml
 
+.PHONY: tests
+tests: vendor ## Runs tests with phpunit/phpunit
+	mkdir -p .build/phpunit
+	vendor/bin/phpunit --configuration=phpunit.xml
+
 vendor: composer.json composer.lock
 	composer validate --strict
 	composer install --no-interaction --no-progress
diff --git a/composer.json b/composer.json
@@ -34,7 +34,10 @@
   "autoload": {
     "psr-4": {
       "Localheinz\\OrganizingTestCodeInPhp\\": "src/"
-    }
+    },
+    "exclude-from-classmap": [
+      "/src/Test/"
+    ]
   },
   "config": {
     "allow-plugins": {

diff --git a/infection.json b/infection.json
@@ -0,0 +1,20 @@
+{
+  "ignoreMsiWithNoMutations": true,
+  "logs": {
+    "text": ".build/infection/infection-log.txt"
+  },
+  "minCoveredMsi": 100,
+  "minMsi": 100,
+  "phpUnit": {
+    "configDir": "."
+  },
+  "source": {
+    "directories": [
+      "src"
+    ],
+    "excludes": [
+      "Test/"
+    ]
+  },
+  "timeout": 10
+}
diff --git a/phpbench.json b/phpbench.json
@@ -0,0 +1,5 @@
+{
+  "$schema":"vendor/phpbench/phpbench/phpbench.schema.json",
+  "runner.bootstrap": "vendor/autoload.php",
+  "runner.file_pattern": "*.php"
+}