Merge pull request #463 from kbsali/housekeeping

Art4 · web-flow · commit 39188d89da9e · 2026-03-13T05:54:20.000+01:00
Housekeeping for v2.10.0
diff --git a/.docker/Behat-Dockerfile b/.docker/Behat-Dockerfile
@@ -0,0 +1,52 @@
+FROM php:7.4-fpm
+
+RUN apt-get update
+RUN apt-get --yes --no-install-recommends install \
+    apt-utils \
+    git \
+    vim \
+    curl \
+    build-essential \
+    locales \
+    zip unzip \
+    libfreetype6-dev \
+    libjpeg62-turbo-dev \
+    libmagickwand-dev \
+    libpng-dev \
+    libzip-dev
+RUN docker-php-ext-configure gd \
+    --with-freetype \
+    --with-jpeg
+RUN docker-php-ext-install -j$(nproc) \
+    pdo \
+    pdo_mysql \
+    mysqli \
+    zip \
+    exif \
+    intl \
+    sockets \
+    gd \
+    bcmath \
+    opcache
+
+COPY build/php/opcache.ini /usr/local/etc/php/conf.d/
+COPY build/php/custom.ini /usr/local/etc/php/conf.d/
+
+RUN pecl install xdebug-3.1.6 && docker-php-ext-enable xdebug
+
+RUN php --version
+
+# Install Composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+# COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
+
+RUN composer --version
+
+RUN usermod -u 33 www-data
+RUN usermod -a -G www-data root
+RUN mkdir -p /var/www/.composer
+RUN chown -R www-data:www-data /var/www
+
+WORKDIR /var/www/project/
+
+USER www-data
diff --git a/.docker/PHP74-Dockerfile b/.docker/PHP74-Dockerfile
@@ -48,3 +48,5 @@ RUN mkdir -p /var/www/.composer
 RUN chown -R www-data:www-data /var/www
 
 WORKDIR /var/www/project/
+
+USER www-data
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,4 @@
 .* export-ignore
-docker-compose.yml
-phpunit.xml.dist export-ignore
+docker-compose.yml export-ignore
+phpunit.dist.xml export-ignore
 tests export-ignore
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -35,7 +35,7 @@ jobs:
         uses: "ramsey/composer-install@v2"
 
       - name: Run tests
-        run: vendor/bin/phpunit --no-coverage
+        run: composer run phpunit -- --no-coverage
 
   # This does not work
   # behat:
@@ -121,7 +121,7 @@ jobs:
 
       - name: Run tests with coverage-clover
         if: ${{ matrix.tool == 'code-coverage' }}
-        run: composer run phpunit -- -c tests/phpunit-coverage.xml.dist --coverage-clover .phpunit.cache/clover.xml
+        run: vendor/bin/phpunit -c tests/phpunit-coverage.dist.xml --coverage-clover .phpunit.cache/clover.xml
 
       - name: Upload coverage reports to Codecov
         if: ${{ matrix.tool == 'code-coverage' }}
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 /.docker/redmine-*_data
 /.php-cs-fixer.cache
+/.php-cs-fixer.php
 /.phpunit.cache
 /composer.lock
 /phpunit.xml
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
diff --git a/.rector.php b/.rector.php
@@ -15,8 +15,10 @@
         \Rector\Set\ValueObject\SetList::CODE_QUALITY,
         \Rector\Set\ValueObject\SetList::DEAD_CODE,
         \Art4\RectorBcLibrary\Set::BC_TYPE_DECLARATION,
-    ])
-    ->withSkip([
-        \Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector::class,
+        \Rector\Set\ValueObject\SetList::PHP_POLYFILLS,
+        \Rector\Set\ValueObject\SetList::EARLY_RETURN,
+        \Rector\Set\ValueObject\SetList::INSTANCEOF,
+        \Rector\Set\ValueObject\SetList::STRICT_BOOLEANS,
+        \Rector\Set\ValueObject\SetList::PRIVATIZATION,
     ])
 ;
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "kbsali/redmine-api",
-    "version": "v2.9.0",
+    "version": "v2.10.0-dev",
     "type": "library",
     "description": "Redmine API client",
     "homepage": "https://github.com/kbsali/php-redmine-api",
