Add Benchmark parsing (#18)

Signed-off-by: Andrew Kofink <akofink@redhat.com>

Author: akofink

lib/openscap_parser.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'openscap_parser/util'
+require 'openscap_parser/benchmarks'
 require 'openscap_parser/profiles'
 require 'openscap_parser/profile'
 require 'openscap_parser/rule'

lib/openscap_parser/benchmark.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/util'
+require 'openscap_parser/xml_file'
+require 'openscap_parser/rules'
+require 'openscap_parser/profiles'
+require 'openscap_parser/rule_references'
+
+# Mimics openscap-ruby Benchmark interface
+module OpenscapParser
+  class Benchmark
+    include OpenscapParser::Util
+    include OpenscapParser::XmlFile
+    include OpenscapParser::Rules
+    include OpenscapParser::RuleReferences
+    include OpenscapParser::Profiles
+
+    def initialize(parsed_xml: nil)
+      @parsed_xml = parsed_xml
+    end
+
+    def id
+      @id ||= @parsed_xml['id']
+    end
+
+    def title
+      @title ||= @parsed_xml.xpath('title') &&
+        @parsed_xml.xpath('title').text
+    end
+
+    def description
+      @description ||= newline_to_whitespace(
+        @parsed_xml.xpath('description') &&
+          @parsed_xml.xpath('description').text || ''
+      )
+    end
+
+    def version
+      @version ||= @parsed_xml.xpath('version') &&
+        @parsed_xml.xpath('version').text
+    end
+  end
+end

lib/openscap_parser/benchmarks.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/benchmark'
+
+module OpenscapParser
+  # Methods related to saving profiles and finding which hosts
+  # they belong to
+  module Benchmarks
+    def self.included(base)
+      base.class_eval do
+        def benchmark
+          @benchmark ||= OpenscapParser::Benchmark.new(parsed_xml: benchmark_node)
+        end
+
+        def benchmark_node(xpath = ".//Benchmark")
+          xpath_node(xpath)
+        end
+      end
+    end
+  end
+end

lib/openscap_parser/datastream.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 require 'openscap_parser/xml_file'
+require 'openscap_parser/benchmarks'
 
 module OpenscapParser
   class Datastream
     include OpenscapParser::XmlFile
-    include OpenscapParser::Rules
-    include OpenscapParser::Profiles
+    include OpenscapParser::Benchmarks
 
     def initialize(report)
       parsed_xml report

lib/openscap_parser/profile.rb

@@ -18,6 +18,11 @@ def description
         @profile_xml.at_css('description').text
     end
 
+    def selected_rule_ids
+      id_refs = @profile_xml.xpath("select[@selected='true']/@idref")
+      id_refs && id_refs.map(&:text)
+    end
+
     def to_h
       { :id => id, :title => title, :description => description }
     end

lib/openscap_parser/rule.rb

@@ -1,68 +1,63 @@
 # frozen_string_literal: true
 
 require 'openscap_parser/rule_identifier'
-require 'openscap_parser/rule_reference'
+require 'openscap_parser/rule_references'
+require 'openscap_parser/xml_file'
 
 # Mimics openscap-ruby Rule interface
 module OpenscapParser
   class Rule
-    def initialize(rule_xml: nil)
-      @rule_xml = rule_xml
+    include OpenscapParser::Util
+    include OpenscapParser::XmlFile
+    include OpenscapParser::RuleReferences
+
+    def initialize(parsed_xml: nil)
+      @parsed_xml = parsed_xml
     end
 
     def id
-      @id ||= @rule_xml['id']
+      @id ||= @parsed_xml['id']
     end
 
     def selected
-      @selected ||= @rule_xml['selected']
+      @selected ||= @parsed_xml['selected']
     end
 
     def severity
-      @severity ||= @rule_xml['severity']
+      @severity ||= @parsed_xml['severity']
     end
 
     def title
-      @title ||= @rule_xml.at_css('title') &&
-        @rule_xml.at_css('title').text
+      @title ||= @parsed_xml.at_css('title') &&
+        @parsed_xml.at_css('title').text
     end
 
     def description
       @description ||= newline_to_whitespace(
-        @rule_xml.at_css('description') &&
-          @rule_xml.at_css('description').text || ''
+        @parsed_xml.at_css('description') &&
+          @parsed_xml.at_css('description').text || ''
       )
     end
 
     def rationale
       @rationale ||= newline_to_whitespace(
-        @rule_xml.at_css('rationale') &&
-          @rule_xml.at_css('rationale').text || ''
+        @parsed_xml.at_css('rationale') &&
+          @parsed_xml.at_css('rationale').text || ''
       )
     end
 
-    def references
-      @references ||= reference_nodes.map do |node|
-        RuleReference.new(reference_xml: node)
-      end
-    end
-
-    def reference_nodes
-      @reference_nodes ||= @rule_xml.xpath('reference')
+    alias :rule_reference_nodes_old :rule_reference_nodes
+    def rule_reference_nodes(xpath = "reference")
+      rule_reference_nodes_old(xpath)
     end
 
-    def identifier
-      @identifier ||= RuleIdentifier.new(identifier_xml: @identifier_node)
+    def rule_identifier
+      @identifier ||= RuleIdentifier.new(identifier_xml: identifier_node)
     end
+    alias :identifier :rule_identifier
 
     def identifier_node
-      @identifier_node ||= @rule_xml.at_xpath('ident')
-    end
-
-    private
-
-    def newline_to_whitespace(string)
-      string.gsub(/ *\n+/, " ").strip
+      @identifier_node ||= @parsed_xml.at_xpath('ident')
     end
   end
 end

lib/openscap_parser/rule_references.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'openscap_parser/xml_file'
+require 'openscap_parser/rule_reference'
+
+module OpenscapParser
+  # Methods related to finding and saving rule references
+  module RuleReferences
+    def self.included(base)
+      base.class_eval do
+        def rule_reference_strings
+          @rule_reference_strings ||= rule_references.map do |rr|
+            "#{rr.label}#{rr.href}"
+          end
+        end
+
+        def rule_references
+          @rule_references ||= rule_reference_nodes.map do |node|
+            OpenscapParser::RuleReference.new(reference_xml: node)
+          end.uniq do |reference|
+            [reference.label, reference.href]
+          end
+        end
+        alias :references :rule_references
+
+        def rule_reference_nodes(xpath = ".//Rule/reference")
+          xpath_nodes(xpath)
+        end
+      end
+    end
+  end
+end

lib/openscap_parser/rules.rb

@@ -11,7 +11,7 @@ def rule_ids
 
         def rule_objects
           @rule_objects ||= rule_nodes.map do |rule_node|
-            Rule.new(rule_xml: rule_node)
+            Rule.new(parsed_xml: rule_node)
           end
         end
         alias :rules :rule_objects

lib/openscap_parser/util.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Utility functions for OpenscapParser
+module OpenscapParser
+  module Util
+    def newline_to_whitespace(string)
+      string.gsub(/ *\n+/, " ").strip
+    end
+  end
+end

lib/openscap_parser/xml_file.rb

@@ -13,11 +13,11 @@ def parsed_xml(report_contents = '')
     end
 
     def xpath_node(xpath)
-      @parsed_xml.at_xpath(xpath)
+      @parsed_xml && @parsed_xml.at_xpath(xpath)
     end
 
     def xpath_nodes(xpath)
-      @parsed_xml.xpath(xpath)
+      @parsed_xml && @parsed_xml.xpath(xpath) || []
     end
   end
 end