abide_dev_utils 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8f5dc40bfe8e447b1440435f020db1fb63decccaa405d52301251d9b5786af9
-  data.tar.gz: 414c7c96cfb731b65ff942cac68cf078ac2d7e4bac01da3a567f0ace10599243
+  metadata.gz: 220a0a755c0e337d22a853e106935f4355564e51a759eb93967e3aeba5a9f020
+  data.tar.gz: e0272122e07a4e53d3efa71486de5dc7a0229ca0d22214b3311c94df0c90100b
 SHA512:
-  metadata.gz: bee0317d5e0c9b745537771c5c9425fb74d8c3a1a745dbaf2b694d9e258730608bf1616404efb59380a6178e51308385f1c4d6bb120fc9f35dd953432569c518
-  data.tar.gz: 47b08b70d6e148804606222ecd9a5d53740483f57c87613bead2fb8292d6f668a4a2507a046c5edb452a353d27ca6193d04f4736d347ac8c6f04291a1dbd61d0
+  metadata.gz: c7710f102655653f4181694c8dd076acff1dfd8040120c54157bc77a89f3db4a892854d2110ac4a47974ead2fdc23c3b3028c4459aa9e7bf75145e71fcebad0b
+  data.tar.gz: a5d0d101010f6ba4129346c4c4447f433b5a61e36e9000c3dab653a1709b78ff08203ec2dd014e61489d09eb2a78badfb51e233d8cbe33d85c903c3654cae90f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.15.0)
+    abide_dev_utils (0.16.0)
       cmdparse (~> 3.0)
       facterdb (>= 1.21)
       google-cloud-storage (~> 1.34)

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

@@ -85,7 +85,7 @@ module AbideDevUtils
                 next if benchmark.framework == 'stig' && control.id_map_type != 'vulnid'
 
                 control_md = ControlMarkdown.new(control, @md, @strings, @module_name, benchmark.framework, opts: @opts)
-                control_md.generate!
+                control_md.generate! if control_md.verify_profile_and_level_selections
                 progress_bar.increment unless @opts[:quiet]
               rescue StandardError => e
                 raise "Failed to generate markdown for control #{control.id}. Original message: #{e.message}"
@@ -248,6 +248,8 @@ module AbideDevUtils
             @framework = framework
             @formatter = formatter.nil? ? TypeExprValueFormatter : formatter
             @opts = opts
+            @valid_level = []
+            @valid_profile = []
             @control_data = {}
           end
 
@@ -262,6 +264,43 @@ module AbideDevUtils
             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.
+          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
+          end
+
           private
 
           def heading_builder
@@ -340,18 +379,36 @@ module AbideDevUtils
           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.
             @md.add_ul('Supported Levels:')
-            @control.levels.each do |l|
-              @md.add_ul(@md.code(l), indent: 1)
+            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
             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.
             @md.add_ul('Supported Profiles:')
-            @control.profiles.each do |l|
-              @md.add_ul(@md.code(l), indent: 1)
+            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
             end
           end
 
@@ -364,6 +421,18 @@ module AbideDevUtils
             end
           end
 
+          # Function that returns true if the profile is in the list of profiles that we want to use.
+          # @param profile [String] the profile to filter
+          def select_control_profile(profile)
+            @opts[:select_profile].include? profile
+          end
+
+          # Function that returns true if the level is in the list of levels that we want to use.
+          # @param level [String] the level to filter
+          def select_control_level(level)
+            @opts[:select_level].include? level
+          end
+
           def dependent_controls_builder
             dep_ctrls = @control.resource.dependent_controls
             return if dep_ctrls.nil? || dep_ctrls.empty?

data/lib/abide_dev_utils/cli/cem.rb

@@ -113,6 +113,12 @@ module Abide
         options.on('-s', '--strict', 'Fails if there are any errors') do
           @data[:strict] = true
         end
+        options.on('-p [PROFILE]', '--select-profile [PROFILE]', 'The list of profiles that the reference.md will use separated by commas') do |pr|
+          @data[:select_profile] = pr.split(',')
+        end
+        options.on('-l [LEVEL]', '--select-level [LEVEL]', 'The list of level that the reference.md will use separated by commas') do |l|
+          @data[:select_level] = l.split(',')
+        end
       end
 
       def execute

data/lib/abide_dev_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - abide-team
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -448,7 +448,7 @@ metadata:
   homepage_uri: https://github.com/puppetlabs/abide_dev_utils
   source_code_uri: https://github.com/puppetlabs/abide_dev_utils
   changelog_uri: https://github.com/puppetlabs/abide_dev_utils
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -463,8 +463,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Helper utilities for developing compliance Puppet code
 test_files: []