abide_dev_utils 0.18.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9b2c93e57d8e1ac68f08bc2d2135185591e0588e2403984e5d9eef6a6ff4e2
-  data.tar.gz: cd9e1a9a6b5020fe00e4390afde8b7717e28b1fb99eca9f868ea91ac03534c57
+  metadata.gz: b4687964cd4b5d202b892c1fbcbc26bae0a4b7ca50892510e66aa1e2ba0a99bb
+  data.tar.gz: e13bbfac5991052c33a8626eed6354454522a5bb3d9211a2d387aa1a5890f191
 SHA512:
-  metadata.gz: 7f0035231a3870d55f1e84f140eb315eb0169e2492d69debd0f5d469705bb5ea4848a0f2b753d4e933f9ccf9b1f18c9a7127d0c26bc2483fbbf21da91eb3982f
-  data.tar.gz: 6eb452f64cbfd4c58d3c37c3808b655c316d1f54adad53f246c0c9b86712a254162a06c0b452a9f94946056d177ee560afef50680c9967de826e826e25b86cf6
+  metadata.gz: 87c903786292eb538ae1e210734fa539b6b551d2cb5d29886175c234e196d29f9cce8627b08e72dedf661945bc8796980c5da5d737a63acfac8216265a7d06a5
+  data.tar.gz: f8ba2cdcb7f2074990563c2791d82d51bd171142446410f5700a7c64bcb36c761034b2bb1a2324b756a66563bc8c18ab949d7fc3454a08cee44e74d9306d3743

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.18.0)
+    abide_dev_utils (0.18.2)
       cmdparse (~> 3.0)
-      facterdb (>= 1.21)
+      facterdb (~> 2.1.0)
       google-cloud-storage (~> 1.34)
       hashdiff (~> 1.0)
       jira-ruby (~> 2.2)
@@ -61,9 +61,9 @@ GEM
     facter (4.4.1)
       hocon (~> 1.3)
       thor (>= 1.0.1, < 2.0)
-    facterdb (1.21.0)
+    facterdb (2.1.0)
       facter (< 5.0.0)
-      jgrep
+      jgrep (~> 1.5, >= 1.5.4)
     faraday (2.3.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
@@ -208,7 +208,8 @@ GEM
       trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
     retriable (3.1.2)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rgen (0.9.1)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -262,6 +263,7 @@ GEM
       hashie
       version_gem (~> 1.1, >= 1.1.1)
     spdx-licenses (1.3.0)
+    strscan (3.1.0)
     thor (1.2.2)
     timers (4.3.3)
     traces (0.11.1)

data/abide_dev_utils.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'selenium-webdriver', '~> 4.0.0.beta4'
   spec.add_dependency 'google-cloud-storage', '~> 1.34'
   spec.add_dependency 'hashdiff', '~> 1.0'
-  spec.add_dependency 'facterdb', '>= 1.21'
+  spec.add_dependency 'facterdb', '~> 2.1.0'
   spec.add_dependency 'metadata-json-lint', '~> 4.0'
 
   # Dev dependencies

data/lib/abide_dev_utils/cli/sce.rb

@@ -126,7 +126,35 @@ module Abide
 
       def execute
         AbideDevUtils::Validate.puppet_module_directory
-        AbideDevUtils::Sce::Generate::Reference.generate(@data)
+        errors, warnings = AbideDevUtils::Sce::Generate::Reference.generate(@data)
+
+        errors.each do |err|
+          output = ["[error]: #{err.message}"]
+          # Errors should all be instances of AbideDevUtils::Errors::BenchmarkLoadError
+          # We check that the extra methods on this error are valid before calling them, though, because
+          # other errors might be returned somehow.
+          if err.respond_to?(:osname) && err.respond_to?(:major_version)
+            output << "Operating System: #{err.osname} #{err.major_version}"
+          end
+          output << "Framework: #{err.framework}" if err.respond_to?(:framework)
+          output << "Puppet Module: #{err.module_name}" if err.respond_to?(:module_name)
+          output << "Original Error Type: #{err.original_error.class}" if err.respond_to?(:original_error)
+          output << "Backtrace:\n\t\t#{err.backtrace.join("\n\t\t")}\n"
+          AbideDevUtils::Output.simple(output.join("\n\t"), stream: $stderr)
+        end
+        warnings.each do |err|
+          output = ["[warn]: #{err.message}"]
+          # Errors should all be instances of AbideDevUtils::Errors::BenchmarkLoadError
+          # We check that the extra methods on this error are valid before calling them, though, because
+          # other errors might be returned somehow.
+          if err.respond_to?(:osname) && err.respond_to?(:major_version)
+            output << "Operating System: #{err.osname} #{err.major_version}"
+          end
+          output << "Framework: #{err.framework}" if err.respond_to?(:framework)
+          output << "Puppet Module: #{err.module_name}" if err.respond_to?(:module_name)
+          AbideDevUtils::Output.simple(output.join("\n\t"), stream: $stderr)
+        end
+        exit 1 unless errors.empty?
       end
     end
 

data/lib/abide_dev_utils/errors/sce.rb

@@ -28,5 +28,22 @@ module AbideDevUtils
     class ControlIdFrameworkMismatchError < GenericError
       @default = 'Control ID is invalid with the given framework:'
     end
+
+    # Raised when a benchmark fails to load for a non-specific reason
+    class BenchmarkLoadError < GenericError
+      attr_accessor :framework, :osname, :major_version, :module_name, :original_error
+
+      @default = 'Error loading benchmark:'
+
+      def message
+        [
+          "#{super} (#{original_error.class})",
+          "Framework: #{framework}",
+          "OS Name: #{osname}",
+          "OS Version: #{major_version}",
+          "Module Name: #{module_name}"
+        ].join(', ')
+      end
+    end
   end
 end

data/lib/abide_dev_utils/markdown.rb

@@ -30,9 +30,9 @@ module AbideDevUtils
       end
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, **kwargs, &block)
       if name.to_s.start_with?('add_')
