pdk 2.3.0 → 2.4.0

data/lib/pdk/context/control_repo.rb

@@ -1,60 +1,60 @@
-require 'pdk'
-
-module PDK
-  module Context
-    # Represents a context for a directory based Control Repository
-    class ControlRepo < PDK::Context::AbstractContext
-      # @param repo_root [String] The root path for the control repo.
-      # @param context_path [String] The path where this context was created from e.g. Dir.pwd
-      # @see PDK::Context::AbstractContext
-      def initialize(repo_root, context_path)
-        super(context_path)
-        @root_path = repo_root
-        @environment_conf = nil
-      end
-
-      # @see PDK::Context::AbstractContext.pdk_compatible?
-      def pdk_compatible?
-        # Currently there is nothing to determine compatibility with the PDK for a
-        # Control Repo. For now assume everything is compatible
-        true
-      end
-
-      # The modulepath setting for this control repository as an array of strings. These paths are relative
-      # and may contain interpolation strings (e.g. $basemodulepath)
-      # @see https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
-      # @return [Array[String]] The modulepath setting for this control repository
-      def module_paths
-        return @module_paths unless @module_paths.nil?
-        value = environment_conf['modulepath'] || ''
-        # We have to use a hardcoded value here because File::PATH_SEPARATOR is ';' on Windows.
-        # As the environment.conf is only used on Puppet Server, it's always ':'
-        # Based on - https://github.com/puppetlabs/puppet/blob/f3e6d7e6d87f46408943a8e2176afb82ff6ea096/lib/puppet/settings/environment_conf.rb#L98-L106
-        @module_paths = value.split(':')
-      end
-
-      # The relative module_paths that exist on disk.
-      # @see https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
-      # @return [Array[String]] The relative module paths on disk
-      def actualized_module_paths
-        @actualized_module_paths ||= module_paths.reject { |path| path.start_with?('$') }
-                                                 .select { |path| PDK::Util::Filesystem.directory?(PDK::Util::Filesystem.expand_path(File.join(root_path, path))) }
-      end
-
-      #:nocov:
-      # @see PDK::Context::AbstractContext.display_name
-      def display_name
-        _('a Control Repository context')
-      end
-      #:nocov:
-
-      private
-
-      # Memoization helper to read the environment.conf file.
-      # @return [PDK::Config::IniFile]
-      def environment_conf
-        @environment_conf ||= PDK::ControlRepo.environment_conf_as_config(File.join(root_path, 'environment.conf'))
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Context
+    # Represents a context for a directory based Control Repository
+    class ControlRepo < PDK::Context::AbstractContext
+      # @param repo_root [String] The root path for the control repo.
+      # @param context_path [String] The path where this context was created from e.g. Dir.pwd
+      # @see PDK::Context::AbstractContext
+      def initialize(repo_root, context_path)
+        super(context_path)
+        @root_path = repo_root
+        @environment_conf = nil
+      end
+
+      # @see PDK::Context::AbstractContext.pdk_compatible?
+      def pdk_compatible?
+        # Currently there is nothing to determine compatibility with the PDK for a
+        # Control Repo. For now assume everything is compatible
+        true
+      end
+
+      # The modulepath setting for this control repository as an array of strings. These paths are relative
+      # and may contain interpolation strings (e.g. $basemodulepath)
+      # @see https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
+      # @return [Array[String]] The modulepath setting for this control repository
+      def module_paths
+        return @module_paths unless @module_paths.nil?
+        value = environment_conf['modulepath'] || ''
+        # We have to use a hardcoded value here because File::PATH_SEPARATOR is ';' on Windows.
+        # As the environment.conf is only used on Puppet Server, it's always ':'
+        # Based on - https://github.com/puppetlabs/puppet/blob/f3e6d7e6d87f46408943a8e2176afb82ff6ea096/lib/puppet/settings/environment_conf.rb#L98-L106
+        @module_paths = value.split(':')
+      end
+
+      # The relative module_paths that exist on disk.
+      # @see https://puppet.com/docs/puppet/latest/config_file_environment.html#allowed-settings
+      # @return [Array[String]] The relative module paths on disk
+      def actualized_module_paths
+        @actualized_module_paths ||= module_paths.reject { |path| path.start_with?('$') }
+                                                 .select { |path| PDK::Util::Filesystem.directory?(PDK::Util::Filesystem.expand_path(File.join(root_path, path))) }
+      end
+
+      #:nocov:
+      # @see PDK::Context::AbstractContext.display_name
+      def display_name
+        _('a Control Repository context')
+      end
+      #:nocov:
+
+      private
+
+      # Memoization helper to read the environment.conf file.
+      # @return [PDK::Config::IniFile]
+      def environment_conf
+        @environment_conf ||= PDK::ControlRepo.environment_conf_as_config(File.join(root_path, 'environment.conf'))
+      end
+    end
+  end
+end

