pdk 1.9.0 → 3.2.0

data/lib/pdk/context.rb

@@ -0,0 +1,98 @@
+require 'pdk'
+
+module PDK
+  module Context
+    autoload :None, 'pdk/context/none'
+    autoload :Module, 'pdk/context/module'
+    autoload :ControlRepo, 'pdk/context/control_repo'
+
+    # Automatically determines the PDK Context given a path. Create will continue up the directory tree until it
+    # finds a valid context
+    # @return [PDK::Context::AbstractContext] Returns a PDK::Context::None if the context could not be determined
+    def self.create(context_path)
+      return PDK::Context::None.new(context_path) unless PDK::Util::Filesystem.directory?(context_path)
+
+      previous = nil
+      current = PDK::Util::Filesystem.expand_path(context_path)
+      until !PDK::Util::Filesystem.directory?(current) || current == previous
+        # Control Repo detection
+        return PDK::Context::ControlRepo.new(current, context_path) if PDK.feature_flag?('controlrepo') && PDK::ControlRepo.control_repo_root?(current)
+
+        # Puppet Module detection
+        metadata_file = File.join(current, 'metadata.json')
+        return PDK::Context::Module.new(current, context_path) if PDK::Util::Filesystem.file?(metadata_file) || PDK::Util.in_module_root?(context_path)
+
+        previous = current
+        current = PDK::Util::Filesystem.expand_path('..', current)
+      end
+      PDK::Context::None.new(context_path)
+    end
+
+    # Abstract class which all PDK Contexts will subclass from.
+    # @abstract
+    class AbstractContext
+      # The root of this context, for example the module root when inside a module. This can be different from context_path
+      # For example a Module context_path could be /path/to/module/manifests/ but the root_path will be /path/to/module as
+      # that is the root of the Module context. Defaults to the context_path if not set.
+      # @return [String]
+      def root_path
+        @root_path || @context_path
+      end
+
+      # The path used to create this context, for example the current working directory. This can be different from root_path
+      # For example a Module context_path could be /path/to/module/manifests/ but the root_path will be /path/to/module as
+      # that is the root of the Module context
+      # @return [String]
+      attr_reader :context_path
+
+      # @param context_path [String] The path where this context was created from e.g. Dir.pwd
+      def initialize(context_path)
+        @context_path = context_path
+        @root_path = nil
+      end
+
+      # Whether the current context is compatible with the PDK e.g. in a Module context, whether it has the correct metadata.json content
+      # @return [Boolean] Default is not compatible
+      def pdk_compatible?
+        false
+      end
+
+      # The friendly name to display for this context
+      # @api private
+      # @abstract
+      def display_name; end
+
+      # The context which this context is in.  For example a Module Context (/controlrepo/site/profile) can be inside of a Control Repo context (/controlrepo)
+      # The default is to search in the parent directory of this context
+      # @return [PDK::Context::AbstractContext, Nil] Returns the parent context or nil if there is no parent.
+      def parent_context
+        # Default detection is just look for the context in the parent directory of this context
+        @parent_context || PDK::Context.create(File.dirname(root_path))
+      end
+
+      # Writes the current context information, and parent contexts, to the PDK Debug Logger.
+      # This is mainly used by the PDK CLI when in debug mode to assist users to figure out why the PDK is misbehaving.
+      # @api private
+      def to_debug_log
+        current = self
+        depth = 1
+        loop do
+          PDK.logger.debug("Detected #{current.display_name} at #{current.root_path.nil? ? current.context_path : current.root_path}")
+          current = current.parent_context
+          break if current.nil?
+
+          depth += 1
+          # Circuit breaker in case there are circular references
+          break if depth > 20
+        end
+        nil
+      end
+
+      # :nocov: There's nothing to test here
+      def to_s
+        "#<#{self.class}:#{object_id}>#{context_path}"
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/pdk/control_repo.rb