@@ -31,12 +31,12 @@
     },
     "require-dev": {
         "art4/rector-bc-library": "^1.0",
-        "behat/behat": "^3.14",
-        "friendsofphp/php-cs-fixer": "^3.68",
-        "guzzlehttp/psr7": "^2",
-        "php-mock/php-mock-phpunit": "^2.13",
+        "behat/behat": "^3.15",
+        "friendsofphp/php-cs-fixer": "^3.94",
+        "guzzlehttp/psr7": "^2.8",
+        "php-mock/php-mock-phpunit": "^2.15",
         "phpstan/phpstan": "^2.1",
-        "phpunit/phpunit": "^9.5 || ^10.5 || ^11.2 || ^12.0.9",
+        "phpunit/phpunit": "^9.6 || ^10.5 || ^11.5 || ^12.5 || ^13.0",
         "rector/rector": "^2.3"
     },
     "autoload": {
@@ -61,9 +61,9 @@
         ],
         "behat": "behat --config tests/Behat/behat.yml",
         "codestyle": "php-cs-fixer fix",
-        "coverage": "phpunit -c tests/phpunit-coverage.xml.dist --coverage-html=\".phpunit.cache/code-coverage\"",
+        "coverage": "phpunit -c tests/phpunit-coverage.dist.xml --coverage-html=\".phpunit.cache/code-coverage\"",
         "phpstan": "phpstan analyze --memory-limit 512M --configuration .phpstan.neon",
-        "phpunit": "phpunit -c phpunit.xml.dist",
+        "phpunit": "phpunit -c phpunit.dist.xml",
         "rectify": [
             "@rector",
             "@codestyle"
@@ -72,6 +72,7 @@
         "test": [
             "@phpstan",
             "@phpunit",
+            "@rector --dry-run",
             "@codestyle --dry-run --diff"
         ]
     }
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,15 +1,26 @@
 services:
+    init-volumes:
+        image: busybox
+        user: "0"
+        command: >
+            sh -c "mkdir -p .docker/redmine-dev_data/files .docker/redmine-dev_data/sqlite
+            .docker/redmine-60101_data/files .docker/redmine-60101_data/sqlite
+            .docker/redmine-60008_data/files .docker/redmine-60008_data/sqlite
+            .docker/redmine-50111_data/files .docker/redmine-50111_data/sqlite &&
+            chmod -R 777 .docker/redmine-*_data/"
+        volumes:
+            - ./:/work
+        working_dir: /work
+
     php:
         build: # Info to build the Docker image
             context: ./.docker # Specify where the Dockerfile is located (e.g. in the root directory of the project)
             dockerfile: PHP74-Dockerfile # Specify the name of the Dockerfile
         ports:
             - 8111:80
         depends_on:
+            - init-volumes
             - redmine-dev
-            - redmine-6-1
-            - redmine-6-0
-            - redmine-5-1
         volumes:
             - ./:/var/www/project/ # Location of the project for php-fpm. Note this should be the same for NGINX.*
 
@@ -27,6 +38,18 @@ services:
             - ./.docker/redmine-dev_data/files:/usr/src/redmine/files
             - ./.docker/redmine-dev_data/sqlite:/usr/src/redmine/sqlite
 
+    behat:
+        build: # PHP container for Behat tests (needs Redmine services)
+            context: ./.docker # Specify where the Dockerfile is located (e.g. in the root directory of the project)
+            dockerfile: Behat-Dockerfile # Specify the name of the Dockerfile
+        depends_on:
+            - init-volumes
+            - redmine-6-1
+            - redmine-6-0
+            - redmine-5-1
+        volumes:
+            - ./:/var/www/project/ # Location of the project for php-fpm. Note this should be the same for NGINX.*
+
     # Make sure the following services are configured in:
     # - /tests/Behat/behat.yml
 
