abide_dev_utils 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3b154482634fc055b078ce36dbf15a387c4da25f6061f96128f33fb3f29e18
-  data.tar.gz: ecf7d53d1b06680970bc21affdbd7603193a84a9c1cac46d53cc1e95b13abbb6
+  metadata.gz: 85fb0e453df008a48284f03fe59bd1577b733498ce030039e215bf1863e1767c
+  data.tar.gz: 9a89ac46e8506ea059044006a5c50d8132847fa2a8f9a6b726174ed51ab6421c
 SHA512:
-  metadata.gz: f8c1b8d427bcde511d53dc505c4c10853a6cd963d0da3d27148b81342f0bd497e364f17cd6212fde0a4d97fb3e0a25d566d11cef679c7220a05c696c6df95191
-  data.tar.gz: 54fd1971163662139121b3e9b7b31a7be8ad42127f8a08b4271cb995454a3b90460477d11b6e13148dfa3d950cfb2b86d84ea491e436ee6b28518c9ae66486bb
+  metadata.gz: 9f221ac5c9c15db1414005ca4017dda7a9f848d8b7586d4b8a3ede9ecaf5fc8e35187ab2f172e127cad92a1d483befe31fa17278279b54b33abcc1d25f7a21a6
+  data.tar.gz: b9f3e5553a03faed668600c94b44759ee4554165e20722b7c6d5108add327ba23a6986e707034647b3eed400e6217b032eb058e537a74f26d11a004cf309bcfd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abide_dev_utils (0.11.1)
+    abide_dev_utils (0.11.2)
       amatch (~> 0.4)
       cmdparse (~> 3.0)
       facterdb (>= 1.18)
@@ -60,10 +60,10 @@ GEM
     diff-lcs (1.5.0)
     digest-crc (0.6.4)
       rake (>= 12.0.0, < 14.0.0)
-    facter (4.2.10)
+    facter (4.2.11)
       hocon (~> 1.3)
       thor (>= 1.0.1, < 2.0)
-    facterdb (1.18.0)
+    facterdb (1.19.0)
       facter (< 5.0.0)
       jgrep
     faraday (2.3.0)
@@ -84,7 +84,7 @@ GEM
       octokit (~> 4.6)
       rainbow (>= 2.2.1)
       rake (>= 10.0)
-    google-apis-core (0.5.0)
+    google-apis-core (0.7.0)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -93,25 +93,25 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
-    google-apis-iamcredentials_v1 (0.10.0)
-      google-apis-core (>= 0.4, < 2.a)
-    google-apis-storage_v1 (0.14.0)
-      google-apis-core (>= 0.4, < 2.a)
+    google-apis-iamcredentials_v1 (0.13.0)
+      google-apis-core (>= 0.7, < 2.a)
+    google-apis-storage_v1 (0.17.0)
+      google-apis-core (>= 0.7, < 2.a)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.2.0)
-    google-cloud-storage (1.36.2)
+    google-cloud-storage (1.38.0)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
       google-apis-iamcredentials_v1 (~> 0.1)
-      google-apis-storage_v1 (~> 0.1)
+      google-apis-storage_v1 (~> 0.17.0)
       google-cloud-core (~> 1.6)
       googleauth (>= 0.16.2, < 2.a)
       mini_mime (~> 1.0)
-    googleauth (1.1.3)
+    googleauth (1.2.0)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
@@ -119,7 +119,7 @@ GEM
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
     hashdiff (1.0.1)
-    hiera (3.9.0)
+    hiera (3.10.0)
     hocon (1.3.1)
     httpclient (2.8.3)
     i18n (1.10.0)
@@ -130,7 +130,7 @@ GEM
       atlassian-jwt
       multipart-post
       oauth (~> 0.5, >= 0.5.0)
-    jwt (2.3.0)
+    jwt (2.4.1)
     locale (2.1.3)
     memoist (0.16.2)
     method_source (1.0.0)
@@ -139,9 +139,9 @@ GEM
     mize (0.4.0)
       protocol (~> 2.0)
     multi_json (1.15.0)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
     nio4r (2.5.8)
-    nokogiri (1.13.6-x86_64-darwin)
+    nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
     oauth (0.5.10)
     octokit (4.25.0)
@@ -164,7 +164,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.7)
-    puppet (7.17.0-universal-darwin)
+    puppet (7.18.0-universal-darwin)
       CFPropertyList (~> 2.2)
       concurrent-ruby (~> 1.0)
       deep_merge (~> 1.0)