-        add(name.to_s.sub('add_', '').to_sym, *args, &block)
+        add(name.to_s.sub('add_', '').to_sym, *args, **kwargs, &block)
       else
         super
       end

data/lib/abide_dev_utils/sce/benchmark.rb

@@ -148,7 +148,7 @@ module AbideDevUtils
     # Represents a singular rule in a benchmark
     class Control
       include AbideDevUtils::DotNumberComparable
-      attr_reader :id, :params, :resource, :framework, :dependent
+      attr_reader :id, :params, :resource, :framework, :dependent, :profiles_levels
 
       def initialize(id, params, resource, framework, mapper)
         validate_id_with_framework(id, framework, mapper)
@@ -157,6 +157,7 @@ module AbideDevUtils
         @resource = resource
         @framework = framework
         @mapper = mapper
+        @profiles_levels = find_levels_and_profiles
         raise AbideDevUtils::Errors::NoMappingDataForControlError, @id unless @mapper.get(id)
       end
 
@@ -202,12 +203,38 @@ module AbideDevUtils
         send(display_title_type) unless display_title_type.nil?
       end
 
+      def profiles_levels_by_level(lvl)
+        pls = profiles_levels.map do |plstr|
+          _, l = plstr.split(';;;', 2)
+          plstr if l == lvl || (lvl.is_a?(Array) && lvl.include?(l))
+        end
+        pls.compact.uniq
+      end
+
+      def profiles_levels_by_profile(prof)
+        pls = profiles_levels.map do |plstr|
+          p, = plstr.split(';;;', 2)
+          plstr if p == prof || (prof.is_a?(Array) && prof.include?(p))
+        end
+        pls.compact.uniq
+      end
+
+      def filtered_profiles_levels(prof: nil, lvl: nil)
+        return profiles_levels if (prof.nil? || prof.empty?) && (lvl.nil? || lvl.empty?)
+        if prof && lvl && !prof.empty? && !lvl.empty?
+          return profiles_levels_by_profile(prof).concat(profiles_levels_by_level(lvl))
+        end
+        return profiles_levels_by_profile(prof) unless prof&.empty?
+
+        profiles_levels_by_level(lvl)
+      end
+
       def levels
-        levels_and_profiles[0]
+        profiles_levels.map { |plstr| plstr.split(';;;', 2).last }
       end
 
       def profiles
-        levels_and_profiles[1]
+        profiles_levels.map { |plstr| plstr.split(';;;', 2).first }
       end
 
       def valid_maps?
@@ -269,22 +296,16 @@ module AbideDevUtils
         @map ||= @mapper.get(id)
       end
 
