HTML API: Improve skipped test reporting with unsupported exception.

dmsnell · dmsnell · commit f79de00cce67 · 2024-09-03T16:25:16.000Z
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 #7285 Discussed in https://core.trac.wordpress.org/ticket/61646 Follow-up to [58714]. Props dmsnell, jonsurrell. See #61646. git-svn-id: https://develop.svn.wordpress.org/trunk@58971 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php b/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php
@@ -54,11 +54,18 @@ class Tests_HtmlApi_Html5lib extends WP_UnitTestCase {
 	 * @param string $expected_tree    Tree structure of parsed HTML.
 	 */
 	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}>" : '';
 
 		/*
@@ -155,7 +162,7 @@ private static function build_tree_representation( ?string $fragment_context, st
 			? WP_HTML_Processor::create_fragment( $html, "<{$fragment_context}>" )
 			: 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() );
 		}
 
 		/*
@@ -170,8 +177,8 @@ private static function build_tree_representation( ?string $fragment_context, st
 		$text_node    = '';
 
 		while ( $processor->next_token() ) {
-			if ( ! is_null( $processor->get_last_error() ) ) {
-				return null;
+			if ( null !== $processor->get_last_error() ) {
+				break;
 			}
 
 			$token_name = $processor->get_token_name();
@@ -335,12 +342,16 @@ static function ( $a, $b ) {
 			}
 		}
 
-		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() );
 		}
 
 		if ( '' !== $text_node ) {
