Build/Test Tools: Pass GitHub Actions environment variables to the Docker container.

SergeyBiryukov · SergeyBiryukov · commit 04e9728701b3 · 2022-05-04T00:38:18.000Z
This ensures that `WP_UnitTestCase::skipOnAutomatedBranches()` has access to the `GITHUB_REF` and `GITHUB_EVENT_NAME` variables, so that some tests can be skipped when appropriate. Additionally, account for renaming the `master` branch to `trunk` in November 2021. Follow-up to [40241], [46999], [49264], [49267], [51868]. Fixes #55668. git-svn-id: https://develop.svn.wordpress.org/trunk@53349 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -41,6 +41,8 @@ services:
       - LOCAL_PHP_MEMCACHED=${LOCAL_PHP_MEMCACHED-false}
       - PHP_FPM_UID=${PHP_FPM_UID-1000}
       - PHP_FPM_GID=${PHP_FPM_GID-1000}
+      - GITHUB_REF=${GITHUB_REF-false}
+      - GITHUB_EVENT_NAME=${GITHUB_EVENT_NAME-false}
 
     volumes:
       - ./tools/local-env/php-config.ini:/usr/local/etc/php/conf.d/php-config.ini
diff --git a/tests/phpunit/includes/abstract-testcase.php b/tests/phpunit/includes/abstract-testcase.php
@@ -202,20 +202,20 @@ public function clean_up_global_scope() {
 	/**
 	 * Allows tests to be skipped on some automated runs.
 	 *
-	 * For test runs on GitHub Actions for something other than trunk/master,
-	 * we want to skip tests that only need to run for master.
+	 * For test runs on GitHub Actions for something other than trunk,
+	 * we want to skip tests that only need to run for trunk.
 	 */
 	public function skipOnAutomatedBranches() {
 		// https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables
 		$github_event_name = getenv( 'GITHUB_EVENT_NAME' );
 		$github_ref        = getenv( 'GITHUB_REF' );
 
-		if ( $github_event_name && 'false' !== $github_event_name ) {
+		if ( $github_event_name ) {
 			// We're on GitHub Actions.
 			$skipped = array( 'pull_request', 'pull_request_target' );
 
-			if ( in_array( $github_event_name, $skipped, true ) || 'refs/heads/master' !== $github_ref ) {
-				$this->markTestSkipped( 'For automated test runs, this test is only run on trunk/master' );
+			if ( in_array( $github_event_name, $skipped, true ) || 'refs/heads/trunk' !== $github_ref ) {
+				$this->markTestSkipped( 'For automated test runs, this test is only run on trunk' );
 			}
 		}
 	}
diff --git a/tests/phpunit/tests/basic.php b/tests/phpunit/tests/basic.php
@@ -8,7 +8,7 @@
 class Tests_Basic extends WP_UnitTestCase {
 
 	public function test_license() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		$license = file_get_contents( ABSPATH . 'license.txt' );
@@ -18,7 +18,7 @@ public function test_license() {
 	}
 
 	public function test_security_md() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		$security = file_get_contents( dirname( ABSPATH ) . '/SECURITY.md' );
diff --git a/tests/phpunit/tests/external-http/basic.php b/tests/phpunit/tests/external-http/basic.php
@@ -10,7 +10,7 @@ class Tests_External_HTTP_Basic extends WP_UnitTestCase {
 	 * @covers ::wp_remote_retrieve_body
 	 */
 	public function test_readme_php_version() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		$readme = file_get_contents( ABSPATH . 'readme.html' );
@@ -31,7 +31,7 @@ public function test_readme_php_version() {
 	 * @covers ::wp_remote_retrieve_body
 	 */
 	public function test_readme_mysql_version() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		$readme = file_get_contents( ABSPATH . 'readme.html' );
@@ -63,7 +63,7 @@ public function test_readme_mysql_version() {
 	 * @covers ::wp_remote_retrieve_body
 	 */
 	public function test_readme_mariadb_version() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		$readme = file_get_contents( ABSPATH . 'readme.html' );
diff --git a/tests/phpunit/tests/theme.php b/tests/phpunit/tests/theme.php
@@ -213,7 +213,7 @@ public function test_default_themes_have_textdomain() {
 	 * @ticket 48566
 	 */
 	public function test_year_in_readme() {
-		// This test is designed to only run on trunk/master.
+		// This test is designed to only run on trunk.
 		$this->skipOnAutomatedBranches();
 
 		foreach ( $this->default_themes as $theme ) {

Original file line number	Diff line number	Diff line change
`@@ -202,20 +202,20 @@ public function clean_up_global_scope() {`
`202`	`202`	`/**`
`203`	`203`	`* Allows tests to be skipped on some automated runs.`
`204`	`204`	`*`
`205`		`- * For test runs on GitHub Actions for something other than trunk/master,`
`206`		`- * we want to skip tests that only need to run for master.`
	`205`	`+ * For test runs on GitHub Actions for something other than trunk,`
	`206`	`+ * we want to skip tests that only need to run for trunk.`
`207`	`207`	`*/`
`208`	`208`	`public function skipOnAutomatedBranches() {`
`209`	`209`	`// https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables`
`210`	`210`	`$github_event_name = getenv( 'GITHUB_EVENT_NAME' );`
`211`	`211`	`$github_ref = getenv( 'GITHUB_REF' );`
`212`	`212`
`213`		`- if ( $github_event_name && 'false' !== $github_event_name ) {`
	`213`	`+ if ( $github_event_name ) {`
`214`	`214`	`// We're on GitHub Actions.`
`215`	`215`	`$skipped = array( 'pull_request', 'pull_request_target' );`
`216`	`216`
`217`		`- if ( in_array( $github_event_name, $skipped, true ) \|\| 'refs/heads/master' !== $github_ref ) {`
`218`		`- $this->markTestSkipped( 'For automated test runs, this test is only run on trunk/master' );`
	`217`	`+ if ( in_array( $github_event_name, $skipped, true ) \|\| 'refs/heads/trunk' !== $github_ref ) {`
	`218`	`+ $this->markTestSkipped( 'For automated test runs, this test is only run on trunk' );`
`219`	`219`	`}`
`220`	`220`	`}`
`221`	`221`	`}`