diff --git a/phpunit.dist.xml b/phpunit.dist.xml
diff --git a/src/Redmine/Api/AbstractApi.php b/src/Redmine/Api/AbstractApi.php
@@ -494,12 +494,16 @@ private function getContentTypeFromPath(string $path): string
 
         if (false !== strpos($path, '/uploads.json') || false !== strpos($path, '/uploads.xml')) {
             return 'application/octet-stream';
-        } elseif ('json' === substr($tmp['path'], -4)) {
+        }
+
+        if ('json' === substr($tmp['path'], -4)) {
             return 'application/json';
-        } elseif ('xml' === substr($tmp['path'], -3)) {
+        }
+
+        if ('xml' === substr($tmp['path'], -3)) {
             return 'application/xml';
-        } else {
-            return '';
         }
+
+        return '';
     }
 }
diff --git a/src/Redmine/Api/Issue.php b/src/Redmine/Api/Issue.php
@@ -57,27 +57,27 @@ final public static function fromHttpClient(HttpClient $httpClient): self
     /**
      * @var null|IssueCategory
      */
-    private $issueCategoryApi = null;
+    private $issueCategoryApi;
 
     /**
      * @var null|IssueStatus
      */
-    private $issueStatusApi = null;
+    private $issueStatusApi;
 
     /**
      * @var null|Project
      */
-    private $projectApi = null;
+    private $projectApi;
 
     /**
      * @var null|Tracker
      */
-    private $trackerApi = null;
+    private $trackerApi;
 
     /**
      * @var null|User
      */
-    private $userApi = null;
+    private $userApi;
 
     /**
      * @deprecated v2.9.0 Use fromHttpClient() instead.
diff --git a/src/Redmine/Serializer/JsonSerializer.php b/src/Redmine/Serializer/JsonSerializer.php
@@ -60,7 +60,7 @@ public function getEncoded(): string
 
     public function __toString(): string
     {
-        return $this->getEncoded();
+        return $this->encoded;
     }
 
     private function decode(string $encoded): void
diff --git a/src/Redmine/Serializer/XmlSerializer.php b/src/Redmine/Serializer/XmlSerializer.php
@@ -64,7 +64,7 @@ public function getEncoded(): string
 
     public function __toString(): string
     {
-        return $this->getEncoded();
+        return $this->encoded;
     }
 
     private function deserialize(string $encoded): void
diff --git a/tests/Behat/README.md b/tests/Behat/README.md
@@ -14,21 +14,21 @@ Now you can run all behaviour-driven tests grouped by Redmine version using the
 
 ```bash
 # all tests
-docker compose exec php composer bdt
+docker compose exec behat composer run bdt
 ```
 
 If you need more control about the behat tests or want to change the output format,
 you can use the `behat` command directly:
 
 ```bash
 # test only a specific redmine version
-docker compose exec php composer behat -- --suite=redmine_6_0
+docker compose exec behat composer run behat -- --suite=redmine_6_1
 # test only specific endpoints
-docker compose exec php composer behat -- --tags=issue,group
+docker compose exec behat composer run behat -- --tags=issue,group
 # test only specific endpoints on a specific redmine version
-docker compose exec php composer behat -- --suite=redmine_6_0 --tags=issue,group
+docker compose exec behat composer run behat -- --suite=redmine_6_1 --tags=issue,group
 # test only a specific redmine version and format the output as `progress` (default is `pretty`)
-docker compose exec php composer behat -- --suite=redmine_6_0 --format=progress
+docker compose exec behat composer run behat -- --suite=redmine_6_1 --format=progress
 ```
 
 ## Redmine version specific features
diff --git a/tests/Behat/behat.yml b/tests/Behat/behat.yml
@@ -3,6 +3,10 @@ default:
         default:
             paths:
                 - '%paths.base%/features'
+            contexts:
+                - Redmine\Tests\Behat\Bootstrap\FeatureContext:
+                    redmineVersion: '6.1.1'
+                    rootPath: '%paths.base%/../../.docker'
         redmine_6_1:
             contexts:
                 - Redmine\Tests\Behat\Bootstrap\FeatureContext:
diff --git a/tests/phpunit-coverage.dist.xml b/tests/phpunit-coverage.dist.xml
