abide_dev_utils 0.11.0 → 0.12.1

data/lib/abide_dev_utils/dot_number_comparable.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  # Module provides comparison methods for "dot numbers", numbers that
+  # take the form of "1.1.1" as found in CIS benchmarks. Classes that
+  # include this module must implement a method "number" that returns
+  # their dot number representation.
+  module DotNumberComparable
+    include ::Comparable
+
+    def <=>(other)
+      return 0 if number_eq(number, other.number)
+      return 1 if number_gt(number, other.number)
+      return -1 if number_lt(number, other.number)
+    end
+
+    def number_eq(this_num, other_num)
+      this_num == other_num
+    end
+
+    def number_parent_of?(this_num, other_num)
+      return false if number_eq(this_num, other_num)
+
+      # We split the numbers into parts and compare the resulting arrays
+      num1_parts = this_num.to_s.split('.')
+      num2_parts = other_num.to_s.split('.')
+      # For this_num to be a parent of other_num, the number of parts in
+      # this_num must be less than the number of parts in other_num.
+      # Additionally, each part of this_num must be equal to the parts of
+      # other_num at the same index.
+      # Example: this_num = '1.2.3' and other_num = '1.2.3.4'
+      # In this case, num1_parts = ['1', '2', '3'] and num2_parts = ['1', '2', '3', '4']
+      # So, this_num is a parent of other_num because at indexes 0, 1, and 2
+      # of num1_parts and num2_parts, the parts are equal.
+      num1_parts.length < num2_parts.length &&
+        num2_parts[0..(num1_parts.length - 1)] == num1_parts
+    end
+
+    def number_child_of?(this_num, other_num)
+      number_parent_of?(other_num, this_num)
+    end
+
+    def number_gt(this_num, other_num)
+      return false if number_eq(this_num, other_num)
+      return true if number_parent_of?(this_num, other_num)
+
+      num1_parts = this_num.to_s.split('.')
+      num2_parts = other_num.to_s.split('.')
+      num1_parts.zip(num2_parts).each do |num1_part, num2_part|
+        next if num1_part == num2_part # we skip past equal parts
+
+        # If num1_part is nil that means that we've had equal numbers so far.
+        # Therfore, this_num is greater than other num because of the
+        # hierarchical nature of the numbers.
+        # Example: this_num = '1.2' and other_num = '1.2.3'
+        # In this case, num1_part is nil and num2_part is '3'
+        # So, this_num is greater than other_num
+        return true if num1_part.nil?
+        # If num2_part is nil that means that we've had equal numbers so far.
+        # Therfore, this_num is less than other num because of the
+        # hierarchical nature of the numbers.
+        # Example: this_num = '1.2.3' and other_num = '1.2'
+        # In this case, num1_part is '3' and num2_part is nil
+        # So, this_num is less than other_num
+        return false if num2_part.nil?
+
+        return num1_part.to_i > num2_part.to_i
+      end
+    end
+
+    def number_lt(this_num, other_num)
+      number_gt(other_num, this_num)
+    end
+  end
+end

data/lib/abide_dev_utils/errors/cem.rb

@@ -18,5 +18,15 @@ module AbideDevUtils
     class ResourceDataNotFoundError < GenericError
       @default = 'Resource data not found using facts:'
     end
+
+    # Raised by Control when it can't find mapping data for itself
+    class NoMappingDataForControlError < GenericError
+      @default = 'No mapping data found for control:'
+    end
+
+    # Raised by a control when it's given ID and framework are incompatible
+    class ControlIdFrameworkMismatchError < GenericError
+      @default = 'Control ID is invalid with the given framework:'
+    end
   end
 end

data/lib/abide_dev_utils/ppt/class_utils.rb

@@ -27,7 +27,7 @@ module AbideDevUtils
       def self.path_from_class_name(class_name)
         parts = class_name.split('::')
         parts[-1] = "#{parts[-1]}.pp"