-      def levels_and_profiles
-        @levels_and_profiles ||= find_levels_and_profiles
-      end
-
       def find_levels_and_profiles
-        lvls = []
-        profs = []
+        profs_lvls = []
         @mapper.levels.each do |lvl|
           @mapper.profiles.each do |prof|
-            unless @mapper.get(id, level: lvl, profile: prof).nil?
-              lvls << lvl
-              profs << prof
-            end
+            next unless @mapper.get(id, level: lvl, profile: prof)
+
+            profs_lvls << "#{prof};;;#{lvl}"
           end
         end
-        [lvls.flatten.compact.uniq, profs.flatten.compact.uniq]
+        profs_lvls.uniq.sort
       end
 
       def ruby_class_to_puppet_type(class_name)
@@ -337,51 +358,6 @@ module AbideDevUtils
         @controls = resources.map(&:controls).flatten.sort
       end
 
-      # Creates Benchmark objects from a Puppet module
-      # @param pupmod [AbideDevUtils::Ppt::PuppetModule] A PuppetModule instance
-      # @param skip_errors [Boolean] True skips errors and loads non-erroring benchmarks, false raises the error.
-      # @return [Array<AbideDevUtils::Sce::Benchmark>] Array of Benchmark instances
-      def self.benchmarks_from_puppet_module(pupmod, ignore_all_errors: false, ignore_framework_mismatch: true)
-        frameworks = pupmod.hiera_conf.local_hiera_files(hierarchy_name: 'Mapping Data').each_with_object([]) do |hf, ary|
-          parts = hf.path.split(pupmod.hiera_conf.default_datadir)[-1].split('/')
-          ary << parts[2] unless ary.include?(parts[2])
-        end
-        pupmod.supported_os.each_with_object([]) do |supp_os, ary|
-          osname, majver = supp_os.split('::')
-          if majver.is_a?(Array)
-            majver.sort.each do |v|
-              frameworks.each do |fw|
-                benchmark = Benchmark.new(osname,
-                                          v,
-                                          pupmod.hiera_conf,
-                                          pupmod.name(strip_namespace: true),
-                                          framework: fw)
-                benchmark.controls
-                ary << benchmark
-              rescue AbideDevUtils::Errors::MappingDataFrameworkMismatchError => e
-                raise e unless ignore_all_errors || ignore_framework_mismatch
-              rescue StandardError => e
-                raise e unless ignore_all_errors
-              end
-            end
-          else
-            frameworks.each do |fw|
-              benchmark = Benchmark.new(osname,
-                                        majver,
-                                        pupmod.hiera_conf,
-                                        pupmod.name(strip_namespace: true),
-                                        framework: fw)
-              benchmark.controls
-              ary << benchmark
-            rescue AbideDevUtils::Errors::MappingDataFrameworkMismatchError => e
-              raise e unless ignore_all_errors || ignore_framework_mismatch
-            rescue StandardError => e
-              raise e unless ignore_all_errors
-            end
-          end
-        end
-      end
-
       def map_data
         mapper.map_data
       end