data/lib/pdk/context/module.rb

@@ -1,28 +1,28 @@
-require 'pdk'
-
-module PDK
-  module Context
-    # Represents a context for a Puppet Module
-    class Module < PDK::Context::AbstractContext
-      # @param module_root [String] The root path for the module.
-      # @param context_path [String] The path where this context was created from e.g. Dir.pwd
-      # @see PDK::Context::AbstractContext
-      def initialize(module_root, context_path)
-        super(context_path)
-        @root_path = module_root
-      end
-
-      # @see PDK::Context::AbstractContext.pdk_compatible?
-      def pdk_compatible?
-        PDK::Util.module_pdk_compatible?(root_path)
-      end
-
-      #:nocov:
-      # @see PDK::Context::AbstractContext.display_name
-      def display_name
-        _('a Puppet Module context')
-      end
-      #:nocov:
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Context
+    # Represents a context for a Puppet Module
+    class Module < PDK::Context::AbstractContext
+      # @param module_root [String] The root path for the module.
+      # @param context_path [String] The path where this context was created from e.g. Dir.pwd
+      # @see PDK::Context::AbstractContext
+      def initialize(module_root, context_path)
+        super(context_path)
+        @root_path = module_root
+      end
+
+      # @see PDK::Context::AbstractContext.pdk_compatible?
+      def pdk_compatible?
+        PDK::Util.module_pdk_compatible?(root_path)
+      end
+
+      #:nocov:
+      # @see PDK::Context::AbstractContext.display_name
+      def display_name
+        _('a Puppet Module context')
+      end
+      #:nocov:
+    end
+  end
+end

data/lib/pdk/context/none.rb

@@ -1,22 +1,22 @@
-require 'pdk'
-
-module PDK
-  module Context
-    # Represents a context which the PDK does not know. For example
-    # an empty directory
-    class None < PDK::Context::AbstractContext
-      #:nocov:
-      # @see PDK::Context::AbstractContext.display_name
-      def display_name
-        _('an unknown context')
-      end
-      #:nocov:
-
-      # @see PDK::Context::AbstractContext.parent_context
-      def parent_context
-        # An unknown context has no parent
-        nil
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Context
+    # Represents a context which the PDK does not know. For example
+    # an empty directory
+    class None < PDK::Context::AbstractContext
+      #:nocov:
+      # @see PDK::Context::AbstractContext.display_name
+      def display_name
+        _('an unknown context')
+      end
+      #:nocov:
+
+      # @see PDK::Context::AbstractContext.parent_context
+      def parent_context
+        # An unknown context has no parent
+        nil
+      end
+    end
+  end
+end

data/lib/pdk/context.rb

@@ -1,99 +1,99 @@
-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')
-        if PDK::Util::Filesystem.file?(metadata_file) || PDK::Util.in_module_root?(context_path)
-          return PDK::Context::Module.new(current, context_path)
-        end
-
-        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
+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')
+        if PDK::Util::Filesystem.file?(metadata_file) || PDK::Util.in_module_root?(context_path)
+          return PDK::Context::Module.new(current, context_path)
+        end
+
+        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

@@ -1,90 +1,90 @@
-require 'pdk'
-
-module PDK
-  module ControlRepo
-    CONTROL_REPO_FILES = %w[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
-             else
-               nil
-             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
+require 'pdk'
+
+module PDK
+  module ControlRepo
+    CONTROL_REPO_FILES = %w[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
+             else
+               nil
+             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