Merge pull request #143 from Automattic/feature-more-options-from-repo

Allow more options to be configured from repo options file.

README.md

@@ -266,7 +266,7 @@ Any parameter can be read from the environment, not just those shown. Parameters
 
 ### Configuration via repository config-file
 
-A few options can currently be configured via a repository config-file. This way, users with commit-access to a git repository can influence the behaviour of `vip-go-ci` when it scans the repository. The idea is to allow users flexibility in how scanning is performed. Various sanity checks are made to the configuration options read. The options that can be specified via repository options are outlined below. A default configuration option is overwritten during run-time by the new value, should it be valid. 
+A number of options can currently be configured via a repository config-file. This way, users with commit-access to a git repository can influence the behaviour of `vip-go-ci` when it scans the repository. The idea is to allow users flexibility in how scanning is performed. Various sanity checks are made to the configuration options read. Some options that can be specified via repository options are outlined below, while others are documented along with the feature itself below (see for example section on PHPCS). A default configuration option is overwritten during run-time by the new value, should it be valid. `vip-go-ci` can be configured to allow only certain options to be configured via config-file. 
 
 The feature can be enabled or disabled via `--repo-options`; by default it is disabled. To use the feature, make sure a `.vipgoci_options` file can be found at the root of the relevant git-repository, containing something similar to this:
 
@@ -276,45 +276,14 @@ The feature can be enabled or disabled via `--repo-options`; by default it is di
 
 Then run `vip-go-ci` like this:
 
-> ./vip-go-ci.php --repo-options=true --repo-options-allowed="phpcs-severity"
+> ./vip-go-ci.php --repo-options=true --repo-options-allowed="phpcs-severity,skip-draft-prs"
 
 `--repo-options-allowed` specifies which options can be specified via `.vipgoci_options`, and that can be used to limit which options are allowed.
 
 Should the configuration file not be found, any configuration value not be valid, or altering of the particular option is not allowed, the relevant option will not be altered on run-time. Note that not all options need to be set in the configuration file, only those desired. The file is expected to be a parsable, valid JSON.
 
-You can use any combination of options you wish. Individual options are documented below.
+You can use any combination of options you wish.
 
-#### Option `--phpcs-severity`
-
-Specifies the severity level to pass to PHPCS when executed.
-
-For example:
-
-```
-{"phpcs-severity":5}
-```
-
-#### Option `--post-generic-pr-support-comments`
-
-Specifies if to post generic support comments, should be a boolean.
-
-For example:
-
-```
-{"post-generic-pr-support-comments":false}
-```
-
-#### Options `phpcs-sniffs-exclude` and `phpcs-sniffs-include`
-
-These are array parameters and if specified in the options file, the items specified will be appended to the options specified on the command line. To configure the `phpcs-sniffs-exclude` option, one can specify something like this in the repository options file:
-
-> {"phpcs-sniffs-exclude":["WordPressVIPMinimum.JS.InnerHTML", "WordPress.WP.CronInterval"]} 
-
-The `phpcs-sniffs-include` is configured in the same way as the `phpcs-sniffs-exclude` option. Note that it works differently behind the scenes, as it will write out a new PHPCS standard on run-time, containing the sniffs to be included as well as the original PHPCS standard, and will then use this standard from then on. The `phpcs-sniffs-include` option is used in this way:
-
-> {"phpcs-sniffs-include":["WordPress.DB.DirectDatabaseQuery"]} 
-
-Please note that should any of the PHPCS sniffs specified be invalid, a warning will be posted on any Pull-Request scanned. The warning will be removed during next scan and not posted again if the issue is fixed.
 
 #### Option `skip-execution`
 
@@ -357,6 +326,31 @@ Any number of PHPCS standards can be specified, and any number of runtime settin
 
 Should any of the PHPCS sniffs included or excluded be invalid, this is reported in the relevant Pull-Requests.
 