data/lib/abide_dev_utils/sce/benchmark_loader.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../ppt/puppet_module'
+require_relative 'benchmark'
+
+module AbideDevUtils
+  module Sce
+    # Namespace for classes and methods for loading benchmarks
+    module BenchmarkLoader
+      # Load benchmarks from a Puppet module
+      # @param module_dir [String] the directory of the Puppet module
+      # @param opts [Hash] options for loading the benchmarks
+      # @option opts [Boolean] :ignore_all_errors ignore all errors when loading benchmarks
+      # @option opts [Boolean] :ignore_framework_mismatch ignore errors when the framework doesn't match
+      # @return [Array<AbideDevUtils::Sce::Benchmark>] the loaded benchmarks
+      def self.benchmarks_from_puppet_module(module_dir = Dir.pwd, **opts)
+        PupMod.new(module_dir, **opts).load
+      end
+
+      # Loads benchmark data for a Puppet module
+      class PupMod
+        attr_reader :pupmod, :load_errors, :load_warnings, :ignore_all_errors, :ignore_framework_mismatch
+
+        def initialize(module_dir = Dir.pwd, **opts)
+          @pupmod = AbideDevUtils::Ppt::PuppetModule.new(module_dir)
+          @load_errors = []
+          @load_warnings = []
+          @ignore_all_errors = opts.fetch(:ignore_all_errors, false)
+          @ignore_framework_mismatch = opts.fetch(:ignore_framework_mismatch, false)
+        end
+
+        # Load the benchmark from the Puppet module
+        # @return [Array<AbideDevUtils::Sce::Benchmark>] the loaded benchmarks
+        # @raise [AbideDevUtils::Errors::BenchmarkLoadError] if a benchmark fails to load
+        def load
+          clear_load_errors
+          clear_load_warnings
+          pupmod.supported_os.each_with_object([]) do |supp_os, ary|
+            osname, majver = supp_os.split('::')
+            if majver.is_a?(Array)
+              majver.sort.each do |v|
+                frameworks.each do |fw|
+                  ary << new_benchmark(osname, v, fw)
+                rescue StandardError => e
+                  handle_load_error(e, fw, osname, v, pupmod.name(strip_namespace: true))
+                end
+              end
+            else
+              frameworks.each do |fw|
+                ary << new_benchmark(osname, majver, fw)
+              rescue StandardError => e
+                handle_load_error(e, fw, osname, majver, pupmod.name(strip_namespace: true))
+              end
+            end
+          end
+        end
+
+        private
+
+        def clear_load_errors
+          @load_errors = []
+        end
+
+        def clear_load_warnings
+          @load_warnings = []
+        end
+
+        def frameworks
+          @frameworks ||= pupmod.hiera_conf.local_hiera_files(hierarchy_name: 'Mapping Data').each_with_object([]) do |hf, ary|
+            parts = hf.path.split(pupmod.hiera_conf.default_datadir)[-1].split('/')
+            ary << parts[2] unless ary.include?(parts[2])
+          end
+        end
+
+        def new_benchmark(osname, majver, framework)
+          benchmark = AbideDevUtils::Sce::Benchmark.new(
+            osname,
+            majver,
+            pupmod.hiera_conf,
+            pupmod.name(strip_namespace: true),
+            framework: framework
+          )
+          benchmark.controls
+          benchmark
+        end
+
+        def handle_load_error(error, framework, osname, majver, module_name)
+          err = AbideDevUtils::Errors::BenchmarkLoadError.new(error.message)
+          err.set_backtrace(error.backtrace)
+          err.framework = framework
+          err.osname = osname
+          err.major_version = majver
+          err.module_name = module_name
+          err.original_error = error
+          if error.is_a?(AbideDevUtils::Errors::MappingDataFrameworkMismatchError) && ignore_framework_mismatch
+            @load_warnings << err
+          elsif ignore_all_errors
+            @load_errors << err
+          else
+            @load_errors << err
+            raise err
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/sce/generate/coverage_report.rb

@@ -4,9 +4,9 @@ require 'date'
 require 'json'
 require 'pathname'
 require 'yaml'
-require 'abide_dev_utils/ppt'
-require 'abide_dev_utils/validate'
-require 'abide_dev_utils/sce/benchmark'
+require_relative '../../ppt'
+require_relative '../../validate'
+require_relative '../benchmark_loader'
 
 module AbideDevUtils
   module Sce
@@ -16,9 +16,9 @@ module AbideDevUtils
       module CoverageReport
         def self.generate(format_func: :to_h, opts: {})
           opts = ReportOptions.new(opts)
-          pupmod = AbideDevUtils::Ppt::PuppetModule.new
-          benchmarks = AbideDevUtils::Sce::Benchmark.benchmarks_from_puppet_module(pupmod,
-                                                                                   ignore_all_errors: opts.ignore_all_errors)
+          benchmarks = AbideDevUtils::Sce::BenchmarkLoader.benchmarks_from_puppet_module(
+            ignore_all_errors: opts.ignore_all_errors
+          )
           benchmarks.map do |b|
             BenchmarkReport.new(b, opts).run.send(format_func)
           end

data/lib/abide_dev_utils/sce/generate/reference.rb

@@ -6,10 +6,10 @@ require 'puppet-strings/yard'
 require 'shellwords'
 require 'timeout'
 require 'yaml'
-require 'abide_dev_utils/markdown'
-require 'abide_dev_utils/output'
-require 'abide_dev_utils/ppt'
-require 'abide_dev_utils/sce/benchmark'
+require_relative '../../markdown'
+require_relative '../../output'
+require_relative '../../ppt'
+require_relative '../benchmark_loader'
 
 module AbideDevUtils
   module Sce
