Merge pull request #37 from YouweGit/release/version3

Release/version3

Author: Anve94

.github/workflows/testing-suite.yml

@@ -4,20 +4,32 @@ jobs:
   PHP:
     strategy:
       matrix:
-        image: [
-          'srcoder/development-php:php74-fpm',
-          'srcoder/development-php:php80-fpm',
-          'srcoder/development-php:php81-fpm'
-        ]
+        php:
+          - {version: 8.1, tasks: 'composer,jsonlint,xmllint,yamllint,phpcs,phplint,phpmd,phpstan,securitychecker_enlightn'}
+          - {version: 8.2, tasks: 'composer,jsonlint,xmllint,yamllint,phpcs,phplint,phpmd,phpstan,securitychecker_enlightn'}
+          - {version: 8.3}
+          - {version: 8.4}
     runs-on: ubuntu-latest
     container:
-      image: ${{ matrix.image }}
+      image: ${{ matrix.php.version == '8.1' && 'srcoder/development-php:php81-fpm' ||
+        matrix.php.version == '8.2' && 'srcoder/development-php:php82-fpm' ||
+        matrix.php.version == '8.3' && 'srcoder/development-php:php83-fpm' ||
+        matrix.php.version == '8.4' && 'srcoder/development-php:php84-fpm' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Testing Suite
+
+      - name: Install Dependencies
         run: |
           composer2 install --dev --prefer-dist --no-scripts --no-progress --optimize-autoloader --no-interaction -vvv
           composer2 show
-          composer2 exec -v grumphp run
+        shell: bash
+
+      - name: Run GrumPHP Tasks
+        run: |
+          runArguments=()
+          if [[ "${{ matrix.php.tasks }}" ]]; then
+            runArguments+=(--tasks="{{ matrix.php.tasks }}")
+          fi
+          composer2 exec -v grumphp -- run "${runArguments[@]}"
         shell: bash

CHANGELOG.md

@@ -4,6 +4,45 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0]
+### Added
+- Added `phpunit/phpunit` to suggested dependencies in `composer.json`.
+- Added `youwe/coding-standard-phpstorm` to suggested dependencies in `composer.json`.
+- Added support to honor upstream version constraints.
+- Github action for php 8.3 and php 8.4 to run unit tests against PHPUnit 12.
+- Testing suite now attempts to install phpunit upstream if it isn't available yet.
+  - Existing upstream versions are honored if already installed.
+  - Upstream projects not having phpunit installed will install phpunit with an @stable version.
+- Added support for Drupal configuration and templates.
+- Migration docs for migration from v2 to v3 of the testing suite.
+
+### Changed
+- [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`
+  are now moved from the `config` section to the `extra` section. The old location was invalid as the `config` section 
+  belongs to configuration from Composer itself. Moving it to the `extra` section which is intended for this purpose 
+  (composer docs: "arbitrary extra data for consumption by scripts"). Only the single `extra.youwe-testing-suite.type` 
+  is supported now. Update your project `composer.json` accordingly.
+- Unit tests as part of the testing suite are rewritten for PHPUnit 12.
+- Updated GitHub Action workflows to support PHP 8.1, 8.2, 8.3, and 8.4
+- `composer.json`: Dropped support for PHP < 8.1.
+- Moved phpunit from require to require-dev.
+- Changed PHPMD suppressions in docblocks to quote the rule name, due to changes in later versions of PHPStan that create false positives on these docblocks if not quoted.
+- Moved existing project-type specific rulesets from inner dependencies to testing-suite package.
+- Simplified PHPMD rulesets with rationale behind rule changes.
+- Updated remote schema location URL for phpmd rulesets to prevent redirecting which may cause flaky builds.
+- Bumped phpro/grumphp-shim dependency from v1 to v2
+- Bumped youwe/composer-dependency-installer from v1 to v2
+
+### Removed
+- Removed support for EOL PHP versions. Projects running PHP < 8.1 can stick to version 2 of the testing-suite.
+- Removed support for Composer 1. Projects still relying on Composer 1 can stick to version 2 of the testing-suite.
+- Removed `youwe/coding-standard-phpstorm` as dependency (it is still listed in suggest).
+- Removed `phpunit/phpunit` as direct dependency (it is still in require-dev and installed upstream through the `youwe/dependency-installer`).
+- Github actions for php < 8.1.
+- Dependency on seperated coding style packages to simplify development and remove overhead.
+- Dropped support for Laravel and Magento 1.
+- Dropped inner dependencies on coding-standard, coding-standard-magento2, and coding-standard-phpstorm packages.
+
 ## 2.19.1
 ### Changed
 - `^0.30` restricts updates to only versions within the `0.30.x` range, preventing upgrades to 0.32.0 for
@@ -102,7 +141,7 @@ on functions ending with `add()` or `odd()` due to checks on dump and die `dd()`
 ## 2.12 - 2022-05-30
 ### Added
 - PHP 8 compatibility.
-- GitHub Actions Workflow to run testing-suite for PHP 7.4, 8.0 and 8.1.
+- GitHub Actions Workflow to run testing-suite for PHP 7.4, 8.0, and 8.1.
 
 ## 2.11.1 - 2022-04-10
 ### Changed

CONTRIBUTING.md

@@ -1,3 +1,11 @@
+Before opening a PR with changes, make sure all the linting steps are successful.
+
+The require-dev dependency for phpunit is set to @stable for the github actions, but the tests themselves\
+assume they are running against PHPUnit 12 and php >= 8.3. The github actions only run phpunit tests against\
+a php 8.3 container.
+
 If a PR is approved please ask one of the following maintainers to get it merged:
-[Igor Wulff](https://github.com/igorwulff)
-[Dan Wallis](https://github.com/fredden)
+
+- [Igor Wulff](https://github.com/igorwulff)
+- [Leon Helmus](https://github.com/leonhelmus)
+- [Rutger Rademaker](https://github.com/rutgerrademaker)

MIGRATION.md

@@ -0,0 +1,76 @@
+## Testing suite v2 to v3 migration guide
+TODO: Validate / update / rewrite this based on experience and later changes when adding the testing suite
+based on experiences with initial v3.0.0-rc1 tests.
+
+### 1. Double check your project type in the project composer.json.
+We use the project type to automatically update some ruleset mappings for PHPCS and PHPMD.
+
+For a list of supported project types, see the [readme](./README.md).
+
+If your project type was configured in `composer.json` within the `config` section, then move that to the `extra` 
+section:
+
+**Old:**
+```json
+{
+    "config": {
+        "youwe-testing-suite": { "type": "magento2" }
+    }
+}
+```
+
+**New:**
+```json
+{
+    "extra": {
+        "youwe-testing-suite": { "type": "magento2" }
+    }
+}
+```
+
+Otherwise, the project type is still taken from the `type` within `composer.json`.
+
+```json
+{
+    "type": "magento2-module"
+}
+```
+
+### 2. Update to version 3
+```bash
+composer require --dev youwe/testing-suite:^3.0 --no-update
+composer remove --dev youwe/coding-standard youwe/coding-standard-magento2 --no-update
+composer update youwe/testing-suite -W
+composer install
+```
+
+Note: starting v3, phpunit may be installed in your project automatically.\
+We use the @stable version constraint for this. If you want to install a specific
+phpunit version in your project you are free to do so. Upstream phpunit versions
+are honored during installation.
+
+### 3. Sanity checks
+Check the following
+
+1. The PHPCS file exists in your project root and points to the correct ruleset
+configuration in youwe/testing-suite
+2. The PHPMD file exists in your project root and points to the correct ruleset
+configuration in youwe/testing-suite
+3. Run `ddev exec grumphp run` or `vendor/bin/grumphp run`
+4. Your git commit hook still functions as expected
+
+### 4. Refactor and/or update/regenerate exclusion rules
+Some rulesets will have changed. In a general sense, the rulesets are less
+strict compared to what they were before.
+
+If your grumphp tasks are failing due to changes in rulesets, you have 3 options:
+
+1. Refactor. This is always the preferred route if the amount of issues raised
+is limited.
+2. Add exclusion filters. Use existing tooling or update your project configuration
+files to exclude existing project files. This will help in the short-term. Note
+that it is always recommended to still refactor in the future so the file
+exclusions lists will reduce in size over time.
+3. Update rulesets in your project. Projects are free to update rulesets and
+validation if they want. Of course it is always recommended to add
+additional rules instead of removing existing rules.

README.md

@@ -11,16 +11,37 @@ predefined default configurations per project type.
 
 ## Features
 
-- [Project Type detector](docs/features/project-type-detector.md)
+- [Project Type detector](docs/features/project-type-detection.md)
 - [PHP storm configuration](docs/features/php-storm-integration.md)
 
 ## Supported project types
 
-- Default (`default`)
-- Laravel (`laravel`)
-- [Magento 1](docs/project-types/magento1.md) (`magento1`)
-- [Magento 2](docs/project-types/magento2.md) (`magento2`)
-- Pimcore (`pimcore`)
+The Youwe Testing Suites offers pre-configured standards for the following project types.
+
+| Testing Suite Project Type | Detected based on Composer Project Type                                    |
+|----------------------------|----------------------------------------------------------------------------|
+| `drupal`                   | `drupal-bundle`, `drupal-project`                                          |
+| `magento2`                 | `magento-module`, `magento-project`, `magento2-module`, `magento2-project` |
+| `pimcore`                  | `pimcore-bundle`, `pimcore-project`                                        |
+| `default`                  | Any other                                                                  |
+
+This project type is either detected from `composer.json` via the section
+
+```json
+{
+    "extra": {
+        "youwe-testing-suite": { "type": "magento2" }
+    }
+}
+```
+
+or if no explicit setting was found for the Testing Suite, via
+
+```json
+{
+    "type": "magento2-module"
+}
+```
 
 ## Included analysis tools
 
@@ -38,6 +59,15 @@ predefined default configurations per project type.
 
 ## Installation
 
+First, configure your project type (see the above list of supported types) via
+```
+composer config type magento2-project
+```
+or
+```
+composer config extra.youwe-testing-suite.type magento2
+```
+
 Testing suite is supposed to be installed as a composer `dev` dependency.
 Within any project just run the command below to install the package:
 ```

composer.json

@@ -24,22 +24,27 @@
         }
     ],
     "require": {
-        "php": "^7.2 || ^8.0",
-        "composer-plugin-api": "^1.1 || ^2.0",
+        "php": "^8.1",
+        "composer-plugin-api": "^2.0",
+        "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "enlightn/security-checker": "^1.5 || ^2.0",
         "kint-php/kint": "@stable",
-        "php-parallel-lint/php-parallel-lint": "^1.2",
-        "phpro/grumphp-shim": "^1.13",
+        "php-parallel-lint/php-parallel-lint": "^1.4",
+        "phpmd/phpmd": "^2.15",
+        "phpro/grumphp-shim": "^2.12",
         "phpstan/phpstan": "@stable",
-        "phpunit/phpunit": "@stable",
-        "youwe/coding-standard": "^3.5.0",
-        "youwe/coding-standard-phpstorm": "^2.3.0",
-        "youwe/composer-dependency-installer": "^1.4.0",
+        "squizlabs/php_codesniffer": "^3.12.0",
+        "youwe/composer-dependency-installer": "^2.0",
         "youwe/composer-file-installer": "^1.2.0"
     },
