Changeset 50441 for trunk/tests/phpunit/tests/oembed/template.php

Timestamp:

02/26/2021 02:07:53 PM (4 years ago)

Author:

johnbillion

Message:

Build/Test Tools: Switch back to running the PHPUnit test suite against the src directory instead of build.

Some PHPUnit tests were concerned with the state of files in the build directory. In order to allow the tests to run without requiring a build to be run first, these have been moved into assertions that run after the build step (and therefore cause it to fail if they do not pass), or into QUnit tests as necessary.

Various other PHPUnit tests implictly depend on built JavaScript files being present. These files are now touched during the test setup to avoid PHP warnings if the build files are not present.

The wp-tests-config-sample.php file and the GitHub Actions configuration have also been changed so ABSPATH uses src instead of build, therefore allowing the PHPUnit tests to be run without a build having to be run first. This means all new local installations of WordPress will use src for PHPUnit testing. If you would like to switch your existing installation over then change the location of ABSPATH in wp-tests-config.php to point to src instead of build.

Props peterwilsoncc, iandunn, gziolo, desroj, johnbillion

Fixes #51734
See #45863

File:

• trunk/tests/phpunit/tests/oembed/template.php (modified) (3 diffs)

trunk/tests/phpunit/tests/oembed/template.php

@@ -23 +23 @@
 
         $this->assertQueryTrue( 'is_single', 'is_singular', 'is_embed' );
+
+        // `print_embed_scripts()` assumes `wp-includes/js/wp-embed-template.js` is present:
+        self::touch( ABSPATH . WPINC . '/js/wp-embed-template.js' );
 
         ob_start();
@@ -291 +294 @@
 
     /**
+     * Confirms that no ampersands exist in src/wp-includes/js/wp-embed.js.
+     *
+     * See also the `verify:wp-embed` Grunt task for verifying the built file.
+     *
      * @ticket 34698
      */
@@ -296 +303 @@
         $this->assertNotContains( '&', file_get_contents( ABSPATH . WPINC . '/js/wp-embed.js' ) );
     }
-
-    /**
-     * @ticket 34698
-     *
-     * @depends test_js_no_ampersands
-     *
-     * The previous test confirms that no ampersands exist in src/wp-includes/js/wp-embed.js.
-     * However, we must also confirm that UglifyJS does not add ampersands during its
-     * optimizations (which we tweak to avoid, but indirectly -- understandably, there's
-     * no "don't add ampersands to my JavaScript file" option).
-     *
-     * So this test checks for ampersands in build/wp-includes/js/wp-embed.min.js.
-     * In many cases, this file will not exist; in those cases, we simply skip the test.
-     *
-     * So when would it be run? We have Travis CI run `npm run test` which then runs, in order,
-     * `qunit:compiled` (which runs the build) and then `phpunit`. Thus, this test will at least be
-     * run during continuous integration.
-     *
-     * However, we need to verify that `qunit:compiled` runs before `phpunit`. So this test also
-     * does a cheap check for a registered Grunt task called `test` that contains both
-     * `qunit:compiled` and `phpunit`, in that order.
-     *
-     * One final failsafe: The Gruntfile.js assertion takes place before checking for the existence
-     * of wp-embed.min.js. If the Grunt tasks are significantly refactored later, it could indicate
-     * that wp-embed.min.js doesn't exist anymore. We wouldn't want the test to silently become one
-     * that is always skipped, and thus useless.
-     */
-    function test_js_no_ampersands_in_compiled() {
-        $gruntfile = file_get_contents( dirname( ABSPATH ) . '/Gruntfile.js' );
-
-        // Confirm this file *should* exist, otherwise this test will always be skipped.
-        $test = '/grunt.registerTask\(\s*\'test\',.*\'qunit:compiled\'.*\'phpunit\'/';
-        $this->assertTrue( (bool) preg_match( $test, $gruntfile ) );
-
-        $file = dirname( ABSPATH ) . '/build/' . WPINC . '/js/wp-embed.min.js';
-        if ( ! file_exists( $file ) ) {
-            return;
-        }
-        $this->assertNotContains( '&', file_get_contents( $file ) );
-    }
-
 }