Adding test for vipgoci_run_scan_total_comments_max_warning_post()

pewresearch · Feb 1, 2022 · fe4a899 · fe4a899
1 parent e7199ef
commit fe4a899
Show file tree

Hide file tree

Showing 2 changed files with 254 additions and 0 deletions.
diff --git a/tests/integration/RunScanTotalCommentsMaxWarningPostTest.php b/tests/integration/RunScanTotalCommentsMaxWarningPostTest.php
@@ -0,0 +1,251 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vipgoci\Tests\Integration;
+
+require_once( __DIR__ . '/IncludesForTests.php' );
+
+use PHPUnit\Framework\TestCase;
+
+// phpcs:disable PSR1.Files.SideEffects
+
+final class RunScanTotalCommentsMaxWarningPostTest extends TestCase {
+	var $options_git = array(
+		'repo-owner' => null,
+		'repo-name'  => null,
+	);
+
+	var $options_commit = array(
+		'commit-test-run-scan-total-comments-max-warning-post' => null,
+		'pr-test-run-scan-total-comments-max-warning-post'     => null,
+	);
+
+	protected function setUp(): void {
+		vipgoci_unittests_get_config_values(
+			'git',
+			$this->options_git
+		);
+
+		vipgoci_unittests_get_config_values(
+			'git-repo-tests',
+			$this->options_commit
+		);
+
+		$this->options['github-token'] =
+			vipgoci_unittests_get_config_value(
+				'git-secrets',
+				'github-token',
+				true // Fetch from secrets file
+			);
+
+		$this->options = array_merge(
+			$this->options,
+			$this->options_git,
+			$this->options_commit,
+		);
+
+		$this->options['token'] = $this->options['github-token'];
+
+		$this->options['commit'] = $this->options['commit-test-run-scan-total-comments-max-warning-post'];
+		$this->options['pr_number'] = $this->options['pr-test-run-scan-total-comments-max-warning-post'];
+
+		if ( ! empty( $this->options['token'] ) ) {
+			vipgoci_unittests_output_suppress();
+
+			$this->current_user_info = vipgoci_github_authenticated_user_get(
+				$this->options['token']
+			);
+
+			vipgoci_unittests_output_unsuppress();
+
+			$this->_clearOldComments();
+		}
+	}
+
+	protected function tearDown(): void {
+		if ( ! empty( $this->options['token'] ) ) {
+			$this->_clearOldComments();
+		}
+
+		$this->options = null;
+		$this->options_git = null;
+		$this->options_commit = null;
+
+		$this->current_user_info = null;
+	}
+
+	private function _verifyIsOurComment( $comment_item ) :bool {
+		if ( ( strpos(
+			$comment_item->body,
+			VIPGOCI_REVIEW_COMMENTS_TOTAL_MAX
+		) ) === false ) {
+			return false;
+		}
+
+		if ( $this->current_user_info->login === $comment_item->user->login ) {
+			return true;
+		}
+
+		return false;
+	}
+
+	private function _clearOldComments(): void {
+		// Clear internal cache so comments are fetched each time
+		vipgoci_cache( VIPGOCI_CACHE_CLEAR );
+
+		vipgoci_unittests_output_suppress();
+
+		$all_comments = vipgoci_github_pr_generic_comments_get_all(
+			$this->options['repo-owner'],
+			$this->options['repo-name'],
+			$this->options['pr_number'],
+			$this->options['token']
+		);
+
+		foreach( $all_comments as $comment_item ) {
+			if ( true === $this->_verifyIsOurComment( $comment_item ) ) {
+				vipgoci_github_pr_generic_comment_delete(
+					$this->options['repo-owner'],
+					$this->options['repo-name'],
+					$this->options['token'],
+					$comment_item->id
+				);
+			}
+		}
+
+		vipgoci_unittests_output_unsuppress();
+
+		// Clear internal cache so comments are fetched each time
+		vipgoci_cache( VIPGOCI_CACHE_CLEAR );
+	}
+
+	/**
+	 * @covers ::vipgoci_run_scan_total_comments_max_warning_post
+	 */
+	public function testTotalCommentsReachedMax(): void {
+		$options_test = vipgoci_unittests_options_test(
+			$this->options,
+			array( 'github-token', 'token' ),
+			$this
+		);
+
+		if ( -1 === $options_test ) {
+			return;
+		}
+
+		$this->options['review-comments-total-max'] = 100;
+
+		$prs_comments_maxed = array(
+			$this->options['pr_number'] => array(),
+		);
+
+
+		// Clear internal cache so comments are fetched each time
+		vipgoci_cache( VIPGOCI_CACHE_CLEAR );
+
+		vipgoci_unittests_output_suppress();
+
+		$all_comments = vipgoci_github_pr_generic_comments_get_all(
+			$this->options['repo-owner'],
+			$this->options['repo-name'],
+			$this->options['pr_number'],
+			$this->options['token']
+		);
+
+		vipgoci_unittests_output_unsuppress();
+
+		$this->assertEmpty( $all_comments );
+
+		vipgoci_unittests_output_suppress();
+
+		vipgoci_run_scan_total_comments_max_warning_post(
+			$this->options,
+			$prs_comments_maxed
+		);
+
+		vipgoci_unittests_output_unsuppress();
+
+
+		sleep(5); // Give API time to catch up
+
+		// Clear internal cache so comments are fetched each time
+		vipgoci_cache( VIPGOCI_CACHE_CLEAR );
+
+		vipgoci_unittests_output_suppress();
+
+		$all_comments = vipgoci_github_pr_generic_comments_get_all(
+			$this->options['repo-owner'],
+			$this->options['repo-name'],
+			$this->options['pr_number'],
+			$this->options['token']
+		);
+
+		vipgoci_unittests_output_unsuppress();
+
+		$this->assertNotEmpty( $all_comments );
+
+		$i = 0;
+
+		foreach( $all_comments as $comment_item ) {
+			$this->assertTrue( $this->_verifyIsOurComment( $comment_item ) );
+			$i++;
+		}
+
+		$this->assertTrue( $i > 0 );
+	}
+
+	public function testTotalCommentsDidNotReachMax(): void {
+		$options_test = vipgoci_unittests_options_test(
+			$this->options,
+			array( 'github-token', 'token' ),
+			$this
+		);
+
+		if ( -1 === $options_test ) {
+			return;
+		}
+
+		$this->options['review-comments-total-max'] = 0;
+
+		$prs_comments_maxed = array(
+			$this->options['pr_number'] => array(),
+		);
+
+		// Clear internal cache so comments are fetched each time
+		vipgoci_cache( VIPGOCI_CACHE_CLEAR );
+
+		vipgoci_unittests_output_suppress();
+
+		$all_comments = vipgoci_github_pr_generic_comments_get_all(
+			$this->options['repo-owner'],
+			$this->options['repo-name'],
+			$this->options['pr_number'],
+			$this->options['token']
+		);
+
+		vipgoci_unittests_output_unsuppress();
+
+		$this->assertEmpty( $all_comments );
+
+		vipgoci_unittests_output_suppress();
+
+		vipgoci_run_scan_total_comments_max_warning_post(
+			$this->options,
+			$prs_comments_maxed
+		);
+
+		sleep(5); // Give API time to catch up
+
+		$all_comments = vipgoci_github_pr_generic_comments_get_all(
+			$this->options['repo-owner'],
+			$this->options['repo-name'],
+			$this->options['pr_number'],
+			$this->options['token']
+		);
+
+		vipgoci_unittests_output_unsuppress();
+
+		$this->assertEmpty( $all_comments );
+	}
+}
diff --git a/unittests.ini.dist b/unittests.ini.dist
@@ -105,6 +105,9 @@ commit-test-submodule-list-get-1=f2008d8519d998d9e38f5688aaa2c5322179a266
 commit-test-submodule-list-get-2=dd18779e980f0302ab4acf7e871d2062d86b5f58
 pr-test-github-pr-results-max=28
 
+commit-test-run-scan-total-comments-max-warning-post=82b587df233dc1f264f792fe8ee9265118dc68b7
+pr-test-run-scan-total-comments-max-warning-post=44
+
 [labels]
 labels-pr-to-modify=12