@@ -19,9 +19,14 @@ module AbideDevUtils
         MAPPING_PATH_KEY = 'Mapping Data'
         RESOURCE_DATA_PATH_KEY = 'Resource Data'
 
+        # @return [Array<Array<StandardError>>] Returns a 2d array with two items. The first item
+        #   is an array containing StandardError-derived objects that are considered halting errors
+        #   in reference generation. The second item is an array of StandardError-derived objects
+        #   that are considered non-halting (warning) errors.
         def self.generate(data = {})
-          pupmod = AbideDevUtils::Ppt::PuppetModule.new
-          doc_title = case pupmod.name
+          pupmod_path = data[:module_dir] || Dir.pwd
+          bm_loader = BenchmarkLoader::PupMod.new(pupmod_path, ignore_framework_mismatch: true)
+          doc_title = case bm_loader.pupmod.name
                       when 'puppetlabs-sce_linux'
                         'SCE for Linux Reference'
                       when 'puppetlabs-sce_windows'
@@ -29,14 +34,15 @@ module AbideDevUtils
                       else
                         'Reference'
                       end
-          benchmarks = AbideDevUtils::Sce::Benchmark.benchmarks_from_puppet_module(pupmod)
+          benchmarks = bm_loader.load
           case data.fetch(:format, 'markdown')
           when 'markdown'
             file = data[:out_file] || 'REFERENCE.md'
-            MarkdownGenerator.new(benchmarks, pupmod.name, file: file, opts: data).generate(doc_title)
+            MarkdownGenerator.new(benchmarks, bm_loader.pupmod.name, file: file, opts: data).generate(doc_title)
           else
             raise "Format #{data[:format]} is unsupported! Only `markdown` format supported"
           end
+          [bm_loader.load_errors, bm_loader.load_warnings]
         end
 
         def self.generate_markdown
@@ -122,10 +128,10 @@ module AbideDevUtils
           attr_reader :search_patterns
 
           def initialize(search_patterns: nil, opts: {})
-            @search_patterns = search_patterns || PuppetStrings::DEFAULT_SEARCH_PATTERNS
+            @search_patterns = search_patterns || ::PuppetStrings::DEFAULT_SEARCH_PATTERNS
             @debug = opts[:debug]
             @quiet = opts[:quiet]
-            PuppetStrings::Yard.setup!
+            ::PuppetStrings::Yard.setup!
             YARD::CLI::Yardoc.run(*yard_args(@search_patterns, debug: @debug, quiet: @quiet))
           end
 
@@ -219,25 +225,6 @@ module AbideDevUtils
           end
         end
 
-        # Generates markdown for Puppet classes based on Puppet Strings JSON
-        # class PuppetClassMarkdown
-        #   def initialize(puppet_classes, md, opts: {})
-        #     @puppet_classes = puppet_classes
-        #     @md = md
-        #     @opts = opts
-        #   end
-
-        #   def generate!
-        #     @puppet_classes.each do |puppet_class|
-        #       @md.add_h2(puppet_class['name'])
-        #       @md.add_paragraph("File(Line): `#{puppet_class['file']}(#{puppet_class['line']})`")
-
-        #   private
-
-        #   def doc_string_builder(puppet_class)
-        #     return if puppet_class['docstring'].nil? || puppet_class['docstring'].empty?
-        # end
-
         # Generates markdown for a control
         class ControlMarkdown
           def initialize(control, md, strings, module_name, framework, formatter: nil, opts: {})
@@ -256,49 +243,23 @@ module AbideDevUtils
           def generate!
             heading_builder
             control_params_builder
-            control_levels_builder
-            control_profiles_builder
+            control_profiles_levels_builder
             config_example_builder
             control_alternate_ids_builder
             dependent_controls_builder
             resource_reference_builder
           end
 
-          # This function act as a filter for controls based on the profile and level selections.
-          # There are few scanarios that can happen:
-          # 1. If no selections are made for profile or level, then all profiles and levels of control will be selected.
-          # 2. If selections are made for profile, then only the selected profile and all levels of control will be selected.
-          # 3. If selections are made for level, then only the selected level and all profiles of control will be selected.
-          # This function adds in some runtime overhead because we're checking each control's level and profile which is
-          # what we're going to be doing later when building the level and profile markdown, but this is
-          # necessary to ensure that the reference.md is generated the way we want it to be.
+          # This function gets the array of string representations of profiles and levels
+          # from the control based on selection filters in opts, if any.
+          # @return [Boolean] if valid profiles and levels were extracted from the control.
           def verify_profile_and_level_selections
