ci: fix tags build

.github/Dockerfile

@@ -0,0 +1,18 @@
+ARG PHP_VERSION=8.2.11
+ARG COMPOSER_VERSION=2.6.5
+
+FROM composer:${COMPOSER_VERSION} as composer
+
+FROM php:${PHP_VERSION}-cli-alpine as runtime
+
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app
+
+COPY composer.json composer.json
+RUN composer update --no-dev
+
+COPY merger merger
+COPY src src
+
+ENTRYPOINT ["/app/merger"]

.github/workflows/ci-tags.yml

@@ -0,0 +1,32 @@
+---
+name: ci-tags
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  build-tag:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Build docker image
+        run: |
+          DOCKER_BUILDKIT=1 docker build \
+            --build-arg BUILDKIT_INLINE_CACHE=1 \
+            --build-arg PHP_VERSION=${{ vars.DOCKER_RUNTIME_PHP_VERSION }} \
+            --build-arg COMPOSER_VERSION=${{ vars.DOCKER_RUNTIME_COMPOSER_VERSION }} \
+            --target=runtime \
+            --tag=dannecron/coverage-merger:${{ github.ref_name }} \
+            --file=./.github/Dockerfile .
+      - name: Login to docker hub
+        uses: actions-hub/docker/login@master
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push docker image to docker-hub
+        uses: actions-hub/docker@master
+        with:
+          args: push dannecron/coverage-merger:${{ github.ref_name }}

.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+---
+name: ci
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php_version: ['8.1', '8.2']
+        prefer_lowest: ['yes', '']
+    container: dannecron/php-for-dev:${{ matrix.php_version }}
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Init composer.lock
+        run: |
+          composer update --no-install $(if [[ "${{ matrix.prefer_lowest }}" == 'yes' ]]; then echo '--prefer-lowest'; fi)
+      - name: Install dependencies
+        run: composer install
+      - name: Run tests
+        run: composer run pest-coverage
+  lint:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php_version: ['80100', '80200']
+    container: dannecron/php-for-dev:8.2
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Init composer.lock and install dependencies
+        run: composer update
+      - name: Run phpcs
+        run: vendor/bin/phpcs --standard=phpcs.xml --report=full --config-set php_version ${{ matrix.php_version }} ./src ./tests
+
+  analyze:
+    runs-on: ubuntu-22.04
+    container: dannecron/php-for-dev:8.2
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Init composer.lock and install dependencies
+        run: composer update
+      - name: Run phpstan
+        run: vendor/bin/phpstan analyse src tests
+
+  build-main:
+    runs-on: ubuntu-22.04
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs:
+      - tests
+      - lint
+      - analyze
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Build docker image
+        run: |
+          DOCKER_BUILDKIT=1 docker build \
+            --build-arg BUILDKIT_INLINE_CACHE=1 \
+            --build-arg PHP_VERSION=${{ vars.DOCKER_RUNTIME_PHP_VERSION }} \
+            --build-arg COMPOSER_VERSION=${{ vars.DOCKER_RUNTIME_COMPOSER_VERSION }} \
+            --target=runtime \
+            --tag=dannecron/coverage-merger:latest \
+            --file=./.github/Dockerfile .
+      - name: Login to docker hub
+        uses: actions-hub/docker/login@master
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push docker image to docker-hub
+        uses: actions-hub/docker@master
+        with:
+          args: push dannecron/coverage-merger:latest

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 - 2023-10-10
+
+### Added
+* phpstan to dev-dependencies
+* CI
+  * New stage for static analysis
+  * New stages for building and pushing docker images
+
 ## 0.1.0 - 2023-09-21
 
 ### Added

README.md

@@ -8,14 +8,37 @@ Supported formats:
 
 ### Install
 
