Changeset 58971

Timestamp:

09/03/2024 04:25:16 PM (2 years ago)

Author:

dmsnell

Message:

HTML API: Improve skipped test reporting with unsupported exception.

The html5lib-tests suite skips a number of tests due to unsupported markup. At the moment, these tests all report "Test includes unsupported markup." This patch calls the get_unsupported_exception() method in these skipped cases to improve the messages reported to PHPUnit so they're more informative: e.g. "Unsupported markup: Foster parenting is not supported."

Developed in ​https://github.com/WordPress/wordpress-develop/pull/7285
Discussed in https://core.trac.wordpress.org/ticket/61646

Follow-up to [58714].

Props dmsnell, jonsurrell.
See #61646.

File:

• trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php (modified) (4 diffs)

trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php

@@ -55 +55 @@
          */
         public function test_parse( ?string $fragment_context, string $html, string $expected_tree ) {
-                $processed_tree = self::build_tree_representation( $fragment_context, $html );
+                try {
+                        $processed_tree = self::build_tree_representation( $fragment_context, $html );
+                } catch ( WP_HTML_Unsupported_Exception $e ) {
+                        $this->markTestSkipped( "Unsupported markup: {$e->getMessage()}" );
+                        return;
+                }
 
                 if ( null === $processed_tree ) {
                         $this->markTestSkipped( 'Test includes unsupported markup.' );
-                }
+                        return;
+                }
+
                 $fragment_detail = $fragment_context ? " in context <{$fragment_context}>" : '';
 
@@ -156 +163 @@
                         : WP_HTML_Processor::create_full_parser( $html );
                 if ( null === $processor ) {
-                        return null;
+                        throw new WP_HTML_Unsupported_Exception( "Could not create a parser with the given fragment context: {$fragment_context}.", '', 0, '', array(), array() );
                 }
 
@@ -171 +178 @@
 
                 while ( $processor->next_token() ) {
-                        if ( ! is_null( $processor->get_last_error() ) ) {
-                                return null;
+                        if ( null !== $processor->get_last_error() ) {
+                                break;
                         }
 
@@ -336 +343 @@
                 }
 
-                if ( ! is_null( $processor->get_last_error() ) ) {
-                        return null;
+                if ( null !== $processor->get_unsupported_exception() ) {
+                        throw $processor->get_unsupported_exception();
+                }
+
+                if ( null !== $processor->get_last_error() ) {
+                        throw new WP_HTML_Unsupported_Exception( "Parser error: {$processor->get_last_error()}", '', 0, '', array(), array() );
                 }
 
                 if ( $processor->paused_at_incomplete_token() ) {
-                        return null;
+                        throw new WP_HTML_Unsupported_Exception( 'Paused at incomplete token.', '', 0, '', array(), array() );
                 }