-            return true if @opts[:select_profile].nil? && @opts[:select_level].nil?
-
-            if @opts[:select_profile].nil? && !@opts[:select_level].nil?
-              @control.levels.each do |level|
-                @valid_level << level if select_control_level(level)
-              end
-
-              return true unless @valid_level.empty?
-            elsif !@opts[:select_profile].nil? && @opts[:select_level].nil?
-              @control.profiles.each do |profile|
-                @valid_profile << profile if select_control_profile(profile)
-              end
-
-              return true unless @valid_profile.empty?
-            elsif !@opts[:select_profile].nil? && !@opts[:select_level].nil?
-              @control.levels.each do |level|
-                @valid_level << level if select_control_level(level)
-              end
-
-              @control.profiles.each do |profile|
-                @valid_profile << profile if select_control_profile(profile)
-              end
-
-              # As long as there are valid profiles and levels for the control at this stage, all is good
-              !@valid_level.empty? && !@valid_profile.empty?
-            end
+            @valid_profs_lvls = @control.filtered_profiles_levels(
+              prof: @opts[:select_profile],
+              lvl: @opts[:select_level]
+            )
+            @valid_profs_lvls.uniq!
+            !@valid_profs_lvls.empty?
           end
 
           private
@@ -365,7 +326,7 @@ module AbideDevUtils
           def control_params_builder
             return unless control_has_valid_params?
 
-            @md.add_ul('Parameters:')
+            @md.add_h3('Parameters:')
             [@control.param_hashes, @control.resource.sce_options, @control.resource.sce_protected].each do |collection|
               collection.each do |hsh|
                 rparam = resource_param(hsh)
@@ -377,56 +338,25 @@ module AbideDevUtils
             end
           end
 
-          def control_levels_builder
-            return unless @control.levels
-
-            # @valid_level is populated in verify_profile_and_level_selections from the fact that we've given
-            # the generator a list of levels we want to use. If we didn't give it a list of levels, then we
-            # want to use all of the levels that the control supports from @control.
-            if @framework == 'stig'
-              @md.add_ul('Supported MAC Levels:')
-            else
-              @md.add_ul('Supported Levels:')
-            end
-
-            if @valid_level.empty?
-              @control.levels.each do |l|
-                @md.add_ul(@md.code(l), indent: 1)
-              end
-            else
-              @valid_level.each do |l|
-                @md.add_ul(@md.code(l), indent: 1)
-              end
-            end
-          end
-
-          def control_profiles_builder
+          def control_profiles_levels_builder
             return unless @control.profiles
 
-            # @valid_profile is populated in verify_profile_and_level_selections from the fact that we've given
-            # the generator a list of profiles we want to use. If we didn't give it a list of profiles, then we
-            # want to use all of the profiles that the control supports from @control.
             if @framework == 'stig'
-              @md.add_ul('Supported Confidentiality:')
+              @md.add_h3('Supported Confidentiality & MAC Levels:')
             else
-              @md.add_ul('Supported Profiles:')
+              @md.add_h3('Supported Profiles & Levels:')
             end
 
-            if @valid_profile.empty?
-              @control.profiles.each do |l|
-                @md.add_ul(@md.code(l), indent: 1)
-              end
-            else
-              @valid_profile.each do |l|
-                @md.add_ul(@md.code(l), indent: 1)
-              end
+            @valid_profs_lvls.each do |plstr|
+              p, l = plstr.split(';;;', 2)
+              @md.add_ul(@md.code("#{p}, #{l}"), indent: 1)
             end
           end
 
           def control_alternate_ids_builder
             # return if @framework == 'stig'
 
-            @md.add_ul('Alternate Config IDs:')
+            @md.add_h3('Alternate Config IDs:')
             @control.alternate_ids.each do |l|
               @md.add_ul(@md.code(l), indent: 1)
             end
@@ -448,9 +378,8 @@ module AbideDevUtils
             dep_ctrls = @control.resource.dependent_controls
             return if dep_ctrls.nil? || dep_ctrls.empty?
 
-            @md.add_ul('Dependent controls:')
+            @md.add_h3('Dependent controls:')
             dep_ctrls.each do |ctrl|
