abide_dev_utils 0.10.1 → 0.11.2

data/lib/abide_dev_utils/xccdf/utils.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/validate'
+
+module AbideDevUtils
+  module XCCDF
+    module Utils
+      # Class for working with directories that contain XCCDF files
+      class FileDir
+        CIS_FILE_NAME_PARTS_PATTERN = /^CIS_(?<subject>[A-Za-z0-9._()-]+)_Benchmark_v(?<version>[0-9.]+)-xccdf$/.freeze
+        def initialize(path)
+          @path = File.expand_path(path)
+          AbideDevUtils::Validate.directory(@path)
+        end
+
+        def files
+          @files ||= Dir.glob(File.join(@path, '*-xccdf.xml')).map { |f| FileNameData.new(f) }
+        end
+
+        def fuzzy_find(label, value)
+          files.find { |f| f.fuzzy_match?(label, value) }
+        end
+
+        def fuzzy_select(label, value)
+          files.select { |f| f.fuzzy_match?(label, value) }
+        end
+
+        def fuzzy_reject(label, value)
+          files.reject { |f| f.fuzzy_match?(label, value) }
+        end
+
+        def label?(label)
+          files.select { |f| f.has?(label) }
+        end
+
+        def no_label?(label)
+          files.reject { |f| f.has?(label) }
+        end
+      end
+
+      # Parses XCCDF file names into labeled parts
+      class FileNameData
+        CIS_PATTERN = /^CIS_(?<subject>[A-Za-z0-9._()-]+?)(?<stig>_STIG)?_Benchmark_v(?<version>[0-9.]+)-xccdf$/.freeze
+
+        attr_reader :path, :name, :labeled_parts
+
+        def initialize(path)
+          @path = path
+          @name = File.basename(path, '.xml')
+          @labeled_parts = File.basename(name, '.xml').match(CIS_PATTERN)&.named_captures
+        end
+
+        def subject
+          @subject ||= labeled_parts&.fetch('subject', nil)
+        end
+
+        def stig
+          @stig ||= labeled_parts&.fetch('subject', nil)
+        end
+
+        def version
+          @version ||= labeled_parts&.fetch('version', nil)
+        end
+
+        def has?(label)
+          val = send(label.to_sym)
+          !val.nil? && !val.empty?
+        end
+
+        def fuzzy_match?(label, value)
+          return false unless has?(label)
+
+          this_val = normalize_char_array(send(label.to_sym).chars)
+          other_val = normalize_char_array(value.chars)
+          other_val.each_with_index do |c, idx|
+            return false unless this_val[idx] == c
+          end
+          true
+        end
+
+        private
+
+        def normalize_char_array(char_array)
+          char_array.grep_v(/[^A-Za-z0-9]/).map(&:downcase)[3..]
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/xccdf.rb