+    "suggest": {
+        "phpunit/phpunit": ">= 9.6",
+        "youwe/coding-standard-phpstorm": "^2.3.0"
+    },
     "require-dev": {
         "composer/composer": "@stable",
-        "mikey179/vfsstream": "@stable"
+        "mikey179/vfsstream": "@stable",
+        "phpunit/phpunit": "@stable"
     },
     "replace": {
         "sensiolabs/security-checker": "*"

config/default/phpmd.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<ruleset name="Youwe/Global"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sourceforge.io/ruleset_xml_schema.xsd">
+    <description>Default / Fallback configuration for PHPMD rulesets.</description>
+
+    <!-- Taken from Global ruleset since we can't modify a referenced rule without overwriting it completely.
+         See: https://github.com/phpmd/phpmd/issues/39 -->
+    <rule ref="rulesets/cleancode.xml">
+        <!-- Even though else statements can be rewritten to be avoided, this rule to always block else statements is a bit
+        extreme to enforce in standards. Rule can still be adopted on project-level if needed. -->
+        <exclude name="ElseExpression"/>
+        <!-- We should not assume all code is OOP based, and static usage is not inherently bad outside OOP/SOLID contexts. -->
+        <exclude name="StaticAccess"/>
+        <!-- Boolean flags are sometimes needed to preserve e.g. backwards compatibility. We don't want to enforce this in a blanket
+         statement / default rule but if projects want to enforce this they are free to do so. -->
+        <exclude name="BooleanArgumentFlag"/>
+    </rule>
+
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/design.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/naming.xml" />
+
+    <rule ref="rulesets/naming.xml/LongVariable">
+        <properties>
+            <!-- 20 limit is hard to make descriptive, plus has historically been 30 so also for better backwards compatibility support -->
+            <property name="maximum" value="30"/>
+        </properties>
+    </rule>
+    <!-- End of global ruleset -->
+</ruleset>

config/default/ruleset.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="Youwe/Default">
+    <description>Youwe coding standards for code sniffing for generic platform-agnostic PHP code.</description>
+    <!-- Show sniff codes in all reports. Easier to ignore rules when necessary -->
+    <arg value="s"/>
+    <!-- Use colors in output -->
+    <arg name="colors" />
+
+    <!-- Base rules on PSR12 -->
+    <rule ref="PSR12" />
+</ruleset>

config/drupal/grumphp.yml

@@ -0,0 +1,6 @@
+imports:
+  - resource: '../default/grumphp.yml'
+
+# Extend git triggers with common Drupal constructs
+parameters:
+  git_blacklist.triggered_by: [ 'php', 'js', 'twig' ]

config/drupal/phpmd.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="PHPMD"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sourceforge.io/ruleset_xml_schema.xsd">
+    <description>PHPMD rules for Drupal projects.</description>
+    <rule ref="./config/default/phpmd.xml" />
+
+    <!-- No overrides compared to default. Revisit this file and recreate default drupal rulesets for projects if needed.
+     Note: seperate ruleset needed until https://github.com/phpmd/phpmd/issues/39 is resolved -->
+</ruleset>