Merge remote-tracking branch 'upstream/develop' into 4.3

kenjis · kenjis · commit 9c35391035c5 · 2022-10-25T06:10:55.000+09:00
Conflicts:
	system/Database/Config.php
	system/Database/OCI8/PreparedQuery.php
diff --git a/.github/workflows/deploy-apidocs.yml b/.github/workflows/deploy-apidocs.yml
@@ -15,7 +15,7 @@ jobs:
   build:
     name: Deploy to api
     if: github.repository == 'codeigniter4/CodeIgniter4'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Setup credentials
diff --git a/.github/workflows/test-autoreview.yml b/.github/workflows/test-autoreview.yml
@@ -21,7 +21,7 @@ concurrency:
 jobs:
   auto-review-tests:
     name: Automatic Code Review
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout
diff --git a/.github/workflows/test-coding-standards.yml b/.github/workflows/test-coding-standards.yml
@@ -19,7 +19,7 @@ concurrency:
 jobs:
   lint:
     name: PHP ${{ matrix.php-version }} Lint with PHP CS Fixer
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       fail-fast: false
diff --git a/.github/workflows/test-deptrac.yml b/.github/workflows/test-deptrac.yml
@@ -31,7 +31,7 @@ concurrency:
 jobs:
   build:
     name: Architectural Inspection
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3
diff --git a/.github/workflows/test-phpcpd.yml b/.github/workflows/test-phpcpd.yml
@@ -30,7 +30,7 @@ concurrency:
 jobs:
   build:
     name: Duplicate Code Detection
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3
diff --git a/.github/workflows/test-phpstan.yml b/.github/workflows/test-phpstan.yml
@@ -34,7 +34,7 @@ concurrency:
 jobs:
   build:
     name: PHP ${{ matrix.php-versions }} Static Analysis
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
     steps:
diff --git a/.github/workflows/test-phpunit.yml b/.github/workflows/test-phpunit.yml
@@ -31,10 +31,13 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+env:
+  COVERAGE_PHP_VERSION: '8.1'
+
 jobs:
   tests:
     name: PHP ${{ matrix.php-versions }} - ${{ matrix.db-platforms }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
 
     strategy:
@@ -69,7 +72,7 @@ jobs:
         options: --health-cmd=pg_isready --health-interval=10s --health-timeout=5s --health-retries=3
 
       mssql:
-        image: mcr.microsoft.com/mssql/server:2019-CU10-ubuntu-20.04
+        image: mcr.microsoft.com/mssql/server:2022-latest
         env:
           SA_PASSWORD: 1Secure*Password1
           ACCEPT_EULA: Y
@@ -133,14 +136,15 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           tools: composer, pecl
           extensions: imagick, sqlsrv, gd, sqlite3, redis, memcached, oci8, pgsql
-          coverage: xdebug
+          coverage: ${{ env.COVERAGE_DRIVER }}
         env:
           update: true
+          COVERAGE_DRIVER: ${{ matrix.php-versions == env.COVERAGE_PHP_VERSION && 'xdebug' || 'none'}}
 
       - name: Install latest ImageMagick
         run: |
           sudo apt-get update
-          sudo apt-get install --reinstall libgs9-common fonts-noto-mono libgs9:amd64 libijs-0.35:amd64 fonts-urw-base35 ghostscript poppler-data libjbig2dec0:amd64 gsfonts libopenjp2-7:amd64 fonts-droid-fallback ttf-dejavu-core
+          sudo apt-get install --reinstall libgs9-common fonts-noto-mono libgs9:amd64 libijs-0.35:amd64 fonts-urw-base35 ghostscript poppler-data libjbig2dec0:amd64 gsfonts libopenjp2-7:amd64 fonts-droid-fallback fonts-dejavu-core
           sudo apt-get install -y imagemagick
           sudo apt-get install --fix-broken
 
@@ -158,44 +162,84 @@ jobs:
         run: |
           composer update --ansi --no-interaction
           composer remove --ansi --dev --unused -W -- rector/rector phpstan/phpstan friendsofphp/php-cs-fixer nexusphp/cs-config codeigniter/coding-standard
-        env:
-          COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
 
-      - name: Profile slow tests in PHP 8.0
-        if: matrix.php-versions == '8.0'
+      - name: Profile slow tests in PHP ${{ env.COVERAGE_PHP_VERSION }}
+        if: matrix.php-versions == env.COVERAGE_PHP_VERSION
         run: echo "TACHYCARDIA_MONITOR_GA=enabled" >> $GITHUB_ENV
 
       - name: Compute coverage option
         uses: actions/github-script@v6
         id: phpunit-coverage-option
         with:
-          script: 'return "${{ matrix.php-versions }}" == "8.0" ? "" : "--no-coverage"'
+          script: |
+            const { COVERAGE_NAME } = process.env
+
+            return "${{ matrix.php-versions }}" == "${{ env.COVERAGE_PHP_VERSION }}" ? `--coverage-php build/cov/coverage-${COVERAGE_NAME}.cov` : "--no-coverage"
           result-encoding: string
+        env:
+          COVERAGE_NAME: php-v${{ env.COVERAGE_PHP_VERSION }}-${{ matrix.db-platforms }}
 
       - name: Test with PHPUnit
         run: script -e -c "vendor/bin/phpunit --color=always --exclude-group=auto-review ${{ steps.phpunit-coverage-option.outputs.result }}"
         env:
           DB: ${{ matrix.db-platforms }}
           TERM: xterm-256color
 
-      - name: Run Coveralls
-        if: github.repository_owner == 'codeigniter4' && matrix.php-versions == '8.0'
-        run: |
-          composer global require --ansi php-coveralls/php-coveralls:^2.4
-          php-coveralls --coverage_clover=build/logs/clover.xml -v
+      - name: Upload coverage file
+        if: matrix.php-versions == env.COVERAGE_PHP_VERSION
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.COVERAGE_NAME }}
+          path: build/cov/coverage-${{ env.COVERAGE_NAME }}.cov
+          if-no-files-found: error
+          retention-days: 1
         env:
-          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COVERALLS_PARALLEL: true
-          COVERALLS_FLAG_NAME: PHP ${{ matrix.php-versions }} - ${{ matrix.db-platforms }}
+          COVERAGE_NAME: php-v${{ env.COVERAGE_PHP_VERSION }}-${{ matrix.db-platforms }}
 
-  coveralls-finish:
+  coveralls:
     if: github.repository_owner == 'codeigniter4'
-    needs: [tests]
-    runs-on: ubuntu-20.04
+    needs: tests
+    runs-on: ubuntu-22.04
 
     steps:
-      - name: Coveralls Finished
-        uses: coverallsapp/github-action@master
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ env.COVERAGE_PHP_VERSION }}
+          tools: composer
+          coverage: xdebug
+        env:
+          update: true
+
+      - name: Download coverage files
+        uses: actions/download-artifact@v3
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel-finished: true
+          path: build/cov
+
+      - name: Display structure of downloaded files
+        run: ls -R
+        working-directory: build/cov
+
+      - name: Get composer cache directory
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer update --ansi --no-interaction
+
+      - name: Merge coverage files
+        run: vendor/bin/phpcov merge --clover build/logs/clover.xml build/cov
+
+      - name: Upload coverage to Coveralls
+        run: vendor/bin/php-coveralls --verbose --exclude-no-stmt --ansi
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/test-rector.yml b/.github/workflows/test-rector.yml
@@ -36,7 +36,7 @@ concurrency:
 jobs:
   build:
     name: PHP ${{ matrix.php-versions }} Analyze code (Rector) on ${{ matrix.paths }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
diff --git a/.github/workflows/test-scss.yml b/.github/workflows/test-scss.yml
@@ -26,7 +26,7 @@ concurrency:
 jobs:
   build:
     name: Compilation of SCSS (Dart Sass)
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout
diff --git a/.github/workflows/test-userguide.yml b/.github/workflows/test-userguide.yml
@@ -17,7 +17,7 @@ concurrency:
 jobs:
   syntax_check:
     name: Check User Guide syntax
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout
diff --git a/composer.json b/composer.json
@@ -21,7 +21,9 @@
         "mikey179/vfsstream": "^1.6",
         "nexusphp/cs-config": "^3.6",
         "nexusphp/tachycardia": "^1.0",
+        "php-coveralls/php-coveralls": "^2.5",
         "phpstan/phpstan": "^1.7.1",
+        "phpunit/phpcov": "^8.2",
         "phpunit/phpunit": "^9.1",
         "predis/predis": "^1.1 || ^2.0",
         "rector/rector": "0.14.6",
diff --git a/rector.php b/rector.php
@@ -61,7 +61,7 @@
         PHPUnitSetList::REMOVE_MOCKS,
     ]);
 
-    $rectorConfig->parallel();
+    $rectorConfig->disableParallel();
 
     // paths to refactor; solid alternative to CLI arguments
     $rectorConfig->paths([__DIR__ . '/app', __DIR__ . '/system', __DIR__ . '/tests', __DIR__ . '/utils']);
diff --git a/system/BaseModel.php b/system/BaseModel.php
@@ -63,6 +63,7 @@ abstract class BaseModel
      * should be instantiated.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup;
 
diff --git a/system/Database/Config.php b/system/Database/Config.php
@@ -12,6 +12,7 @@
 namespace CodeIgniter\Database;
 
 use CodeIgniter\Config\BaseConfig;