@@ -234,9 +234,9 @@ GEM
       rubyzip (>= 1.2.2)
     semantic_puppet (1.0.4)
     sexp_processor (4.16.1)
-    signet (0.16.1)
+    signet (0.17.0)
       addressable (~> 2.8)
-      faraday (>= 0.17.5, < 3.0)
+      faraday (>= 0.17.5, < 3.a)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
     sync (0.5.0)

data/lib/abide_dev_utils/cem/benchmark.rb

@@ -21,6 +21,11 @@ module AbideDevUtils
         @dependent = []
       end
 
+      # Returns a representation of the actual manifest backing this resource.
+      # This is used to gather information from the Puppet code about this
+      # resource.
+      # @return [AbideDevUtils::Ppt::CodeIntrospection::Manifest]
+      # @return [nil] if the manifest could not be found or could not be parsed
       def manifest
         @manifest ||= load_manifest
       end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'shellwords'
 require 'timeout'
 require 'yaml'
 require 'abide_dev_utils/markdown'
@@ -58,6 +59,8 @@ module AbideDevUtils
 
         # Generates a markdown reference doc
         class MarkdownGenerator
+          SPECIAL_CONTROL_IDS = %w[dependent cem_options cem_protected].freeze
+
           def initialize(benchmarks, module_name, file: 'REFERENCE.md')
             @benchmarks = benchmarks
             @module_name = module_name
@@ -72,7 +75,7 @@ module AbideDevUtils
                                                             total: benchmark.controls.length)
               md.add_h1(benchmark.title_key)
               benchmark.controls.each do |control|
-                next if ['cem_options', 'cem_protected', 'dependent'].include? control.id
+                next if SPECIAL_CONTROL_IDS.include? control.id
                 next if benchmark.framework == 'stig' && control.id_map_type != 'vulnid'
 
                 control_md = ControlMarkdown.new(control, @md, @module_name, benchmark.framework)
@@ -91,12 +94,15 @@ module AbideDevUtils
           attr_reader :benchmarks, :md
         end
 
+        class ConfigExampleError < StandardError; end
+
         class ControlMarkdown
-          def initialize(control, md, module_name, framework)
+          def initialize(control, md, module_name, framework, formatter: nil)
             @control = control
             @md = md
             @module_name = module_name
             @framework = framework
+            @formatter = formatter.nil? ? TypeExprValueFormatter : formatter
             @control_data = {}
           end
 
@@ -128,7 +134,6 @@ module AbideDevUtils
             return unless @control.resource.manifest?
 
             @control.resource.manifest.declaration.parameters&.find { |x| x.name == "$#{ctrl_param[:name]}" }
-            #raise "Cannot find resource parameter for param #{ctrl_param[:name]}" unless rparam
           end
 
           def param_type_expr(ctrl_param, rsrc_param)
@@ -204,36 +209,110 @@ module AbideDevUtils
             @control.param_hashes.each do |param_hash|
               next if param_hash[:name] == 'No parameters'
 
-              val = if @control_data[param_hash[:name]][:default] &&
-                       @control_data[param_hash[:name]][:type_expr]&.match?(/String|Path/)
-                      "'#{@control_data[param_hash[:name]][:default]}'"
-                    elsif @control_data[param_hash[:name]][:default]
-                      @control_data[param_hash[:name]][:default]
-                    elsif @control_data[param_hash[:name]][:type_expr]
-                      "<#{@control_data[param_hash[:name]][:type_expr]}>"
-                    else
-                      'undef'
-                    end
+              val = @formatter.format(@control_data[param_hash[:name]][:default],
+                                      @control_data[param_hash[:name]][:type_expr],
+                                      optional_strategy: :placeholder)
               out_str << "#{indent}#{param_hash[:name]}: #{val}"
             end
             return if out_str.empty?
 
-            begin
-              out_str.unshift("    #{@control.title.dump}:")
-            rescue NoMethodError
-              require 'pry'
-              binding.pry
-            end
+            out_str.unshift("    #{@control.title.dump}:")
             out_str.unshift('  control_configs:')
             out_str.unshift("#{@module_name}::config:")
             @md.add_ul('Hiera Configuration Example:')
             @md.add_code_block(out_str.join("\n"), language: 'yaml')
