inspec_tools 2.0.7 → 2.1.0

data/lib/utilities/xccdf/xccdf_score.rb

@@ -0,0 +1,116 @@
+module Utils
+  # Perform scoring calculations for the different types that is used in a TestResult score.
+  class XCCDFScore
+    # @param groups [Array[HappyMapperTools::Benchmark::Group]]
+    # @param rule_results [Array[RuleResultType]]
+    def initialize(groups, rule_results)
+      @groups = groups
+      @rule_results = rule_results
+    end
+
+    # Calculate and return the urn:xccdf:scoring:default score for the entire benchmark.
+    # @return ScoreType
+    def default_score
+      HappyMapperTools::Benchmark::ScoreType.new('urn:xccdf:scoring:default', 100, score_benchmark_default)
+    end
+
+    # urn:xccdf:scoring:flat
+    # @return ScoreType
+    def flat_score
+      results = score_benchmark_with_weights(true)
+      HappyMapperTools::Benchmark::ScoreType.new('urn:xccdf:scoring:flat', results[:max], results[:score])
+    end
+
+    # urn:xccdf:scoring:flat-unweighted
+    # @return ScoreType
+    def flat_unweighted_score
+      results = score_benchmark_with_weights(false)
+      HappyMapperTools::Benchmark::ScoreType.new('urn:xccdf:scoring:flat-unweighted', results[:max], results[:score])
+    end
+
+    # urn:xccdf:scoring:absolute
+    # @return ScoreType
+    def absolute_score
+      results = score_benchmark_with_weights(true)
+      HappyMapperTools::Benchmark::ScoreType.new('urn:xccdf:scoring:absolute', 1, (results[:max] == results[:score] && results[:max].positive? ? 1 : 0))
+    end
+
+    private
+
+    # Return the overall score for the default model
+    def score_benchmark_default
+      return 0.0 unless @groups
+
+      count = 0
+      cumulative_score = 0.0
+
+      @groups.each do |group|
+        # Default weighted scoring only provides value when more than one rule exists per group. This implementation
+        # is not currently supporting more than one rule per group so weight need not apply.
+        rule_score = score_default_rule(test_results(group.rule.id))
+
+        if rule_score[:rule_count].positive?
+          count += 1
+          cumulative_score += rule_score[:rule_score]
+        end
+      end
+
+      return 0.0 unless count.positive?
+
+      (cumulative_score / count).round(2)
+    end
+
+    # @param weighted [Boolean] Indicate to apply with weights.
+    def score_benchmark_with_weights(weighted)
+      score = 0.0
+      max_score = 0.0
+
+      return { score: score, max: max_score } unless @groups
+
+      @groups.each do |group|
+        # Default weighted scoring only provides value when more than one rule exists per group. This implementation
+        # is not currently supporting more than one rule per group so weight need not apply.
+        rule_score = rule_counts_and_score(test_results(group.rule.id))
+
+        next unless rule_score[:rule_count].positive?
+
+        weight =
+          if weighted
+            group.rule.weight.nil? ? 1.0 : group.rule.weight.to_f
+          else
+            group.rule.weight.nil? || group.rule.weight.to_f != 0.0 ? 1.0 : 0.0
+          end
+
+        max_score += weight
+        score += (weight * rule_score[:rule_score]) / rule_score[:rule_count]
+      end
+
+      { score: score.round(2), max: max_score }
+    end
+
+    def score_default_rule(results)
+      sum = rule_counts_and_score(results)
+      return sum if sum[:rule_count].zero?
+
+      sum[:rule_score] = (100 * sum[:rule_score]) / sum[:rule_count]
+      sum
+    end
+
+    # Perform basic summation of rule results and passing tests
+    def rule_counts_and_score(results)
+      excluded_results = %w{notapplicable notchecked informational notselected}
+      rule_count = results.count { |r| !excluded_results.include?(r.result) }
+      rule_score = results.count { |r| r.result == 'pass' }
+
+      { rule_count: rule_count, rule_score: rule_score }
+    end
+
+    # Get all test results with the matching rule id
+    # @return [Array]
+    def test_results(id)
+      return [] unless @rule_results
+
+      @rule_results.select { |r| r.idref == id }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inspec_tools
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0
 platform: ruby
 authors:
 - Robert Thew
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -27,6 +27,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: git-lite-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: inspec
   requirement: !ruby/object:Gem::Requirement
@@ -132,41 +146,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: word_wrap
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: git-lite-version-bump
+  name: word_wrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -174,7 +188,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,7 +202,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -202,7 +216,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -216,21 +230,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -244,7 +258,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -258,7 +272,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -304,6 +318,7 @@ files:
 - lib/inspec_tools/ckl.rb
 - lib/inspec_tools/cli.rb
 - lib/inspec_tools/csv.rb
+- lib/inspec_tools/generate_map.rb
 - lib/inspec_tools/help.rb
 - lib/inspec_tools/help/compliance.md
 - lib/inspec_tools/help/csv2inspec.md
@@ -327,12 +342,17 @@ files:
 - lib/overrides/object.rb
 - lib/overrides/string.rb
 - lib/overrides/true_class.rb
+- lib/utilities/cci_xml.rb
 - lib/utilities/cis_to_nist.rb
 - lib/utilities/csv_util.rb
 - lib/utilities/extract_pdf_text.rb
 - lib/utilities/inspec_util.rb
+- lib/utilities/mapping_validator.rb
 - lib/utilities/parser.rb
 - lib/utilities/text_cleaner.rb
+- lib/utilities/xccdf/from_inspec.rb
+- lib/utilities/xccdf/to_xccdf.rb
+- lib/utilities/xccdf/xccdf_score.rb
 homepage: https://inspec-tools.mitre.org/
 licenses:
 - Apache-2.0