[11.x] Add Coveralls CI workflow for test coverage reporting #53648

joelbladt · 2024-11-24T12:43:36Z

Description

This Pull Request introduces a new GitHub Actions workflow to integrate Coveralls for automated test coverage reporting. The workflow is added under .github/workflows/coveralls.yml. It is designed to provide detailed code coverage metrics for pull requests and the main branches.

Benefit to End Users

The inclusion of Coveralls enhances the development workflow by providing:

Transparent Code Coverage Metrics: Developers and contributors gain insights into the impact of their changes on the overall code coverage.
Improved Code Quality: Encourages maintaining and improving code coverage across the framework.
Better Collaboration: Simplifies identifying areas of insufficient test coverage during code reviews.

These benefits ensure a more robust and reliable Laravel framework for developers and end users alike.

Implementation Details

Workflow Name: coveralls
Triggers: The workflow runs on:

Push events to the master branch and branches matching the *.x pattern.
All pull requests.

Jobs Configuration:

Runs on ubuntu-24.04 with a matrix of PHP versions (8.2, 8.3, 8.4) and PHPUnit versions (10.5.12, 11.3.2).
Executes tests with phpunit and generates a Clover coverage report.
Uploads the coverage data to Coveralls using the php-coveralls library.

The workflow does not interfere with existing configurations and complements the current CI/CD processes.

Why It Doesn't Break Existing Features

The workflow operates independently of existing testing and deployment pipelines.
No changes were made to the core functionality or APIs of the Laravel framework.
The coveralls.yml file is isolated and only concerns reporting test coverage metrics.

How It Makes Building Web Applications Easier

By integrating Coveralls, contributors can:

Ensure that new code is properly tested and covered.
Quickly identify areas in the framework that need more rigorous testing.
Enhance trust and confidence in the stability of the framework with every new change.

Tests

No additional feature tests are required for this change since it pertains to CI workflow. However:

The workflow has been tested locally and on other repositories to ensure compatibility with the defined configurations and tools (PHP, PHPUnit, Coveralls).
Verified that coverage reports are generated and uploaded successfully to Coveralls.

crynobone · 2024-11-25T11:03:21Z

.github/workflows/coveralls.yml

+      fail-fast: true
+      matrix:
+        php: [ 8.2, 8.3, 8.4 ]
+        phpunit: [ '10.5.12', '11.3.2' ]


It should just run on a single PHP version and the latest PHPUnit.

crynobone · 2024-11-25T11:03:37Z

.github/workflows/databases-nightly.yml

          tools: composer:v2
-          coverage: none
+          coverage: xdebug


Suggested change

coverage: xdebug

coverage: none

crynobone · 2024-11-25T11:03:56Z

.github/workflows/databases-nightly.yml

@@ -77,9 +77,9 @@ jobs:
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr


Suggested change

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

crynobone · 2024-11-25T11:04:18Z

.github/workflows/databases-nightly.yml

          tools: composer:v2
-          coverage: none
+          coverage: xdebug


Suggested change

coverage: xdebug

coverage: none

crynobone · 2024-11-25T11:04:34Z

.github/workflows/databases-nightly.yml

@@ -31,9 +31,9 @@ jobs:
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr


Suggested change

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

crynobone · 2024-11-25T11:04:47Z

.github/workflows/tests.yml

          tools: composer:v2
-          coverage: none
+          coverage: xdebug


Suggested change

coverage: xdebug

coverage: none

crynobone · 2024-11-25T11:08:59Z

.github/workflows/databases.yml

@@ -128,9 +128,9 @@ jobs:
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr


Suggested change

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

crynobone · 2024-11-25T11:09:07Z

.github/workflows/databases.yml

          tools: composer:v2
-          coverage: none
+          coverage: xdebug


Suggested change

coverage: xdebug

coverage: none

crynobone · 2024-11-25T11:09:14Z

.github/workflows/databases.yml

@@ -82,9 +82,9 @@ jobs:
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr


Suggested change

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

crynobone · 2024-11-25T11:09:22Z

.github/workflows/databases.yml

          tools: composer:v2
-          coverage: none
+          coverage: xdebug


Suggested change

coverage: xdebug

coverage: none

crynobone · 2024-11-25T11:09:30Z

.github/workflows/databases.yml

@@ -35,9 +35,9 @@ jobs:
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr


Suggested change

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr

extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

driesvints · 2024-11-25T11:28:14Z

While I think your intentions are well, I don't think this PR should be merged. Coverage only brings so much benefit without having its downsides, most notable runtime. This workflow will become to longest running workflow of the CI suite a thus unnecessarily slowing down feedback loops on the framework repo. I do not feel this repo will benefit from code coverage that much that it warrants the shorter feedback loop.

taylorotwell · 2024-11-25T14:12:43Z

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If applicable, please consider releasing your code as a package so that the community can still take advantage of your contributions!

joelbladt added 2 commits November 24, 2024 13:26

Configure PHPUnit coverage reporting and add Coveralls badge to README

e4a15c4

Add Coveralls CI workflow for automated test coverage reporting

5e40c28

joelbladt changed the base branch from master to 10.x November 24, 2024 12:43

joelbladt changed the base branch from 10.x to 11.x November 24, 2024 12:44

joelbladt changed the title ~~Add Coveralls CI workflow for test coverage reporting~~ [11.x] Add Coveralls CI workflow for test coverage reporting Nov 24, 2024

joelbladt added 3 commits November 24, 2024 16:30

Update README.md; Add branch to coveralls badge

a5fbece

fix tests.yml - add code coverage driver

5a6cfdf

fix databases and queues workflow; add code coverage driver

67d3ed3

crynobone reviewed Nov 25, 2024

View reviewed changes

crynobone requested changes Nov 25, 2024

View reviewed changes

taylorotwell closed this Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[11.x] Add Coveralls CI workflow for test coverage reporting #53648

[11.x] Add Coveralls CI workflow for test coverage reporting #53648

joelbladt commented Nov 24, 2024 •

edited

Loading

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

crynobone Nov 25, 2024

driesvints commented Nov 25, 2024

taylorotwell commented Nov 25, 2024

	extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, xml, xdebug, :php-psr
	extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_mysql, :php-psr

[11.x] Add Coveralls CI workflow for test coverage reporting #53648

[11.x] Add Coveralls CI workflow for test coverage reporting #53648

Conversation

joelbladt commented Nov 24, 2024 • edited Loading

Description

Benefit to End Users

Implementation Details

Why It Doesn't Break Existing Features

How It Makes Building Web Applications Easier

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

driesvints commented Nov 25, 2024

taylorotwell commented Nov 25, 2024

joelbladt commented Nov 24, 2024 •

edited

Loading