Merge pull request #1264 from acelaya-forks/feature/unify-ci-jobs

Unified jobs in ci pipeline as much as possible

.github/workflows/ci.yml

@@ -27,107 +27,17 @@ jobs:
       - run: composer install --no-interaction --prefer-dist
       - run: composer ${{ matrix.command }}
 
-  unit-tests:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['8.0', '8.1']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: openswoole-4.8.1
-          coverage: pcov
-          ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer test:unit:ci
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '8.0' }}
-        with:
-          name: coverage-unit
-          path: |
-            build/coverage-unit
-            build/coverage-unit.cov
-
-  db-tests-sqlite:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['8.0', '8.1']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: openswoole-4.8.1
-          coverage: pcov
-          ini-values: pcov.directory=module
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:sqlite:ci
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '8.0' }}
-        with:
-          name: coverage-db
-          path: |
-            build/coverage-db
-            build/coverage-db.cov
-
-  db-tests-mysql:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['8.0', '8.1']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: openswoole-4.8.1
-          coverage: none
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:mysql
-
-  db-tests-maria:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['8.0', '8.1']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: openswoole-4.8.1
-          coverage: none
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:maria
-
-  db-tests-postgres:
+  tests:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
         php-version: ['8.0', '8.1']
+        test-group: ['unit', 'api']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Start database server
+        if: ${{ matrix.test-group == 'api' }}
         run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
       - name: Use PHP
         uses: shivammathur/setup-php@v2
@@ -135,69 +45,62 @@ jobs:
           php-version: ${{ matrix.php-version }}
           tools: composer
           extensions: openswoole-4.8.1
-          coverage: none
+          coverage: pcov
+          ini-values: pcov.directory=module
       - run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:postgres
+      - run: composer test:${{ matrix.test-group }}:ci
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.php-version == '8.0' }}
+        with:
+          name: coverage-${{ matrix.test-group }}
+          path: |
+            build/coverage-${{ matrix.test-group }}
+            build/coverage-${{ matrix.test-group }}.cov
 
-  db-tests-ms:
+  db-tests:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
         php-version: ['8.0', '8.1']
+        platform: ['sqlite:ci', 'mysql', 'maria', 'postgres', 'ms']
     env:
       LC_ALL: C
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Install MSSQL ODBC
+        if: ${{ matrix.platform == 'ms' }}
         run: sudo ./data/infra/ci/install-ms-odbc.sh
       - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms
+        if: ${{ matrix.platform != 'sqlite:ci' }}
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_${{ matrix.platform }}
       - name: Use PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
           extensions: openswoole-4.8.1, pdo_sqlsrv-5.10.0beta2
-          coverage: none
-      - run: composer install --no-interaction --prefer-dist
-      - name: Create test database
-        run: docker-compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
-      - run: composer test:db:ms
-
-  api-tests:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['8.0', '8.1']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: openswoole-4.8.1
           coverage: pcov
           ini-values: pcov.directory=module
       - run: composer install --no-interaction --prefer-dist
-      - run: bin/test/run-api-tests.sh
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '8.0' }}
+      - name: Create test database
+        if: ${{ matrix.platform == 'ms' }}
+        run: docker-compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
+      - name: Run tests
+        run: composer test:db:${{ matrix.platform }}
+      - name: Upload code coverage
+        uses: actions/upload-artifact@v2
+        if: ${{ matrix.php-version == '8.0' && matrix.platform == 'sqlite:ci' }}
         with:
-          name: coverage-api
+          name: coverage-db
           path: |
-            build/coverage-api
-            build/coverage-api.cov
+            build/coverage-db
+            build/coverage-db.cov
 
   mutation-tests:
     needs:
-      - unit-tests
-      - db-tests-sqlite
-      - api-tests
+      - tests
+      - db-tests
     runs-on: ubuntu-20.04
     strategy:
       matrix:
@@ -227,9 +130,8 @@ jobs:
 
   upload-coverage:
     needs:
-      - unit-tests
-      - db-tests-sqlite
-      - api-tests
+      - tests
+      - db-tests
     runs-on: ubuntu-20.04
     strategy:
       matrix:

bin/test/run-api-tests.sh

@@ -2,6 +2,7 @@
 export APP_ENV=test
 export DB_DRIVER=postgres
 export TEST_ENV=api
+export GENERATE_COVERAGE=${GENERATE_COVERAGE:-"no"}
 
 rm -rf data/log/api-tests
 

composer.json

@@ -126,7 +126,7 @@
         "test:ci": [
             "@test:unit:ci",
             "@test:db",
-            "@test:api"
+            "@test:api:ci"
         ],
         "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
         "test:unit:ci": "@test:unit --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
@@ -139,13 +139,14 @@
         "test:db:postgres": "DB_DRIVER=postgres composer test:db:sqlite",
         "test:db:ms": "DB_DRIVER=mssql composer test:db:sqlite",
         "test:api": "bin/test/run-api-tests.sh",
+        "test:api:ci": "GENERATE_COVERAGE=yes composer test:api",
         "infect:ci:base": "infection --threads=4 --log-verbosity=default --only-covered --only-covering-test-cases --skip-initial-tests",
         "infect:ci:unit": "@infect:ci:base --coverage=build/coverage-unit --min-msi=83",
         "infect:ci:db": "@infect:ci:base --coverage=build/coverage-db --min-msi=95 --configuration=infection-db.json",
         "infect:ci:api": "@infect:ci:base --coverage=build/coverage-api --min-msi=80 --configuration=infection-api.json",
         "infect:ci": "@parallel infect:ci:unit infect:ci:db infect:ci:api",
         "infect:test": [
-            "@parallel test:unit:ci test:db:sqlite:ci test:api",
+            "@parallel test:unit:ci test:db:sqlite:ci test:api:ci",
             "@infect:ci"
         ],
         "infect:test:unit": [
@@ -153,7 +154,7 @@
             "@infect:ci:unit"
         ],
         "infect:test:api": [
-            "@test:api",
+            "@test:api:ci",
             "@infect:ci:api"
         ],
         "swagger:validate": "php-openapi validate docs/swagger/swagger.json",
