simp-beaker-helpers 1.16.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb4493d282ad548aeb475ef2918f65d1b331cd03bf9a463d2b928b58eb39b02b
-  data.tar.gz: 6fc59e935a58ed366560a2b0adc270af741ca0d41e2ccc4538c3261320388dea
+  metadata.gz: 2d2df234c2357c8763e82b9cabaf6b9da39736ca7fcedc4a16dd344a993c2c2d
+  data.tar.gz: eda59ab6e07fadc67fb31b0d5d5462b89a2f4290129f46d32fda963999b5bc99
 SHA512:
-  metadata.gz: a0551449fe17b14f27af4428ba49385e355f4ae28e5e7bab592215df56d6c91bdcb6e7b6222da0ec002ceb7f3ae373038ae2d26fef5b23fbba93f510ce2ef8d4
-  data.tar.gz: e610f52d3bafec88e05ed6af1a3197441c76308287df3854324d94740d360c510c835db0a9f812e202a31270d7f03dd48d502b40e89dd74af7164061546f820b
+  metadata.gz: bbcabe0f22e139595747cde2afd378e8f7d4f35e1d4ce387fc2c09da3bc57d2099e8abfc0beb407cfff0a53aad13c4be032840d54a78f86a7c4f5f47a504628a
+  data.tar.gz: 84235e55f67ee2fefc02dce2221763e817876a22fb1bf6cfee7adfcbfd261913022a39bba804ad66643f0cc884c164f41e0ac3b239a8b339e1809c8b7e55b063

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.17.0 / 2019-10-22
+* Allow users to perform exclusion filters on SSG results
+* Allow users to pass Arrays of items to match for SSG results
+
 ### 1.16.2 / 2019-10-10
 * Pull latest inspec package now that the upstream bug is fixed
 

data/lib/simp/beaker_helpers/ssg.rb

@@ -156,23 +156,45 @@ module Simp::BeakerHelpers
       end
     end
 
-    # Retrieve a subset of test results based on a match to
-    # filter
+    # Retrieve a subset of test results based on a match to filter
+    #
+    # @param filter [String, Array[String]]
+    #   A 'short name' filter that will be matched against the rule ID name
+    #
+    # @param exclusions [String, Array[String]]
+    #   A 'short name' filter of items that will be removed from the `filter`
+    #   matches
+    #
+    # @return [Hash] A Hash of statistics and a formatted report
     #
     # FIXME:
     # - This is a hack! Should be searching for rules based on a set
     #   set of STIG ids, but don't see those ids in the oscap results xml.
     #   Further mapping is required...
     # - Create the same report structure as inspec
-    def process_ssg_results(filter=nil)
-      self.class.process_ssg_results(File.join(@output_dir, @result_file) + '.xml', filter)
+    def process_ssg_results(filter=nil, exclusions=nil)
+      self.class.process_ssg_results(
+        File.join(@output_dir, @result_file) + '.xml',
+        filter,
+        exclusions
+      )
     end
 
     # Process the results of an SSG run
     #
+    # @param result_file [String]
+    #   The oscap result XML file to process
+    #
+    # @param filter [String, Array[String]]
+    #   A 'short name' filter that will be matched against the rule ID name
+    #
+    # @param exclusions [String, Array[String]]
+    #   A 'short name' filter of items that will be removed from the `filter`
+    #   matches
+    #
     # @return [Hash] A Hash of statistics and a formatted report
     #
-    def self.process_ssg_results(result_file, filter=nil)
+    def self.process_ssg_results(result_file, filter=nil, exclusions=nil)
       require 'highline'
       require 'nokogiri'
 
@@ -187,10 +209,39 @@ module Simp::BeakerHelpers
       doc.remove_namespaces!
 
       if filter
+        filter = Array(filter)
+
+        xpath_query = [
+          '//rule-result[(',
+        ]
+
+        xpath_query << filter.map do |flt|
+          "contains(@idref,'#{flt}')"
+        end.join(' or ')
+
+        xpath_query << ')' if filter.size > 1
+
+        if exclusions
+          exclusions = Array(exclusions)
+
+          xpath_query << 'and not('
+
+          xpath_query << exclusions.map do |exl|
+            "contains(@idref,'#{exl}')"
+          end.join(' or ')
+
+          xpath_query << ')' if exclusions.size > 1
+        end
+
+        xpath_query << ')]'
+
+        xpath_query = xpath_query.join(' ')
+
         # XPATH to get the pertinent test results:
         #   Any node named 'rule-result' for which the attribute 'idref'
-        #   contains filter
-        result_nodes = doc.xpath("//rule-result[contains(@idref,'#{filter}')]")
+        #   contains any of the `filter` Strings and does not contain any of the
+        #   `exclusions` Strings
+        result_nodes = doc.xpath(xpath_query)
       else
         result_nodes = doc.xpath('//rule-result')
       end

data/lib/simp/beaker_helpers/version.rb

@@ -1,5 +1,5 @@
 module Simp; end
 
 module Simp::BeakerHelpers
-  VERSION = '1.16.2'
+  VERSION = '1.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simp-beaker-helpers
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Chris Tessmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker