Merge pull request #375 from Yoast/feature/threshold-no-zero-exit-cod…

…e-on-below-threshold Threshold report: add new `YOASTCS_THRESHOLD_EXACT_MATCH` constant
Yoast · Apr 4, 2024 · ccc28df · ccc28df
2 parents 081c3f5 + 7bed8ba
commit ccc28df
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/Yoast/Reports/Threshold.php b/Yoast/Reports/Threshold.php
@@ -133,6 +133,7 @@ public function generate(
 		echo \PHP_EOL;
 
 		$above_threshold = false;
+		$below_threshold = false;
 
 		if ( $totalErrors > $error_threshold ) {
 			echo self::RED, 'Please fix any errors introduced in your code and run PHPCS again to verify.', self::RESET, \PHP_EOL;
@@ -141,6 +142,7 @@ public function generate(
 		elseif ( $totalErrors < $error_threshold ) {
 			echo self::GREEN, 'Found less errors than the threshold, great job!', self::RESET, \PHP_EOL;
 			echo 'Please update the ERRORS threshold in the composer.json file to ', self::GREEN, $totalErrors, '.', self::RESET, \PHP_EOL;
+			$below_threshold = true;
 		}
 
 		if ( $totalWarnings > $warning_threshold ) {
@@ -150,17 +152,26 @@ public function generate(
 		elseif ( $totalWarnings < $warning_threshold ) {
 			echo self::GREEN, 'Found less warnings than the threshold, great job!', self::RESET, \PHP_EOL;
 			echo 'Please update the WARNINGS threshold in the composer.json file to ', self::GREEN, $totalWarnings, '.', self::RESET, \PHP_EOL;
+			$below_threshold = true;
 		}
 
 		if ( $above_threshold === false ) {
 			echo \PHP_EOL;
 			echo 'Coding standards checks have passed!', \PHP_EOL;
 		}
 
-		// Make the threshold comparison outcome available to the calling script.
+		// Make the threshold comparison outcomes available to the calling script.
 		// The conditional define is only so as to make the method testable.
-		if ( \defined( 'YOASTCS_ABOVE_THRESHOLD' ) === false ) {
+		$exact_match = ( $above_threshold === false && $below_threshold === false );
+		if ( \defined( 'PHP_CODESNIFFER_IN_TESTS' ) === false ) {
 			\define( 'YOASTCS_ABOVE_THRESHOLD', $above_threshold );
+			\define( 'YOASTCS_THRESHOLD_EXACT_MATCH', $exact_match );
+		}
+		else {
+			// Only used in the tests to verify the above constants are being set correctly.
+			echo \PHP_EOL;
+			echo 'YOASTCS_ABOVE_THRESHOLD: ', ( $above_threshold === true ) ? 'true' : 'false', \PHP_EOL;
+			echo 'YOASTCS_THRESHOLD_EXACT_MATCH: ', ( $exact_match === true ) ? 'true' : 'false', \PHP_EOL;
 		}
 	}
 }
diff --git a/Yoast/Tests/Reports/ThresholdReportTest.php b/Yoast/Tests/Reports/ThresholdReportTest.php
@@ -121,6 +121,8 @@ public static function data_generate() {
 					. '\\033\[33mCoding standards WARNINGS: 300/0\.\\033\[0m\s+'
 					. '\\033\[31mPlease fix any errors introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
 					. '\\033\[33mPlease fix any warnings introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: true\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: false\s+'
 					. '`',
 			],
 			'Threshold: both errors and warnings below threshold' => [
@@ -136,6 +138,8 @@ public static function data_generate() {
 					. '\\033\[32mFound less warnings than the threshold, great job!\\033\[0m\s+'
 					. 'Please update the WARNINGS threshold in the composer.json file to \\033\[32m300\.\\033\[0m\s+'
 					. 'Coding standards checks have passed!\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: false\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: false\s+'
 					. '`',
 			],
 			'Threshold: both errors and warnings exactly at threshold' => [
@@ -147,6 +151,8 @@ public static function data_generate() {
 					. '\\033\[32mCoding standards ERRORS: 150/150\.\\033\[0m\s+'
 					. '\\033\[32mCoding standards WARNINGS: 300/300\.\\033\[0m\s+'
 					. 'Coding standards checks have passed!\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: false\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: true\s+'
 					. '`',
 			],
 			'Threshold: errors below threshold, warnings above' => [
@@ -160,6 +166,8 @@ public static function data_generate() {
 					. '\\033\[32mFound less errors than the threshold, great job!\\033\[0m\s+'
 					. 'Please update the ERRORS threshold in the composer\.json file to \\033\[32m150\.\\033\[0m\s+'
 					. '\\033\[33mPlease fix any warnings introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: true\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: false\s+'
 					. '`',
 			],
 			'Threshold: errors above threshold, warnings below' => [
@@ -173,6 +181,8 @@ public static function data_generate() {
 					. '\\033\[31mPlease fix any errors introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
 					. '\\033\[32mFound less warnings than the threshold, great job!\\033\[0m\s+'
 					. 'Please update the WARNINGS threshold in the composer.json file to \\033\[32m300\.\\033\[0m\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: true\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: false\s+'
 					. '`',
 			],
 			'Threshold: both errors and warnings above threshold' => [
@@ -185,6 +195,8 @@ public static function data_generate() {
 					. '\\033\[33mCoding standards WARNINGS: 300/200\.\\033\[0m\s+'
 					. '\\033\[31mPlease fix any errors introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
 					. '\\033\[33mPlease fix any warnings introduced in your code and run PHPCS again to verify\.\\033\[0m\s+'
+					. 'YOASTCS_ABOVE_THRESHOLD: true\s+'
+					. 'YOASTCS_THRESHOLD_EXACT_MATCH: false\s+'
 					. '`',
 			],
 		];