-        File.expand_path(File.join('manifests', parts[1..-1]))
+        File.expand_path(File.join('manifests', parts[1..]))
       end
 
       # Returns the namespaced class name from a file path

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'puppet'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      module DataTypes
+        def infer_data_type(data)
+          Puppet::Pops::Types::TypeCalculator.infer(data).to_s
+        end
+
+        # Displays a Puppet type value as a string
+        def display_value(val)
+          if val.is_a?(Puppet::Pops::Model::LiteralUndef)
+            'undef'
+          elsif val.respond_to?(:value)
+            display_value(val.value)
+          elsif val.respond_to?(:cased_value)
+            display_value(val.cased_value)
+          else
+            val
+          end
+        end
+
+        # Displays a Puppet type expression (type signature) as a string
+        # @param param [Puppet::Pops::Model::Parameter] AST Parameter node of a parsed Puppet manifest
+        def display_type_expr(param)
+          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
+            te.value
+          end
+        end
+
+        # Used by #display_type_expr
+        def display_type_expr_with_left_expr(te)
+          cased = nil
+          keys = nil
+          cased = te.left_expr.cased_value if te.left_expr.respond_to? :cased_value
+          keys = te.keys.map { |x| display_type_expr(x) }.to_s if te.respond_to? :keys
+          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
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      module Generate
+        def self.a_manifest
+          AbideDevUtils::Ppt::CodeGen::Manifest.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      class Resource
+        attr_reader :type, :title
+
+        def initialize(type, title, **attributes)
+          validate_type_and_title(type, title)
+          @type = type
+          @title = title
+          @attributes = attributes
+        end
+
+        def reference
+          "#{title.split('::').map(&:capitalize).join('::')}['#{title}']"
+        end
+
+        def to_s
+          return "#{type} { '#{title}': }" if @attributes.empty?
+
+          str_array = ["#{type} { '#{title}':"]
+          @attributes.each do |key, val|
+            str_array << "  #{pad_attribute(key)} => #{val},"
+          end
+          str_array << '}'
+          str_array.join("\n")
+        end
+
+        private
+
+        def validate_type_and_title(type, title)
+          raise 'Type / title must be String' unless type.is_a?(String) && title.is_a?(String)
+          raise 'Type / title must not be empty' if type.empty? || title.empty?
+        end
+
+        def longest_attribute_length
+          return @longest_attribute_length if defined?(@longest_attribute_length)
+
+          longest = ''
+          @attributes.each_key do |k|
+            longest = k if k.length > longest.length
+          end
+          @longest_attribute_length = longest.length
+          @longest_attribute_length
+        end
+
+        def pad_attribute(attribute)
+          return attribute if attribute.length == longest_attribute_length
+
+          attr_array = [attribute]
+          (longest_attribute_length - attribute.length).times { attr_array << ' ' }
+          attr_array.join
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_gen/resource_types/base.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      # Base class for all code gen objects
+      class Base
+        attr_accessor :title, :id
+
+        def initialize
+          @id = SecureRandom.hex(10)
+          @supports_value = false
+          @supports_children = false
+        end
+
+        def to_s
+          "#{type} : value: #{@value}; children: #{@children}"
+        end
+
+        def reference
+          raise NotImplementedError, "#{type} does not support having a reference"
+        end
+
+        def type
+          self.class.to_s
+        end
+
+        def value
+          raise NotImplementedError, "#{type} does not support having a value" unless @supports_value
+
+          @value
+        end
+
+        def get_my(t, named: nil)
+          if named.nil?
+            children.each_with_object([]) do |(k, v), arr|
+              arr << v if k.start_with?("#{t.to_s.capitalize}_")
+            end
+          else
+            children["#{t.to_s.capitalize}_#{named}"]
+          end
+        end
+
+        # Creates a new object of the given type and adds it to the current objects children
+        # if the current object supports children.
+        # Returns `self`. If a block is given, the new
+        # object will be yielded before adding to children.
+        def with_a(t, named: nil)
+          obj = Object.const_get("AbideDevUtils::Ppt::CodeGen::#{t.to_s.capitalize}").new
+          obj.title = named unless named.nil? || named.empty?
+
+          yield obj if block_given?
+
+          children["#{t.to_s.capitalize}_#{obj.id}"] = obj
+          self
+        end
+        alias and_a with_a
+
+        def has_a(t, named: nil)
+          obj = Object.const_get("AbideDevUtils::Ppt::CodeGen::#{t.to_s.capitalize}").new
+          obj.title = named unless named.nil? || named.empty?
+          children["#{t.to_s.capitalize}_#{obj.id}"] = obj
+          obj
+        end
+        alias and_has_a has_a
+        alias that_has_a has_a
+
+        # Sets the explicit value of the current object if the current object has an explicit value.
+        def that_equals(val)
+          self.value = val
+          self
+        end
+        alias and_assign_a_value_of that_equals
+        alias has_a_value_of that_equals
+        alias that_has_a_value_of that_equals
+
+        private
+
+        def children
+          raise NotImplementedError, "#{type} does not support children" unless @supports_children
+
+          @children ||= {}
+        end
+
+        def value=(val)
+          @value = val if @supports_value
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_gen/resource_types/class.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types/base'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      class Class < Base
+        def initialize
+          super
+          @supports_children = true
+          @supports_value = true
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_gen/resource_types/manifest.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types/base'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      class Manifest < Base
+        def initialize
+          super
+          @supports_children = true
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_gen/resource_types/parameter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types/base'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      class Parameter < Base
+        def initialize
+          @supports_children = true
+          @supports_value = true
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_gen/resource_types/strings.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types/base'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      class Strings < Base
+        VALID_CHILDREN = %w[See Summary Param Example].freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/resource_types/class'
+require 'abide_dev_utils/ppt/code_gen/resource_types/manifest'
+require 'abide_dev_utils/ppt/code_gen/resource_types/parameter'
+require 'abide_dev_utils/ppt/code_gen/resource_types/strings'