@@ -0,0 +1,89 @@
+require 'pdk'
+
+module PDK
+  module ControlRepo
+    CONTROL_REPO_FILES = ['environment.conf', 'Puppetfile'].freeze
+
+    DEFAULT_IGNORED = [
+      '/pkg/',
+      '~*',
+      '/coverage',
+      # Strictly speaking this isn't default but if people have tricked older PDK into thinking that a
+      # Control Repo is a module, they may have recursive symlinks in spec/fixtures/modules
+      '/spec/fixtures/modules/',
+      '/vendor/'
+    ].freeze
+
+    # Returns path to the root of the Control Repo being worked on.
+    #
+    # An environment.conf is required for a PDK compatible Control Repo,
+    # whereas Puppetfile is optional.
+    #
+    # Note - A Bolt Project can also be a Control Repo.
+    #
+    # Note - Non-Directory environments can exist however directory based
+    # environments are the supported/preferred way.
+    #
+    # @see https://puppet.com/docs/pe/latest/control_repo.html
+    #
+    # @param strict_check [Boolean] When strict_check is true, only return the path
+    #   if the Control Repo is strictly _only_ a control repository. For example,
+    #   not also a Puppet Bolt project directory  Default is false.
+    #
+    # @return [String, nil] Fully qualified base path to Control Repo, or nil if
+    #   the current working dir does not appear to be within a Control Repo.
+    def find_control_repo_root(strict_check = false)
+      environment_conf_path = PDK::Util.find_upwards('environment.conf')
+      path = if environment_conf_path
+               File.dirname(environment_conf_path)
+             elsif control_repo_root?(Dir.pwd)
+               Dir.pwd
+             end
+      return path if path.nil? || !strict_check
+
+      PDK::Bolt.bolt_project_root?(path) ? nil : path
+    end
+    module_function :find_control_repo_root
+
+    # Returns true or false depending on if any of the common files in a Control Repo
+    # are found in the specified directory. If a directory is not specified, the current
+    # working directory is used.
+    #
+    # @return [boolean] True if any folders from CONTROL_REPO_FILES are found in the current dir,
+    #   false otherwise.
+    def control_repo_root?(path = Dir.pwd)
+      CONTROL_REPO_FILES.any? { |file| PDK::Util::Filesystem.file?(File.join(path, file)) }
+    end
+    module_function :control_repo_root?
+
+    # Returns a PDK::Config::Namespace for the specified environment.conf file.
+    # Note there is no validation of the path.
+    #
+    # @param path [String] The path to the environment.conf file
+    #
+    # @return [PDK::Config::IniFile] The configuration file
+    def environment_conf_as_config(path)
+      PDK::Config::IniFile.new('environment', file: path) do
+        setting :modulepath do
+          # As per https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
+          default_to { 'modules:$basemodulepath' }
+        end
+
+        setting :manifest do
+          # As per https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
+          default_to { 'manifests/' }
+        end
+      end
+    end
+    module_function :environment_conf_as_config
+
+    def default_ignored_pathspec(ignore_dotfiles = true)
+      require 'pathspec'
+
+      PathSpec.new(DEFAULT_IGNORED).tap do |ps|
+        ps.add('.*') if ignore_dotfiles
+      end
+    end
+    module_function :default_ignored_pathspec
+  end
+end

data/lib/pdk/generate/defined_type.rb

@@ -1,48 +1,42 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate
     class DefinedType < PuppetObject
-      OBJECT_TYPE = :defined_type
+      PUPPET_STRINGS_TYPE = 'defined_types'.freeze
 
-      # Prepares the data needed to render the new defined type template.
-      #
-      # @return [Hash{Symbol => Object}] a hash of information that will be
-      # provided to the defined type and defined type spec templates during
-      # rendering.
-      def template_data
-        data = { name: object_name }
+      def initialize(*_args)
+        super
+        object_name_parts = @object_name.split('::')
 
-        data
+        @object_name = if object_name_parts.first == module_name
+                         object_name
+                       else
+                         [module_name, object_name].join('::')
+                       end
       end
 