+use Config\Database as DbConfig;
 use InvalidArgumentException;
 
 /**
@@ -38,8 +39,10 @@ class Config extends BaseConfig
     /**
      * Creates the default
      *
-     * @param array|BaseConnection|string|null $group     The name of the connection group to use, or an array of configuration settings.
-     * @param bool                             $getShared Whether to return a shared instance of the connection.
+     * @param array|BaseConnection|string|null $group The name of the connection group to use,
+     *                                                or an array of configuration settings.
+     * @phpstan-param array|BaseConnection|non-empty-string|null $group
+     * @param bool $getShared Whether to return a shared instance of the connection.
      *
      * @return BaseConnection
      */
@@ -53,16 +56,21 @@ public static function connect($group = null, bool $getShared = true)
         if (is_array($group)) {
             $config = $group;
             $group  = 'custom-' . md5(json_encode($config));
-        }
+        } else {
+            /** @var DbConfig $dbConfig */
+            $dbConfig = config('Database');
 
-        $config ??= config('Database');
+            if ($group === null) {
+                $group = (ENVIRONMENT === 'testing') ? 'tests' : $dbConfig->defaultGroup;
+            }
 
-        if (empty($group)) {
-            $group = ENVIRONMENT === 'testing' ? 'tests' : $config->defaultGroup;
-        }
+            assert(is_string($group));
+
+            if (! isset($dbConfig->{$group})) {
+                throw new InvalidArgumentException($group . ' is not a valid database connection group.');
+            }
 
-        if (is_string($group) && ! isset($config->{$group}) && strpos($group, 'custom-') !== 0) {
-            throw new InvalidArgumentException($group . ' is not a valid database connection group.');
+            $config = $dbConfig->{$group};
         }
 
         if ($getShared && isset(static::$instances[$group])) {
@@ -71,13 +79,9 @@ public static function connect($group = null, bool $getShared = true)
 
         static::ensureFactory();
 
-        if (isset($config->{$group})) {
-            $config = $config->{$group};
-        }
-
         $connection = static::$factory->load($config, $group);
 
-        static::$instances[$group] = &$connection;
+        static::$instances[$group] = $connection;
 
         return $connection;
     }
@@ -122,6 +126,8 @@ public static function utils($group = null)
     /**
      * Returns a new instance of the Database Seeder.
      *
+     * @phpstan-param null|non-empty-string $group
+     *
      * @return Seeder
      */
     public static function seeder(?string $group = null)
diff --git a/system/Database/OCI8/Connection.php b/system/Database/OCI8/Connection.php
@@ -12,7 +12,6 @@
 namespace CodeIgniter\Database\OCI8;
 
 use CodeIgniter\Database\BaseConnection;
-use CodeIgniter\Database\ConnectionInterface;
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use CodeIgniter\Database\Query;
 use ErrorException;
@@ -23,7 +22,7 @@
  *
  * @extends BaseConnection<false|resource>
  */
-class Connection extends BaseConnection implements ConnectionInterface
+class Connection extends BaseConnection
 {
     /**
      * Database driver
diff --git a/system/Database/OCI8/PreparedQuery.php b/system/Database/OCI8/PreparedQuery.php
@@ -14,14 +14,13 @@
 use BadMethodCallException;
 use CodeIgniter\Database\BasePreparedQuery;
 use CodeIgniter\Database\Exceptions\DatabaseException;
-use CodeIgniter\Database\PreparedQueryInterface;
 
 /**
  * Prepared query for OCI8
  *
  * @extends BasePreparedQuery<false|resource, resource>
  */
-class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
+class PreparedQuery extends BasePreparedQuery
 {
     /**
      * A reference to the db connection to use.
diff --git a/system/Database/OCI8/Result.php b/system/Database/OCI8/Result.php
@@ -12,13 +12,12 @@
 namespace CodeIgniter\Database\OCI8;
 
 use CodeIgniter\Database\BaseResult;
-use CodeIgniter\Database\ResultInterface;
 use CodeIgniter\Entity\Entity;
 
 /**
  * Result for OCI8
  */
-class Result extends BaseResult implements ResultInterface
+class Result extends BaseResult
 {
     /**
      * Gets the number of fields in the result set.
diff --git a/system/Database/Seeder.php b/system/Database/Seeder.php
@@ -26,6 +26,7 @@ class Seeder
      * The name of the database group to use.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup;
 
diff --git a/system/Test/CIUnitTestCase.php b/system/Test/CIUnitTestCase.php
@@ -134,6 +134,7 @@ abstract class CIUnitTestCase extends TestCase
      * If not present, will use the defaultGroup.
      *
      * @var string
+     * @phpstan-var non-empty-string
      */
     protected $DBGroup = 'tests';
 
diff --git a/user_guide_src/source/testing/database.rst b/user_guide_src/source/testing/database.rst
