<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[49834] trunk/.github/workflows/test-coverage.yml: Build/Test Tools: Generate a code coverage report using GitHub Actions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/49834">49834</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/49834","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-12-18 00:28:27 +0000 (Fri, 18 Dec 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Build/Test Tools: Generate a code coverage report using GitHub Actions.
This introduces a new GitHub Action workflow to generate a code coverage report when running the PHPUnit test suite as both a single and multisite install.
The workflow will run once per week on Sunday at 00:00 UTC.
For now, the reports are not submitted anywhere, but they will be uploaded to the workflow run as ZIP file artifacts where they will persist for 90 days.
Making code coverage reports more readily available will hopefully better highlight areas of Core with poor coverage, and encourage more contributors to help increase test coverage of those areas.
Props ocean90, johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/52034">#52034</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowstestcoverageyml">trunk/.github/workflows/test-coverage.yml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowstestcoverageyml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/.github/workflows/test-coverage.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/test-coverage.yml (rev 0)
+++ trunk/.github/workflows/test-coverage.yml 2020-12-18 00:28:27 UTC (rev 49834)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,156 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+name: Code Coverage Report
+
+on:
+ # Once weekly On Sundays at 00:00 UTC.
+ schedule:
+ - cron: '0 0 * * 0'
+
+env:
+ LOCAL_DIR: build
+ PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: ${{ true }}
+ COMPOSER_INSTALL: ${{ false }}
+ # Controls which NPM script to use for running PHPUnit tests. Options ar `php` and `php-composer`.
+ PHPUNIT_SCRIPT: php
+ LOCAL_PHP: '7.4-fpm'
+ LOCAL_PHP_XDEBUG: true
+ LOCAL_PHP_MEMCACHED: ${{ false }}
+
+jobs:
+ # Sets up WordPress for testing or development use.
+ #
+ # Performs the following steps:
+ # - Set environment variables.
+ # - Checks out the repository.
+ # - Checks out the WordPress Importer plugin (needed for the Core PHPUnit tests).
+ # - Logs debug information about the runner container.
+ # - Installs NodeJS 14.
+ # - Sets up caching for NPM.
+ # _ Installs NPM dependencies using install-changed to hash the `package.json` file.
+ # - Builds WordPress to run from the `build` directory.
+ # - Logs Docker debug information (about the Docker installation within the runner).
+ # - Starts the WordPress Docker container.
+ # - Logs debug general information.
+ # - Logs the running Docker containers.
+ # - Logs WordPress Docker container debug information.
+ # - Logs debug information about what's installed within the WordPress Docker containers.
+ # - Install WordPress within the Docker container.
+ # - Run the PHPUnit tests.
+ # - Creates a ZIP file of the code coverage report.
+ # - Uploads ZIP file as an artifact.
+ # - Run the PHPUnit tests as a multisite.
+ # - Creates a ZIP file of the code coverage report.
+ # - Uploads ZIP file as an artifact.
+ test-coverage-report:
+ name: Generate a code coverage report
+ runs-on: ubuntu-latest
+ if: ${{ github.repository == 'WordPress/wordpress-develop' }}
+
+ steps:
+ - name: Configure environment variables
+ run: |
+ echo "PHP_FPM_UID=$(id -u)" >> $GITHUB_ENV
+ echo "PHP_FPM_GID=$(id -g)" >> $GITHUB_ENV
+
+ - name: Checkout repository
+ uses: actions/checkout@v2
+
+ - name: Checkout the WordPress Importer plugin
+ run: svn checkout -r 2387243 https://plugins.svn.wordpress.org/wordpress-importer/trunk/ tests/phpunit/data/plugins/wordpress-importer
+
+ - name: Log debug information
+ run: |
+ echo "$GITHUB_REF"
+ echo "$GITHUB_EVENT_NAME"
+ npm --version
+ node --version
+ curl --version
+ git --version
+ svn --version
+ php --version
+ php -i
+ locale -a
+
+ - name: Install NodeJS
+ uses: actions/setup-node@v1
+ with:
+ node-version: 14
+
+ - name: Cache NodeJS modules
+ uses: actions/cache@v2
+ env:
+ cache-name: cache-node-modules
+ with:
+ # npm cache files are stored in `~/.npm` on Linux/macOS
+ path: ~/.npm
+ key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+ restore-keys: |
+ ${{ runner.os }}-npm-
+
+ - name: Install Dependencies
+ run: npx install-changed --install-command="npm ci"
+
+ - name: Build WordPress
+ run: npm run build
+
+ - name: Docker debug information
+ run: |
+ docker -v
+ docker-compose -v
+
+ - name: Start Docker environment
+ run: |
+ npm run env:start
+
+ - name: General debug information
+ run: |
+ npm --version
+ node --version
+ curl --version
+ git --version
+ svn --version
+
+ - name: Log running Docker containers
+ run: docker ps -a
+
+ - name: WordPress Docker container debug information
+ run: |
+ docker-compose run --rm mysql mysql --version
+ docker-compose run --rm php php --version
+ docker-compose run --rm php php -m
+ docker-compose run --rm php php -i
+ docker-compose run --rm php locale -a
+
+ - name: Install WordPress
+ run: npm run env:install
+
+ - name: Run tests as a single site
+ run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c phpunit.xml.dist --coverage-html wp-code-coverage-single-${{ github.sha }}
+
+ - name: Create ZIP artifact of single site results
+ uses: thedoctor0/zip-release@0.4.1
+ with:
+ filename: wp-code-coverage-single-${{ github.sha }}.zip
+ path: wp-code-coverage-single-${{ github.sha }}
+
+ - name: Upload single site coverage report
+ uses: actions/upload-artifact@v2
+ with:
+ name: wp-code-coverage-single-${{ github.sha }}
+ path: wp-code-coverage-single-${{ github.sha }}.zip
+ if-no-files-found: error
+
+ - name: Run tests as a multisite install
+ run: npm run test:${{ env.PHPUNIT_SCRIPT }} -- --verbose -c tests/phpunit/multisite.xml --coverage-html wp-code-coverage-multisite-${{ github.sha }}
+
+ - name: Create ZIP artifact of multisite results
+ uses: thedoctor0/zip-release@0.4.1
+ with:
+ filename: wp-code-coverage-multisite-${{ github.sha }}.zip
+ path: wp-code-coverage-multisite-${{ github.sha }}
+
+ - name: Upload multisite coverage report
+ uses: actions/upload-artifact@v2
+ with:
+ name: wp-code-coverage-multisite-${{ github.sha }}
+ path: wp-code-coverage-multisite-${{ github.sha }}.zip
+ if-no-files-found: error
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/.github/workflows/test-coverage.yml
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>