Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bot feedback message for limit of lines exceeded #204

Merged
merged 1 commit into from
Sep 8, 2021
Merged

Fix bot feedback message for limit of lines exceeded #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions github-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2501,7 +2501,8 @@ function vipgoci_github_pr_review_submit(
$results,
$informational_msg,
$github_review_comments_max,
$github_review_comments_include_severity
$github_review_comments_include_severity,
int $skip_large_files_limit
) {

$stats_types_to_process = array(
Expand Down Expand Up @@ -2814,7 +2815,7 @@ function vipgoci_github_pr_review_submit(

$github_postfields[ 'body' ] .= vipgoci_get_skipped_files_message(
$results[ VIPGOCI_SKIPPED_FILES ][ $pr_number ],
$pr_number
$skip_large_files_limit
);
}

Expand Down
7 changes: 4 additions & 3 deletions main.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ function vipgoci_help_print( $argv ) {
"\t" . '--skip-large-files=true=BOOL If true, skip scanning files that have number of lines higher than the skip-large-files-limit value.' . PHP_EOL .
"\t" . ' Default is true.' . PHP_EOL .
"\t" . '--skip-large-files-limit=INTEGER Defines the maximum number of lines limit per file.' . PHP_EOL .
"\t" . ' Default is 15000 lines.' . PHP_EOL .
"\t" . ' Default is ' . VIPGOCI_VALIDATION_MAXIMUM_LINES_LIMIT . ' lines.' . PHP_EOL .
"\t" . '--branches-ignore=STRING,... What branches to ignore -- useful to make sure' . PHP_EOL .
"\t" . ' some branches never get scanned. Separate branches' . PHP_EOL .
"\t" . ' with commas.' . PHP_EOL .
Expand Down Expand Up @@ -828,7 +828,7 @@ function vipgoci_run() {
range( 0, 500, 1 )
);

vipgoci_option_integer_handle( $options, 'skip-large-files-limit', 15000 );
vipgoci_option_integer_handle( $options, 'skip-large-files-limit', VIPGOCI_VALIDATION_MAXIMUM_LINES_LIMIT );

/*
* Handle boolean parameters
Expand Down Expand Up @@ -2190,7 +2190,8 @@ function vipgoci_run() {
$results,
$options['informational-msg'],
$options['review-comments-max'],
$options['review-comments-include-severity']
$options['review-comments-include-severity'],
$options['skip-large-files-limit']
);

if ( true === $options['dismiss-stale-reviews'] ) {
Expand Down
12 changes: 8 additions & 4 deletions skip-file.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,19 @@ function vipgoci_set_prs_implicated_skipped_files(
}

/**
* @param $skipped
* @param array $skipped
* @param int $skip_large_files_limit
*
* @return string
*/
function vipgoci_get_skipped_files_message( array $skipped ): string
function vipgoci_get_skipped_files_message( array $skipped, int $skip_large_files_limit ): string
{
$body = PHP_EOL . '**' . VIPGOCI_SKIPPED_FILES . '**' . PHP_EOL . PHP_EOL;
foreach ( $skipped[ 'issues' ] as $issue => $file ) {
$body .= vipgoci_get_skipped_files_issue_message(
$skipped[ 'issues' ][ $issue ],
$issue
$issue,
$skip_large_files_limit
);
}

Expand All @@ -71,14 +73,16 @@ function vipgoci_get_skipped_files_message( array $skipped ): string
/**
* @param array $affected_files
* @param string $issue_type
* @param int $max_lines
*
* Get Markdown Skipped File error message
*
* @return string
*/
function vipgoci_get_skipped_files_issue_message(
array $affected_files,
string $issue_type,
int $max_lines = 15000
int $max_lines
): string {
$affected_files = implode( PHP_EOL . ' - ', $affected_files );
$validation_message = sprintf(
Expand Down
30 changes: 28 additions & 2 deletions tests/VipgociSkipFileTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public function testGetSkippedFilesMessage() {
),
'total' => 2
);
$skipped_files_message = vipgoci_get_skipped_files_message( $skipped );
$skipped_files_message = vipgoci_get_skipped_files_message( $skipped, 15000 );

$expected_skipped_files_message = '
**skipped-files**
Expand All @@ -186,6 +186,31 @@ public function testGetSkippedFilesMessage() {
- MyFailedClass.php
- MyFailedClass2.php

Note that the above file(s) were not analyzed due to their length.';

$this->assertSame( $expected_skipped_files_message, $skipped_files_message );
}

/**
* @covers ::vipgoci_get_skipped_files_message
*/
public function testGetSkippedFilesMessageWithNumberOfLinesExceededDifferentThanDefault() {

$skipped = array(
'issues' => array(
'max-lines' => array( 'MyFailedClass.php', 'MyFailedClass2.php' )
),
'total' => 2
);
$skipped_files_message = vipgoci_get_skipped_files_message( $skipped, 25000 );

$expected_skipped_files_message = '
**skipped-files**

Maximum number of lines exceeded (25000):
- MyFailedClass.php
- MyFailedClass2.php

Note that the above file(s) were not analyzed due to their length.';

$this->assertSame( $expected_skipped_files_message, $skipped_files_message );
Expand All @@ -199,7 +224,8 @@ public function testGetSkippedFilesIssueMessage() {

$skipped_files_issue_message = vipgoci_get_skipped_files_issue_message(
$affected_files_mock,
'max-lines'
'max-lines',
15000
);

$expected_skipped_files_issue_message = 'Maximum number of lines exceeded (15000):
Expand Down