data/lib/abide_dev_utils/ppt/code_gen.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/ppt/code_gen/data_types'
+require 'abide_dev_utils/ppt/code_gen/resource'
+require 'abide_dev_utils/ppt/code_gen/resource_types'
+
+module AbideDevUtils
+  module Ppt
+    module CodeGen
+      def self.generate_a_manifest
+        Manifest.new
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/code_introspection.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'puppet_pal'
+require_relative 'code_gen/data_types'
+
+module AbideDevUtils
+  module Ppt
+    module CodeIntrospection
+      class Manifest
+        attr_reader :manifest_file
+
+        def initialize(manifest_file)
+          @manifest_file = File.expand_path(manifest_file)
+          raise ArgumentError, "File #{@manifest_file} is not a file" unless File.file?(@manifest_file)
+        end
+
+        def ast
+          @ast ||= Puppet::Pal::Compiler.new(nil).parse_file(manifest_file)
+        end
+
+        def declaration
+          @declaration ||= Declaration.new(ast)
+        end
+      end
+
+      class Declaration
+        include AbideDevUtils::Ppt::CodeGen::DataTypes
+        attr_reader :ast
+
+        def initialize(ast)
+          @ast = ast.definitions.first
+        end
+
+        def parameters?
+          ast.respond_to? :parameters
+        end
+
+        def parameters
+          return unless parameters?
+
+          @parameters ||= ast.parameters.map { |p| Parameter.new(p) }
+        end
+      end
+
+      class Parameter
+        include AbideDevUtils::Ppt::CodeGen::DataTypes
+        attr_reader :ast
+
+        def initialize(param_ast)
+          @ast = param_ast
+        end
+
+        def to_a(raw: false)
+          [type_expr(raw: raw), name(raw: raw), value(raw: raw)]
+        end
+
+        def to_h(raw: false)
+          {
+            type_expr: type_expr(raw: raw),
+            name: name(raw: raw),
+            value: value(raw: raw),
+          }
+        end
+
+        def to_s(raw: false)
+          stra = [type_expr(raw: raw), name(raw: raw)]
+          stra << '=' if value? && !raw
+          stra << value(raw: raw)
+          stra.compact.join(' ')
+        end
+
+        def name(raw: false)
+          return ast.name if raw
+
+          "$#{ast.name}"
+        end
+
+        def value?
+          ast.respond_to? :value
+        end
+
+        def value(raw: false)
+          return unless value?
+          return ast.value if raw
+
+          display_value(ast)
+        end
+
+        def type_expr?
+          ast.respond_to? :type_expr
+        end
+
+        def type_expr(raw: false)
+          return unless type_expr?
+          return ast.type_expr if raw
+
+          display_type_expr(ast)
+        end
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/hiera.rb

@@ -38,10 +38,13 @@ module AbideDevUtils
           @path = File.expand_path(path)
           raise "Hiera config file at path #{@path} not found!" unless File.file?(@path)
 
+          @root_dir = File.dirname(@path)
           @conf = YAML.load_file(File.expand_path(path))
           @by_name_path_store = {}
-          AbideDevUtils::Ppt::Hiera.default_datadir = @conf['defaults']['datadir'] if @conf['defaults'].key?('datadir')
           AbideDevUtils::Ppt::Hiera.facter_version = facter_version
+          if @conf['defaults'].key?('datadir')
+            AbideDevUtils::Ppt::Hiera.default_datadir = File.join(@root_dir, @conf['defaults']['datadir'])
+          end
         end
 
         def hierarchy

data/lib/abide_dev_utils/ppt/puppet_module.rb

@@ -14,6 +14,7 @@ module AbideDevUtils
         readme: 'README.md',
         reference: 'REFERENCE.md',
         changelog: 'CHANGELOG.md',
+        hiera_config: 'hiera.yaml',
         fixtures: '.fixtures.yml',
         rubocop: '.rubocop.yml',
         sync: '.sync.yml',
@@ -42,7 +43,7 @@ module AbideDevUtils
       end
 
       def hiera_conf
-        @hiera_conf ||= AbideDevUtils::Ppt::Hiera::Config.new
+        @hiera_conf ||= AbideDevUtils::Ppt::Hiera::Config.new(special_files[:hiera_config])
       end
 
       private

data/lib/abide_dev_utils/ppt.rb

@@ -3,6 +3,9 @@
 require 'abide_dev_utils/output'
 require 'abide_dev_utils/validate'
 require 'abide_dev_utils/errors'
+require 'abide_dev_utils/ppt/api'
+require 'abide_dev_utils/ppt/code_gen'
+require 'abide_dev_utils/ppt/code_introspection'
 require 'abide_dev_utils/ppt/class_utils'
 require 'abide_dev_utils/ppt/facter_utils'
 require 'abide_dev_utils/ppt/hiera'

data/lib/abide_dev_utils/version.rb

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