+          rescue StandardError => e
+            err_msg = [
+              "Failed to generate config example for control #{@control.id}",
+              "Error: #{e.message}",
+              "Control: Data #{@control_data.inspect}",
+              e.backtrace.join("\n")
+            ].join("\n")
+            raise ConfigExampleError, err_msg
           end
 
           def resource_reference_builder
             @md.add_ul("Resource: #{@md.code(@control.resource.to_reference)}")
           end
         end
+
+        # Holds methods for formmating values based on type expressions
+        class TypeExprValueFormatter
+          UNDEF_VAL = 'undef'
+
+          # Formats a value based on a type expression.
+          # @param value [Any] the value to format
+          # @param type_expr [String] the type expression to use for formatting
+          # @param optional_strategy [Symbol] the strategy to use for optional values
+          # @return [Any] the formatted value
+          def self.format(value, type_expr, optional_strategy: :undef)
+            return value if value == 'No parameters'
+
+            case type_expr
+            when /^(String|Stdlib::(Unix|Windows|Absolute)path|Enum)/
+              quote(value)
+            when /^Optional\[/
+              optional(value, type_expr, strategy: optional_strategy)
+            else
+              return type_expr_placeholder(type_expr) if value.nil?
+
+              quote(value)
+            end
+          end
+
+          # Escapes and quotes a string. If value is not a string, returns value.
+          # @param value [Any] the string to quote.
+          # @return [String] the quoted string.
+          # @return [Any] the value if it is not a string.
+          def self.quote(value)
+            if value.is_a?(String)
+              value.inspect
+            else
+              value
+            end
+          end
+
+          # Checks if a value is considered undef.
+          # @param value [Any] the value to check.
+          # @return [Boolean] true if value is considered undef (nil or 'undef').
+          def self.undef?(value)
+            value.nil? || value == UNDEF_VAL
+          end
+
+          # Returns the display representation of the value with an Optional type expression.
+          # If the value is not nil or 'undef', returns the quoted form of the value.
+          # @param value [Any] the value to format.
+          # @param type_expr [String] the type expression.
+          # @param strategy [Symbol] the strategy to use. Valid strategies are :undef and :placeholder.
+          #   :undef will return 'undef' if the value is nil or 'undef'.
+          #   :placeholder will return a peeled type expression placeholder if the value is nil or 'undef'.
+          # @return [String] the formatted value.
+          # @return [Any] the quoted value if it is not nil.
+          def self.optional(value, type_expr, strategy: :undef)
+            return UNDEF_VAL if undef?(value) && strategy == :undef
+            return type_expr_placeholder(peel_type_expr(type_expr)) if undef?(value) && strategy == :placeholder
+
+            quote(value)
+          end
+
+          # Returns a "peeled" type expression. Peeling a type expression removes the
+          # first layer of the type expression. For example, if the type expression is
+          # Optional[String], the peeled type expression is String.
+          # @param type_expr [String] the type expression to peel.
+          # @return [String] the peeled type expression.
+          def self.peel_type_expr(type_expr)
+            return type_expr unless type_expr.include?('[')
+
+            type_expr.match(/^[A-Z][a-z0-9_]*\[(?<peeled>[A-Za-z0-9:,_{}=>\[\]\\\s]+)\]$/)[:peeled]
+          end
+
+          # Formats the type expression as a placeholder.
+          # @param type_expr [String] The type expression to format.
+          # @return [String] The formatted type expression.
+          def self.type_expr_placeholder(type_expr)
+            "<<Type #{type_expr}>>"
+          end
+        end
       end
     end
   end

data/lib/abide_dev_utils/ppt/code_gen/data_types.rb

@@ -29,6 +29,8 @@ module AbideDevUtils
           te = param.respond_to?(:type_expr) ? param.type_expr : param
           if te.respond_to? :left_expr
             display_type_expr_with_left_expr(te)
+          elsif te.respond_to? :entries
+            display_type_expr_with_entries(te)
           elsif te.respond_to? :cased_value
             te.cased_value
           elsif te.respond_to? :value
@@ -45,6 +47,17 @@ module AbideDevUtils
           keys.tr!('"', '') unless cased == 'Enum'
           "#{cased}#{keys}"
         end
+
+        # Used by #display_type_expr
+        def display_type_expr_with_entries(te)
+          te.entries.each_with_object({}) do |x, hsh|
+            key = nil
+            val = nil
+            key = display_value(x.key) if x.respond_to? :key
+            val = display_type_expr(x.value) if x.respond_to? :value
+            hsh[key] = val if key
+          end
+        end
       end
     end
   end

data/lib/abide_dev_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri