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();
     }
 
     /**