Filter Scans on Tags (#49)

* Deprecate fileProtocol.group and add ability to filter on tags

* Add tags scan documentation example

* Update parent version and bump pom minor version

* Update copyright to 2021

* Update NOTICE description

* Fix flatten config specs with config update

Author: brianwyka

.test/bad-parent-2.yml

@@ -2,7 +2,6 @@
 file-protocols:
   - name: Maven Parent
     description: Maven Parent is correct
-    group: maven
     tags:
       - maven
       - parent

.test/bad-parent.yml

@@ -2,7 +2,6 @@
 file-protocols:
   - name: Maven Parent
     description: Maven Parent is correct
-    group: maven
     tags:
       - maven
       - parent

.test/glob-example.yml

@@ -2,7 +2,6 @@
 file-protocols:
   - name: Maven Parent
     description: Maven Parent is correct
-    group: maven
     tags:
       - maven
       - parent

.test/override.yml

@@ -2,7 +2,6 @@
 file-protocols:
   - name: Maven Parent
     description: Maven Parent is correct
-    group: maven
     tags:
       - maven
       - parent
@@ -11,7 +10,6 @@ file-protocols:
       - enforcer: .maven.MavenParentEquals
         expected-coordinates: com.optum.sourcehawk:sourcehawk-jar-parent
 
-
 # Composable recursive source hawk configs (Must be public repo)
 config-locations:
   - .test/bad-parent.yml

.test/tags.yml

@@ -0,0 +1,21 @@
+
+file-protocols:
+  - name: Maven Parent
+    description: Maven Parent is correct
+    tags:
+      - maven
+      - parent
+    repository-path: pom.xml
+    enforcers:
+      - enforcer: .maven.MavenParentEquals
+        expected-coordinates: com.optum.sourcehawk:sourcehawk-jar-parent
+  - name: Lombok
+    description: Lombok config is correct
+    tags:
+      - config
+      - lombok
+    repository-path: lombok.config
+    enforcers:
+      - enforcer: .common.StringPropertyEquals
+        property-name: config.stopBubbling
+        expected-property-value: false

NOTICE.txt

@@ -1,10 +1,10 @@
 sourcehawk
 
-Copyright 2020 Optum
+Copyright 2021 Optum
 
 Project Description:
 ====================
-Sourcehawk is a source code compliance as code automation suite of tools.
+Sourcehawk is an extensible compliance as code automation tool which enables teams to run tailored compliance scans on their source code.
 
 Contributors:
 @brianwyka - Project Lead

bom/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.5.1-SNAPSHOT</version>
+        <version>0.6.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>sourcehawk-bom</artifactId>

cli/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <artifactId>sourcehawk</artifactId>
         <groupId>com.optum.sourcehawk</groupId>
-        <version>0.5.1-SNAPSHOT</version>
+        <version>0.6.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>sourcehawk-cli</artifactId>

cli/src/main/asciidoc/_scan-examples.adoc

@@ -25,6 +25,12 @@ sourcehawk scan --config-file-url https://raw.githubsercontent.com/optum/sourceh
 sourcehawk scan -f MARKDOWN --fail-on-warnings > sourcehawk-scan-results.md
 ----
 
+.Scan only the provided tags to limit the scope
+[source,sh]
+----
+sourcehawk scan --tags "config" --tags "build"
+----
+
 .Output in JSON format and pretty print with jq
 [source,sh]
 ----

cli/src/main/java/com/optum/sourcehawk/cli/AbstractExecCommand.java

@@ -48,12 +48,13 @@ protected ExecOptions buildExecOptions() {
                 .map(Object::toString)
                 .ifPresent(builder::configurationFileLocation);
         Optional.ofNullable(exec.verbosity).ifPresent(builder::verbosity);
+        Optional.ofNullable(exec.tags).ifPresent(builder::tags);
         Optional.ofNullable(exec.outputFormat).ifPresent(builder::outputFormat);
         if (exec.outputFormat == OutputFormat.JSON || exec.outputFormat == OutputFormat.MARKDOWN) {
             builder.verbosity(Verbosity.ZERO);
         }
-        builder.failOnWarnings(exec.failOnWarnings);
-        return builder.build();
+        return builder.failOnWarnings(exec.failOnWarnings)
+                .build();
     }
 
     /**

cli/src/main/java/com/optum/sourcehawk/cli/CommandOptions.java

@@ -9,6 +9,7 @@
 
 import java.net.URL;
 import java.nio.file.Path;
+import java.util.List;
 
 /**
  * Command option definitions
@@ -28,6 +29,12 @@ static class Exec {
         @CommandLine.ArgGroup
         ConfigFile configFile;
 
+        @CommandLine.Option(
+                names = {"-t", "--tags"},
+                description = "Tags of file protocols to limit the scope of execution"
+        )
+        List<String> tags;
+
         @CommandLine.Option(
                 names = {"-v", "--verbosity"},
                 description = "Verbosity of output, valid values: ${COMPLETION-CANDIDATES}",

cli/src/test/groovy/com/optum/sourcehawk/cli/BitbucketScanSubCommandSpec.groovy

@@ -61,7 +61,7 @@ class BitbucketScanSubCommandSpec extends Specification {
     def "commandLine.execute bitbucket server - custom configuration file (failed)"() {
         given:
         CommandLine commandLine = new CommandLine(new ScanCommand())
-        String[] args = ["-c", "target/test-classes/sourcehawk-basic2.yml", "bitbucket", "-S", bitbucketServerUrl, "project/repo@develop" ]
+        String[] args = ["-c", "src/test/resources/sourcehawk-basic2.yml", "bitbucket", "-S", bitbucketServerUrl, "project/repo@develop" ]
         clientAndServer
                 .when(HttpRequest.request()
                         .withMethod("HEAD")

cli/src/test/groovy/com/optum/sourcehawk/cli/ScanCommandSpec.groovy

@@ -41,6 +41,10 @@ class ScanCommandSpec extends CliBaseSpecification {
                 [ "--config-file", "sourcehawk.yml", repositoryRoot.toString() ] as String[],
                 [ "-v", "HIGH", repositoryRoot.toString() ] as String[],
                 [ "--verbosity", "HIGH", repositoryRoot.toString() ] as String[],
+                [ "-t", "maven", repositoryRoot.toString() ] as String[],
+                [ "-t", "maven", "-t", "lombok", repositoryRoot.toString() ] as String[],
+                [ "--tags", "maven", repositoryRoot.toString() ] as String[],
+                [ "--tags", "maven", "--tags", "lombok", repositoryRoot.toString() ] as String[],
                 [ "-f", "JSON", repositoryRoot.toString() ] as String[],
                 [ "--output-format", "JSON", repositoryRoot.toString() ] as String[],
                 [ "-w", repositoryRoot.toString() ] as String[],

cli/src/test/resources/flattened/sourcehawk-flattened-base.yml

@@ -1,7 +1,6 @@
 file-protocols:
 - name: "Maven Pom"
   description: "maven pom.xml has correct configuration"
-  group: "maven"
   repository-path: "pom.xml"
   required: true
   tags:
@@ -11,28 +10,8 @@ file-protocols:
   - enforcer: ".xml.XPathEquals"
     expectations:
       //project/ciManagement/system/text(): "github"
-- name: "License"
-  description: null
-  group: null
-  repository-path: "LICENSE"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers: []
-- name: "Individual Contributor License"
-  description: null
-  group: null
-  repository-path: "INDIVIDUAL_CONTRIBUTOR_LICENSE.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLineMatchingAt"
-    expected-line-pattern: "(.*)Individual Contributor License Agreement(.*)"
-    expected-line-number: 1
 - name: "Lombok Config"
   description: "Lombok Configured appropriately"
-  group: "lombok"
   repository-path: "lombok.config"
   required: true
   tags:
@@ -48,7 +27,6 @@ file-protocols:
     expected-property-value: true
 - name: "Notice"
   description: null
-  group: null
   repository-path: "NOTICE.txt"
   required: true
   tags: []
@@ -57,18 +35,15 @@ file-protocols:
   - enforcer: ".common.ContainsLineAt"
     expected-line: "sourcehawk"
     expected-line-number: 1
-  - enforcer: ".common.ContainsLineAt"
-    expected-line: "Copyright 2020 Optum"
+  - enforcer: ".common.ContainsLineMatchingAt"
+    expected-line-pattern: "Copyright (.*) Optum"
     expected-line-number: 3
-  - enforcer: ".common.ContainsLine"
-    expected-line: "Project Description:"
   - enforcer: ".common.ContainsLine"
     expected-line: "@brianwyka - Project Lead"
   - enforcer: ".common.ContainsLine"
     expected-line: "@ctoestriech - Project Lead"
 - name: "Maven Wrapper"
   description: "Maven build wrapper"
-  group: "lombok"
   repository-path: ".mvn/wrapper/maven-wrapper.properties"
   required: true
   tags:
@@ -79,35 +54,3 @@ file-protocols:
   - enforcer: ".common.StringPropertyEquals"
     property-name: "distributionUrl"
     expected-property-value: "https://apache.claz.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip"
-- name: "Code of Conduct"
-  description: null
-  group: null
-  repository-path: "CODE_OF_CONDUCT.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLine"
-    expected-line: "# Contributor Covenant Code of Conduct"
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[homepage]: http://contributor-covenant.org"
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[email]: mailto:[email protected]"
-- name: "Attribution"
-  description: null
-  group: null
-  repository-path: "attribution.txt"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers: []
-- name: "Contributing"
-  description: null
-  group: null
-  repository-path: "CONTRIBUTING.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[email]: mailto:[email protected]"

cli/src/test/resources/flattened/sourcehawk-flattened-override.yml

@@ -1,7 +1,6 @@
 file-protocols:
 - name: "Maven Banned Deps"
   description: "Maven pom.xml banned deps check"
-  group: "maven"
   repository-path: "pom.xml"
   required: true
   tags:
@@ -14,7 +13,6 @@ file-protocols:
       special.skip: true
 - name: "Maven Pom"
   description: "maven pom.xml has correct configuration"
-  group: "maven"
   repository-path: "pom.xml"
   required: true
   tags:
@@ -24,28 +22,8 @@ file-protocols:
   - enforcer: ".xml.XPathEquals"
     expectations:
       //project/ciManagement/type/text(): "ghe"
-- name: "License"
-  description: null
-  group: null
-  repository-path: "LICENSE"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers: []
-- name: "Individual Contributor License"
-  description: null
-  group: null
-  repository-path: "INDIVIDUAL_CONTRIBUTOR_LICENSE.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLineMatchingAt"
-    expected-line-pattern: "(.*)Individual Contributor License Agreement(.*)"
-    expected-line-number: 1
 - name: "Lombok Config"
   description: "Lombok Configured appropriately"
-  group: "lombok"
   repository-path: "lombok.config"
   required: true
   tags:
@@ -61,7 +39,6 @@ file-protocols:
     expected-property-value: false
 - name: "Notice"
   description: null
-  group: null
   repository-path: "NOTICE.txt"
   required: true
   tags: []
@@ -70,26 +47,22 @@ file-protocols:
   - enforcer: ".common.ContainsLineAt"
     expected-line: "sourcehawk"
     expected-line-number: 1
-  - enforcer: ".common.ContainsLineAt"
-    expected-line: "Copyright 2020 Optum"
+  - enforcer: ".common.ContainsLineMatchingAt"
+    expected-line-pattern: "Copyright (.*) Optum"
     expected-line-number: 3
-  - enforcer: ".common.ContainsLine"
-    expected-line: "Project Description:"
   - enforcer: ".common.ContainsLine"
     expected-line: "@brianwyka - Project Lead"
   - enforcer: ".common.ContainsLine"
     expected-line: "@ctoestriech - Project Lead"
 - name: "Maven Wrapper"
   description: "Maven Wrapper exists"
-  group: null
   repository-path: ".mvn/wrapper/maven-wrapper.jar"
   required: true
   tags: []
   severity: "ERROR"
   enforcers: []
 - name: "Maven Wrapper"
   description: "Maven build wrapper"
-  group: "lombok"
   repository-path: ".mvn/wrapper/maven-wrapper.properties"
   required: true
   tags:
@@ -100,35 +73,3 @@ file-protocols:
   - enforcer: ".common.StringPropertyEquals"
     property-name: "distributionUrl"
     expected-property-value: "https://apache.claz.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip"
-- name: "Code of Conduct"
-  description: null
-  group: null
-  repository-path: "CODE_OF_CONDUCT.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLine"
-    expected-line: "# Contributor Covenant Code of Conduct"
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[homepage]: http://contributor-covenant.org"
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[email]: mailto:[email protected]"
-- name: "Attribution"
-  description: null
-  group: null
-  repository-path: "attribution.txt"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers: []
-- name: "Contributing"
-  description: null
-  group: null
-  repository-path: "CONTRIBUTING.md"
-  required: true
-  tags: []
-  severity: "ERROR"
-  enforcers:
-  - enforcer: ".common.ContainsLine"
-    expected-line: "[email]: mailto:[email protected]"

cli/src/test/resources/repo-updates/sourcehawk.yml

@@ -2,7 +2,6 @@
 file-protocols:
   - name: Lombok Config Override
     description: Lombok Configured appropriately
-    group: lombok
     tags:
       - lombok
       - config