Merge pull request #19 from BrandEmbassy/DE-55463-SonarQubeIntegration

DE-55463 Update Sonar Qube integration
BrandEmbassy · Feb 1, 2024 · 19b4085 · 19b4085
2 parents 84f29cf + 82cdf65
commit 19b4085
Show file tree

Hide file tree

Showing 15 changed files with 107 additions and 144 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -4,126 +4,50 @@ on: [pull_request, workflow_dispatch]
 
 jobs:
   phpstan:
-    runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
         php-version:
-          - 7.4
           - 8.1
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, sockets
-
-      - name: Get composer cache directory
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache composer dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-
-      - name: Install dependencies
-        run: composer install --prefer-dist
-
-      - name: Run phpstan
-        run: composer phpstan
-
+          - 8.2
+    uses: BrandEmbassy/github-actions/.github/workflows/php-phpstan.yml@master
+    with:
+      PHP_VERSION: ${{ matrix.php-version }}
 
   ecs:
-    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         php-version:
-          - 7.4
           - 8.1
+          - 8.2
+    uses: BrandEmbassy/github-actions/.github/workflows/php-ecs.yml@master
+    with:
+      PHP_VERSION: ${{ matrix.php-version }}
 
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, sockets
-
-      - name: Get composer cache directory
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache composer dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-
-      - name: Install dependencies
-        run: composer install --prefer-dist
-
-      - name: Run code-sniffer
-        run: composer check-cs
-
+  rector:
+    uses: BrandEmbassy/github-actions/.github/workflows/php-rector.yml@master
+    with:
+      PHP_VERSION: '8.1'
+      RECTOR_CACHE_PATH: './var/rector'
 
   phpunit:
-    runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
         composer-arg:
           - "install"
           - "update --prefer-lowest"
         php-version:
