Generalize scap parsing (#15)

* s/report_xml/parsed_xml/g

We're using this module for any SCAP xml content, not just reports

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

* Separate results from profiles/rules

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

Author: akofink

lib/openscap_parser.rb

@@ -18,21 +18,10 @@ class Base
     include OpenscapParser::Profiles
     include OpenscapParser::Rules
     include OpenscapParser::RuleResults
+    include OpenscapParser::TestResult
 
     def initialize(report)
-      report_xml(report)
-    end
-
-    def score
-      test_result_node.search('score').text.to_f
-    end
-
-    def start_time
-      @start_time ||= DateTime.parse(test_result_node['start-time'])
-    end
-
-    def end_time
-      @end_time ||= DateTime.parse(test_result_node['end-time'])
+      parsed_xml(report)
     end
   end
 end

lib/openscap_parser/ds.rb

@@ -6,23 +6,23 @@ class Ds
     include OpenscapParser::XmlFile
 
     def initialize(report)
-      report_xml report
+      parsed_xml report
     end
 
     def profiles
       @profiles ||= profile_nodes
     end
 
     def valid?
-      return true if @report_xml.root.name == 'data-stream-collection' && namespaces.keys.include?('xmlns:ds')
-      return true if @report_xml.root.name == 'Tailoring' && namespaces.keys.include?('xmlns:xccdf')
+      return true if @parsed_xml.root.name == 'data-stream-collection' && namespaces.keys.include?('xmlns:ds')
+      return true if @parsed_xml.root.name == 'Tailoring' && namespaces.keys.include?('xmlns:xccdf')
       false
     end
 
     private
 
     def profile_nodes
-      @report_xml.xpath(".//Profile").map do |node|
+      @parsed_xml.xpath(".//Profile").map do |node|
         id_node = node.attribute('id')
         id = id_node.value if id_node
         title_node = node.at_xpath('./title')

lib/openscap_parser/profile.rb

@@ -1,6 +1,22 @@
 module OpenscapParser
   class Profile
-    attr_acessor :id, :title, :description
+    def initialize(profile_xml: nil)
+      @profile_xml = profile_xml
+    end
+
+    def id
+      @id ||= @profile_xml['id']
+    end
+
+    def title
+      @title ||= @profile_xml.at_css('title') &&
+        @profile_xml.at_css('title').text
+    end
+
+    def description
+      @description ||= @profile_xml.at_css('description') &&
+        @profile_xml.at_css('description').text
+    end
 
     def to_h
       { :id => id, :title => title, :description => description }

lib/openscap_parser/profiles.rb

@@ -1,25 +1,21 @@
 # frozen_string_literal: true
-require 'openscap_parser/test_result'
 
 module OpenscapParser
   # Methods related to saving profiles and finding which hosts
   # they belong to
   module Profiles
-    include TestResult
-
     def self.included(base)
       base.class_eval do
         def profiles
-          @profiles ||= {
-            profile_node['id'] => profile_node.at_css('title').text
-          }
-        end
+          @profiles ||= profile_nodes.inject({}) do |profiles, profile_node|
+            profiles[profile_node['id']] = profile_node.at_css('title').text
 
-        private
+            profiles
+          end
+        end
 
-        def profile_node
-          @report_xml.at_xpath(".//Profile\
-                             [contains('#{test_result_node['id']}', @id)]")
+        def profile_nodes(xpath = ".//Profile")
+          xpath_nodes(xpath)
         end
       end
     end

lib/openscap_parser/rule.rb

@@ -16,19 +16,22 @@ def severity
     end
 
     def title
-      @title ||= @rule_xml.at_css('title').children.first.text
+      @title ||= @rule_xml.at_css('title') &&
+        @rule_xml.at_css('title').text
     end
 
     def description
-      rule_node ||= @rule_xml.at_css('description')
-      @description ||= newline_to_whitespace(rule_node.text) if rule_node && rule_node.text
+      @description ||= newline_to_whitespace(
+        @rule_xml.at_css('description') &&
+          @rule_xml.at_css('description').text || ''
+      )
     end
 
     def rationale
-      rationale_node ||= @rule_xml.at_css('rationale')
-      @rationale ||= newline_to_whitespace(rationale_node.children.text) if rationale_node &&
-        rationale_node.children &&
-        rationale_node.children.text
+      @rationale ||= newline_to_whitespace(
+        @rule_xml.at_css('rationale') &&
+          @rule_xml.at_css('rationale').text || ''
+      )
     end
 
     def references

lib/openscap_parser/rules.rb

@@ -10,13 +10,15 @@ def rule_ids
         end
 
         def rule_objects
-          return @rule_objects unless @rule_objects.nil?
-
-          @rule_objects ||= @report_xml.search('Rule').map do |rule|
-            Rule.new(rule_xml: rule)
+          @rule_objects ||= rule_nodes.map do |rule_node|
+            Rule.new(rule_xml: rule_node)
           end
         end
         alias :rules :rule_objects
+
+        def rule_nodes(xpath = ".//Rule")
+          xpath_nodes(xpath)
+        end
       end
     end
   end

lib/openscap_parser/test_result.rb

@@ -4,10 +4,41 @@ module OpenscapParser
   module TestResult
     def self.included(base)
       base.class_eval do
-        private
+        def score
+          @score ||= test_result_node &&
+            test_result_node.search('score').text.to_f
+        end
+
+        def start_time
+          @start_time ||= test_result_node &&
+            DateTime.parse(test_result_node['start-time'])
+        end
+
+        def end_time
+          @end_time ||= test_result_node &&
+            DateTime.parse(test_result_node['end-time'])
+        end
+
+        def test_result_profiles
+          @test_result_profiles ||= test_result_profile_nodes.inject({}) do |profiles, profile_node|
+            profiles[profile_node['id']] = profile_node.at_css('title').text
+
+            profiles
+          end
+        end
 
         def test_result_node
-          @test_result_node ||= @report_xml.at_css('TestResult')
+          @test_result_node ||= xpath_node('.//TestResult')
+        end
+
+        def test_result_profile_id
+          test_result_node.xpath('./profile/@idref').text
+        end
+
+        private
+
+        def test_result_profile_nodes
+          profile_nodes(".//Profile [@id='#{test_result_profile_id}']")
         end
       end
     end

lib/openscap_parser/xml_file.rb

@@ -5,11 +5,19 @@ module OpenscapParser
   module XmlFile
     attr_reader :namespaces
 
-    def report_xml(report_contents = '')
-      @report_xml ||= ::Nokogiri::XML.parse(
+    def parsed_xml(report_contents = '')
+      @parsed_xml ||= ::Nokogiri::XML.parse(
         report_contents, nil, nil, Nokogiri::XML::ParseOptions.new.norecover)
-      @namespaces = @report_xml.namespaces.clone
-      @report_xml.remove_namespaces!
+      @namespaces = @parsed_xml.namespaces.clone
+      @parsed_xml.remove_namespaces!
+    end
+
+    def xpath_node(xpath)
+      @parsed_xml.at_xpath(xpath)
+    end
+
+    def xpath_nodes(xpath)
+      @parsed_xml.xpath(xpath)
     end
   end
 end

lib/openscap_parser/xml_report.rb

@@ -11,11 +11,11 @@ def self.included(base)
         include OpenscapParser::XmlFile
 
         def host
-          @report_xml.search('target').text
+          @parsed_xml.search('target').text
         end
 
         def description
-          @report_xml.search('description').first.text
+          @parsed_xml.search('description').first.text
         end
       end
     end

test/openscap_parser/profiles_test.rb

@@ -4,44 +4,54 @@
 
 class ProfilesTest < Minitest::Test
   describe 'profiles are parsed from' do
-    include OpenscapParser::Profiles
-    include OpenscapParser::XMLReport
+    class TestParser
+      include OpenscapParser::Profiles
+      include OpenscapParser::XMLReport
+      include OpenscapParser::TestResult
 
-    def report_description
-      'description'
+      def report_description
+        'description'
+      end
     end
 
     def setup
       @profiles = nil
     end
 
     test 'standard fedora' do
-      def test_result_node
-        OpenStruct.new(id: ['xccdf_org.ssgproject.content_profile_standard'])
+      class TestParser
+        def test_result_profile_id
+          'xccdf_org.ssgproject.content_profile_standard'
+        end
       end
 
-      report_xml(file_fixture('xccdf_report.xml').read)
+      test_parser = TestParser.new
+
+      test_parser.parsed_xml(file_fixture('xccdf_report.xml').read)
 
       expected = {
         'xccdf_org.ssgproject.content_profile_standard' => \
         'Standard System Security Profile for Fedora'
       }
-      assert_equal expected, profiles
+      assert_equal expected, test_parser.test_result_profiles
     end
 
     test 'ospp42 rhel' do
-      def test_result_node
-        OpenStruct.new(id: ['xccdf_org.open-scap_testresult_xccdf_org.'\
-                            'ssgproject.content_profile_ospp42'])
+      class TestParser
+        def test_result_profile_id
+          'xccdf_org.ssgproject.content_profile_ospp42'
+        end
       end
 
-      report_xml(file_fixture('rhel-xccdf-report.xml').read)
+      test_parser = TestParser.new
+
+      test_parser.parsed_xml(file_fixture('rhel-xccdf-report.xml').read)
 
       expected = {
         'xccdf_org.ssgproject.content_profile_ospp42' => 'OSPP - Protection '\
         'Profile for General Purpose Operating Systems v. 4.2'
       }
-      assert_equal expected, profiles
+      assert_equal expected, test_parser.test_result_profiles
     end
   end
 end