@@ -70,6 +70,7 @@ module AbideDevUtils
       CIS_LEVEL_CODE = /(?:_|^)([Ll]evel_[0-9]|[Ll]1|[Ll]2|[NnBb][GgLl]|#{CIS_NEXT_GEN_WINDOWS})/.freeze
       CIS_CONTROL_PARTS = /#{CIS_CONTROL_NUMBER}#{CIS_LEVEL_CODE}?_+([A-Za-z].*)/.freeze
       CIS_PROFILE_PARTS = /#{CIS_LEVEL_CODE}[_-]+([A-Za-z].*)/.freeze
+      STIG_PROFILE_PARTS = /(STIG)/.freeze
 
       def xpath(path)
         @xml.xpath(path)
@@ -119,6 +120,8 @@ module AbideDevUtils
       end
 
       def profile_parts(profile)
+        return ['STIG', ''] if profile == 'STIG'
+
         parts = control_profile_text(profile).match(CIS_PROFILE_PARTS)
         raise AbideDevUtils::Errors::ProfilePartsError, profile if parts.nil?
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.2
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: facterdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -345,6 +359,21 @@ files:
 - exe/abide
 - lib/abide_dev_utils.rb
 - lib/abide_dev_utils/cem.rb
+- lib/abide_dev_utils/cem/benchmark.rb
+- lib/abide_dev_utils/cem/generate.rb
+- lib/abide_dev_utils/cem/generate/coverage_report.rb
+- lib/abide_dev_utils/cem/generate/reference.rb
+- lib/abide_dev_utils/cem/hiera_data.rb
+- lib/abide_dev_utils/cem/hiera_data/mapping_data.rb
+- lib/abide_dev_utils/cem/hiera_data/mapping_data/map_data.rb
+- lib/abide_dev_utils/cem/hiera_data/mapping_data/mixins.rb
+- lib/abide_dev_utils/cem/hiera_data/resource_data.rb
+- lib/abide_dev_utils/cem/hiera_data/resource_data/control.rb
+- lib/abide_dev_utils/cem/hiera_data/resource_data/parameters.rb
+- lib/abide_dev_utils/cem/hiera_data/resource_data/resource.rb
+- lib/abide_dev_utils/cem/mapping/mapper.rb
+- lib/abide_dev_utils/cem/validate.rb
+- lib/abide_dev_utils/cem/validate/resource_data.rb
 - lib/abide_dev_utils/cli.rb
 - lib/abide_dev_utils/cli/abstract.rb
 - lib/abide_dev_utils/cli/cem.rb
@@ -356,8 +385,10 @@ files:
 - lib/abide_dev_utils/comply.rb
 - lib/abide_dev_utils/config.rb
 - lib/abide_dev_utils/constants.rb
+- lib/abide_dev_utils/dot_number_comparable.rb
 - lib/abide_dev_utils/errors.rb
 - lib/abide_dev_utils/errors/base.rb
+- lib/abide_dev_utils/errors/cem.rb
 - lib/abide_dev_utils/errors/comply.rb
 - lib/abide_dev_utils/errors/gcloud.rb
 - lib/abide_dev_utils/errors/general.rb
@@ -367,13 +398,27 @@ files:
 - lib/abide_dev_utils/files.rb
 - lib/abide_dev_utils/gcloud.rb
 - lib/abide_dev_utils/jira.rb
+- lib/abide_dev_utils/markdown.rb
 - lib/abide_dev_utils/mixins.rb
 - lib/abide_dev_utils/output.rb
 - lib/abide_dev_utils/ppt.rb
 - lib/abide_dev_utils/ppt/api.rb
 - lib/abide_dev_utils/ppt/class_utils.rb
-- lib/abide_dev_utils/ppt/coverage.rb
+- lib/abide_dev_utils/ppt/code_gen.rb
+- lib/abide_dev_utils/ppt/code_gen/data_types.rb
+- lib/abide_dev_utils/ppt/code_gen/generate.rb
+- lib/abide_dev_utils/ppt/code_gen/resource.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types/base.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types/class.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types/manifest.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types/parameter.rb
+- lib/abide_dev_utils/ppt/code_gen/resource_types/strings.rb
+- lib/abide_dev_utils/ppt/code_introspection.rb
+- lib/abide_dev_utils/ppt/facter_utils.rb
+- lib/abide_dev_utils/ppt/hiera.rb
 - lib/abide_dev_utils/ppt/new_obj.rb
+- lib/abide_dev_utils/ppt/puppet_module.rb
 - lib/abide_dev_utils/ppt/score_module.rb
 - lib/abide_dev_utils/prompt.rb
 - lib/abide_dev_utils/resources/generic_spec.erb
@@ -388,9 +433,11 @@ files:
 - lib/abide_dev_utils/xccdf/diff/benchmark/property_existence.rb
 - lib/abide_dev_utils/xccdf/diff/utils.rb
 - lib/abide_dev_utils/xccdf/parser.rb
+- lib/abide_dev_utils/xccdf/parser/helpers.rb
 - lib/abide_dev_utils/xccdf/parser/objects.rb
 - lib/abide_dev_utils/xccdf/parser/objects/digest_object.rb
 - lib/abide_dev_utils/xccdf/parser/objects/numbered_object.rb
+- lib/abide_dev_utils/xccdf/utils.rb
 - new_diff.rb
 homepage: https://github.com/puppetlabs/abide_dev_utils
 licenses:

data/lib/abide_dev_utils/ppt/coverage.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'pathname'
-require 'yaml'
-require 'puppet_pal'
-require 'abide_dev_utils/ppt/class_utils'
-
-module AbideDevUtils
-  module Ppt
-    class CoverageReport
-      def self.generate(puppet_class_dir, hiera_path, profile = nil)
-        coverage = {}
-        coverage['classes'] = {}
-        all_cap = ClassUtils.find_all_classes_and_paths(puppet_class_dir)
-        invalid_classes = find_invalid_classes(all_cap)
-        valid_classes = find_valid_classes(all_cap, invalid_classes)
-        coverage['classes']['invalid'] = invalid_classes
-        coverage['classes']['valid'] = valid_classes
-        hiera = YAML.safe_load(File.open(hiera_path))
-        profile&.gsub!(/^profile_/, '') unless profile.nil?
-
-        matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
-        hiera.each do |k, v|
-          key_base = k.split('::')[-1]
-          coverage['benchmark'] = v if key_base == 'title'
-          next unless key_base.match?(matcher)
-
-          coverage[key_base] = generate_uncovered_data(v, valid_classes)
-        end
-        coverage
-      end
-
-      def self.generate_uncovered_data(ctrl_list, valid_classes)
-        out_hash = {}
-        out_hash[:num_total] = ctrl_list.length
-        out_hash[:uncovered] = []
-        out_hash[:covered] = []
-        ctrl_list.each do |c|
-          if valid_classes.include?(c)
-            out_hash[:covered] << c
-          else
-            out_hash[:uncovered] << c
-          end
-        end
-        out_hash[:num_covered] = out_hash[:covered].length
-        out_hash[:num_uncovered] = out_hash[:uncovered].length
-        out_hash[:coverage] = Float(
-          (Float(out_hash[:num_covered]) / Float(out_hash[:num_total])) * 100.0
-        ).floor(3)
-        out_hash
-      end
-
-      def self.find_valid_classes(all_cap, invalid_classes)
-        all_classes = all_cap.dup.transpose[0]
-        return [] if all_classes.nil?
-
-        return all_classes - invalid_classes unless invalid_classes.nil?
-
-        all_classes
-      end
-
-      def self.find_invalid_classes(all_cap)
-        invalid_classes = []
-        all_cap.each do |cap|
-          invalid_classes << cap[0] unless class_valid?(cap[1])
-        end
-        invalid_classes
-      end
-
-      def self.class_valid?(manifest_path)
-        compiler = Puppet::Pal::Compiler.new(nil)
-        ast = compiler.parse_file(manifest_path)
-        ast.body.body.statements.each do |s|
-          next unless s.respond_to?(:arguments)
-          next unless s.arguments.respond_to?(:each)
-
-          s.arguments.each do |i|
-            return false if i.value == 'Not implemented'
-          end
-        end
-        true
-      end
-    end
-  end
-end