diff options
31 files changed, 1029 insertions, 303 deletions
diff --git a/.github/workflows/reusable-test-local-docker-environment-v1.yml b/.github/workflows/reusable-test-local-docker-environment-v1.yml index 83ed4d1ac7..c4bbfae729 100644 --- a/.github/workflows/reusable-test-local-docker-environment-v1.yml +++ b/.github/workflows/reusable-test-local-docker-environment-v1.yml @@ -155,7 +155,7 @@ jobs: run: npm run env:restart - name: Test a CLI command - run: npm run env:cli wp option get siteurl + run: npm run env:cli option get siteurl - name: Test logs command run: npm run env:logs diff --git a/docker-compose.yml b/docker-compose.yml index 48f3abc607..863cbd2ea9 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -106,10 +106,14 @@ services: PHP_FPM_UID: ${PHP_FPM_UID-1000} PHP_FPM_GID: ${PHP_FPM_GID-1000} HOST_PATH: ${PWD-}/${LOCAL_DIR-src} + WP_CONFIG_PATH: /var/www/wp-config.php volumes: - ./:/var/www + # Keeps the service alive. + command: 'sleep infinity' + # The init directive ensures the command runs with a PID > 1, so Ctrl+C works correctly. init: true diff --git a/package.json b/package.json index aeef7640f4..77c2b2d68c 100644 --- a/package.json +++ b/package.json @@ -184,7 +184,7 @@ "env:clean": "node ./tools/local-env/scripts/docker.js down -v --remove-orphans", "env:reset": "node ./tools/local-env/scripts/docker.js down --rmi all -v --remove-orphans", "env:install": "node ./tools/local-env/scripts/install.js", - "env:cli": "node ./tools/local-env/scripts/docker.js run --rm cli", + "env:cli": "node ./tools/local-env/scripts/docker.js exec cli wp --allow-root", "env:logs": "node ./tools/local-env/scripts/docker.js logs", "env:pull": "node ./tools/local-env/scripts/docker.js pull", "test:performance": "wp-scripts test-playwright --config tests/performance/playwright.config.js", diff --git a/src/js/_enqueues/admin/user-profile.js b/src/js/_enqueues/admin/user-profile.js index ad808d3131..ce680ef4c4 100644 --- a/src/js/_enqueues/admin/user-profile.js +++ b/src/js/_enqueues/admin/user-profile.js @@ -101,6 +101,8 @@ return; } $toggleButton = $pass1Row.find('.wp-hide-pw'); + + // Toggle between showing and hiding the password. $toggleButton.show().on( 'click', function () { if ( 'password' === $pass1.attr( 'type' ) ) { $pass1.attr( 'type', 'text' ); @@ -110,6 +112,14 @@ resetToggle( true ); } }); + + // Ensure the password input type is set to password when the form is submitted. + $pass1Row.closest( 'form' ).on( 'submit', function() { + if ( $pass1.attr( 'type' ) === 'text' ) { + $pass1.attr( 'type', 'password' ); + resetToggle( true ); + } + } ); } /** diff --git a/src/wp-admin/includes/file.php b/src/wp-admin/includes/file.php index 40059273ba..0658662126 100644 --- a/src/wp-admin/includes/file.php +++ b/src/wp-admin/includes/file.php @@ -2622,7 +2622,7 @@ function request_filesystem_credentials( $form_post, $type = '', $error = false, <?php if ( isset( $types['ssh'] ) ) { $hidden_class = ''; - if ( 'ssh' !== $connection_type || empty( $connection_type ) ) { + if ( 'ssh' !== $connection_type ) { $hidden_class = ' class="hidden"'; } ?> diff --git a/src/wp-content/themes/twentynineteen/sass/navigation/_menu-main-navigation.scss b/src/wp-content/themes/twentynineteen/sass/navigation/_menu-main-navigation.scss index d1e30256f3..6d6d744ed8 100644 --- a/src/wp-content/themes/twentynineteen/sass/navigation/_menu-main-navigation.scss +++ b/src/wp-content/themes/twentynineteen/sass/navigation/_menu-main-navigation.scss @@ -433,9 +433,13 @@ white-space: inherit; } + &:not(:has(.sub-menu.expanded-true)) { + overflow-y: scroll; + } + &.expanded-true { - display: table; + display: block; margin-top: 0; opacity: 1; padding-left: 0; diff --git a/src/wp-content/themes/twentynineteen/style-rtl.css b/src/wp-content/themes/twentynineteen/style-rtl.css index da1b3636c0..9f1700c012 100644 --- a/src/wp-content/themes/twentynineteen/style-rtl.css +++ b/src/wp-content/themes/twentynineteen/style-rtl.css @@ -3271,8 +3271,12 @@ body.page .main-navigation { white-space: inherit; } +.main-navigation .main-menu .menu-item-has-children.off-canvas .sub-menu:not(:has(.sub-menu.expanded-true)) { + overflow-y: scroll; +} + .main-navigation .main-menu .menu-item-has-children.off-canvas .sub-menu.expanded-true { - display: table; + display: block; margin-top: 0; opacity: 1; padding-right: 0; diff --git a/src/wp-content/themes/twentynineteen/style.css b/src/wp-content/themes/twentynineteen/style.css index 2124cf584f..634a947b3a 100644 --- a/src/wp-content/themes/twentynineteen/style.css +++ b/src/wp-content/themes/twentynineteen/style.css @@ -3271,8 +3271,12 @@ body.page .main-navigation { white-space: inherit; } +.main-navigation .main-menu .menu-item-has-children.off-canvas .sub-menu:not(:has(.sub-menu.expanded-true)) { + overflow-y: scroll; +} + .main-navigation .main-menu .menu-item-has-children.off-canvas .sub-menu.expanded-true { - display: table; + display: block; margin-top: 0; opacity: 1; padding-left: 0; diff --git a/src/wp-includes/author-template.php b/src/wp-includes/author-template.php index 184d7d0f38..a48a6d3e6e 100644 --- a/src/wp-includes/author-template.php +++ b/src/wp-includes/author-template.php @@ -286,7 +286,7 @@ function get_the_author_posts() { if ( ! $post ) { return 0; } - return count_user_posts( $post->post_author, $post->post_type ); + return (int) count_user_posts( $post->post_author, $post->post_type ); } /** diff --git a/src/wp-includes/capabilities.php b/src/wp-includes/capabilities.php index d6c340c95e..48586e093c 100644 --- a/src/wp-includes/capabilities.php +++ b/src/wp-includes/capabilities.php @@ -470,7 +470,7 @@ function map_meta_cap( $cap, $user_id, ...$args ) { if ( $meta_key ) { $allowed = ! is_protected_meta( $meta_key, $object_type ); - if ( ! empty( $object_subtype ) && has_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" ) ) { + if ( has_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" ) ) { /** * Filters whether the user is allowed to edit a specific meta key of a specific object type and subtype. @@ -512,36 +512,33 @@ function map_meta_cap( $cap, $user_id, ...$args ) { $allowed = apply_filters( "auth_{$object_type}_meta_{$meta_key}", $allowed, $meta_key, $object_id, $user_id, $cap, $caps ); } - if ( ! empty( $object_subtype ) ) { - - /** - * Filters whether the user is allowed to edit meta for specific object types/subtypes. - * - * Return true to have the mapped meta caps from `edit_{$object_type}` apply. - * - * The dynamic portion of the hook name, `$object_type` refers to the object type being filtered. - * The dynamic portion of the hook name, `$object_subtype` refers to the object subtype being filtered. - * The dynamic portion of the hook name, `$meta_key`, refers to the meta key passed to map_meta_cap(). - * - * @since 4.6.0 As `auth_post_{$post_type}_meta_{$meta_key}`. - * @since 4.7.0 Renamed from `auth_post_{$post_type}_meta_{$meta_key}` to - * `auth_{$object_type}_{$object_subtype}_meta_{$meta_key}`. - * @deprecated 4.9.8 Use {@see 'auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}'} instead. - * - * @param bool $allowed Whether the user can add the object meta. Default false. - * @param string $meta_key The meta key. - * @param int $object_id Object ID. - * @param int $user_id User ID. - * @param string $cap Capability name. - * @param string[] $caps Array of the user's capabilities. - */ - $allowed = apply_filters_deprecated( - "auth_{$object_type}_{$object_subtype}_meta_{$meta_key}", - array( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ), - '4.9.8', - "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" - ); - } + /** + * Filters whether the user is allowed to edit meta for specific object types/subtypes. + * + * Return true to have the mapped meta caps from `edit_{$object_type}` apply. + * + * The dynamic portion of the hook name, `$object_type` refers to the object type being filtered. + * The dynamic portion of the hook name, `$object_subtype` refers to the object subtype being filtered. + * The dynamic portion of the hook name, `$meta_key`, refers to the meta key passed to map_meta_cap(). + * + * @since 4.6.0 As `auth_post_{$post_type}_meta_{$meta_key}`. + * @since 4.7.0 Renamed from `auth_post_{$post_type}_meta_{$meta_key}` to + * `auth_{$object_type}_{$object_subtype}_meta_{$meta_key}`. + * @deprecated 4.9.8 Use {@see 'auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}'} instead. + * + * @param bool $allowed Whether the user can add the object meta. Default false. + * @param string $meta_key The meta key. + * @param int $object_id Object ID. + * @param int $user_id User ID. + * @param string $cap Capability name. + * @param string[] $caps Array of the user's capabilities. + */ + $allowed = apply_filters_deprecated( + "auth_{$object_type}_{$object_subtype}_meta_{$meta_key}", + array( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ), + '4.9.8', + "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" + ); if ( ! $allowed ) { $caps[] = $cap; diff --git a/src/wp-includes/class-wp-image-editor-imagick.php b/src/wp-includes/class-wp-image-editor-imagick.php index 2e7c7039d5..f57e6f281f 100644 --- a/src/wp-includes/class-wp-image-editor-imagick.php +++ b/src/wp-includes/class-wp-image-editor-imagick.php @@ -305,7 +305,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor { * image operations within the time of the HTTP request. * * @since 6.2.0 - * @since 6.3.0 This method was deprecated. + * @deprecated 6.3.0 No longer used in core. * * @return int|null The new limit on success, null on failure. */ diff --git a/src/wp-includes/class-wp-oembed.php b/src/wp-includes/class-wp-oembed.php index 2d59c2217d..43f95ed150 100644 --- a/src/wp-includes/class-wp-oembed.php +++ b/src/wp-includes/class-wp-oembed.php @@ -739,9 +739,9 @@ class WP_oEmbed { * * @since 2.9.0 * - * @param string $return The returned oEmbed HTML. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. + * @param string|false $return The returned oEmbed HTML, or false on failure. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. */ return apply_filters( 'oembed_dataparse', $return, $data, $url ); } @@ -752,10 +752,10 @@ class WP_oEmbed { * @since 2.9.0 as strip_scribd_newlines() * @since 3.0.0 * - * @param string $html Existing HTML. - * @param object $data Data object from WP_oEmbed::data2html() - * @param string $url The original URL passed to oEmbed. - * @return string Possibly modified $html + * @param string|false $html Existing HTML. + * @param object $data Data object from WP_oEmbed::data2html() + * @param string $url The original URL passed to oEmbed. + * @return string|false Possibly modified $html. */ public function _strip_newlines( $html, $data, $url ) { if ( ! str_contains( $html, "\n" ) ) { diff --git a/src/wp-includes/class-wp-tax-query.php b/src/wp-includes/class-wp-tax-query.php index 5a489f5662..c6ec3258cc 100644 --- a/src/wp-includes/class-wp-tax-query.php +++ b/src/wp-includes/class-wp-tax-query.php @@ -44,7 +44,7 @@ class WP_Tax_Query { * Standard response when the query should not return any rows. * * @since 3.2.0 - * @var string + * @var array<string, array<string>> */ private static $no_results = array( 'join' => array( '' ), diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php index cd41d4b200..f023c03cd0 100644 --- a/src/wp-includes/comment-template.php +++ b/src/wp-includes/comment-template.php @@ -2446,6 +2446,7 @@ function wp_list_comments( $args = array(), $comments = null ) { * @since 4.6.0 Introduced the 'action' argument. * @since 4.9.6 Introduced the 'cookies' default comment field. * @since 5.5.0 Introduced the 'class_container' argument. + * @since 6.8.2 Introduced the 'novalidate' argument. * * @param array $args { * Optional. Default arguments and form fields to override. @@ -2467,6 +2468,7 @@ function wp_list_comments( $args = array(), $comments = null ) { * Default 'Your email address will not be published.'. * @type string $comment_notes_after HTML element for a message displayed after the textarea field. * @type string $action The comment form element action attribute. Default '/wp-comments-post.php'. + * @type bool $novalidate Whether the novalidate attribute is added to the comment form. Default false. * @type string $id_form The comment form element id attribute. Default 'commentform'. * @type string $id_submit The comment submit element id attribute. Default 'submit'. * @type string $class_container The comment form container class attribute. Default 'comment-respond'. @@ -2646,6 +2648,7 @@ function comment_form( $args = array(), $post = null ) { ), 'comment_notes_after' => '', 'action' => site_url( '/wp-comments-post.php' ), + 'novalidate' => false, 'id_form' => 'commentform', 'id_submit' => 'submit', 'class_container' => 'comment-respond', @@ -2729,7 +2732,7 @@ function comment_form( $args = array(), $post = null ) { esc_url( $args['action'] ), esc_attr( $args['id_form'] ), esc_attr( $args['class_form'] ), - ( $html5 ? ' novalidate' : '' ) + ( $args['novalidate'] ? ' novalidate' : '' ) ); /** diff --git a/src/wp-includes/embed.php b/src/wp-includes/embed.php index b5b30acead..a3c23be931 100644 --- a/src/wp-includes/embed.php +++ b/src/wp-includes/embed.php @@ -843,10 +843,10 @@ function _oembed_create_xml( $data, $node = null ) { * * @since 5.2.0 * - * @param string $result The oEmbed HTML result. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. - * @return string The filtered oEmbed result. + * @param string|false $result The oEmbed HTML result. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. + * @return string|false The filtered oEmbed result. */ function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) { if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) { @@ -910,10 +910,10 @@ function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) { * * @since 4.4.0 * - * @param string $result The oEmbed HTML result. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. - * @return string The filtered and sanitized oEmbed result. + * @param string|false $result The oEmbed HTML result. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. + * @return string|false The filtered and sanitized oEmbed result. */ function wp_filter_oembed_result( $result, $data, $url ) { if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) { diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index 9fd6d1d00d..1dbac5e1d7 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -2676,9 +2676,11 @@ if ( ! function_exists( 'wp_hash_password' ) ) : * - `PASSWORD_ARGON2ID` * - `PASSWORD_DEFAULT` * + * The values of the algorithm constants are strings in PHP 7.4+ and integers in PHP 7.3 and earlier. + * * @since 6.8.0 * - * @param string $algorithm The hashing algorithm. Default is the value of the `PASSWORD_BCRYPT` constant. + * @param string|int $algorithm The hashing algorithm. Default is the value of the `PASSWORD_BCRYPT` constant. */ $algorithm = apply_filters( 'wp_hash_password_algorithm', PASSWORD_BCRYPT ); @@ -2688,12 +2690,14 @@ if ( ! function_exists( 'wp_hash_password' ) ) : * The default hashing algorithm is bcrypt, but this can be changed via the {@see 'wp_hash_password_algorithm'} * filter. You must ensure that the options are appropriate for the algorithm in use. * + * The values of the algorithm constants are strings in PHP 7.4+ and integers in PHP 7.3 and earlier. + * * @since 6.8.0 * - * @param array $options Array of options to pass to the password hashing functions. - * By default this is an empty array which means the default - * options will be used. - * @param string $algorithm The hashing algorithm in use. + * @param array $options Array of options to pass to the password hashing functions. + * By default this is an empty array which means the default + * options will be used. + * @param string|int $algorithm The hashing algorithm in use. */ $options = apply_filters( 'wp_hash_password_options', array(), $algorithm ); diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index bd749b2f82..b312ac394b 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -4874,6 +4874,15 @@ function wp_insert_post( $postarr, $wp_error = false, $fire_after_hooks = true ) } } + /** + * Fires immediately before a new post is inserted in the database. + * + * @since 6.9.0 + * + * @param array $data Array of unslashed post data. + */ + do_action( 'pre_post_insert', $data ); + if ( false === $wpdb->insert( $wpdb->posts, $data ) ) { if ( $wp_error ) { if ( 'attachment' === $post_type ) { @@ -6868,7 +6877,9 @@ function wp_get_attachment_metadata( $attachment_id = 0, $unfiltered = false ) { * * @param int $attachment_id Attachment post ID. * @param array $data Attachment meta data. - * @return int|false False if $post is invalid. + * @return int|bool Whether the metadata was successfully updated. + * True on success, the Meta ID if the key didn't exist. + * False if $post is invalid, on failure, or if $data is the same as the existing metadata. */ function wp_update_attachment_metadata( $attachment_id, $data ) { $attachment_id = (int) $attachment_id; diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php index 004f5851a2..66cf8785e4 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php @@ -147,6 +147,18 @@ class WP_REST_Settings_Controller extends WP_REST_Controller { $params = $request->get_params(); + if ( empty( $params ) || ! empty( array_diff_key( $params, $options ) ) ) { + $message = empty( $params ) + ? __( 'Request body cannot be empty.' ) + : __( 'Invalid parameter(s) provided.' ); + + return new WP_Error( + 'rest_invalid_param', + $message, + array( 'status' => 400 ) + ); + } + foreach ( $options as $name => $args ) { if ( ! array_key_exists( $name, $params ) ) { continue; diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php index 083de80304..ecd22ab38c 100644 --- a/src/wp-includes/user.php +++ b/src/wp-includes/user.php @@ -477,7 +477,7 @@ function wp_authenticate_application_password( */ do_action( 'wp_authenticate_application_password_errors', $error, $user, $item, $password ); - if ( is_wp_error( $error ) && $error->has_errors() ) { + if ( $error->has_errors() ) { /** This action is documented in wp-includes/user.php */ do_action( 'application_password_failed_authentication', $error ); @@ -637,7 +637,7 @@ function count_user_posts( $userid, $post_type = 'post', $public_only = false ) * @since 4.1.0 Added `$post_type` argument. * @since 4.3.1 Added `$public_only` argument. * - * @param int $count The user's post count. + * @param string $count The user's post count as a numeric string. * @param int $userid User ID. * @param string|array $post_type Single post type or array of post types to count the number of posts for. * @param bool $public_only Whether to limit counted posts to public posts. diff --git a/tests/phpunit/includes/abstract-testcase.php b/tests/phpunit/includes/abstract-testcase.php index f665bdafb1..29ce8d8b53 100644 --- a/tests/phpunit/includes/abstract-testcase.php +++ b/tests/phpunit/includes/abstract-testcase.php @@ -1,5 +1,6 @@ <?php +require_once __DIR__ . '/build-visual-html-tree.php'; require_once __DIR__ . '/factory.php'; require_once __DIR__ . '/trac.php'; @@ -13,7 +14,6 @@ require_once __DIR__ . '/trac.php'; * All WordPress unit tests should inherit from this class. */ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase { - protected static $forced_tickets = array(); protected $expected_deprecated = array(); protected $caught_deprecated = array(); @@ -136,6 +136,21 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase { $this->start_transaction(); $this->expectDeprecated(); add_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) ); + add_filter( 'wp_hash_password_options', array( $this, 'wp_hash_password_options' ), 1, 2 ); + } + + /** + * Sets the bcrypt cost option for password hashing during tests. + * + * @param array $options The options for password hashing. + * @param string|int $algorithm The algorithm to use for hashing. This is a string in PHP 7.4+ and an integer in PHP 7.3 and earlier. + */ + public function wp_hash_password_options( array $options, $algorithm ): array { + if ( PASSWORD_BCRYPT === $algorithm ) { + $options['cost'] = 5; + } + + return $options; } /** @@ -1181,6 +1196,44 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase { } /** + * Check HTML markup (including blocks) for semantic equivalence. + * + * Given two markup strings, assert that they translate to the same semantic HTML tree, + * normalizing tag names, attribute names, and attribute order. Furthermore, attributes + * and class names are sorted and deduplicated, and whitespace in style attributes + * is normalized. Finally, block delimiter comments are recognized and normalized, + * applying the same principles. + * + * @since 6.9.0 + * + * @param string $expected The expected HTML. + * @param string $actual The actual HTML. + * @param string|null $fragment_context Optional. The fragment context, for example "<td>" expected HTML + * must occur within "<table><tr>" fragment context. Default "<body>". + * Only "<body>" or `null` are supported at this time. + * Set to `null` to parse a full HTML document. + * @param string|null $message Optional. The assertion error message. + */ + public function assertEqualHTML( string $expected, string $actual, ?string $fragment_context = '<body>', $message = 'HTML markup was not equivalent.' ): void { + try { + $tree_expected = build_visual_html_tree( $expected, $fragment_context ); + $tree_actual = build_visual_html_tree( $actual, $fragment_context ); + } catch ( Exception $e ) { + // For PHP 8.4+, we can retry, using the built-in DOM\HTMLDocument parser. + if ( class_exists( 'DOM\HtmlDocument' ) ) { + $dom_expected = DOM\HtmlDocument::createFromString( $expected, LIBXML_NOERROR ); + $tree_expected = build_visual_html_tree( $dom_expected->saveHtml(), $fragment_context ); + $dom_actual = DOM\HtmlDocument::createFromString( $actual, LIBXML_NOERROR ); + $tree_actual = build_visual_html_tree( $dom_actual->saveHtml(), $fragment_context ); + } else { + throw $e; + } + } + + $this->assertSame( $tree_expected, $tree_actual, $message ); + } + + /** * Helper function to convert a single-level array containing text strings to a named data provider. * * The value of the data set will also be used as the name of the data set. diff --git a/tests/phpunit/includes/build-visual-html-tree.php b/tests/phpunit/includes/build-visual-html-tree.php new file mode 100644 index 0000000000..e0f6c3ac3d --- /dev/null +++ b/tests/phpunit/includes/build-visual-html-tree.php @@ -0,0 +1,304 @@ +<?php + +/* phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped */ + +/** + * Generates representation of the semantic HTML tree structure. + * + * This is inspired by the representation used by the HTML5lib tests. It's been extended here for + * blocks to render the semantic structure of blocks and their attributes. + * The order of attributes and class names is normalized both for HTML tags and blocks, + * as is the whitespace in HTML tags' style attribute. + * + * For example, consider the following block markup: + * + * <!-- wp:separator {"className":"is-style-default has-custom-classname","style":{"spacing":{"margin":{"top":"50px","bottom":"50px"}}},"backgroundColor":"accent-1"} --> + * <hr class="wp-block-separator is-style-default has-custom-classname" style="margin-top: 50px; margin-bottom: 50px" /> + * <!-- /wp:separator --> + * + * This will be represented as: + * + * BLOCK["core/separator"] + * { + * "backgroundColor": "accent-1", + * "className": "has-custom-classname is-style-default", + * "style": { + * "spacing": { + * "margin": { + * "top": "50px", + * "bottom": "50px" + * } + * } + * } + * } + * <hr> + * class="has-custom-classname is-style-default wp-block-separator" + * style="margin-top:50px;margin-bottom:50px;" + * + * + * @see https://github.com/WordPress/wordpress-develop/blob/trunk/tests/phpunit/data/html5lib-tests/tree-construction/README.md + * + * @since 6.9.0 + * + * @throws WP_HTML_Unsupported_Exception|Error If the markup could not be parsed. + * + * @param string $html Given test HTML. + * @param string|null $fragment_context Context element in which to parse HTML, such as BODY or SVG. + * @return string Tree structure of parsed HTML, if supported. + */ +function build_visual_html_tree( string $html, ?string $fragment_context ): string { + $processor = $fragment_context + ? WP_HTML_Processor::create_fragment( $html, $fragment_context ) + : WP_HTML_Processor::create_full_parser( $html ); + if ( null === $processor ) { + throw new Error( 'Could not create a parser.' ); + } + $tree_indent = ' '; + + $output = ''; + $indent_level = 0; + $was_text = null; + $text_node = ''; + + $block_context = array(); + + while ( $processor->next_token() ) { + if ( null !== $processor->get_last_error() ) { + break; + } + + $token_name = $processor->get_token_name(); + $token_type = $processor->get_token_type(); + $is_closer = $processor->is_tag_closer(); + + if ( $was_text && '#text' !== $token_name ) { + if ( '' !== $text_node ) { + $output .= "{$text_node}\"\n"; + } + $was_text = false; + $text_node = ''; + } + + switch ( $token_type ) { + case '#doctype': + $doctype = $processor->get_doctype_info(); + $output .= "<!DOCTYPE {$doctype->name}"; + if ( null !== $doctype->public_identifier || null !== $doctype->system_identifier ) { + $output .= " \"{$doctype->public_identifier}\" \"{$doctype->system_identifier}\""; + } + $output .= ">\n"; + break; + + case '#tag': + $namespace = $processor->get_namespace(); + $tag_name = 'html' === $namespace + ? strtolower( $processor->get_tag() ) + : "{$namespace} {$processor->get_qualified_tag_name()}"; + + if ( $is_closer ) { + --$indent_level; + + if ( 'html' === $namespace && 'TEMPLATE' === $token_name ) { + --$indent_level; + } + + break; + } + + $tag_indent = $indent_level; + + if ( $processor->expects_closer() ) { + ++$indent_level; + } + + $output .= str_repeat( $tree_indent, $tag_indent ) . "<{$tag_name}>\n"; + + $attribute_names = $processor->get_attribute_names_with_prefix( '' ); + if ( $attribute_names ) { + $sorted_attributes = array(); + foreach ( $attribute_names as $attribute_name ) { + $sorted_attributes[ $attribute_name ] = $processor->get_qualified_attribute_name( $attribute_name ); + } + + /* + * Sorts attributes to match html5lib sort order. + * + * - First comes normal HTML attributes. + * - Then come adjusted foreign attributes; these have spaces in their names. + * - Finally come non-adjusted foreign attributes; these have a colon in their names. + * + * Example: + * + * From: <math xlink:author definitionurl xlink:title xlink:show> + * Sorted: 'definitionURL', 'xlink show', 'xlink title', 'xlink:author' + */ + uasort( + $sorted_attributes, + static function ( $a, $b ) { + $a_has_ns = str_contains( $a, ':' ); + $b_has_ns = str_contains( $b, ':' ); + + // Attributes with `:` should follow all other attributes. + if ( $a_has_ns !== $b_has_ns ) { + return $a_has_ns ? 1 : -1; + } + + $a_has_sp = str_contains( $a, ' ' ); + $b_has_sp = str_contains( $b, ' ' ); + + // Attributes with a namespace ' ' should come after those without. + if ( $a_has_sp !== $b_has_sp ) { + return $a_has_sp ? 1 : -1; + } + + return $a <=> $b; + } + ); + + foreach ( $sorted_attributes as $attribute_name => $display_name ) { + $val = $processor->get_attribute( $attribute_name ); + /* + * Attributes with no value are `true` with the HTML API, + * we use the empty string value in the tree structure. + */ + if ( true === $val ) { + $val = ''; + } elseif ( 'class' === $attribute_name ) { + $class_names = iterator_to_array( $processor->class_list() ); + sort( $class_names, SORT_STRING ); + $val = implode( ' ', $class_names ); + } elseif ( 'style' === $attribute_name ) { + $normalized_style = ''; + foreach ( explode( ';', $val ) as $style ) { + if ( empty( trim( $style ) ) ) { + continue; + } + list( $style_key, $style_val ) = explode( ':', $style ); + + $style_key = trim( $style_key ); + $style_val = trim( $style_val ); + + $normalized_style .= "{$style_key}:{$style_val};"; + } + $val = $normalized_style; + } + $output .= str_repeat( $tree_indent, $tag_indent + 1 ) . "{$display_name}=\"{$val}\"\n"; + } + } + + // Self-contained tags contain their inner contents as modifiable text. + $modifiable_text = $processor->get_modifiable_text(); + if ( '' !== $modifiable_text ) { + $output .= str_repeat( $tree_indent, $tag_indent + 1 ) . "\"{$modifiable_text}\"\n"; + } + + if ( 'html' === $namespace && 'TEMPLATE' === $token_name ) { + $output .= str_repeat( $tree_indent, $indent_level ) . "content\n"; + ++$indent_level; + } + + break; + + case '#cdata-section': + case '#text': + $text_content = $processor->get_modifiable_text(); + if ( '' === trim( $text_content, " \f\t\r\n" ) ) { + break; + } + $was_text = true; + if ( '' === $text_node ) { + $text_node .= str_repeat( $tree_indent, $indent_level ) . '"'; + } + $text_node .= $text_content; + break; + + case '#funky-comment': + // Comments must be "<" then "!-- " then the data then " -->". + $output .= str_repeat( $tree_indent, $indent_level ) . "<!-- {$processor->get_modifiable_text()} -->\n"; + break; + + case '#comment': + // Comments must be "<" then "!--" then the data then "-->". + $comment = "<!--{$processor->get_full_comment_text()}-->"; + + // Maybe the comment is a block delimiter. + $parser = new WP_Block_Parser(); + $parser->document = $comment; + $parser->offset = 0; + list( $delimiter_type, $block_name, $block_attrs, $start_offset, $token_length ) = $parser->next_token(); + + switch ( $delimiter_type ) { + case 'block-opener': + case 'void-block': + $output .= str_repeat( $tree_indent, $indent_level ) . "BLOCK[\"{$block_name}\"]\n"; + + if ( 'block-opener' === $delimiter_type ) { + $block_context[] = $block_name; + ++$indent_level; + } + + // If they're no attributes, we're done here. + if ( empty( $block_attrs ) ) { + break; + } + + // Normalize attribute order. + ksort( $block_attrs, SORT_STRING ); + + if ( isset( $block_attrs['className'] ) ) { + // Normalize class name order (and de-duplicate), as we need to be tolerant of different orders. + // (Style attributes don't need this treatment, as they are parsed into a nested array.) + $block_class_processor = new WP_HTML_Tag_Processor( '<div>' ); + $block_class_processor->next_token(); + $block_class_processor->set_attribute( 'class', $block_attrs['className'] ); + $class_names = iterator_to_array( $block_class_processor->class_list() ); + sort( $class_names, SORT_STRING ); + $block_attrs['className'] = implode( ' ', $class_names ); + } + + $block_attrs = json_encode( $block_attrs, JSON_PRETTY_PRINT ); + // Fix indentation by "halving" it (2 spaces instead of 4). + // Additionally, we need to indent each line by the current indentation level. + $block_attrs = preg_replace( '/^( +)\1/m', str_repeat( $tree_indent, $indent_level ) . '$1', $block_attrs ); + // Finally, indent the first line, and the last line (with the closing curly brace). + $output .= str_repeat( $tree_indent, $indent_level ) . substr( $block_attrs, 0, -1 ) . str_repeat( $tree_indent, $indent_level ) . "}\n"; + break; + case 'block-closer': + // Is this a closer for the currently open block? + if ( ! empty( $block_context ) && end( $block_context ) === $block_name ) { + // If it's a closer, we don't add it to the output. + // Instead, we decrease indentation and remove the block from block context stack. + --$indent_level; + array_pop( $block_context ); + } + break; + default: // Not a block delimiter. + $output .= str_repeat( $tree_indent, $indent_level ) . $comment . "\n"; + break; + } + break; + default: + // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export + $serialized_token_type = var_export( $processor->get_token_type(), true ); + throw new Error( "Unhandled token type for tree construction: {$serialized_token_type}" ); + } + } + + if ( null !== $processor->get_unsupported_exception() ) { + throw $processor->get_unsupported_exception(); + } + + if ( null !== $processor->get_last_error() ) { + throw new Error( "Parser error: {$processor->get_last_error()}" ); + } + + if ( $processor->paused_at_incomplete_token() ) { + throw new Error( 'Paused at incomplete token.' ); + } + + if ( '' !== $text_node ) { + $output .= "{$text_node}\"\n"; + } + + return $output; +} diff --git a/tests/phpunit/tests/auth.php b/tests/phpunit/tests/auth.php index 405a8526d0..a490842ebd 100644 --- a/tests/phpunit/tests/auth.php +++ b/tests/phpunit/tests/auth.php @@ -2089,9 +2089,6 @@ class Tests_Auth extends WP_UnitTestCase { } private static function get_default_bcrypt_cost(): int { - $hash = password_hash( 'password', PASSWORD_BCRYPT ); - $info = password_get_info( $hash ); - - return $info['options']['cost']; + return 5; } } diff --git a/tests/phpunit/tests/build-visual-html-tree.php b/tests/phpunit/tests/build-visual-html-tree.php new file mode 100644 index 0000000000..42e35c5b74 --- /dev/null +++ b/tests/phpunit/tests/build-visual-html-tree.php @@ -0,0 +1,144 @@ +<?php + +/** + * Tests for build_visual_html_tree(). + * + * @package WordPress + * + * @group testsuite + */ +class Tests_Build_Equivalent_HTML_Semantic_Tree extends WP_UnitTestCase { + public function data_build_equivalent_html_semantic_tree() { + $block_markup = <<<END + <!-- wp:separator {"className":"is-style-default has-custom-classname","style":{"spacing":{"margin":{"top":"50px","bottom":"50px"}}},"backgroundColor":"accent-1"} --> + <hr class="wp-block-separator is-style-default has-custom-classname" style="margin-top: 50px; margin-bottom: 50px" /> + <!-- /wp:separator --> +END; + + $tree_structure = <<<END +BLOCK["core/separator"] + { + "backgroundColor": "accent-1", + "className": "has-custom-classname is-style-default", + "style": { + "spacing": { + "margin": { + "top": "50px", + "bottom": "50px" + } + } + } + } + <hr> + class="has-custom-classname is-style-default wp-block-separator" + style="margin-top:50px;margin-bottom:50px;" + +END; + + return array( + 'Block delimiter' => array( $block_markup, $tree_structure ), + ); + } + + /** + * @ticket 63527 + * + * @covers ::build_visual_html_tree + * + * @dataProvider data_build_equivalent_html_semantic_tree + */ + public function test_build_equivalent_html_semantic_tree( $markup, $expected ) { + $actual = build_visual_html_tree( $markup, '<body>' ); + $this->assertSame( $expected, $actual ); + } + + public function data_build_equivalent_html_semantic_tree_with_equivalent_html() { + return array( + 'Different attribute order' => array( + '<img src="wp.png" alt="The WordPress logo">', + '<img alt="The WordPress logo" src="wp.png">', + ), + 'Different class name order' => array( + '<hr class="wp-block-separator is-style-default">', + '<hr class="is-style-default wp-block-separator">', + ), + 'Differences in style attribute whitespace and trailing semicolon' => array( + '<hr style="margin-top: 50px; margin-bottom: 50px;">', + '<hr style="margin-top:50px;margin-bottom: 50px">', + ), + 'Different block attribute order' => array( + '<!-- wp:separator {"className":"is-style-default","backgroundColor":"accent-1"} -->', + '<!-- wp:separator {"backgroundColor":"accent-1","className":"is-style-default"} -->', + ), + 'Different block class name order' => array( + '<!-- wp:separator {"className":"is-style-default has-custom-classname"} -->', + '<!-- wp:separator {"className":"has-custom-classname is-style-default"} -->', + ), + 'Different whitespace in block class name' => array( + '<!-- wp:separator {"className":"wp-block-separator is-style-default"} -->', + '<!-- wp:separator {"className":"wp-block-separator is-style-default "} -->', + ), + 'Duplicated block class names' => array( + '<!-- wp:separator {"className":"wp-block-separator is-style-default"} -->', + '<!-- wp:separator {"className":"wp-block-separator is-style-default wp-block-separator"} -->', + ), + 'Different Capitalization of tag' => array( + '<IMG src="wp.png" alt="The WordPress logo">', + '<img src="wp.png" alt="The WordPress logo">', + ), + ); + } + + /** + * @ticket 63527 + * + * @covers ::build_visual_html_tree + * + * @dataProvider data_build_equivalent_html_semantic_tree_with_equivalent_html + */ + public function test_build_equivalent_html_semantic_tree_with_equivalent_html( $expected, $actual ) { + $tree_expected = build_visual_html_tree( $expected, '<body>' ); + $tree_actual = build_visual_html_tree( $actual, '<body>' ); + + $this->assertSame( $tree_expected, $tree_actual ); + } + + public function data_build_equivalent_html_semantic_tree_with_non_equivalent_html() { + return array( + 'Different attributes' => array( + '<img src="wp.png" alt="The WordPress logo">', + '<img alt="The WordPress logo" src="wp.png" title="WordPress">', + ), + 'Different class names' => array( + '<hr class="wp-block-separator is-style-default">', + '<hr class="is-style-default wp-block-hairline">', + ), + 'Different styles' => array( + '<hr style="margin-top: 50px; margin-bottom: 50px;">', + '<hr style="margin-top: 50px; margin-bottom: 100px">', + ), + 'Different comments' => array( + '<!-- abc -->', + '<!-- xyz -->', + ), + 'Semantically relevant whitespace' => array( + '<div style="color: rgb(50 139 31)">Test</div>', + '<div style="color:rgb(5013931)">Test</div>', + ), + ); + } + + /** + * @ticket 63527 + * + * @covers ::build_visual_html_tree + * + * @dataProvider data_build_equivalent_html_semantic_tree_with_non_equivalent_html + */ + public function test_build_equivalent_html_semantic_tree_with_non_equivalent_html( $expected, $actual ) { + $tree_expected = build_visual_html_tree( $expected, '<body>' ); + $tree_actual = build_visual_html_tree( $actual, '<body>' ); + + $this->assertNotSame( $tree_expected, $tree_actual ); + } +} diff --git a/tests/phpunit/tests/comment/commentForm.php b/tests/phpunit/tests/comment/commentForm.php index 771cbc1b57..e3dab07e24 100644 --- a/tests/phpunit/tests/comment/commentForm.php +++ b/tests/phpunit/tests/comment/commentForm.php @@ -193,4 +193,38 @@ class Tests_Comment_CommentForm extends WP_UnitTestCase { $post_hidden_field = "<input type='hidden' name='comment_post_ID' value='{$post_id}' id='comment_post_ID' />"; $this->assertStringContainsString( $post_hidden_field, $form ); } + + /** + * Tests novalidate attribute on the comment form. + * + * @ticket 47595 + */ + public function test_comment_form_and_novalidate_attribute() { + $post_id = self::$post_id; + + // By default, the novalidate is not emitted. + $form = get_echo( 'comment_form', array( array(), $post_id ) ); + $p = new WP_HTML_Tag_Processor( $form ); + $this->assertTrue( $p->next_tag( array( 'tag_name' => 'FORM' ) ), 'Expected FORM tag.' ); + $this->assertNull( $p->get_attribute( 'novalidate' ), 'Expected FORM to not have novalidate attribute by default.' ); + + // Opt in to the novalidate attribute by passing an arg to comment_form(). + $form = get_echo( 'comment_form', array( array( 'novalidate' => true ), $post_id ) ); + $p = new WP_HTML_Tag_Processor( $form ); + $this->assertTrue( $p->next_tag( array( 'tag_name' => 'FORM' ) ), 'Expected FORM tag.' ); + $this->assertTrue( $p->get_attribute( 'novalidate' ), 'Expected FORM to have the novalidate attribute.' ); + + // Opt in to the novalidate attribute via the comment_form_defaults filter. + add_filter( + 'comment_form_defaults', + static function ( array $defaults ): array { + $defaults['novalidate'] = true; + return $defaults; + } + ); + $form = get_echo( 'comment_form', array( array(), $post_id ) ); + $p = new WP_HTML_Tag_Processor( $form ); + $this->assertTrue( $p->next_tag( array( 'tag_name' => 'FORM' ) ), 'Expected FORM tag.' ); + $this->assertTrue( $p->get_attribute( 'novalidate' ), 'Expected FORM to have novalidate attribute.' ); + } } diff --git a/tests/phpunit/tests/dependencies/scripts.php b/tests/phpunit/tests/dependencies/scripts.php index 89bfb4ef92..d00c77b5a1 100644 --- a/tests/phpunit/tests/dependencies/scripts.php +++ b/tests/phpunit/tests/dependencies/scripts.php @@ -79,7 +79,7 @@ JS; $expected .= "<script type='text/javascript' src='http://example.com?ver=1.2' id='empty-deps-version-js'></script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='empty-deps-null-version-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. $this->assertSame( '', get_echo( 'wp_print_scripts' ) ); @@ -125,7 +125,7 @@ JS; 'id' => 'ms-isa-1-js-after', ) ); - $this->assertEqualMarkup( $expected, $output, 'Inline scripts in the "after" position, that are attached to a deferred main script, are failing to print/execute.' ); + $this->assertEqualHTML( $expected, $output, '<body>', 'Inline scripts in the "after" position, that are attached to a deferred main script, are failing to print/execute.' ); } /** @@ -154,7 +154,7 @@ JS; ) ); - $this->assertEqualMarkup( $expected, $output, 'Inline scripts in the "after" position, that are attached to a blocking main script, are failing to print/execute.' ); + $this->assertEqualHTML( $expected, $output, '<body>', 'Inline scripts in the "after" position, that are attached to a blocking main script, are failing to print/execute.' ); } /** @@ -187,9 +187,9 @@ JS; 'id' => 'ds-i1-1-js-before', ) ); - $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-1.js' id='ds-i1-1-js' $strategy data-wp-strategy='{$strategy}'></script>\n"; - $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-2.js' id='ds-i1-2-js' $strategy data-wp-strategy='{$strategy}'></script>\n"; - $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-3.js' id='ds-i1-3-js' $strategy data-wp-strategy='{$strategy}'></script>\n"; + $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-1.js' id='ds-i1-1-js' {$strategy}='{$strategy}' data-wp-strategy='{$strategy}'></script>\n"; + $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-2.js' id='ds-i1-2-js' {$strategy}='{$strategy}' data-wp-strategy='{$strategy}'></script>\n"; + $expected .= "<script type='text/javascript' src='http://example.org/ds-i1-3.js' id='ds-i1-3-js' {$strategy}='{$strategy}' data-wp-strategy='{$strategy}'></script>\n"; $expected .= wp_get_inline_script_tag( 'console.log("before last");', array( @@ -197,9 +197,9 @@ JS; 'type' => 'text/javascript', ) ); - $expected .= "<script type='text/javascript' src='http://example.org/ms-i1-1.js' id='ms-i1-1-js' {$strategy} data-wp-strategy='{$strategy}'></script>\n"; + $expected .= "<script type='text/javascript' src='http://example.org/ms-i1-1.js' id='ms-i1-1-js' {$strategy}='{$strategy}' data-wp-strategy='{$strategy}'></script>\n"; - $this->assertEqualMarkup( $expected, $output, 'Inline scripts in the "before" position, that are attached to a deferred main script, are failing to print/execute.' ); + $this->assertEqualHTML( $expected, $output, '<body>', 'Inline scripts in the "before" position, that are attached to a deferred main script, are failing to print/execute.' ); } /** @@ -216,8 +216,8 @@ JS; // No dependents, No dependencies then async. wp_enqueue_script( 'main-script-a1', '/main-script-a1.js', array(), null, array( 'strategy' => 'async' ) ); $output = get_echo( 'wp_print_scripts' ); - $expected = "<script type='text/javascript' src='/main-script-a1.js' id='main-script-a1-js' async data-wp-strategy='async'></script>\n"; - $this->assertEqualMarkup( $expected, $output, 'Scripts enqueued with an async loading strategy are failing to have the async attribute applied to the script handle when being printed.' ); + $expected = "<script type='text/javascript' src='/main-script-a1.js' id='main-script-a1-js' async='async' data-wp-strategy='async'></script>\n"; + $this->assertEqualHTML( $expected, $output, '<body>', 'Scripts enqueued with an async loading strategy are failing to have the async attribute applied to the script handle when being printed.' ); } /** @@ -238,9 +238,9 @@ JS; wp_enqueue_script( 'dependency-script-a2', '/dependency-script-a2.js', array(), null ); wp_enqueue_script( 'main-script-a2', '/main-script-a2.js', array( 'dependency-script-a2' ), null, compact( 'strategy' ) ); $output = get_echo( 'wp_print_scripts' ); - $expected = "<script id='dependency-script-a2-js' src='/dependency-script-a2.js'></script>\n"; - $expected .= "<script type='text/javascript' src='/main-script-a2.js' id='main-script-a2-js' {$strategy} data-wp-strategy='{$strategy}'></script>"; - $this->assertEqualMarkup( $expected, $output, 'Dependents of a blocking dependency are free to have any strategy.' ); + $expected = "<script id='dependency-script-a2-js' src='/dependency-script-a2.js' type='text/javascript'></script>\n"; + $expected .= "<script type='text/javascript' src='/main-script-a2.js' id='main-script-a2-js' {$strategy}='{$strategy}' data-wp-strategy='{$strategy}'></script>"; + $this->assertEqualHTML( $expected, $output, '<body>', 'Dependents of a blocking dependency are free to have any strategy.' ); } /** @@ -264,7 +264,7 @@ JS; <script type='text/javascript' src='/main-script-a3.js' id='main-script-a3-js' data-wp-strategy='{$strategy}'></script> <script id="dependent-script-a3-js" src="/dependent-script-a3.js" type="text/javascript"></script> JS; - $this->assertEqualMarkup( $expected, $output, 'Blocking dependents must force delayed dependencies to become blocking.' ); + $this->assertEqualHTML( $expected, $output, '<body>', 'Blocking dependents must force delayed dependencies to become blocking.' ); } /** @@ -511,18 +511,26 @@ JS; }, 'expected_markup' => <<<HTML <script id="blocking-not-async-without-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-not-async-without-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-not-async-without-dependency:%20script' id='blocking-not-async-without-dependency-js'></script> <script id="blocking-not-async-without-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-not-async-without-dependency: after inline" ) +/* ]]> */ </script> <script id="async-with-blocking-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-blocking-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-with-blocking-dependency:%20script' id='async-with-blocking-dependency-js' data-wp-strategy='async'></script> <script id="async-with-blocking-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-blocking-dependency: after inline" ) +/* ]]> */ </script> HTML , @@ -548,25 +556,37 @@ HTML }, 'expected_markup' => <<<HTML <script id="async-no-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-no-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-no-dependency:%20script' id='async-no-dependency-js' data-wp-strategy='async'></script> <script id="async-no-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-no-dependency: after inline" ) +/* ]]> */ </script> <script id="async-one-async-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-one-async-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-one-async-dependency:%20script' id='async-one-async-dependency-js' data-wp-strategy='async'></script> <script id="async-one-async-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-one-async-dependency: after inline" ) +/* ]]> */ </script> <script id="async-two-async-dependencies-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-two-async-dependencies: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-two-async-dependencies:%20script' id='async-two-async-dependencies-js' data-wp-strategy='async'></script> <script id="async-two-async-dependencies-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-two-async-dependencies: after inline" ) +/* ]]> */ </script> HTML , @@ -584,18 +604,26 @@ HTML }, 'expected_markup' => <<<HTML <script id="async-with-blocking-dependent-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-blocking-dependent: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-with-blocking-dependent:%20script' id='async-with-blocking-dependent-js' data-wp-strategy='async'></script> <script id="async-with-blocking-dependent-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-blocking-dependent: after inline" ) +/* ]]> */ </script> <script id="blocking-dependent-of-async-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependent-of-async: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-dependent-of-async:%20script' id='blocking-dependent-of-async-js'></script> <script id="blocking-dependent-of-async-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependent-of-async: after inline" ) +/* ]]> */ </script> HTML , @@ -613,18 +641,26 @@ HTML }, 'expected_markup' => <<<HTML <script id="async-with-defer-dependent-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-defer-dependent: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-with-defer-dependent:%20script' id='async-with-defer-dependent-js' data-wp-strategy='async'></script> <script id="async-with-defer-dependent-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-with-defer-dependent: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-async-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-async: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-async:%20script' id='defer-dependent-of-async-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-async-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-async: after inline" ) +/* ]]> */ </script> HTML , @@ -645,17 +681,25 @@ HTML }, 'expected_markup' => <<<HTML <script id="blocking-bundle-of-none-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-of-none: before inline" ) +/* ]]> */ </script> <script id="blocking-bundle-of-none-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-of-none: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-blocking-bundle-of-none-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-bundle-of-none: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-blocking-bundle-of-none:%20script' id='defer-dependent-of-blocking-bundle-of-none-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-blocking-bundle-of-none-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-bundle-of-none: after inline" ) +/* ]]> */ </script> HTML , @@ -679,25 +723,37 @@ HTML }, 'expected_markup' => <<<HTML <script id="blocking-bundle-member-one-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-member-one: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-bundle-member-one:%20script' id='blocking-bundle-member-one-js'></script> <script id="blocking-bundle-member-one-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-member-one: after inline" ) +/* ]]> */ </script> <script id="blocking-bundle-member-two-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-member-two: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-bundle-member-two:%20script' id='blocking-bundle-member-two-js'></script> <script id="blocking-bundle-member-two-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-bundle-member-two: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-blocking-bundle-of-two-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-bundle-of-two: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-blocking-bundle-of-two:%20script' id='defer-dependent-of-blocking-bundle-of-two-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-blocking-bundle-of-two-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-bundle-of-two: after inline" ) +/* ]]> */ </script> HTML , @@ -720,17 +776,25 @@ HTML }, 'expected_markup' => <<<HTML <script id="defer-bundle-of-none-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-bundle-of-none: before inline" ) +/* ]]> */ </script> <script id="defer-bundle-of-none-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-bundle-of-none: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-defer-bundle-of-none-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-defer-bundle-of-none: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-defer-bundle-of-none:%20script' id='defer-dependent-of-defer-bundle-of-none-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-defer-bundle-of-none-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-defer-bundle-of-none: after inline" ) +/* ]]> */ </script> HTML , @@ -751,25 +815,37 @@ HTML }, 'expected_markup' => <<<HTML <script id="blocking-dependency-with-defer-following-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependency-with-defer-following-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-dependency-with-defer-following-dependency:%20script' id='blocking-dependency-with-defer-following-dependency-js'></script> <script id="blocking-dependency-with-defer-following-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependency-with-defer-following-dependency: after inline" ) +/* ]]> */ </script> <script id="defer-dependency-with-blocking-preceding-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependency-with-blocking-preceding-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependency-with-blocking-preceding-dependency:%20script' id='defer-dependency-with-blocking-preceding-dependency-js' data-wp-strategy='defer'></script> <script id="defer-dependency-with-blocking-preceding-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependency-with-blocking-preceding-dependency: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-blocking-and-defer-dependencies-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-and-defer-dependencies: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-blocking-and-defer-dependencies:%20script' id='defer-dependent-of-blocking-and-defer-dependencies-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-blocking-and-defer-dependencies-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-blocking-and-defer-dependencies: after inline" ) +/* ]]> */ </script> HTML , @@ -790,25 +866,37 @@ HTML }, 'expected_markup' => <<<HTML <script id="defer-dependency-with-blocking-following-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependency-with-blocking-following-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependency-with-blocking-following-dependency:%20script' id='defer-dependency-with-blocking-following-dependency-js' data-wp-strategy='defer'></script> <script id="defer-dependency-with-blocking-following-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependency-with-blocking-following-dependency: after inline" ) +/* ]]> */ </script> <script id="blocking-dependency-with-defer-preceding-dependency-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependency-with-defer-preceding-dependency: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=blocking-dependency-with-defer-preceding-dependency:%20script' id='blocking-dependency-with-defer-preceding-dependency-js'></script> <script id="blocking-dependency-with-defer-preceding-dependency-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "blocking-dependency-with-defer-preceding-dependency: after inline" ) +/* ]]> */ </script> <script id="defer-dependent-of-defer-and-blocking-dependencies-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-defer-and-blocking-dependencies: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-defer-and-blocking-dependencies:%20script' id='defer-dependent-of-defer-and-blocking-dependencies-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-defer-and-blocking-dependencies-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-defer-and-blocking-dependencies: after inline" ) +/* ]]> */ </script> HTML , @@ -826,18 +914,26 @@ HTML }, 'expected_markup' => <<<HTML <script id="defer-with-async-dependent-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-with-async-dependent: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-with-async-dependent:%20script' id='defer-with-async-dependent-js' data-wp-strategy='defer'></script> <script id="defer-with-async-dependent-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-with-async-dependent: after inline" ) +/* ]]> */ </script> <script id="async-dependent-of-defer-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-dependent-of-defer: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=async-dependent-of-defer:%20script' id='async-dependent-of-defer-js' data-wp-strategy='async'></script> <script id="async-dependent-of-defer-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "async-dependent-of-defer: after inline" ) +/* ]]> */ </script> HTML , @@ -851,9 +947,11 @@ HTML }, 'expected_markup' => <<<HTML <script id="defer-with-before-inline-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-with-before-inline: before inline" ) +/* ]]> */ </script> -<script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-with-before-inline:%20script' id='defer-with-before-inline-js' defer data-wp-strategy='defer'></script> +<script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-with-before-inline:%20script' id='defer-with-before-inline-js' defer='defer' data-wp-strategy='defer'></script> HTML , ), @@ -867,7 +965,9 @@ HTML 'expected_markup' => <<<HTML <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-with-after-inline:%20script' id='defer-with-after-inline-js' data-wp-strategy='defer'></script> <script id="defer-with-after-inline-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-with-after-inline: after inline" ) +/* ]]> */ </script> HTML , @@ -883,9 +983,9 @@ HTML wp_enqueue_script( 'theme-functions', 'https://example.com/theme-functions.js', array( 'jquery' ), null, array( 'strategy' => 'defer' ) ); }, 'expected_markup' => <<<HTML -<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery.js' id='jquery-core-js' defer data-wp-strategy='defer'></script> -<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery-migrate.js' id='jquery-migrate-js' defer data-wp-strategy='defer'></script> -<script type='text/javascript' src='https://example.com/theme-functions.js' id='theme-functions-js' defer data-wp-strategy='defer'></script> +<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery.js' id='jquery-core-js' defer='defer' data-wp-strategy='defer'></script> +<script type='text/javascript' src='http://$wp_tests_domain/wp-includes/js/jquery/jquery-migrate.js' id='jquery-migrate-js' defer='defer' data-wp-strategy='defer'></script> +<script type='text/javascript' src='https://example.com/theme-functions.js' id='theme-functions-js' defer='defer' data-wp-strategy='defer'></script> HTML , ), @@ -912,11 +1012,15 @@ HTML <script type='text/javascript' src='https://example.com/external.js?script_event_log=inner-bundle-member-two:%20script' id='inner-bundle-member-two-js' data-wp-strategy='defer'></script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=outer-bundle-leaf-member:%20script' id='outer-bundle-leaf-member-js'></script> <script id="defer-dependent-of-nested-aliases-js-before" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-nested-aliases: before inline" ) +/* ]]> */ </script> <script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-nested-aliases:%20script' id='defer-dependent-of-nested-aliases-js' data-wp-strategy='defer'></script> <script id="defer-dependent-of-nested-aliases-js-after" type="text/javascript"> +/* <![CDATA[ */ scriptEventLog.push( "defer-dependent-of-nested-aliases: after inline" ) +/* ]]> */ </script> HTML , @@ -935,9 +1039,9 @@ HTML $this->enqueue_test_script( 'defer-dependent-of-async-aliases', 'defer', array( $alias_handle ) ); }, 'expected_markup' => <<<HTML -<script type='text/javascript' src='https://example.com/external.js?script_event_log=async1:%20script' id='async1-js' defer data-wp-strategy='async'></script> -<script type='text/javascript' src='https://example.com/external.js?script_event_log=async2:%20script' id='async2-js' defer data-wp-strategy='async'></script> -<script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-async-aliases:%20script' id='defer-dependent-of-async-aliases-js' defer data-wp-strategy='defer'></script> +<script type='text/javascript' src='https://example.com/external.js?script_event_log=async1:%20script' id='async1-js' defer='defer' data-wp-strategy='async'></script> +<script type='text/javascript' src='https://example.com/external.js?script_event_log=async2:%20script' id='async2-js' defer='defer' data-wp-strategy='async'></script> +<script type='text/javascript' src='https://example.com/external.js?script_event_log=defer-dependent-of-async-aliases:%20script' id='defer-dependent-of-async-aliases-js' defer='defer' data-wp-strategy='defer'></script> HTML , ), @@ -960,7 +1064,7 @@ HTML public function test_various_strategy_dependency_chains( $set_up, $expected_markup ) { $set_up(); $actual_markup = get_echo( 'wp_print_scripts' ); - $this->assertEqualMarkup( trim( $expected_markup ), trim( $actual_markup ), "Actual markup:\n{$actual_markup}" ); + $this->assertEqualHTML( trim( $expected_markup ), trim( $actual_markup ), '<body>', "Actual markup:\n{$actual_markup}" ); } /** @@ -1036,12 +1140,12 @@ HTML wp_enqueue_script( 'dependent-script-d4-2', '/dependent-script-d4-2.js', array( 'dependent-script-d4-1' ), null, array( 'strategy' => 'async' ) ); wp_enqueue_script( 'dependent-script-d4-3', '/dependent-script-d4-3.js', array( 'dependent-script-d4-2' ), null, array( 'strategy' => 'defer' ) ); $output = get_echo( 'wp_print_scripts' ); - $expected = "<script type='text/javascript' src='/main-script-d4.js' id='main-script-d4-js' defer data-wp-strategy='defer'></script>\n"; - $expected .= "<script type='text/javascript' src='/dependent-script-d4-1.js' id='dependent-script-d4-1-js' defer data-wp-strategy='defer'></script>\n"; - $expected .= "<script type='text/javascript' src='/dependent-script-d4-2.js' id='dependent-script-d4-2-js' defer data-wp-strategy='async'></script>\n"; - $expected .= "<script type='text/javascript' src='/dependent-script-d4-3.js' id='dependent-script-d4-3-js' defer data-wp-strategy='defer'></script>\n"; + $expected = "<script type='text/javascript' src='/main-script-d4.js' id='main-script-d4-js' defer='defer' data-wp-strategy='defer'></script>\n"; + $expected .= "<script type='text/javascript' src='/dependent-script-d4-1.js' id='dependent-script-d4-1-js' defer='defer' data-wp-strategy='defer'></script>\n"; + $expected .= "<script type='text/javascript' src='/dependent-script-d4-2.js' id='dependent-script-d4-2-js' defer='defer' data-wp-strategy='async'></script>\n"; + $expected .= "<script type='text/javascript' src='/dependent-script-d4-3.js' id='dependent-script-d4-3-js' defer='defer' data-wp-strategy='defer'></script>\n"; - $this->assertEqualMarkup( $expected, $output, 'Scripts registered as defer but that have dependents that are async are expected to have said dependents deferred.' ); + $this->assertEqualHTML( $expected, $output, '<body>', 'Scripts registered as defer but that have dependents that are async are expected to have said dependents deferred.' ); } /** @@ -1113,7 +1217,7 @@ HTML $expected_header .= "<script type='text/javascript' src='/enqueue-header-old.js' id='enqueue-header-old-js'></script>\n"; $expected_header .= "<script type='text/javascript' src='/enqueue-header-new.js' id='enqueue-header-new-js'></script>\n"; - $this->assertEqualMarkup( $expected_header, $actual_header, 'Scripts registered/enqueued using the older $in_footer parameter or the newer $args parameter should have the same outcome.' ); + $this->assertEqualHTML( $expected_header, $actual_header, '<body>', 'Scripts registered/enqueued using the older $in_footer parameter or the newer $args parameter should have the same outcome.' ); $this->assertEmpty( $actual_footer, 'Expected footer to be empty since all scripts were for head.' ); } @@ -1141,7 +1245,7 @@ HTML $expected_footer .= "<script type='text/javascript' src='/enqueue-footer-new.js' id='enqueue-footer-new-js'></script>\n"; $this->assertEmpty( $actual_header, 'Expected header to be empty since all scripts targeted footer.' ); - $this->assertEqualMarkup( $expected_footer, $actual_footer, 'Scripts registered/enqueued using the older $in_footer parameter or the newer $args parameter should have the same outcome.' ); + $this->assertEqualHTML( $expected_footer, $actual_footer, '<body>', 'Scripts registered/enqueued using the older $in_footer parameter or the newer $args parameter should have the same outcome.' ); } /** @@ -1260,7 +1364,7 @@ HTML wp_register_script( 'invalid-strategy', '/defaults.js', array(), null, array( 'strategy' => 'random-strategy' ) ); wp_enqueue_script( 'invalid-strategy' ); - $this->assertEqualMarkup( + $this->assertEqualHTML( "<script type='text/javascript' src='/defaults.js' id='invalid-strategy-js'></script>\n", get_echo( 'wp_print_scripts' ) ); @@ -1285,7 +1389,7 @@ HTML wp_script_add_data( 'invalid-strategy', 'strategy', 'random-strategy' ); wp_enqueue_script( 'invalid-strategy' ); - $this->assertEqualMarkup( + $this->assertEqualHTML( "<script type='text/javascript' src='/defaults.js' id='invalid-strategy-js'></script>\n", get_echo( 'wp_print_scripts' ) ); @@ -1306,7 +1410,7 @@ HTML public function test_script_strategy_doing_it_wrong_via_enqueue() { wp_enqueue_script( 'invalid-strategy', '/defaults.js', array(), null, array( 'strategy' => 'random-strategy' ) ); - $this->assertEqualMarkup( + $this->assertEqualHTML( "<script type='text/javascript' src='/defaults.js' id='invalid-strategy-js'></script>\n", get_echo( 'wp_print_scripts' ) ); @@ -1342,9 +1446,9 @@ HTML $concatenate_scripts = $old_value; $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=one-concat-dep,two-concat-dep,three-concat-dep&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' src='/main-script.js' id='main-defer-script-js' defer data-wp-strategy='defer'></script>\n"; + $expected .= "<script type='text/javascript' src='/main-script.js' id='main-defer-script-js' defer='defer' data-wp-strategy='defer'></script>\n"; - $this->assertEqualMarkup( $expected, $print_scripts, 'Scripts are being incorrectly concatenated when a main script is registered with a "defer" loading strategy. Deferred scripts should not be part of the script concat loading query.' ); + $this->assertEqualHTML( $expected, $print_scripts, '<body>', 'Scripts are being incorrectly concatenated when a main script is registered with a "defer" loading strategy. Deferred scripts should not be part of the script concat loading query.' ); } /** @@ -1377,9 +1481,9 @@ HTML $concatenate_scripts = $old_value; $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=one-concat-dep-1,two-concat-dep-1,three-concat-dep-1&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' src='/main-script.js' id='main-async-script-1-js' async data-wp-strategy='async'></script>\n"; + $expected .= "<script type='text/javascript' src='/main-script.js' id='main-async-script-1-js' async='async' data-wp-strategy='async'></script>\n"; - $this->assertEqualMarkup( $expected, $print_scripts, 'Scripts are being incorrectly concatenated when a main script is registered with an "async" loading strategy. Async scripts should not be part of the script concat loading query.' ); + $this->assertEqualHTML( $expected, $print_scripts, '<body>', 'Scripts are being incorrectly concatenated when a main script is registered with an "async" loading strategy. Async scripts should not be part of the script concat loading query.' ); } /** @@ -1416,9 +1520,9 @@ HTML $concatenate_scripts = $old_value; $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=one-concat-dep-2,two-concat-dep-2,three-concat-dep-2,four-concat-dep-2,five-concat-dep-2,six-concat-dep-2&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' src='/main-script.js' id='deferred-script-2-js' defer data-wp-strategy='defer'></script>\n"; + $expected .= "<script type='text/javascript' src='/main-script.js' id='deferred-script-2-js' defer='defer' data-wp-strategy='defer'></script>\n"; - $this->assertEqualMarkup( $expected, $print_scripts, 'Scripts are being incorrectly concatenated when a main script is registered as deferred after other blocking scripts are registered. Deferred scripts should not be part of the script concat loader query string. ' ); + $this->assertEqualHTML( $expected, $print_scripts, '<body>', 'Scripts are being incorrectly concatenated when a main script is registered as deferred after other blocking scripts are registered. Deferred scripts should not be part of the script concat loader query string. ' ); } /** @@ -1427,6 +1531,8 @@ HTML public function test_wp_enqueue_script_with_html5_support_does_not_contain_type_attribute() { global $wp_version; + $this->add_html5_script_theme_support(); + $GLOBALS['wp_scripts'] = new WP_Scripts(); $GLOBALS['wp_scripts']->default_version = get_bloginfo( 'version' ); @@ -1434,7 +1540,7 @@ HTML $expected = "<script src='http://example.com?ver={$wp_version}' id='empty-deps-no-version-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1473,7 +1579,7 @@ HTML $expected .= "<script type='text/javascript' src='{$wp_scripts->base_url}ftp://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js?ver={$wp_version}' id='jquery-ftp-js'></script>\n"; // Go! - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. $this->assertSame( '', get_echo( 'wp_print_scripts' ) ); @@ -1516,7 +1622,7 @@ HTML $expected .= "<script type='text/javascript' src='http://example.com' id='test-only-data-js'></script>\n"; // Go! - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. $this->assertSame( '', get_echo( 'wp_print_scripts' ) ); @@ -1531,10 +1637,10 @@ HTML // Enqueue and add conditional comments. wp_enqueue_script( 'test-only-conditional', 'example.com', array(), null ); wp_script_add_data( 'test-only-conditional', 'conditional', 'gt IE 7' ); - $expected = "<!--[if gt IE 7]>\n<script type='text/javascript' src='http://example.com' id='test-only-conditional-js'></script>\n<![endif]-->\n"; + $expected = "<!--[if gt IE 7]>\n<script type=\"text/javascript\" src=\"http://example.com\" id=\"test-only-conditional-js\"></script>\n<![endif]-->\n"; // Go! - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. $this->assertSame( '', get_echo( 'wp_print_scripts' ) ); @@ -1555,7 +1661,7 @@ HTML $expected = str_replace( "'", '"', $expected ); // Go! - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. $this->assertSame( '', get_echo( 'wp_print_scripts' ) ); @@ -1573,10 +1679,10 @@ HTML $expected = "<script type='text/javascript' src='http://example.com' id='test-invalid-js'></script>\n"; // Go! - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); // No scripts left to print. - $this->assertEqualMarkup( '', get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( '', get_echo( 'wp_print_scripts' ) ); } /** @@ -1602,7 +1708,7 @@ HTML wp_enqueue_script( 'handle-three' ); - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1690,8 +1796,8 @@ HTML $expected_header .= "<script type='text/javascript' src='/child-head.js' id='child-head-js'></script>\n"; $expected_footer = "<script type='text/javascript' src='/parent.js' id='parent-js'></script>\n"; - $this->assertEqualMarkup( $expected_header, $header, 'Expected same header markup.' ); - $this->assertEqualMarkup( $expected_footer, $footer, 'Expected same footer markup.' ); + $this->assertEqualHTML( $expected_header, $header, '<body>', 'Expected same header markup.' ); + $this->assertEqualHTML( $expected_footer, $footer, '<body>', 'Expected same footer markup.' ); } /** @@ -1711,8 +1817,8 @@ HTML $expected_footer = "<script type='text/javascript' src='/child-footer.js' id='child-footer-js'></script>\n"; $expected_footer .= "<script type='text/javascript' src='/parent.js' id='parent-js'></script>\n"; - $this->assertEqualMarkup( $expected_header, $header, 'Expected same header markup.' ); - $this->assertEqualMarkup( $expected_footer, $footer, 'Expected same footer markup.' ); + $this->assertEqualHTML( $expected_header, $header, '<body>', 'Expected same header markup.' ); + $this->assertEqualHTML( $expected_footer, $footer, '<body>', 'Expected same footer markup.' ); } /** @@ -1742,8 +1848,8 @@ HTML $expected_footer .= "<script type='text/javascript' src='/child2-footer.js' id='child2-footer-js'></script>\n"; $expected_footer .= "<script type='text/javascript' src='/parent-footer.js' id='parent-footer-js'></script>\n"; - $this->assertEqualMarkup( $expected_header, $header, 'Expected same header markup.' ); - $this->assertEqualMarkup( $expected_footer, $footer, 'Expected same footer markup.' ); + $this->assertEqualHTML( $expected_header, $header, '<body>', 'Expected same header markup.' ); + $this->assertEqualHTML( $expected_footer, $footer, '<body>', 'Expected same footer markup.' ); } /** @@ -1770,10 +1876,16 @@ HTML wp_enqueue_script( 'test-example', 'example.com', array(), null ); wp_add_inline_script( 'test-example', 'console.log("before");', 'before' ); - $expected = "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected = <<<HTML +<script type='text/javascript' id='test-example-js-before'> +/* <![CDATA[ */ +console.log("before"); +/* ]]> */ +</script> +HTML; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1784,9 +1896,15 @@ HTML wp_add_inline_script( 'test-example', 'console.log("after");' ); $expected = "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= <<<HTML +<script type='text/javascript' id='test-example-js-after'> +/* <![CDATA[ */ +console.log("after"); +/* ]]> */ +</script> +HTML; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1797,11 +1915,11 @@ HTML wp_add_inline_script( 'test-example', 'console.log("before");', 'before' ); wp_add_inline_script( 'test-example', 'console.log("after");' ); - $expected = "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected = "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1812,9 +1930,9 @@ HTML wp_enqueue_script( 'test-example' ); wp_add_inline_script( 'test-example', 'console.log("before");', 'before' ); - $expected = "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected = "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1825,9 +1943,9 @@ HTML wp_enqueue_script( 'test-example' ); wp_add_inline_script( 'test-example', 'console.log("after");' ); - $expected = "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected = "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1839,10 +1957,10 @@ HTML wp_add_inline_script( 'test-example', 'console.log("before");', 'before' ); wp_add_inline_script( 'test-example', 'console.log("after");' ); - $expected = "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected = "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1855,11 +1973,11 @@ HTML wp_add_inline_script( 'test-example', 'console.log("after");' ); wp_add_inline_script( 'test-example', 'console.log("after");' ); - $expected = "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\nconsole.log(\"before\");\n</script>\n"; + $expected = "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1872,11 +1990,11 @@ HTML wp_add_inline_script( 'test-example', 'console.log("after");' ); $expected = "<script type='text/javascript' id='test-example-js-extra'>\n/* <![CDATA[ */\nvar testExample = {\"foo\":\"bar\"};\n/* ]]> */\n</script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1895,13 +2013,13 @@ HTML wp_add_inline_script( 'one', 'console.log("before one");', 'before' ); wp_add_inline_script( 'two', 'console.log("before two");', 'before' ); - $expected = "<script type='text/javascript' id='one-js-before'>\nconsole.log(\"before one\");\n</script>\n"; + $expected = "<script type='text/javascript' id='one-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before one\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}one.js?ver={$wp_version}' id='one-js'></script>\n"; - $expected .= "<script type='text/javascript' id='two-js-before'>\nconsole.log(\"before two\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='two-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before two\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}two.js?ver={$wp_version}' id='two-js'></script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}three.js?ver={$wp_version}' id='three-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1919,12 +2037,12 @@ HTML wp_add_inline_script( 'one', 'console.log("before one");', 'before' ); - $expected = "<script type='text/javascript' id='one-js-before'>\nconsole.log(\"before one\");\n</script>\n"; + $expected = "<script type='text/javascript' id='one-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before one\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}one.js?ver={$wp_version}' id='one-js'></script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}two.js?ver={$wp_version}' id='two-js'></script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}three.js?ver={$wp_version}' id='three-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1946,12 +2064,12 @@ HTML $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=one&ver={$wp_version}'></script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}two.js?ver={$wp_version}' id='two-js'></script>\n"; - $expected .= "<script type='text/javascript' id='two-js-after'>\nconsole.log(\"after two\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='two-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after two\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}three.js?ver={$wp_version}' id='three-js'></script>\n"; - $expected .= "<script type='text/javascript' id='three-js-after'>\nconsole.log(\"after three\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='three-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after three\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='{$this->default_scripts_dir}four.js?ver={$wp_version}' id='four-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -1969,9 +2087,9 @@ HTML $expected_localized = str_replace( "'", '"', $expected_localized ); $expected = "<!--[if gte IE 9]>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; $expected .= "<![endif]-->\n"; $expected = str_replace( "'", '"', $expected ); @@ -1982,7 +2100,7 @@ HTML wp_script_add_data( 'test-example', 'conditional', 'gte IE 9' ); $this->assertSame( $expected_localized, get_echo( 'wp_print_scripts' ) ); - $this->assertEqualMarkup( $expected, $wp_scripts->print_html ); + $this->assertEqualHTML( $expected, $wp_scripts->print_html ); $this->assertTrue( $wp_scripts->do_concat ); } @@ -1999,7 +2117,7 @@ HTML $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate&ver={$wp_version}'></script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; wp_enqueue_script( 'test-example', 'http://example.com', array( 'jquery' ), null ); wp_add_inline_script( 'test-example', 'console.log("after");' ); @@ -2007,7 +2125,7 @@ HTML wp_print_scripts(); $print_scripts = get_echo( '_print_scripts' ); - $this->assertEqualMarkup( $expected, $print_scripts ); + $this->assertEqualHTML( $expected, $print_scripts ); } /** @@ -2023,8 +2141,8 @@ HTML $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate&ver={$wp_version}'></script>\n"; $expected .= "<!--[if gte IE 9]>\n"; - $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type=\"text/javascript\" src=\"http://example.com\" id=\"test-example-js\"></script>\n"; + $expected .= "<script type=\"text/javascript\" id=\"test-example-js-after\">\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; $expected .= "<![endif]-->\n"; wp_enqueue_script( 'test-example', 'http://example.com', array( 'jquery' ), null ); @@ -2034,7 +2152,7 @@ HTML wp_print_scripts(); $print_scripts = get_echo( '_print_scripts' ); - $this->assertEqualMarkup( $expected, $print_scripts ); + $this->assertEqualHTML( $expected, $print_scripts ); } /** @@ -2050,7 +2168,7 @@ HTML $wp_scripts->do_concat = true; $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; wp_enqueue_script( 'test-example', 'http://example.com', array( 'jquery' ), null ); @@ -2059,7 +2177,7 @@ HTML wp_print_scripts(); $print_scripts = get_echo( '_print_scripts' ); - $this->assertEqualMarkup( $expected, $print_scripts ); + $this->assertEqualHTML( $expected, $print_scripts ); } /** @@ -2075,15 +2193,17 @@ HTML $wp_scripts->do_concat = true; $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate,wp-dom-ready,wp-hooks&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example-js-before'>\nconsole.log(\"before\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/dist/i18n.min.js' id='wp-i18n-js'></script>\n"; $expected .= "<script type='text/javascript' id='wp-i18n-js-after'>\n"; + $expected .= "/* <![CDATA[ */\n"; $expected .= "wp.i18n.setLocaleData( { 'text direction\u0004ltr': [ 'ltr' ] } );\n"; + $expected .= "/* ]]> */\n"; $expected .= "</script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/dist/a11y.min.js' id='wp-a11y-js'></script>\n"; $expected .= "<script type='text/javascript' src='http://example2.com' id='test-example2-js'></script>\n"; - $expected .= "<script type='text/javascript' id='test-example2-js-after'>\nconsole.log(\"after\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='test-example2-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after\");\n/* ]]> */\n</script>\n"; wp_enqueue_script( 'test-example', 'http://example.com', array( 'jquery' ), null ); wp_add_inline_script( 'test-example', 'console.log("before");', 'before' ); @@ -2109,7 +2229,7 @@ HTML $print_scripts // Printed scripts. ); - $this->assertEqualMarkup( $expected, $print_scripts ); + $this->assertEqualHTML( $expected, $print_scripts ); } /** @@ -2126,7 +2246,9 @@ HTML $expected_tail = "<script type='text/javascript' src='/customize-dependency.js' id='customize-dependency-js'></script>\n"; $expected_tail .= "<script type='text/javascript' id='customize-dependency-js-after'>\n"; + $expected_tail .= "/* <![CDATA[ */\n"; $expected_tail .= "tryCustomizeDependency()\n"; + $expected_tail .= "/* ]]> */\n"; $expected_tail .= "</script>\n"; $handle = 'customize-dependency'; @@ -2142,7 +2264,7 @@ HTML $tail = substr( $print_scripts, strrpos( $print_scripts, '<script type="text/javascript" src="/customize-dependency.js" id="customize-dependency-js">' ) ); - $this->assertEqualMarkup( $expected_tail, $tail ); + $this->assertEqualHTML( $expected_tail, $tail ); } /** @@ -2161,12 +2283,12 @@ HTML wp_enqueue_script( 'four', '/wp-includes/js/script4.js' ); $expected = "<script type='text/javascript' src='/wp-includes/js/script.js?ver={$wp_version}' id='one-js'></script>\n"; - $expected .= "<script type='text/javascript' id='one-js-after'>\nconsole.log(\"after one\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='one-js-after'>\n/* <![CDATA[ */\nconsole.log(\"after one\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script2.js?ver={$wp_version}' id='two-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script3.js?ver={$wp_version}' id='three-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script4.js?ver={$wp_version}' id='four-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2185,11 +2307,11 @@ HTML wp_enqueue_script( 'four', '/wp-includes/js/script4.js' ); $expected = "<script type='text/javascript' src='/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=one,two&ver={$wp_version}'></script>\n"; - $expected .= "<script type='text/javascript' id='three-js-before'>\nconsole.log(\"before three\");\n</script>\n"; + $expected .= "<script type='text/javascript' id='three-js-before'>\n/* <![CDATA[ */\nconsole.log(\"before three\");\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script3.js?ver={$wp_version}' id='three-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script4.js?ver={$wp_version}' id='four-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2206,7 +2328,7 @@ HTML ), 'delayed' => false, 'expected_data' => '/*before foo 1*/', - 'expected_tag' => "<script id='foo-js-before' type='text/javascript'>\n/*before foo 1*/\n</script>\n", + 'expected_tag' => "<script id='foo-js-before' type='text/javascript'>\n/* <![CDATA[ */\n/*before foo 1*/\n/* ]]> */\n</script>\n", ), 'after-blocking' => array( 'position' => 'after', @@ -2216,7 +2338,7 @@ HTML ), 'delayed' => false, 'expected_data' => "/*after foo 1*/\n/*after foo 2*/", - 'expected_tag' => "<script id='foo-js-after' type='text/javascript'>\n/*after foo 1*/\n/*after foo 2*/\n</script>\n", + 'expected_tag' => "<script id='foo-js-after' type='text/javascript'>\n/* <![CDATA[ */\n/*after foo 1*/\n/*after foo 2*/\n/* ]]> */\n</script>\n", ), 'before-delayed' => array( 'position' => 'before', @@ -2225,7 +2347,7 @@ HTML ), 'delayed' => true, 'expected_data' => '/*before foo 1*/', - 'expected_tag' => "<script id='foo-js-before' type='text/javascript'>\n/*before foo 1*/\n</script>\n", + 'expected_tag' => "<script id='foo-js-before' type='text/javascript'>\n/* <![CDATA[ */\n/*before foo 1*/\n/* ]]> */\n</script>\n", ), 'after-delayed' => array( 'position' => 'after', @@ -2235,7 +2357,7 @@ HTML ), 'delayed' => true, 'expected_data' => "/*after foo 1*/\n/*after foo 2*/", - 'expected_tag' => "<script id='foo-js-after' type='text/javascript'>\n/*after foo 1*/\n/*after foo 2*/\n</script>\n", + 'expected_tag' => "<script id='foo-js-after' type='text/javascript'>\n/* <![CDATA[ */\n/*after foo 1*/\n/*after foo 2*/\n/* ]]> */\n</script>\n", ), ); } @@ -2287,13 +2409,13 @@ HTML $this->assertSame( $expected_data, $wp_scripts->get_inline_script_data( $handle, $position ) ); $this->assertSame( $expected_data, $wp_scripts->print_inline_script( $handle, $position, false ) ); - $this->assertEqualMarkup( + $this->assertEqualHTML( $expected_tag, $wp_scripts->get_inline_script_tag( $handle, $position ) ); ob_start(); $output = $wp_scripts->print_inline_script( $handle, $position, true ); - $this->assertEqualMarkup( $expected_tag, ob_get_clean() ); + $this->assertEqualHTML( $expected_tag, ob_get_clean() ); $this->assertEquals( $expected_data, $output ); } @@ -2321,7 +2443,7 @@ HTML ); $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2348,7 +2470,7 @@ HTML ); $expected .= "<script type='text/javascript' src='/wp-content/plugins/my-plugin/js/script.js' id='plugin-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2375,7 +2497,7 @@ HTML ); $expected .= "<script type='text/javascript' src='/wp-content/themes/my-theme/js/script.js' id='theme-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2402,7 +2524,7 @@ HTML ); $expected .= "<script type='text/javascript' src='/wp-admin/js/script.js' id='script-handle-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2432,7 +2554,7 @@ HTML $expected = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js' id='wp-i18n-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-admin/js/script.js' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2461,7 +2583,7 @@ HTML ); $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2491,7 +2613,7 @@ HTML $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js' id='test-dependency-js'></script>\n"; $expected .= "<script type='text/javascript' src='/wp-includes/js/script2.js' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2880,7 +3002,7 @@ HTML $expected = "<script type='text/javascript' id='test-example-js-extra'>\n/* <![CDATA[ */\nvar testExample = {$expected};\n/* ]]> */\n</script>\n"; $expected .= "<script type='text/javascript' src='http://example.com' id='test-example-js'></script>\n"; - $this->assertEqualMarkup( $expected, get_echo( 'wp_print_scripts' ) ); + $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) ); } /** @@ -2945,7 +3067,7 @@ HTML $expected .= "<script type='text/javascript' src='/plugins/wp-i18n.js' id='wp-i18n-js'></script>\n"; $expected .= "<script type='text/javascript' src='/default/common.js' id='common-js'></script>\n"; - $this->assertEqualMarkup( $expected, $print_scripts ); + $this->assertEqualHTML( $expected, $print_scripts ); } /** @@ -2981,87 +3103,6 @@ HTML } /** - * Parse an HTML markup fragment. - * - * @param string $markup Markup. - * @return DOMDocument Document containing the normalized markup fragment. - */ - protected function parse_markup_fragment( $markup ) { - $dom = new DOMDocument(); - $dom->loadHTML( - "<!DOCTYPE html><html><head><meta charset=utf8></head><body>{$markup}</body></html>" - ); - - /** @var DOMElement $body */ - $body = $dom->getElementsByTagName( 'body' )->item( 0 ); - - // Trim whitespace nodes added before/after which can be added when parsing. - foreach ( array( $body->firstChild, $body->lastChild ) as $node ) { - if ( $node instanceof DOMText && '' === trim( $node->data ) ) { - $body->removeChild( $node ); - } - } - - // Normalize other whitespace nodes. - $xpath = new DOMXPath( $dom ); - foreach ( $xpath->query( '//text()' ) as $node ) { - /** @var DOMText $node */ - if ( preg_match( '/^\s+$/', $node->nodeValue ) ) { - $node->nodeValue = ' '; - } - } - - return $dom; - } - - /** - * Assert markup is equal after normalizing script tags. - * - * @param string $expected Expected markup. - * @param string $actual Actual markup. - * @param string $message Message. - */ - protected function assertEqualMarkup( $expected, $actual, $message = '' ) { - $expected_dom = $this->parse_markup_fragment( $expected ); - $actual_dom = $this->parse_markup_fragment( $actual ); - foreach ( array( $expected_dom, $actual_dom ) as $dom ) { - $xpath = new DOMXPath( $dom ); - /** @var DOMElement $script */ - - // Normalize type attribute. When missing, it defaults to text/javascript. - foreach ( $xpath->query( '//script[ not( @type ) ]' ) as $script ) { - $script->setAttribute( 'type', 'text/javascript' ); - } - - // Normalize script contents to remove CDATA wrapper. - foreach ( $xpath->query( '//script[ contains( text(), "<![CDATA[" ) ]' ) as $script ) { - $script->textContent = str_replace( - array( - "/* <![CDATA[ */\n", - "\n/* ]]> */", - ), - '', - $script->textContent - ); - } - - // Normalize XHTML-compatible boolean attributes to HTML5 ones. - foreach ( array( 'async', 'defer' ) as $attribute ) { - foreach ( iterator_to_array( $xpath->query( "//script[ @{$attribute} = '{$attribute}' ]" ) ) as $script ) { - $script->removeAttribute( $attribute ); - $script->setAttributeNode( $dom->createAttribute( $attribute ) ); - } - } - } - - $this->assertEquals( - $expected_dom->getElementsByTagName( 'body' )->item( 0 ), - $actual_dom->getElementsByTagName( 'body' )->item( 0 ), - $message - ); - } - - /** * Adds html5 script theme support. */ protected function add_html5_script_theme_support() { @@ -3100,8 +3141,8 @@ HTML wp_scripts()->do_footer_items(); $footer = ob_get_clean(); - $this->assertEqualMarkup( $expected_header, $header, 'Expected header script markup to match.' ); - $this->assertEqualMarkup( $expected_footer, $footer, 'Expected footer script markup to match.' ); + $this->assertEqualHTML( $expected_header, $header, '<body>', 'Expected header script markup to match.' ); + $this->assertEqualHTML( $expected_footer, $footer, '<body>', 'Expected footer script markup to match.' ); $this->assertEqualSets( $expected_in_footer, wp_scripts()->in_footer, 'Expected to have the same handles for in_footer.' ); $this->assertEquals( $expected_groups, wp_scripts()->groups, 'Expected groups to match.' ); } diff --git a/tests/phpunit/tests/rest-api/rest-settings-controller.php b/tests/phpunit/tests/rest-api/rest-settings-controller.php index e8f90b53f2..2e5e978655 100644 --- a/tests/phpunit/tests/rest-api/rest-settings-controller.php +++ b/tests/phpunit/tests/rest-api/rest-settings-controller.php @@ -385,14 +385,21 @@ class WP_Test_REST_Settings_Controller extends WP_Test_REST_Controller_Testcase } /** - * @doesNotPerformAssertions + * Settings can't be created */ public function test_create_item() { - // Controller does not implement create_item(). + wp_set_current_user( self::$administrator ); + + $request = new WP_REST_Request( 'POST', '/wp/v2/settings' ); + $request->set_param( 'new_setting', 'New value' ); + $response = rest_get_server()->dispatch( $request ); + + $this->assertSame( 400, $response->get_status() ); } public function test_update_item() { wp_set_current_user( self::$administrator ); + $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' ); $request->set_param( 'title', 'The new title!' ); $response = rest_get_server()->dispatch( $request ); @@ -403,6 +410,27 @@ class WP_Test_REST_Settings_Controller extends WP_Test_REST_Controller_Testcase $this->assertSame( get_option( 'blogname' ), $data['title'] ); } + public function test_update_nonexistent_item() { + wp_set_current_user( self::$administrator ); + + $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' ); + $request->set_param( 'i_do_no_exist', 'New value' ); + $response = rest_get_server()->dispatch( $request ); + + $this->assertSame( 400, $response->get_status() ); + } + + public function test_update_partially_valid_items() { + wp_set_current_user( self::$administrator ); + + $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' ); + $request->set_param( 'title', 'The new title!' ); + $request->set_param( 'i_do_no_exist', 'New value' ); + $response = rest_get_server()->dispatch( $request ); + + $this->assertSame( 400, $response->get_status() ); + } + public function update_setting_custom_callback( $result, $name, $value, $args ) { if ( 'title' === $name && 'The new title!' === $value ) { // Do not allow changing the title in this case. diff --git a/tests/phpunit/tests/user/getTheAuthorPosts.php b/tests/phpunit/tests/user/getTheAuthorPosts.php index 5cd87bc79b..3a0abac5de 100644 --- a/tests/phpunit/tests/user/getTheAuthorPosts.php +++ b/tests/phpunit/tests/user/getTheAuthorPosts.php @@ -42,7 +42,7 @@ class Tests_User_GetTheAuthorPosts extends WP_UnitTestCase { // Test with no global post, result should be 0 because no author is found. $this->assertSame( 0, get_the_author_posts() ); $GLOBALS['post'] = self::$post_id; - $this->assertEquals( 1, get_the_author_posts() ); + $this->assertSame( 1, get_the_author_posts() ); } /** @@ -60,7 +60,7 @@ class Tests_User_GetTheAuthorPosts extends WP_UnitTestCase { ); $GLOBALS['post'] = $cpt_ids[0]; - $this->assertEquals( 2, get_the_author_posts() ); + $this->assertSame( 2, get_the_author_posts() ); _unregister_post_type( 'wptests_pt' ); } diff --git a/tools/local-env/scripts/docker.js b/tools/local-env/scripts/docker.js index c1dc2b27e1..e39b42a812 100644 --- a/tools/local-env/scripts/docker.js +++ b/tools/local-env/scripts/docker.js @@ -1,21 +1,36 @@ -const dotenv = require( 'dotenv' ); +/* jshint node:true */ + +const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); -const { execSync } = require( 'child_process' ); +const { spawnSync } = require( 'child_process' ); const local_env_utils = require( './utils' ); dotenvExpand.expand( dotenv.config() ); const composeFiles = local_env_utils.get_compose_files(); -if (process.argv.includes('--coverage-html')) { +if ( process.argv.includes( '--coverage-html' ) ) { process.env.LOCAL_PHP_XDEBUG = 'true'; process.env.LOCAL_PHP_XDEBUG_MODE = 'coverage'; } -// This try-catch prevents the superfluous Node.js debugging information from being shown if the command fails. -try { - // Execute any Docker compose command passed to this script. - execSync( 'docker compose ' + composeFiles + ' ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } ); -} catch ( error ) { - process.exit( 1 ); +// Add --no-TTY (-T) arg after exec and run commands when STDIN is not a TTY. +const dockerCommand = process.argv.slice( 2 ); +if ( [ 'exec', 'run' ].includes( dockerCommand[0] ) && ! process.stdin.isTTY ) { + dockerCommand.splice( 1, 0, '--no-TTY' ); } + +// Execute any Docker compose command passed to this script. +const returns = spawnSync( + 'docker', + [ + 'compose', + ...composeFiles + .map( ( composeFile ) => [ '-f', composeFile ] ) + .flat(), + ...dockerCommand, + ], + { stdio: 'inherit' } +); + +process.exit( returns.status ); diff --git a/tools/local-env/scripts/install.js b/tools/local-env/scripts/install.js index 3bbc30d4d8..19a0f46e08 100644 --- a/tools/local-env/scripts/install.js +++ b/tools/local-env/scripts/install.js @@ -1,8 +1,10 @@ +/* jshint node:true */ + const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); const wait_on = require( 'wait-on' ); const { execSync } = require( 'child_process' ); -const { renameSync, readFileSync, writeFileSync } = require( 'fs' ); +const { readFileSync, writeFileSync } = require( 'fs' ); const local_env_utils = require( './utils' ); dotenvExpand.expand( dotenv.config() ); @@ -11,7 +13,10 @@ dotenvExpand.expand( dotenv.config() ); local_env_utils.determine_auth_option(); // Create wp-config.php. -wp_cli( 'config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force' ); +wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file="wp-config.php"` ); + +// Since WP-CLI runs as root, the wp-config.php created above will be read-only. This needs to be writable for the sake of E2E tests. +execSync( 'node ./tools/local-env/scripts/docker.js exec cli chmod 666 wp-config.php' ); // Add the debug settings to wp-config.php. // Windows requires this to be done as an additional step, rather than using the --extra-php option in the previous step. @@ -22,26 +27,35 @@ wp_cli( `config set SCRIPT_DEBUG ${process.env.LOCAL_SCRIPT_DEBUG} --raw --type= wp_cli( `config set WP_ENVIRONMENT_TYPE ${process.env.LOCAL_WP_ENVIRONMENT_TYPE} --type=constant` ); wp_cli( `config set WP_DEVELOPMENT_MODE ${process.env.LOCAL_WP_DEVELOPMENT_MODE} --type=constant` ); -// Move wp-config.php to the base directory, so it doesn't get mixed up in the src or build directories. -renameSync( `${process.env.LOCAL_DIR}/wp-config.php`, 'wp-config.php' ); - // Read in wp-tests-config-sample.php, edit it to work with our config, then write it to wp-tests-config.php. const testConfig = readFileSync( 'wp-tests-config-sample.php', 'utf8' ) .replace( 'youremptytestdbnamehere', 'wordpress_develop_tests' ) .replace( 'yourusernamehere', 'root' ) .replace( 'yourpasswordhere', 'password' ) .replace( 'localhost', 'mysql' ) - .replace( "'WP_TESTS_DOMAIN', 'example.org'", `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` ) - .concat( "\ndefine( 'FS_METHOD', 'direct' );\n" ); + .replace( `'WP_TESTS_DOMAIN', 'example.org'`, `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` ) + .concat( `\ndefine( 'FS_METHOD', 'direct' );\n` ); writeFileSync( 'wp-tests-config.php', testConfig ); // Once the site is available, install WordPress! -wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } ) +wait_on( { + resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`], + timeout: 3000, +} ) + .catch( err => { + console.error( `Error: It appears the development environment has not been started. Message: ${ err.message }` ); + console.error( `Did you forget to do 'npm run env:start'?` ); + process.exit( 1 ); + } ) .then( () => { wp_cli( 'db reset --yes' ); const installCommand = process.env.LOCAL_MULTISITE === 'true' ? 'multisite-install' : 'install'; wp_cli( `core ${ installCommand } --title="WordPress Develop" --admin_user=admin --admin_password=password --admin_email=test@example.com --skip-email --url=http://localhost:${process.env.LOCAL_PORT}` ); + } ) + .catch( err => { + console.error( `Error: Unable to reset DB and install WordPress. Message: ${ err.message }` ); + process.exit( 1 ); } ); /** @@ -50,7 +64,5 @@ wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } ) * @param {string} cmd The WP-CLI command to run. */ function wp_cli( cmd ) { - const composeFiles = local_env_utils.get_compose_files(); - - execSync( `docker compose ${composeFiles} run --quiet-pull --rm cli ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } ); + execSync( `npm --silent run env:cli -- ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } ); } diff --git a/tools/local-env/scripts/start.js b/tools/local-env/scripts/start.js index 0dc8b95700..b0389b2fb0 100644 --- a/tools/local-env/scripts/start.js +++ b/tools/local-env/scripts/start.js @@ -1,11 +1,13 @@ +/* jshint node:true */ + const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); -const { execSync } = require( 'child_process' ); +const { execSync, spawnSync } = require( 'child_process' ); const local_env_utils = require( './utils' ); const { constants, copyFile } = require( 'node:fs' ); // Copy the default .env file when one is not present. -copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, (e) => { +copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, () => { console.log( '.env file already exists. .env.example was not copied.' ); }); @@ -28,18 +30,38 @@ try { } // Start the local-env containers. -const containers = ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) - ? 'wordpress-develop memcached' - : 'wordpress-develop'; -execSync( `docker compose ${composeFiles} up --quiet-pull -d ${containers}`, { stdio: 'inherit' } ); +const containers = [ 'wordpress-develop', 'cli' ]; +if ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) { + containers.push( 'memcached' ); +} + +spawnSync( + 'docker', + [ + 'compose', + ...composeFiles.map( ( composeFile ) => [ '-f', composeFile ] ).flat(), + 'up', + '--quiet-pull', + '-d', + ...containers, + ], + { stdio: 'inherit' } +); // If Docker Toolbox is being used, we need to manually forward LOCAL_PORT to the Docker VM. if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) { // VBoxManage is added to the PATH on every platform except Windows. - const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage' + const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage'; // Check if the port forwarding is already configured for this port. - const vminfoBuffer = execSync( `"${ vboxmanage }" showvminfo "${ process.env.DOCKER_MACHINE_NAME }" --machinereadable` ); + const vminfoBuffer = spawnSync( + vboxmanage, + [ + 'showvminfo', + process.env.DOCKER_MACHINE_NAME, + '--machinereadable' + ] + ).stdout; const vminfo = vminfoBuffer.toString().split( /[\r\n]+/ ); vminfo.forEach( ( info ) => { @@ -53,10 +75,29 @@ if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) { // Delete rules that are using the port we need. if ( rule[ 3 ] === process.env.LOCAL_PORT || rule[ 5 ] === process.env.LOCAL_PORT ) { - execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 delete ${ rule[ 0 ] }`, { stdio: 'inherit' } ); + spawnSync( + vboxmanage, + [ + 'controlvm', + process.env.DOCKER_MACHINE_NAME, + 'natpf1', + 'delete', + rule[ 0 ] + ], + { stdio: 'inherit' } + ); } } ); // Add our port forwarding rule. - execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 "tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }"`, { stdio: 'inherit' } ); + spawnSync( + vboxmanage, + [ + 'controlvm', + process.env.DOCKER_MACHINE_NAME, + 'natpf1', + `tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }` + ], + { stdio: 'inherit' } + ); } diff --git a/tools/local-env/scripts/utils.js b/tools/local-env/scripts/utils.js index d76f3068a5..3f3e601db2 100644 --- a/tools/local-env/scripts/utils.js +++ b/tools/local-env/scripts/utils.js @@ -1,3 +1,5 @@ +/* jshint node:true */ + const { existsSync } = require( 'node:fs' ); const local_env_utils = { @@ -10,12 +12,14 @@ const local_env_utils = { * * When PHP 7.2 or 7.3 is used in combination with MySQL 8.4, an override file will also be returned to ensure * that the mysql_native_password plugin authentication plugin is on and available for use. + * + * @return {string[]} Compose files. */ get_compose_files: function() { - var composeFiles = '-f docker-compose.yml'; + const composeFiles = [ 'docker-compose.yml' ]; if ( existsSync( 'docker-compose.override.yml' ) ) { - composeFiles = composeFiles + ' -f docker-compose.override.yml'; + composeFiles.push( 'docker-compose.override.yml' ); } if ( process.env.LOCAL_DB_TYPE !== 'mysql' ) { @@ -28,7 +32,7 @@ const local_env_utils = { // PHP 7.2/7.3 in combination with MySQL 8.4 requires additional configuration to function properly. if ( process.env.LOCAL_DB_VERSION === '8.4' ) { - composeFiles = composeFiles + ' -f tools/local-env/old-php-mysql-84.override.yml'; + composeFiles.push( 'tools/local-env/old-php-mysql-84.override.yml' ); } return composeFiles; |