-          - 7.4
           - 8.1
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, sockets${{ matrix.php-version == '8.1' && matrix.composer-arg == 'install' && ', xdebug' || '' }}
-
-      - name: Get composer cache directory
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache composer dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-
-      - name: Install dependencies
-        run: composer ${{ matrix.composer-arg }} --prefer-dist
-
-      - name: Run tests
-        run: composer test
-        if: matrix.php-version != '8.1' && matrix.composer-arg != 'install'
-
-      - name: Run tests with coverage
-        run: composer test-with-coverage
-        if: matrix.php-version == '8.1' && matrix.composer-arg == 'install'
-
-      - name: SonarQube Scan
-        uses: SonarSource/sonarqube-scan-action@master
-        if: matrix.php-version == '8.1' && matrix.composer-arg == 'install'
-        env:
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-          SONAR_HOST_URL: "https://sonar.nice.com"
+          - 8.2
+        exclude:
+          - composer-arg: install
+            php-version: 8.1
+    uses: BrandEmbassy/github-actions/.github/workflows/php-phpunit.yml@master
+    with:
+      COMPOSER_ARG: ${{ matrix.composer-arg }}
+      PHP_VERSION: ${{ matrix.php-version }}
+
+  phpunit-with-sonar-qube:
+    uses: BrandEmbassy/github-actions/.github/workflows/php-phpunit-with-sonar-qube.yml@master
+    secrets:
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/sonar-qube-master.yml b/.github/workflows/sonar-qube-master.yml
@@ -0,0 +1,12 @@
+name: Sonar Qube on push to master
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  phpunit-with-sonar-qube:
+    uses: BrandEmbassy/github-actions/.github/workflows/php-phpunit-with-sonar-qube.yml@master
+    secrets:
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 vendor/
-temp/
+/var/*
+!.gitkeep
 composer.lock
 .phpunit.cache
 coverage.xml

diff --git a/composer.json b/composer.json
@@ -7,24 +7,26 @@
     }
   },
   "require": {
-    "php": "^7.4 || >=8.1",
+    "php": ">=8.1",
     "beberlei/assert": "^3.2",
     "psr/log": "^1.1"
   },
   "require-dev": {
-    "brandembassy/coding-standard": "10.0.0-beta",
+    "brandembassy/coding-standard": "^11.1",
     "mockery/mockery": "^1.5.1",
     "nette/utils": "^2.4 || ^3.0",
-    "phpunit/phpunit": "^9.6.6",
+    "phpunit/phpunit": "^10.5",
     "roave/security-advisories": "dev-latest"
   },
   "scripts": {
     "check-cs": "vendor/bin/ecs check --ansi",
     "fix-cs": "vendor/bin/ecs check --fix --ansi",
     "phpstan": "php -dxdebug.mode=off vendor/bin/phpstan analyse --memory-limit=-1",
     "phpstan-generate-baseline": "php -dxdebug.mode=off vendor/bin/phpstan analyse --memory-limit=-1 --generate-baseline",
-    "test": "./vendor/bin/phpunit",
-    "test-with-coverage": "php -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-clover=coverage.xml --log-junit=test-report.xml"
+    "phpunit": "./vendor/bin/phpunit --no-coverage",
+    "phpunit-cc": "php -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-clover=coverage.xml --log-junit=test-report.xml",
+    "check-rector": "vendor/bin/rector process --dry-run --ansi",
+    "fix-rector": "vendor/bin/rector process --ansi"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,

diff --git a/phpstan.neon b/phpstan.neon
@@ -6,4 +6,4 @@ parameters:
     paths:
         - src
 
-    tmpDir: temp/phpstan
+    tmpDir: var/phpstan
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,27 +1,31 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         cacheResultFile=".phpunit.cache/test-results"
+         colors="true"
+         cacheDirectory="var/.phpunit.cache"
          executionOrder="depends,defects"
-         forceCoversAnnotation="false"
-         beStrictAboutCoversAnnotation="true"
+         requireCoverageMetadata="false"
+         beStrictAboutCoverageMetadata="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         convertDeprecationsToExceptions="true"
          failOnRisky="true"
-         failOnWarning="true"
-         verbose="true">
+         failOnWarning="true">
     <testsuites>
         <testsuite name="default">
             <directory>src</directory>
         </testsuite>
     </testsuites>
-
-    <coverage cacheDirectory=".phpunit.cache/code-coverage"
-              processUncoveredFiles="true">
+    <coverage>
+        <report>
+            <html outputDirectory="./var/code-coverage" lowUpperBound="50" highLowerBound="80"/>
+        </report>
+    </coverage>
+    <source>
         <include>
             <directory suffix=".php">src</directory>
         </include>
-    </coverage>
+        <exclude>
+            <directory suffix="Test.php">src</directory>
+        </exclude>
+    </source>
 </phpunit>
diff --git a/rector.php b/rector.php
@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+use Rector\Caching\ValueObject\Storage\FileCacheStorage;
+use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
+use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
+use Rector\Config\RectorConfig;
+use Rector\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $defaultRectorConfigurationSetup = require 'vendor/brandembassy/coding-standard/default-rector.php';
+    $defaultSkipList = $defaultRectorConfigurationSetup($rectorConfig);
+
+    $rectorConfig->phpstanConfig(__DIR__ . '/phpstan.neon');
+
+    $rectorConfig->cacheClass(FileCacheStorage::class);
+    $rectorConfig->cacheDirectory('./var/rector');
+
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    $skipList = [];
+
+    $rectorConfig->skip(
+        array_merge(
+            $defaultSkipList,
+            $skipList
+        )
+    );
+};
diff --git a/src/UnitOfWork/DummyTestOperationProcessorAccessor.php b/src/UnitOfWork/DummyTestOperationProcessorAccessor.php
@@ -7,10 +7,7 @@
  */
 class DummyTestOperationProcessorAccessor implements OperationProcessorAccessor
 {
-    /**
-     * @var OperationProcessor
-     */
-    private $operationProcessor;
+    private OperationProcessor $operationProcessor;
 
 
     public function __construct(OperationProcessor $operationProcessor)

diff --git a/src/UnitOfWork/NaiveUnitOfWorkExecutor.php b/src/UnitOfWork/NaiveUnitOfWorkExecutor.php
@@ -16,12 +16,9 @@ class NaiveUnitOfWorkExecutor implements UnitOfWorkExecutor
     /**
      * @var OperationProcessorAccessor[]
      */
-    private $operationProcessorAccessors;
+    private array $operationProcessorAccessors;
 
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
+    private LoggerInterface $logger;
 
 
     /**

diff --git a/src/UnitOfWork/OperationConsolidator.php b/src/UnitOfWork/OperationConsolidator.php
@@ -5,7 +5,6 @@
 use function array_pop;
 use function array_reverse;
 use function array_values;
-use function count;
 
 /**
  * @final
@@ -28,7 +27,7 @@ public function consolidate(array $operations): array
         /** @var Operation[] $merged */
         $merged = [array_pop($operations)];
 
-        while (count($operations) > 0) {
+        while ($operations !== []) {
             /** @var Operation $previous */
             $previous = array_pop($merged);
             /** @var Operation $current */

diff --git a/src/UnitOfWork/ReducingUnitOfWorkExecutor.php b/src/UnitOfWork/ReducingUnitOfWorkExecutor.php
@@ -7,15 +7,9 @@
  */
 class ReducingUnitOfWorkExecutor implements UnitOfWorkExecutor
 {
-    /**
-     * @var OperationConsolidator
-     */
-    private $consolidator;
+    private OperationConsolidator $consolidator;
 
-    /**
-     * @var UnitOfWorkExecutor
-     */
-    private $unitOfWorkExecutor;
+    private UnitOfWorkExecutor $unitOfWorkExecutor;
 
 
     public function __construct(UnitOfWorkExecutor $unitOfWorkExecutor, OperationConsolidator $consolidator)

diff --git a/src/UnitOfWork/UnitOfWorkReducer.php b/src/UnitOfWork/UnitOfWorkReducer.php
@@ -17,11 +17,12 @@ public function reduceFromBeginning(UnitOfWork $unitOfWorkToReduce, Operation $o
         $index = 0;
 
         while (count($operations) > $index && $operations[$index]->canBeMergedWith($operationToReduceBy)) {
-            $index++;
+            ++$index;
         }
+
         while (count($operations) > $index) {
             $operationsAfterReduction[] = $operations[$index];
-            $index++;
+            ++$index;
         }
 
         return UnitOfWork::fromOperations($operationsAfterReduction);

diff --git a/src/UnitOfWork/UnitOfWorkReducerTest.php b/src/UnitOfWork/UnitOfWorkReducerTest.php
@@ -31,7 +31,7 @@ public function testShouldReduceOperationsFromBeginning(
         $expectedOperationsCount = count($expectedOperationsAfterReduction);
         Assert::assertCount($expectedOperationsCount, $actualOperationsAfterReduction);
 
-        for ($i = 0; $i < $expectedOperationsCount; $i++) {
+        for ($i = 0; $i < $expectedOperationsCount; ++$i) {
             Assert::assertSame($expectedOperationsAfterReduction[$i], $actualOperationsAfterReduction[$i]);
         }
     }

diff --git a/src/UnitOfWork/UnitOfWorkTest.php b/src/UnitOfWork/UnitOfWorkTest.php
@@ -14,6 +14,7 @@ public function testShouldUnionUnitOfWork(): void
     {
         $unitOfWorkA = new UnitOfWork();
         $unitOfWorkA->registerOperation(new MergeableOperation(1));
+
         $unitOfWorkB = new UnitOfWork();
         $unitOfWorkB->registerOperation(new MergeableOperation(2));
 

diff --git a/var/.gitkeep b/var/.gitkeep
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,4 +6,4 @@ parameters: @@
         paths:
             - src
-        tmpDir: temp/phpstan
+        tmpDir: var/phpstan