Merge pull request #4 from wp-graphql/feature/not-modifier

"WPGraphQLTestCommon::not()" implemented and tested.
wp-graphql · Mar 31, 2021 · 79e48d5 · 79e48d5
2 parents 20d4fa8 + 8159d71
commit 79e48d5
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 21 deletions.
diff --git a/src/TestCase/WPGraphQLTestCommon.php b/src/TestCase/WPGraphQLTestCommon.php
@@ -51,7 +51,7 @@ public function toRelayId() {
 	 * @return array
 	 */
 	public function expectedObject( string $path, $expected_value ) {
-		$type = 'OBJECT';
+		$type = $this->get_not() . 'OBJECT';
 		return compact( 'type', 'path', 'expected_value' );
 	}
 
@@ -64,7 +64,7 @@ public function expectedObject( string $path, $expected_value ) {
 	 * @return array
 	 */
 	public function expectedNode( string $path, $expected_value = null, $expected_index = null ) {
-		$type = 'NODE';
+		$type = $this->get_not() . 'NODE';
 		return compact( 'type', 'path', 'expected_value', 'expected_index' );
 	}
 
@@ -77,10 +77,31 @@ public function expectedNode( string $path, $expected_value = null, $expected_in
 	 * @return array
 	 */
 	public function expectedEdge( string $path, $expected_value = null, $expected_index = null ) {
-		$type = 'EDGE';
+		$type = $this->get_not() . 'EDGE';
 		return compact( 'type', 'path', 'expected_value', 'expected_index' );
 	}
 
+	/**
+	 * Triggers the "not" flag for the next expect*() call.
+	 *
+	 * @return WPGraphQLTestCommon
+	 */
+	public function not() {
+		$this->not = '!';
+		return $this;
+	}
+
+	/**
+	 * Clears the "not" flag and return the proper prefix.
+	 *
+	 * @return string
+	 */
+	private function get_not() {
+		$prefix = $this->not ? '!' : '';
+		unset( $this->not );
+		return $prefix;
+	}
+
 	/**
 	 * Returns an expected "location" error data object.
 	 *
@@ -201,8 +222,8 @@ public function assertExpectedDataFound( array $response, array $expected_data,
 		}
 
 		// Evaluate expected data.
-		switch( $type ) {
-			case 'OBJECT':
+		switch( true ) {
+			case $this->endsWith( 'OBJECT', $type ):
 				// Log assertion.
 				$actual_log_type = is_array( $actual_data ) ? 'ACTUAL_DATA_OBJECT' : 'ACTUAL_DATA';
 				$assertion_log = array(
@@ -211,18 +232,21 @@ public function assertExpectedDataFound( array $response, array $expected_data,
 				);
 				$this->logData( $assertion_log );
 
+				$assert_same       = ! $this->startsWith( '!', $type );
+				$assertion         = $assert_same ? 'assertSame' : 'assertNotSame';
+				$assertion_message = $assert_same ? 'doesn\'t match' : 'shouldn\'t match';
 				// Execute assertion.
-				$this->assertSame(
+				$this->$assertion(
 					$expected_value,
 					$actual_data,
 					$this->maybe_print_message(
 						$message,
-						sprintf( 'Data found at path "%s" doesn\'t match the provided value', $actual_path )
+						sprintf( 'Data found at path "%1$s" %2$s the provided value', $actual_path, $assertion_message )
 					)
 				);
 				break;
-			case 'NODE':
-			case 'EDGE':
+			case $this->endsWith( 'NODE', $type ):
+			case $this->endsWith( 'EDGE', $type ):
 				if ( $check_order ) {
 					// Log assertion.
 					$actual_log_type = is_array( $actual_data ) ? 'ACTUAL_DATA_OBJECT' : 'ACTUAL_DATA';
@@ -232,13 +256,16 @@ public function assertExpectedDataFound( array $response, array $expected_data,
 					);
 					$this->logData( $assertion_log );
 
+					$assert_same       = ! $this->startsWith( '!', $type );
+					$assertion         = $assert_same ? 'assertSame' : 'assertNotSame';
+					$assertion_message = $assert_same ? 'doesn\'t match' : 'shouldn\'t match';
 					// Execute assertion
-					$this->assertSame(
+					$this->$assertion(
 						$expected_value,
 						$actual_data,
 						$this->maybe_print_message(
 							$message,
-							sprintf( 'Data found at path "%s" doesn\'t match the provided value', $actual_path )
+							sprintf( 'Data found at path "%1$s" %2$s the provided value', $actual_path, $assertion_message )
 						)
 					);
 					break;
@@ -250,20 +277,37 @@ public function assertExpectedDataFound( array $response, array $expected_data,
 				);
 				$this->logData( $assertion_log );
 
-				foreach ( $actual_data as $actual_node ) {
+				$assert_same       = ! $this->startsWith( '!', $type );
+				foreach ( $actual_data as $index => $actual_node ) {
 					// If match found, Assert true.
 					if ( $expected_value === $actual_node ) {
-						$this->assertTrue( true );
-						break 2;
+						if ( $assert_same ) {
+							$this->assertTrue( true );
+							break 2;
+						} else {
+							$this->assertTrue(
+								false,
+								$this->maybe_print_message(
+									$message,
+									sprintf( 'Undesired data found in %1$s list at path "%2$s.%3$d"', strtolower( $type ), $actual_path, $index )
+								)
+							);
+						}
 					}
 				}
-				$this->assertTrue(
-					false,
-					$this->maybe_print_message(
-						$message,
-						sprintf( 'Expected data not found in the %1$s list at path "%2$s"', strtolower( $type ), $actual_path )
-					)
-				);
+
+				if ( $assert_same ) {
+					$this->assertTrue(
+						false,
+						$this->maybe_print_message(
+							$message,
+							sprintf( 'Expected data not found in the %1$s list at path "%2$s"', strtolower( $type ), $actual_path )
+						)
+					);
+				}
+
+				$this->assertTrue( true );
+
 				break;
 			default:
 				throw new \Exception( 'Invalid data object provided for evaluation.' );

diff --git a/tests/codeception/wpunit/WPGraphQLTestCaseTest.php b/tests/codeception/wpunit/WPGraphQLTestCaseTest.php
@@ -45,6 +45,10 @@ public function testAssertQuerySuccessful() {
 			$this->expectedNode(
 				'posts.nodes',
 				array( 'id' => $this->toRelayId( 'post', $post_id ) )
+			),
+			$this->not()->expectedNode(
+				'posts.nodes',
+				array( 'id' => $this->toRelayId( 'post', 10001 ) )
 			)
 		);
 

diff --git a/tests/phpunit/unit/test-wpgraphqlunittestcase.php b/tests/phpunit/unit/test-wpgraphqlunittestcase.php
@@ -41,6 +41,10 @@ public function test_AssertQuerySuccessful() {
 			$this->expectedNode(
 				'posts.nodes',
 				array( 'id' => $this->toRelayId( 'post', $post_id ) )
+			),
+			$this->not()->expectedNode(
+				'posts.nodes',
+				array( 'id' => $this->toRelayId( 'post', 10001 ) )
 			)
 		);