open-issues.php

<?php

/*
 * Remove issues to be filtered away.
 *
 * If there are any periods or spaces at the beginning
 * or end of issue messages, ignore those when doing comparison.
 * Do the same with $ignorable_issues.
 */
function vipgocs_filter_ignorable_issues(
	array $ignorable_issues,
	array $all_results
) :array {
	$ignorable_issues = array_map(
		function( $item ) {
			return trim(
				$item,
				' .'
			);
		},
		$ignorable_issues
	);

	foreach(
		$all_results['files'] as
			$file_path => &$file_issues // $file_issues is a pointer
	) {
		foreach(
			$file_issues['messages'] as
				$file_issue_key => $file_issue_item
		) {
			/*
			 * Remove possible period or space
			 */
			$file_issue_item['message'] = trim(
				$file_issue_item['message'],
				' .'
			);

			/*
			 * Check if message is there, remove if so.
			 */
			if ( in_array(
				$file_issue_item['message'],
				$ignorable_issues
			) ) {
				unset(
					$file_issues['messages']
						[ $file_issue_key ]
				);

				continue;
			}
		}

		/*
		 * Recreate messages to avoid gaps in index.
		 */
		$file_issues['messages'] = array_values(
			$file_issues['messages']
		);
	}

	return $all_results;
}

/*
 * Open up issues on GitHub for each
 * problem we found when scanning.
 */
function vipgocs_open_issues(
	array $options,
	array $all_results,
	string $git_branch,
	array $labels,
	array $assignees = array(),
	bool $emulate_only = false
) :array {

	/*
	 * Keep some statistics on what
	 * we do.
	 */
	$issue_statistics = array(
		'phpcs_issues_found'	=> 0,
		'github_issues_opened'	=> 0,
	);

	vipgoci_log(
		( $emulate_only ? 'Emulating o' : 'O' ) . 'pening up issues on GitHub for problems found',
		array(
			'repo-owner'			=> $options['repo-owner'],
			'repo-name'			=> $options['repo-name'],
			'github_issue_title'		=> $options['github-issue-title'],
			'github_issue_body'		=> $options['github-issue-body'],
			'issues'			=> $all_results,
			'assignees'			=> $assignees,
			'emulate_only'			=> $emulate_only,
		)
	);

	/*
	 * Remove irrellevant results
	 */
	if ( ! empty( $options['review-comments-ignore'] ) ) {
		$all_results = vipgocs_filter_ignorable_issues(
			$options['review-comments-ignore'],
			$all_results
		);
	}

	foreach(
		$all_results['files'] as
			$file_path => $file_issues
	) {

		/*
		 * No issues, nothing to do.
		 */
		if ( empty( $file_issues['messages'] ) ) {
			continue;
		}

		/*
		 * Compose string to post as body of an issue.
		 */
		$error_msg = '';

		foreach( $file_issues['messages'] as $file_issue ) {
			/*
			 * Construct link to file
			 */
			$error_msg_link =
				$file_issue['github_commit_url'] . '/';

			if ( false === $file_issue['file_is_in_submodule'] ) {
				$error_msg_link .= $file_issue['file_relative_path'];
			}

			else {
				$error_msg_link .= $file_issue['file_path_without_submodule'];
			}

			$error_msg_link .=
				'#L' . $file_issue['line'];

			/*
			 * Construct error message
			 */
			$error_msg .=
				'* <b>' .
					ucfirst ( strtolower(
						$file_issue['type']
					) );

			if ( 'folder' === $options['github-issue-group-by'] ) {
				$error_msg .= ' in ' .
					$file_issue['file_relative_path'];
			}

			$error_msg .= '</b>: ' .
				$file_issue['message'];


			if ( false === $file_issue['file_is_in_submodule'] ) {
				$error_msg .=
					' ' .
					$error_msg_link;
			}

			else {
				$error_msg .=
					'. In submodule, <a href="' . $error_msg_link . '">here</a>.';
			}

			$error_msg .=
				PHP_EOL . PHP_EOL;

			$issue_statistics['phpcs_issues_found']++;
		}

		$github_url =
			VIPGOCI_GITHUB_BASE_URL . '/' .
			'repos/' .
			rawurlencode( $options['repo-owner'] ) . '/' .
			rawurlencode( $options['repo-name'] ) . '/' .
			'issues';

		/*
		 * Create issue on GitHub.
		 */
		$github_req_body =
			array(
				'title'		=>
					$options['github-issue-title'] . $file_path,
				'body'		=>
					str_replace(
						array(
							'%error_msg%',
							'%branch_name%',
						),
						array(
							PHP_EOL . $error_msg . PHP_EOL . PHP_EOL,
							$git_branch,
						),
						$options['github-issue-body'] . PHP_EOL
					)
			);

		if ( ! empty( $options['github-labels'] ) ) {
			$github_req_body['labels'] = $labels;
		}

		if ( ! empty( $assignees ) ) {
			$github_req_body['assignees'] = $assignees;
		}

		if ( false === $emulate_only ) {
			$res = vipgoci_http_api_post_url(
				$github_url,
				$github_req_body,
				$options['token'],
				false,
				true,
				CURL_HTTP_VERSION_1_1,
				'application/x-www-form-urlencoded'
			);
		}

		$issue_statistics['github_issues_opened']++;

		/*
		 * Clean up and return.
		 */
		unset( $github_url );
		unset( $res );
		unset( $file_path );
		unset( $file_issues );
		unset( $error_msg );

		gc_collect_cycles();

		sleep( 2 + rand( 0, 3 ));
	}

	vipgoci_log(
		( $emulate_only ? 'Emulated' : 'Finished' ) . ' opening up issues on GitHub',
		array(
			'issue_statistics' => $issue_statistics,
		)
	);

	return $issue_statistics;
}