-      # Calculates the path to the .pp file that the new defined type will be
-      # written to.
-      #
-      # @return [String] the path where the new defined type will be written.
-      def target_object_path
-        @target_pp_path ||= begin
-          define_name_parts = object_name.split('::')[1..-1]
-          define_name_parts << 'init' if define_name_parts.empty?
-
-          "#{File.join(module_dir, 'manifests', *define_name_parts)}.pp"
-        end
+      def friendly_name
+        'Defined Type'.freeze
       end
 
-      # Calculates the path to the file where the tests for the new defined
-      # type will be written.
-      #
-      # @return [String] the path where the tests for the new defined type
-      # will be written.
-      def target_spec_path
-        @target_spec_path ||= begin
-          define_name_parts = object_name.split('::')
+      def template_files
+        # Calculate the defined type tests name
+        define_name_parts = object_name.split('::')
+        # drop the module name if the object name contains multiple parts
+        define_name_parts.delete_at(0) if define_name_parts.length > 1
+        files = { 'defined_type_spec.erb' => "#{File.join('spec', 'defines', *define_name_parts)}_spec.rb" }
+        return files if spec_only?
+
+        define_name_parts = object_name.split('::')[1..]
+        define_name_parts << 'init' if define_name_parts.empty?
+        files['defined_type.erb'] = "#{File.join('manifests', *define_name_parts)}.pp"
 
-          # drop the module name if the object name contains multiple parts
-          define_name_parts.delete_at(0) if define_name_parts.length > 1
+        files
+      end
 
-          "#{File.join(module_dir, 'spec', 'defines', *define_name_parts)}_spec.rb"
-        end
+      def template_data
+        { name: object_name }
       end
     end
   end

data/lib/pdk/generate/fact.rb

@@ -0,0 +1,26 @@
+require 'pdk'
+
+module PDK
+  module Generate
+    class Fact < PuppetObject
+      def friendly_name
+        'Custom Fact'.freeze
+      end
+
+      def template_files
+        files = {
+          'fact_spec.erb' => "#{File.join('spec', 'unit', 'facter', object_name)}_spec.rb"
+        }
+        return files if spec_only?
+
+        files.merge(
+          'fact.erb' => "#{File.join('lib', 'facter', object_name)}.rb"
+        )
+      end
+
+      def template_data
+        { name: object_name }
+      end
+    end
+  end
+end

data/lib/pdk/generate/function.rb

@@ -0,0 +1,49 @@
+require 'pdk'
+
+module PDK
+  module Generate
+    class Function < PuppetObject
+      def initialize(*_args)
+        super
+        object_name_parts = @object_name.split('::')
+
+        @object_name = if object_name_parts.first == module_name
+                         object_name
+                       else
+                         [module_name, object_name].join('::')
+                       end
+      end
+
+      def friendly_name
+        'Function'.freeze
+      end
+
+      def template_files
+        # Calculate the function tests name
+        func_name_parts = object_name.split('::')
+        # Drop the module name if the object name contains multiple parts
+        func_name_parts.delete_at(0) if func_name_parts.length > 1
+        files = {
+          File.join('functions', 'function_spec.erb') => "#{File.join('spec', 'functions', *func_name_parts)}_spec.rb"
+        }
+        return files if spec_only?
+
+        func_name_parts = object_name.split('::')[1..]
+        template_file = File.join('functions', "#{options[:type]}_function.erb")
+
+        files[template_file] = if options[:type].eql?('v4')
+                                 "#{File.join('lib', 'puppet', 'functions', module_name, *func_name_parts)}.rb"
+                               else
+                                 "#{File.join('functions', *func_name_parts)}.pp"
+                               end
+        files
+      end
+
+      def template_data
+        func_name = object_name.split('::').last
+        namespace = object_name.split('::')[0...-1].join('::')
+        { name: object_name, func_name: func_name, namespace: namespace }
+      end
+    end
+  end
+end