Update test cases to handle ETag being required

Signed-off-by: Shyamsundar Gadde <[email protected]>

Author: ShyamGadde

plugins/optimization-detective/tests/storage/test-class-od-url-metrics-post-type.php

@@ -90,6 +90,7 @@ public function data_provider_test_get_url_metrics_from_post(): array {
 		$valid_content = array(
 			array(
 				'url'       => home_url( '/' ),
+				'etag'      => md5( '' ),
 				'viewport'  => array(
 					'width'  => 640,
 					'height' => 480,

plugins/optimization-detective/tests/test-class-od-url-metric.php

@@ -31,8 +31,8 @@ public function data_provider_to_test_constructor(): array {
 		return array(
 			'valid_minimal'                   => array(
 				'data' => array(
-					// Note: The 'etag' field is currently optional, so this data is still valid without it.
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(),
@@ -127,14 +127,14 @@ static function ( $value ) {
 				'error' => 'OD_URL_Metric[etag] must be at most 32 characters long.',
 			),
 			'missing_etag'                    => array(
-				'data' => array(
+				'data'  => array(
 					'uuid'      => wp_generate_uuid4(),
 					'url'       => home_url( '/' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(),
 				),
-				// Note: Add error message 'etag is a required property of OD_URL_Metric.' when 'etag' becomes mandatory.
+				'error' => 'etag is a required property of OD_URL_Metric.',
 			),
 			'missing_viewport'                => array(
 				'data'  => array(
@@ -327,14 +327,9 @@ static function ( OD_Element $element ) {
 		$this->assertSame( $data['url'], $url_metric->get_url() );
 		$this->assertSame( $data['url'], $url_metric->get( 'url' ) );
 
-		// Note: When the 'etag' field becomes required, the else statement can be removed.
-		if ( array_key_exists( 'etag', $data ) ) {
-			$this->assertSame( $data['etag'], $url_metric->get_etag() );
-			$this->assertSame( $data['etag'], $url_metric->get( 'etag' ) );
-			$this->assertTrue( 1 === preg_match( '/^[a-f0-9]{32}$/', $url_metric->get_etag() ) );
-		} else {
-			$this->assertNull( $url_metric->get_etag() );
-		}
+		$this->assertSame( $data['etag'], $url_metric->get_etag() );
+		$this->assertSame( $data['etag'], $url_metric->get( 'etag' ) );
+		$this->assertTrue( 1 === preg_match( '/^[a-f0-9]{32}$/', $url_metric->get_etag() ) );
 
 		$this->assertTrue( wp_is_uuid( $url_metric->get_uuid() ) );
 		$this->assertSame( $url_metric->get_uuid(), $url_metric->get( 'uuid' ) );
@@ -370,6 +365,7 @@ public function data_provider_to_test_constructor_with_extended_schema(): array
 
 		$data = array(
 			'url'       => home_url( '/' ),
+			'etag'      => md5( '' ),
 			'viewport'  => $viewport,
 			'timestamp' => microtime( true ),
 			'elements'  => array( $valid_element ),
@@ -390,6 +386,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(),
@@ -424,6 +421,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(),
@@ -455,6 +453,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(),
@@ -478,6 +477,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(
@@ -516,6 +516,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array( $valid_element ),
@@ -545,6 +546,7 @@ static function ( array $properties ): array {
 				},
 				'data'   => array(
 					'url'       => home_url( '/' ),
+					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
 					'timestamp' => microtime( true ),
 					'elements'  => array(
@@ -917,8 +919,7 @@ public function test_get_json_schema_extensibility( Closure $set_up, Closure $as
 	 */
 	protected function check_schema_subset( array $schema, string $path, bool $extended = false ): void {
 		$this->assertArrayHasKey( 'required', $schema, $path );
-		// Skipping the check for 'root/etag' as it is currently optional.
-		if ( ! $extended && 'root/etag' !== $path ) {
+		if ( ! $extended ) {
 			$this->assertTrue( $schema['required'], $path );
 		}
 		$this->assertArrayHasKey( 'type', $schema, $path );

plugins/optimization-detective/tests/test-class-od-url-metrics-group.php

@@ -73,6 +73,7 @@ public function data_provider_test_construction(): array {
 					new OD_URL_Metric(
 						array(
 							'url'       => home_url( '/' ),
+							'etag'      => md5( '' ),
 							'viewport'  => array(
 								'width'  => 1,
 								'height' => 2,
@@ -263,21 +264,6 @@ public function data_provider_test_is_complete(): array {
 				),
 				'expected_is_group_complete' => false,
 			),
-			// Note: The following test case will not be required once the ETag is mandatory in a future release.
-			'etag_missing'   => array(
-				'url_metric'                 => new OD_URL_Metric(
-					array(
-						'url'       => home_url( '/' ),
-						'viewport'  => array(
-							'width'  => 400,
-							'height' => 700,
-						),
-						'timestamp' => microtime( true ),
-						'elements'  => array(),
-					)
-				),
-				'expected_is_group_complete' => false,
-			),
 			'etag_mismatch'  => array(
 				'url_metric'                 => $this->get_sample_url_metric( array( 'etag' => md5( 'different_etag' ) ) ),
 				'expected_is_group_complete' => false,