@@ -170,6 +171,7 @@
         "test:ci": "<fg=blue;options=bold>Runs all test suites, generating all needed reports and logs for CI envs</>",
         "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
         "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
+        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
         "test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB, PostgreSQL and MsSQL</>",
         "test:db:sqlite": "<fg=blue;options=bold>Runs database test suites on a SQLite database</>",
         "test:db:sqlite:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite database, generating all needed reports and logs for CI envs</>",
@@ -178,7 +180,7 @@
         "test:db:postgres": "<fg=blue;options=bold>Runs database test suites on a PostgreSQL database</>",
         "test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Miscrosoft SQL Server database</>",
         "test:api": "<fg=blue;options=bold>Runs API test suites</>",
-        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
+        "test:api:ci": "<fg=blue;options=bold>Runs API test suites, and generates code coverage reports</>",
         "infect:ci": "<fg=blue;options=bold>Checks unit and db tests quality applying mutation testing with existing reports and logs</>",
         "infect:ci:unit": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
         "infect:ci:db": "<fg=blue;options=bold>Checks db tests quality applying mutation testing with existing reports and logs</>",

config/autoload/entity-manager.local.php.dist

@@ -9,7 +9,7 @@ return [
             'user' => 'root',
             'password' => 'root',
             'driver' => 'pdo_mysql',
-            'host' => 'shlink_db',
+            'host' => 'shlink_db_mysql',
             'dbname' => 'shlink',
             'charset' => 'utf8',
         ],

config/test/test_config.global.php

@@ -30,7 +30,8 @@ use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
 use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
 
 $isApiTest = env('TEST_ENV') === 'api';
-if ($isApiTest) {
+$generateCoverage = env('GENERATE_COVERAGE') === 'yes';
+if ($isApiTest && $generateCoverage) {
     $filter = new Filter();
     $filter->includeDirectory(__DIR__ . '/../../module/Core/src');
     $filter->includeDirectory(__DIR__ . '/../../module/Rest/src');
@@ -40,7 +41,6 @@ if ($isApiTest) {
 $buildDbConnection = static function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
     $isCi = env('CI', false);
-    $getMysqlHost = static fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
     $getCiMysqlPort = static fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
 
     return match ($driver) {
@@ -66,7 +66,7 @@ $buildDbConnection = static function (): array {
         ],
         default => [ // mysql and maria
             'driver' => 'pdo_mysql',
-            'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
+            'host' => $isCi ? '127.0.0.1' : sprintf('shlink_db_%s', $driver),
             'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
             'user' => 'root',
             'password' => 'root',
@@ -124,7 +124,6 @@ return [
                 if ($coverage) { // @phpstan-ignore-line
                     $basePath = __DIR__ . '/../../build/coverage-api';
 
-                    // TODO Generate these coverages dynamically based on CLI options
                     (new PHP())->process($coverage, $basePath . '.cov');
                     (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
                     (new Html())->process($coverage, $basePath . '/coverage-html');

docker-compose.ci.yml

@@ -1,7 +1,7 @@
 version: '3'
 
 services:
-    shlink_db:
+    shlink_db_mysql:
         environment:
             MYSQL_DATABASE: shlink_test
 

docker-compose.override.yml.dist

@@ -13,7 +13,7 @@ services:
             - /etc/passwd:/etc/passwd:ro
             - /etc/group:/etc/group:ro
 
-    shlink_db:
+    shlink_db_mysql:
         user: 1000:1000
         volumes:
             - /etc/passwd:/etc/passwd:ro

docker-compose.yml

@@ -22,7 +22,7 @@ services:
             - ./:/home/shlink/www
             - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
-            - shlink_db
+            - shlink_db_mysql
             - shlink_db_postgres
             - shlink_db_maria
             - shlink_db_ms
@@ -57,7 +57,7 @@ services:
             - ./:/home/shlink
             - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
-            - shlink_db
+            - shlink_db_mysql
             - shlink_db_postgres
             - shlink_db_maria
             - shlink_db_ms
@@ -69,8 +69,8 @@ services:
         extra_hosts:
             - 'host.docker.internal:host-gateway'
 
-    shlink_db:
-        container_name: shlink_db
+    shlink_db_mysql:
+        container_name: shlink_db_mysql
         image: mysql:5.7
         ports:
             - "3307:3306"

module/Core/test/Config/SimplifiedConfigParserTest.php

@@ -29,7 +29,7 @@ class SimplifiedConfigParserTest extends TestCase
             'entity_manager' => [
                 'connection' => [
                     'driver' => 'mysql',
-                    'host' => 'shlink_db',
+                    'host' => 'shlink_db_mysql',
                     'port' => '3306',
                 ],
             ],
@@ -78,7 +78,7 @@ class SimplifiedConfigParserTest extends TestCase
             'entity_manager' => [
                 'connection' => [
                     'driver' => 'mysql',
-                    'host' => 'shlink_db',
+                    'host' => 'shlink_db_mysql',
                     'dbname' => 'shlink',
                     'user' => 'foo',
                     'password' => 'bar',