abide_dev_utils 0.15.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8f5dc40bfe8e447b1440435f020db1fb63decccaa405d52301251d9b5786af9
-  data.tar.gz: 414c7c96cfb731b65ff942cac68cf078ac2d7e4bac01da3a567f0ace10599243
+  metadata.gz: 9ba88038da5800b45085201557c28a7d4096027230083e0c8d5a811a7fd1de5a
+  data.tar.gz: 78da6fd7887fdb50a7de4505b4dd95b6fa2e24400dc6b5419dcc44aaa1f15d24
 SHA512:
-  metadata.gz: bee0317d5e0c9b745537771c5c9425fb74d8c3a1a745dbaf2b694d9e258730608bf1616404efb59380a6178e51308385f1c4d6bb120fc9f35dd953432569c518
-  data.tar.gz: 47b08b70d6e148804606222ecd9a5d53740483f57c87613bead2fb8292d6f668a4a2507a046c5edb452a353d27ca6193d04f4736d347ac8c6f04291a1dbd61d0
+  metadata.gz: 3e1577583c8fcc597f75e02d3ef5edee126984f8daaea8fc98741c718c0254044767189acf24e0e21ba2b60607f4042c1f0c52be934dbc129d270008042f8bf5
+  data.tar.gz: eb8b1038e223efeec1f7a2b3d0d0ee0f04cba49f385b58c8de5e1dfe8c2d935dac0d760faf65d8ab45f0b539f4729ea9195926d0cce1d4fe294c19f6e426e879

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.15.0)
+    abide_dev_utils (0.16.1)
       cmdparse (~> 3.0)
       facterdb (>= 1.21)
       google-cloud-storage (~> 1.34)
@@ -17,7 +17,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (2.3.6)
-    activesupport (7.0.4.3)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -29,15 +29,15 @@ GEM
       console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-http (0.56.6)
+    async-http (0.60.2)
       async (>= 1.25)
       async-io (>= 1.28)
       async-pool (>= 0.2)
-      protocol-http (~> 0.22.0)
-      protocol-http1 (~> 0.14.0)
-      protocol-http2 (~> 0.14.0)
-      traces (~> 0.4.0)
-    async-http-faraday (0.11.0)
+      protocol-http (~> 0.24.0)
+      protocol-http1 (~> 0.15.0)
+      protocol-http2 (~> 0.15.0)
+      traces (>= 0.10.0)
+    async-http-faraday (0.12.0)
       async-http (~> 0.42)
       faraday
     async-io (1.33.0)
@@ -120,7 +120,7 @@ GEM
     hiera (3.12.0)
     hocon (1.4.0)
     httpclient (2.8.3)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jgrep (1.5.4)
     jira-ruby (2.3.0)
@@ -133,12 +133,14 @@ GEM
     memoist (0.16.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.18.0)
+    minitest (5.19.0)
     multi_json (1.15.0)
     multipart-post (2.3.0)
     nio4r (2.5.8)
     nokogiri (1.15.2-x86_64-darwin)
       racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
     oauth (0.6.2)
       snaky_hash (~> 2.0)
       version_gem (~> 1.1)
@@ -150,16 +152,27 @@ GEM
     parser (3.1.2.0)
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
-    protocol-http (0.22.6)
-    protocol-http1 (0.14.4)
+    protocol-http (0.24.7)
+    protocol-http1 (0.15.1)
       protocol-http (~> 0.22)
-    protocol-http2 (0.14.2)
+    protocol-http2 (0.15.1)
       protocol-hpack (~> 1.4)
       protocol-http (~> 0.18)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.7)
+    puppet (7.24.0)
+      concurrent-ruby (~> 1.0, < 1.2.0)
+      deep_merge (~> 1.0)
+      facter (> 2.0.1, < 5)
+      fast_gettext (>= 1.1, < 3)
+      hiera (>= 3.2.1, < 4)
+      locale (~> 2.1)
+      multi_json (~> 1.10)
+      puppet-resource_api (~> 1.5)
+      scanf (~> 1.0)
+      semantic_puppet (~> 1.0)
     puppet (7.24.0-universal-darwin)
       CFPropertyList (~> 2.2)
       concurrent-ruby (~> 1.0, < 1.2.0)
@@ -241,7 +254,7 @@ GEM
       version_gem (~> 1.1, >= 1.1.1)
     thor (1.2.2)
     timers (4.3.3)
-    traces (0.4.1)
+    traces (0.11.1)
     trailblazer-option (0.1.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -273,4 +286,4 @@ DEPENDENCIES
   rubocop-rspec (~> 2.1)
 
 BUNDLED WITH
-   2.3.9
+   2.4.19

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?
@@ -390,7 +459,7 @@ 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}::config:")
+            out_str.unshift("#{@module_name.split('-').last}::config:")
             @md.add_ul('Hiera Configuration Example:')
             @md.add_code_block(out_str.join("\n"), language: 'yaml')
           rescue StandardError => e

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/cli/jira.rb

@@ -40,7 +40,7 @@ module Abide
       def execute
         client = JIRA.client
         myself = JIRA.myself(client)
-        return if myself.attrs['name'].empty?
+        return if myself.attrs['displayName'].empty?
 
         Abide::CLI::OUTPUT.simple("Successfully authenticated user #{myself.attrs['name']}!")
       end

data/lib/abide_dev_utils/jira.rb

@@ -67,9 +67,8 @@ module AbideDevUtils
       fields = {}
       fields['summary'] = summary
       fields['project'] = project(client, project)
-      fields['reporter'] = myself(client)
       fields['issuetype'] = issuetype(client, 'Task')
-      fields['priority'] = priority(client, '6')
+      fields['priority'] = priority(client, '3')
       fields['description'] = description if description
       fields['labels'] = labels
       epic = issue(client, epic) if epic && !epic.is_a?(JIRA::Resource::Issue)
@@ -89,7 +88,6 @@ module AbideDevUtils
       fields = {
         'summary' => summary,
         'project' => project(client, project),
-        'reporter' => myself(client),
         'issuetype' => issuetype(client, 'Epic'),
         'customfield_10007' => summary, # Epic Name
       }
@@ -114,7 +112,6 @@ module AbideDevUtils
       fields['parent'] = issue
       fields['summary'] = summary
       fields['project'] = issue_fields['project']
-      fields['reporter'] = myself(client)
       fields['issuetype'] = issuetype(client, '5')
       fields['priority'] = issue_fields['priority']
       subtask = client.Issue.build

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.15.0"
+  VERSION = "0.16.1"
 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.1
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -463,7 +463,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Helper utilities for developing compliance Puppet code