+The following PHPCS-related options can be configured via repository config-file:
+
+#### Options `--phpcs` and `--phpcs-severity`
+
+Specifies if to do PHPCS scanning and specifies the severity level to pass to PHPCS when executed.
+
+For example:
+
+```
+{"phpcs":true,"phpcs-severity":5}
+```
+
+#### Options `phpcs-sniffs-exclude` and `phpcs-sniffs-include`
+
+These are array parameters and if specified in the options file, the items specified will be appended to the options specified on the command line. To configure the `phpcs-sniffs-exclude` option, one can specify something like this in the repository options file:
+
+> {"phpcs-sniffs-exclude":["WordPressVIPMinimum.JS.InnerHTML", "WordPress.WP.CronInterval"]} 
+
+The `phpcs-sniffs-include` is configured in the same way as the `phpcs-sniffs-exclude` option. Note that it works differently behind the scenes, as it will write out a new PHPCS standard on run-time, containing the sniffs to be included as well as the original PHPCS standard, and will then use this standard from then on. The `phpcs-sniffs-include` option is used in this way:
+
+> {"phpcs-sniffs-include":["WordPress.DB.DirectDatabaseQuery"]} 
+
+Please note that should any of the PHPCS sniffs specified be invalid, a warning will be posted on any Pull-Request scanned. The warning will be removed during next scan and not posted again if the issue is fixed.
+
+
 ### SVG scanning
 
 `vip-go-ci` supports scanning SVG files for dangerous tags. The scanning is accomplished by a [SVG scanner](https://github.com/Automattic/vip-go-svg-sanitizer), while `vip-go-ci` takes care of posting the issues found.
@@ -367,6 +361,16 @@ To make use of this feature, the `--svg-checks` and `--svg-scanner-path` options
 
 With these options, SVG scanning is turned on and a scanner at a particular path location is to be used. 
 
+The following SVG-related options can be configured via repository config-file:
+
+#### Option `--svg-checks`
+
+Specifies if to do SVG scanning. For instance:
+
+```
+{"svg-checks": false}
+```
+
 ### Autoapprovals
 
 `vip-go-ci` can auto-approve Pull-Requests that only alter particular types of files. The 'type' is based on file-ending, such as `.txt`. The idea is to allow faster approvals of Pull-Requests that do not need to be reviewed or do not need any automated feedback.
@@ -385,6 +389,18 @@ With this setting, any PHP files having only whitespacing changes or updating to
 
 Note that `vip-go-ci` will collect which files of the relevant Pull-Request are approved, whether `.css`, `.gif`, `.php` or other, and if _all_ the files altered by it have been found to be auto-approvable, the whole Pull-Request will be approved automatically. This applies also to the Hashes API (see below).
 
+The following Autoapprovals-related options can be configured via repository config-file:
+
+#### Options `--autoapprove` and `--autoapprove-php-nonfunctional-changes`
+
+Using these options, users can disable autoapproval entirely as well as the autoapprovals of non-functional changes.
+
+For instance:
+
+```
+{"autoapprove": false, "autoapprove-php-nonfunctional-changes": false}
+```
+
 ### Hashes API
 
 This feature is useful when you want to automatically approve Pull-Requests containing PHP or JavaScript files that are already known to be good and are approved already, so no manual reviewing is needed. To make use of this feature, you will need a database of files already approved. You will also have to be using the auto-approvals feature. 
@@ -407,6 +423,16 @@ The JSON result can contain other fields, but they are not used. Note that a sin
 
 An open-source tool to label files as approved or non-approved is available [here](https://github.com/Automattic/vip-hash/). It requires a HTTP API service that `vip-go-ci` communicates with as well.
 
+The following Hashes-API related option can be configured via repository config-file:
+
+#### Option `--hashes-api`
+
+Specifies if to check for approved files in Hashes-API. For instance:
+
+```
+{"hashes-api":true}
+```
+
 ### Ignore certain branches
 
 Sometimes users do not want specific branches scanned for any issues -- they want them effectively to be ignored. To do this, you can use the `--branches-ignore` option. 
@@ -434,8 +460,39 @@ Folders can also be specified in files placed at the root of the repository, `.v
 
 Any folders found in the files at the root of the repository will be merged with options specified on the command-line.
 
-### Limiting review comments 
+### Configuring review comments 
+
+Review comments posted can be configured and number of them limited.
+
+#### Sorting review comments
+
+One can sort the review comments posted according to severity of the issue found. This applies to any issue, PHPCS, SVG, etc. This is disabled by default.
+
+The option can be used in this way:
 
+> ./vip-go-ci.php --results-comments-sort=true
+
+This option can be configured via repository-config file as well:
+
+```
+{"results-comments-sort":true}
+```
+
+#### Including severity in review comments
+
+One can let `vip-go-ci` include the severity of the issue found in the review comments posted to GitHub. This is disabled by default.
+
+The option can be used in this way:
+
+> ./vip-go-ci.php --review-comments-include-severity=true
+
+This option can be configured via repository-config file as well:
+
+```
+{"review-comments-include-severity":true}
+```
+
+#### Limiting review comments
 One can limit the number of review comments posted to GitHub Pull-Requests. Also, one can ignore certain comments so that they will not be posted to Pull-Request reviews. This is useful when Pull-Requests are created or updated, and contain many issues. 
 
 The options can be used in this way:
@@ -479,6 +536,18 @@ For example:
 
 With the `--post-generic-pr-support-comments-repo-meta-match` parameter added, `vip-go-ci` will look at the data returned by the repo-meta API, and check if these fields and their values are found in there for at least one entry. If so, the generic support message will be posted, and not otherwise.
 
+The following Generic Support Message related options can be configured via repository-config file:
+
+#### Option `--post-generic-pr-support-comments`
+
+Specifies if to post generic support comments, should be a boolean.
+
+For example:
+
+```
+{"post-generic-pr-support-comments":false}
+```
+
 ### Support labels
 
 `vip-go-ci` can put labels on Pull-Requests indicating level of support provided. With this feature configured, `vip-go-ci` will attach a label to every new Pull-Request that does not have it. For this to work, it will need access to a `repo-meta API` that needs to be available and `vip-go-ci` has to be configured to work with.

main.php

@@ -176,6 +176,7 @@ function vipgoci_run() {
 			'repo-meta-api-base-url:',
 			'repo-meta-api-user-id:',
 			'repo-meta-api-access-token:',
+			'phpcs:',
 			'phpcs-path:',
 			'phpcs-standard:',
 			'phpcs-severity:',
@@ -187,6 +188,7 @@ function vipgoci_run() {
 			'phpcs-skip-folders-in-repo-options-file:',
 			'repo-options:',
 			'repo-options-allowed:',
+			'hashes-api:',
 			'hashes-api-url:',
 			'hashes-oauth-token:',
 			'hashes-oauth-token-secret:',
@@ -203,7 +205,6 @@ function vipgoci_run() {
 			'lint:',
 			'lint-skip-folders:',
 			'lint-skip-folders-in-repo-options-file:',
-			'phpcs:',
 			'svg-checks:',
 			'svg-scanner-path:',
 			'autoapprove:',
@@ -212,7 +213,6 @@ function vipgoci_run() {
 			'autoapprove-php-nonfunctional-changes:',
 			'help',
 			'debug-level:',
-			'hashes-api:',
 		);
 
 	/*
@@ -979,10 +979,17 @@ function vipgoci_run() {
 		array(
 			'skip-execution',
 			'skip-draft-prs',
+			'results-comments-sort',
+			'review-comments-include-severity',
+			'phpcs',
 			'phpcs-severity',
 			'post-generic-pr-support-comments',
 			'phpcs-sniffs-include',
 			'phpcs-sniffs-exclude',
+			'hashes-api',
+			'svg-checks',
+			'autoapprove',
+			'autoapprove-php-nonfunctional-changes',
 		)
 	);
 
@@ -1421,6 +1428,10 @@ function vipgoci_run() {
 	 * Certain options are configurable via
 	 * options-file in the repository. Set
 	 * these options here.
+	 *
+	 * Note that any new option added here should
+	 * be added to the --repo-options-allowed option
+	 * found above.
 	 */
 	vipgoci_options_read_repo_file(
 		$options,
@@ -1436,6 +1447,21 @@ function vipgoci_run() {
 				'valid_values'	=> array( true, false ),
 			),
 
+			'results-comments-sort' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
+
+			'review-comments-include-severity' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
+
+			'phpcs' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
+
 			'phpcs-severity' => array(
 				'type'		=> 'integer',
 				'valid_values'	=> array( 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ),
@@ -1457,6 +1483,26 @@ function vipgoci_run() {
 				'append'	=> true,
 				'valid_values'	=> null,
 			),
+
+			'hashes-api' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
+
+			'svg-checks' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),	
+			),
+
+			'autoapprove' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
+
+			'autoapprove-php-nonfunctional-changes' => array(
+				'type'		=> 'boolean',
+				'valid_values'	=> array( true, false ),
+			),
 		)
 	);
 
@@ -1742,6 +1788,9 @@ function vipgoci_run() {
 	 * can be auto-approved, and then actually do the
 	 * auto-approval if possible.
 	 */
+
+	$auto_approved_files_arr = array();
+
 	if ( true === $options['autoapprove'] ) {
 		/*
 		 * FIXME: Move the function-calls below
@@ -1754,7 +1803,6 @@ function vipgoci_run() {
 		 * scan through the files in the PR, and
 		 * register which can be auto-approved.
 		 */
-		$auto_approved_files_arr = array();
 
 		if ( ! empty( $options[ 'autoapprove-filetypes' ] ) ) {
 			vipgoci_ap_file_types(

statistics.php

@@ -167,6 +167,13 @@ function vipgoci_counter_update_with_issues_found(
 	);
 
 	foreach( $stats_types as $stat_type ) {
+		/*
+		 * Skip statistics for stat-types skipped
+		 */
+		if ( null === $results['stats'][ $stat_type ] ) {
+			continue;
+		}
+
 		$pr_keys = array_keys(
 			$results['stats'][ $stat_type ]
 		);