-// todo
+#### As global composer dependency
+
+```shell
+composer global require dannecron/coverage-merger
+```
+
+#### As local composer dev-dependency
+
+```shell
+composer require --dev dannecron/coverage-merger
+```
+
+#### As docker-container
+
+Images published on [hub.docker.com](https://hub.docker.com/r/dannecron/coverage-merger)
+
+```shell
+docker pull dannecron/coverage-merger:latest
+```
 
 ### Usage
 
 It's cli-app with single access point:
 
 ```shell
-./merger
+# if installed globally
+$COMPOSER_HOME/vendor/bin/merger
+# if installed locally
+./vendor/bin/merger
+# if pulled from docker hub
+docker run --rm dannecron/coverage-merger:latest
 ```
 
 ```text

composer.json

@@ -18,6 +18,7 @@
     "require-dev": {
         "mockery/mockery": "1.6.6",
         "pestphp/pest": "2.18.2",
+        "phpstan/phpstan": "1.10.37",
         "squizlabs/php_codesniffer": "3.7.2"
     },
     "autoload": {
@@ -37,5 +38,10 @@
         "allow-plugins": {
             "pestphp/pest-plugin": false
         }
+    },
+    "scripts": {
+        "pest": "vendor/bin/pest",
+        "pest-coverage": "env XDEBUG_MODE=coverage vendor/bin/pest --coverage-html=./tests/data/coverage-html --coverage-text",
+        "pest-coverage-html": "env XDEBUG_MODE=coverage vendor/bin/pest --coverage-html=./tests/data/coverage-html"
     }
 }

phpstan.neon

@@ -0,0 +1,32 @@
+parameters:
+    level: 8
+    paths:
+        - src
+        - tests
+    scanFiles:
+        # Pest handles loading custom helpers only when running tests
+        # @see https://pestphp.com/docs/helpers#usage
+        - tests/Pest.php
+        # Mockery doesn't autoload its helper functions
+        - vendor/mockery/mockery/library/helpers.php
+    ignoreErrors:
+        # Pest implicitly binds $this to the current test case
+        # @see https://pestphp.com/docs/underlying-test-case
+        - message: '#^Undefined variable: \$this$#'
+          paths:
+            - tests/*
+        # Pest custom expectations are dynamic and not conducive static analysis
+        # @see https://pestphp.com/docs/expectations#custom-expectations
+        - messages:
+            - '#Call to an undefined method Pest\\Expectation|Pest\\Support\\Extendable::#'
+            - '#Call to an undefined method Pest\\Mixins\\Expectation#'
+            - '#Call to an undefined method Pest\\PendingCalls\\TestCall|Pest\\Support\\HigherOrderTapProxy::#'
+            - '#Access to an undefined property Pest\\Mixins\\Expectation#'
+          paths:
+            - tests/*
+        # Some mockery errors
+        - messages:
+            - '#Call to an undefined method Mockery\\ExpectationInterface|Mockery\\HigherOrderMessage::#'
+            - '#Parameter .+ Mockery\\LegacyMockInterface given.#'
+          paths:
+            - tests/*

src/Clover/Dto/ClassDto.php

@@ -14,6 +14,9 @@ class ClassDto
     ) {
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getProperties(): array
     {
         return $this->properties;

src/Clover/Dto/LineDto.php

@@ -22,6 +22,9 @@ class LineDto
         return $this->count;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getProperties(): array
     {
         return $this->properties;

src/Clover/Parser.php

@@ -57,6 +57,10 @@ class Parser implements ElementsDictionary
         return new LineDto($properties, (int) $count);
     }
 
+    /**
+     * @param \SimpleXMLElement $xml
+     * @return array<array-key, \SimpleXMLElement>
+     */
     public function getAttributes(\SimpleXMLElement $xml): array
     {
         return ((array) $xml->attributes())['@attributes'] ?? [];

src/Clover/Renderer.php

@@ -14,7 +14,7 @@ class Renderer
 {
     /**
      * @param Accumulator $accumulator
-     * @return array
+     * @return array{0: string, 1: Metrics}
      * @throws \DOMException
      */
     public function renderAccumulator(Accumulator $accumulator): array
@@ -71,7 +71,7 @@ class Renderer
 
         $xmlProject->appendChild($this->renderMetricsProject($xmlDocument, $projectMetrics));
 
-        return [$xmlDocument->saveXML(), $projectMetrics];
+        return [(string) $xmlDocument->saveXML(), $projectMetrics];
     }
 
     /**

src/Command/CloverMergeCommand.php

@@ -56,6 +56,11 @@ final class CloverMergeCommand extends CliCommand
     }
 
     /**
+     * @param array<array-key, string> $files
+     * @param string $output
+     * @param string|null $workdir
+     * @param bool $stats
+     * @return int
      * @throws ExecuteException
      */
     public function execute(array $files, string $output, ?string $workdir, bool $stats): int

tests/Unit/Clover/Handler/HandleSingleDocumentTest.php

@@ -10,11 +10,11 @@ use Dannecron\CoverageMerger\Clover\Parser;
 \test('examples without files', function (string $exampleFilename): void {
     $handler = new Handler(new Parser());
 
-    $cloverContents = \file_get_contents(\getExamplePath($exampleFilename));
+    $cloverContents = (string) \file_get_contents(\getExamplePath($exampleFilename));
+    /** @var \SimpleXMLElement $xml */
+    $xml = \simplexml_load_string($cloverContents);
 
-    $accumulator = $handler->handleSingleDocument(
-        \simplexml_load_string($cloverContents),
-    );
+    $accumulator = $handler->handleSingleDocument($xml);
 
     $files = $accumulator->getFiles();
     \expect($files)->toHaveCount(0);
@@ -34,11 +34,11 @@ use Dannecron\CoverageMerger\Clover\Parser;
 ): void {
     $handler = new Handler(new Parser());
 
-    $cloverContents = \file_get_contents(\getExamplePath($exampleFilename));
+    $cloverContents = (string) \file_get_contents(\getExamplePath($exampleFilename));
+    /** @var \SimpleXMLElement $xml */
+    $xml = \simplexml_load_string($cloverContents);
 
-    $accumulator = $handler->handleSingleDocument(
-        \simplexml_load_string($cloverContents),
-    );
+    $accumulator = $handler->handleSingleDocument($xml);
 
     $files = $accumulator->getFiles();
     \expect($files)->toHaveCount(1)->toHaveKey($expectedFilename);
@@ -62,11 +62,11 @@ use Dannecron\CoverageMerger\Clover\Parser;
 ): void {
     $handler = new Handler(new Parser());
 
-    $cloverContents = \file_get_contents(\getExamplePath($exampleFilename));
+    $cloverContents = (string) \file_get_contents(\getExamplePath($exampleFilename));
+    /** @var \SimpleXMLElement $xml */
+    $xml = \simplexml_load_string($cloverContents);
 
-    $accumulator = $handler->handleSingleDocument(
-        \simplexml_load_string($cloverContents),
-    );
+    $accumulator = $handler->handleSingleDocument($xml);
 
     $files = $accumulator->getFiles();
     \expect($files)->toHaveCount(2)
@@ -81,12 +81,12 @@ use Dannecron\CoverageMerger\Clover\Parser;
 \test('examples with invalid structure', function (string $exampleFilename): void {
     $handler = new Handler(new Parser());
 
-    $cloverContents = \file_get_contents(\getExamplePath($exampleFilename));
+    $cloverContents = (string) \file_get_contents(\getExamplePath($exampleFilename));
+    /** @var \SimpleXMLElement $xml */
+    $xml = \simplexml_load_string($cloverContents);
 
     $this->expectException(HandleException::class);
-    $handler->handleSingleDocument(
-        \simplexml_load_string($cloverContents),
-    );
+    $handler->handleSingleDocument($xml);
 })
     ->with([
         'file-with-bad-line.xml',

tests/Unit/Clover/Handler/HandleTest.php

@@ -9,18 +9,27 @@ use Dannecron\CoverageMerger\Clover\Handler;
 use Dannecron\CoverageMerger\Clover\Parser;
 
 \test('merge multiple valid files', function (): void {
-    $fileWithPackage = \file_get_contents(\getExamplePath('file-with-package.xml'));
-    $fileWithoutPackage = \file_get_contents(\getExamplePath('file-without-package.xml'));
-    $fileWithDifferences = \file_get_contents(\getExamplePath('file-with-differences.xml'));
-    $metricsAndClasses = \file_get_contents(\getExamplePath('metrics-and-classes.xml'));
+    $fileWithPackage = (string) \file_get_contents(\getExamplePath('file-with-package.xml'));
+    $fileWithoutPackage = (string) \file_get_contents(\getExamplePath('file-without-package.xml'));
+    $fileWithDifferences = (string) \file_get_contents(\getExamplePath('file-with-differences.xml'));
+    $metricsAndClasses = (string) \file_get_contents(\getExamplePath('metrics-and-classes.xml'));
 
     $handler = new Handler(new Parser());
 
+    /** @var \SimpleXMLElement $xmlFileWithPackage */
+    $xmlFileWithPackage = \simplexml_load_string($fileWithPackage);
+    /** @var \SimpleXMLElement $xmlFileWithoutPackage */
+    $xmlFileWithoutPackage = \simplexml_load_string($fileWithoutPackage);
+    /** @var \SimpleXMLElement $xmlFileWithDifferences */
+    $xmlFileWithDifferences = \simplexml_load_string($fileWithDifferences);
+    /** @var \SimpleXMLElement $xmlMetricsAndClasses */
+    $xmlMetricsAndClasses = \simplexml_load_string($metricsAndClasses);
+
     $accumulator = $handler->handle(
-        \simplexml_load_string($fileWithPackage),
-        \simplexml_load_string($fileWithoutPackage),
-        \simplexml_load_string($fileWithDifferences),
-        \simplexml_load_string($metricsAndClasses),
+        $xmlFileWithPackage,
+        $xmlFileWithoutPackage,
+        $xmlFileWithDifferences,
+        $xmlMetricsAndClasses,
     );
 
     $files = $accumulator->getFiles();

tests/data/examples/not-xml.json

@@ -0,0 +1 @@
+{"foo": "bar"}