-              puts "DEPENDENT: #{ctrl.id}"
               @md.add_ul(@md.code(ctrl.display_title), indent: 1)
             end
           end
@@ -471,11 +400,9 @@ module AbideDevUtils
             @control.title.nil? ? out_str.unshift("    #{@control.id.dump}:") : out_str.unshift("    #{@control.title.dump}:")
             out_str.unshift('  control_configs:')
             out_str.unshift("#{@module_name.split('-').last}::config:")
-            @md.add_ul('Hiera Configuration Example:')
+            @md.add_h3('Hiera Configuration Example:')
             @md.add_code_block(out_str.join("\n"), language: 'yaml')
           rescue StandardError => e
-            require 'pry'
-            binding.pry
             err_msg = [
               "Failed to generate config example for control #{@control.id}",
               "Error: #{e.message}",
@@ -486,7 +413,8 @@ module AbideDevUtils
           end
 
           def resource_reference_builder
-            @md.add_ul("Resource: #{@md.code(@control.resource.to_reference)}")
+            @md.add_h3('Resource:')
+            @md.add_ul(@md.code(@control.resource.to_reference), indent: 1)
           end
         end
 

data/lib/abide_dev_utils/sce/hiera_data/{resource_data.rb → .resource_data.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'abide_dev_utils/errors'
-require 'abide_dev_utils/ppt/facter_utils'
-require 'abide_dev_utils/sce/hiera_data/resource_data/control'
-require 'abide_dev_utils/sce/hiera_data/resource_data/resource'
+# This should be unused, keeping around incase shit breaks and it's needed
+require_relative '../../../errors'
+require_relative '../../../ppt/facter_utils'
+require_relative '../benchmark_loader'
 
 module AbideDevUtils
   module Sce

data/lib/abide_dev_utils/sce/hiera_data/resource_data/{control.rb → .control.rb}

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# This should be unused, keeping around incase shit breaks and it's needed
 require 'abide_dev_utils/dot_number_comparable'
 require 'abide_dev_utils/errors'
 require 'abide_dev_utils/sce/hiera_data/mapping_data'

data/lib/abide_dev_utils/sce/hiera_data/resource_data/{parameters.rb → .parameters.rb}

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# This should be unused, keeping around incase shit breaks and it's needed
 require 'set'
 
 module AbideDevUtils

data/lib/abide_dev_utils/sce/hiera_data/resource_data/{resource.rb → .resource.rb}

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# This should be unused, keeping around incase shit breaks and it's needed
 require 'set'
 require 'abide_dev_utils/errors'
 require 'abide_dev_utils/sce/hiera_data/resource_data/control'

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.18.0"
+  VERSION = "0.18.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.2
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -140,16 +140,16 @@ dependencies:
   name: facterdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
   requirement: !ruby/object:Gem::Requirement
@@ -432,17 +432,18 @@ files:
 - lib/abide_dev_utils/resources/generic_spec.erb
 - lib/abide_dev_utils/sce.rb
 - lib/abide_dev_utils/sce/benchmark.rb
+- lib/abide_dev_utils/sce/benchmark_loader.rb
 - lib/abide_dev_utils/sce/generate.rb
 - lib/abide_dev_utils/sce/generate/coverage_report.rb
 - lib/abide_dev_utils/sce/generate/reference.rb
 - lib/abide_dev_utils/sce/hiera_data.rb
+- lib/abide_dev_utils/sce/hiera_data/.resource_data.rb
 - lib/abide_dev_utils/sce/hiera_data/mapping_data.rb
 - lib/abide_dev_utils/sce/hiera_data/mapping_data/map_data.rb
 - lib/abide_dev_utils/sce/hiera_data/mapping_data/mixins.rb
-- lib/abide_dev_utils/sce/hiera_data/resource_data.rb
-- lib/abide_dev_utils/sce/hiera_data/resource_data/control.rb
-- lib/abide_dev_utils/sce/hiera_data/resource_data/parameters.rb
-- lib/abide_dev_utils/sce/hiera_data/resource_data/resource.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/.control.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/.parameters.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/.resource.rb
 - lib/abide_dev_utils/sce/mapping/mapper.rb
 - lib/abide_dev_utils/sce/validate.rb
 - lib/abide_dev_utils/sce/validate/resource_data.rb