pdk 1.10.0 → 1.11.0

data/lib/pdk/config/validator.rb

@@ -0,0 +1,31 @@
+module PDK
+  class Config
+    # A collection of predefined validators for use with {PDK::Config::Value}.
+    #
+    # @example
+    #   value :enabled do
+    #     validate PDK::Config::Validator.boolean
+    #   end
+    module Validator
+      # @return [Hash{Symbol => [Proc,String]}] a {PDK::Config::Value}
+      #   validator that ensures that the value is either a TrueClass or
+      #   FalseClass.
+      def self.boolean
+        {
+          proc:    ->(value) { [true, false].include?(value) },
+          message: _('must be a boolean true or false'),
+        }
+      end
+
+      # @return [Hash{Symbol => [Proc,String]}] a {PDK::Config::Value}
+      #   validator that ensures that the value is a String that matches the
+      #   regex for a version 4 UUID.
+      def self.uuid
+        {
+          proc:    ->(value) { value.match(%r{\A\h{8}(?:-\h{4}){3}-\h{12}\z}) },
+          message: _('must be a version 4 UUID'),
+        }
+      end
+    end
+  end
+end

data/lib/pdk/config/value.rb

@@ -0,0 +1,94 @@
+module PDK
+  class Config
+    # A class for describing the value of a {PDK::Config} setting.
+    #
+    # Generally, this is never instantiated manually, but is instead
+    # instantiated by passing a block to {PDK::Config::Namespace#value}.
+    #
+    # @example
+    #
+    # PDK::Config::Namespace.new('analytics') do
+    #   value :disabled do
+    #     validate PDK::Config::Validator.boolean
+    #     default_to { false }
+    #   end
+    # end
+    class Value
+      # Initialises an empty value definition.
+      #
+      # @param name [String,Symbol] the name of the value.
+      def initialize(name)
+        @name = name
+        @validators = []
+      end
+
+      # Assign a validator to the value.
+      #
+      # @param validator [Hash{Symbol => [Proc,String]}]
+      # @option validator [Proc] :proc a lambda that takes the value to be
+      #   validated as the argument and returns `true` if the value is valid.
+      # @option validator [String] :message a description of what the validator
+      #   is testing for, that is displayed to the user as part of the error
+      #   message for invalid values.
+      #
+      # @raise [ArgumentError] if not passed a Hash.
+      # @raise [ArgumentError] if the Hash doesn't have a `:proc` key that
+      #   contains a Proc.
+      # @raise [ArgumentError] if the Hash doesn't have a `:message` key that
+      #   contains a String.
+      #
+      # @return [nil]
+      def validate(validator)
+        raise ArgumentError, _('validator must be a Hash') unless validator.is_a?(Hash)
+        raise ArgumentError, _('the :proc key must contain a Proc') unless validator.key?(:proc) && validator[:proc].is_a?(Proc)
+        raise ArgumentError, _('the :message key must contain a String') unless validator.key?(:message) && validator[:message].is_a?(String)
+
+        @validators << validator
+      end
+
+      # Validate a value against the assigned validators.
+      #
+      # @param key [String] the name of the value being validated.
+      # @param value [Object] the value being validated.
+      #
+      # @raise [ArgumentError] if any of the assigned validators fail to
+      #   validate the value.
+      #
+      # @return [nil]
+      def validate!(key, value)
+        @validators.each do |validator|
+          next if validator[:proc].call(value)
+
+          raise ArgumentError, _('%{key} %{message}') % {
+            key:     key,
+            message: validator[:message],
+          }
+        end
+      end
+
+      # Assign a default value.
+      #
+      # @param block [Proc] a block that is lazy evaluated when necessary in
+      #   order to determine the default value.
+      #
+      # @return [nil]
+      def default_to(&block)
+        raise ArgumentError, _('must be passed a block') unless block_given?
+        @default_to = block
+      end
+
+      # Evaluate the default value block.
+      #
+      # @return [Object,nil] the result of evaluating the block given to
+      #   {#default_to}, or `nil` if the value has no default.
+      def default
+        default? ? @default_to.call : nil
+      end
+
+      # @return [Boolean] true if the value has a default value block.
+      def default?
+        !@default_to.nil?
+      end
+    end
+  end
+end

data/lib/pdk/config/yaml.rb

@@ -0,0 +1,31 @@
+require 'pdk/config/namespace'
+
+module PDK
+  class Config
+    class YAML < Namespace
+      def parse_data(data, filename)
+        return {} if data.nil? || data.empty?
+
+        require 'yaml'
+
+        ::YAML.safe_load(data, [Symbol], [], true)
+      rescue Psych::SyntaxError => e
+        raise PDK::Config::LoadError, _('Syntax error when loading %{file}: %{error}') % {
+          file:  filename,
+          error: "#{e.problem} #{e.context}",
+        }
+      rescue Psych::DisallowedClass => e
+        raise PDK::Config::LoadError, _('Unsupported class in %{file}: %{error}') % {
+          file:  filename,
+          error: e.message,
+        }
+      end
+
+      def serialize_data(data)
+        require 'yaml'
+
+        ::YAML.dump(data)
+      end
+    end
+  end
+end

data/lib/pdk/generate/module.rb

@@ -124,7 +124,7 @@ module PDK
         defaults['name'] = "#{opts[:username]}-#{opts[:module_name]}" unless opts[:module_name].nil?
         defaults['author'] = PDK.answers['author'] unless PDK.answers['author'].nil?
         defaults['license'] = PDK.answers['license'] unless PDK.answers['license'].nil?
-        defaults['license'] = opts[:license] if opts.key? :license
+        defaults['license'] = opts[:license] if opts.key?(:license)
 
         metadata = PDK::Module::Metadata.new(defaults)
         module_interview(metadata, opts) unless opts[:'skip-interview']
@@ -199,6 +199,7 @@ module PDK
             question: _('What operating systems does this module support?'),
             help:     _('Use the up and down keys to move between the choices, space to select and enter to continue.'),
             required: true,
+            type:     :multi_select,
             choices:  PDK::Module::Metadata::OPERATING_SYSTEMS,
             default:  PDK::Module::Metadata::DEFAULT_OPERATING_SYSTEMS.map do |os_name|
               # tty-prompt uses a 1-index
@@ -252,7 +253,7 @@ module PDK
         else
           questions.reject! { |q| q[:name] == 'module_name' } if opts.key?(:module_name)
           questions.reject! { |q| q[:name] == 'license' } if opts.key?(:license)
-          questions.reject! { |q| q[:forge_only] } unless opts.key?(:'full-interview')
+          questions.reject! { |q| q[:forge_only] } unless opts[:'full-interview']
         end
 
         interview.add_questions(questions)

data/lib/pdk/logger.rb

@@ -6,17 +6,37 @@ module PDK
   end
 
   class Logger < ::Logger
+    WRAP_COLUMN_LIMIT = 78
+
     def initialize
       super(STDERR)
+      @sent_messages = {}
 
       # TODO: Decide on output format.
       self.formatter = proc do |severity, _datetime, _progname, msg|
-        "pdk (#{severity}): #{msg}\n"
+        prefix = "pdk (#{severity}): "
+        if msg.is_a?(Hash)
+          if msg.fetch(:wrap, false)
+            wrap_pattern = %r{(.{1,#{WRAP_COLUMN_LIMIT - prefix.length}})(\s+|\Z)}
+            "#{prefix}#{msg[:text].gsub(wrap_pattern, "\\1\n#{' ' * prefix.length}")}\n"
+          else
+            "#{prefix}#{msg[:text]}\n"
+          end
+        else
+          "#{prefix}#{msg}\n"
+        end
       end
 
       self.level = ::Logger::INFO
     end
 
+    def warn_once(*args)
+      hash = args.inspect.hash
+      return if (@sent_messages[::Logger::WARN] ||= {}).key?(hash)
+      @sent_messages[::Logger::WARN][hash] = true
+      warn(*args)
+    end
+
     def enable_debug_output
       self.level = ::Logger::DEBUG
     end

data/lib/pdk/module/build.rb

@@ -120,8 +120,14 @@ module PDK
         elsif File.symlink?(path)
           warn_symlink(path)
         else
+          validate_ustar_path!(relative_path.to_path)
           FileUtils.cp(path, dest_path, preserve: true)
         end
+      rescue ArgumentError => e
+        raise PDK::CLI::ExitWithError, _(
+          '%{message} Please rename the file or exclude it from the package ' \
+          'by adding it to the .pdkignore file in your module.',
+        ) % { message: e.message }
       end
 
       # Check if the given path matches one of the patterns listed in the
@@ -152,6 +158,58 @@ module PDK
         }
       end
 
+      # Checks if the path length will fit into the POSIX.1-1998 (ustar) tar
+      # header format.
+      #
+      # POSIX.1-2001 (which allows paths of infinite length) was adopted by GNU
+      # tar in 2004 and is supported by minitar 0.7 and above. Unfortunately
+      # much of the Puppet ecosystem still uses minitar 0.6.1.
+      #
+      # POSIX.1-1998 tar format does not allow for paths greater than 256 bytes,
+      # or paths that can't be split into a prefix of 155 bytes (max) and
+      # a suffix of 100 bytes (max).
+      #
+      # This logic was pretty much copied from the private method
+      # {Archive::Tar::Minitar::Writer#split_name}.
+      #
+      # @param path [String] the relative path to be added to the tar file.
+      #
+      # @raise [ArgumentError] if the path is too long or could not be split.
+      #
+      # @return [nil]
+      def validate_ustar_path!(path)
+        if path.bytesize > 256
+          raise ArgumentError, _("The path '%{path}' is longer than 256 bytes.") % {
+            path: path,
+          }
+        end
+
+        if path.bytesize <= 100
+          prefix = ''
+        else
+          parts = path.split(File::SEPARATOR)
+          newpath = parts.pop
+          nxt = ''
+
+          loop do
+            nxt = parts.pop || ''
+            break if newpath.bytesize + 1 + nxt.bytesize >= 100
+            newpath = File.join(nxt, newpath)
+          end
+
+          prefix = File.join(*parts, nxt)
+          path = newpath
+        end
+
+        return unless path.bytesize > 100 || prefix.bytesize > 155
+
+        raise ArgumentError, _(
+          "'%{path}' could not be split at a directory separator into two " \
+          'parts, the first having a maximum length of 155 bytes and the ' \
+          'second having a maximum length of 100 bytes.',
+        ) % { path: path }
+      end
+
       # Creates a gzip compressed tarball of the build directory.
       #
       # If the destination package already exists, it will be removed before

data/lib/pdk/module/convert.rb

@@ -129,7 +129,7 @@ module PDK
             path: metadata_path,
           }
         else
-          return nil if options[:noop]
+          return if options[:noop]
 
           project_dir = File.basename(Dir.pwd)
           options[:module_name] = project_dir.split('-', 2).compact[-1]

data/lib/pdk/module/metadata.rb

@@ -108,6 +108,7 @@ module PDK
           raise ArgumentError, _('Invalid JSON in metadata.json: %{msg}') % { msg: e.message }
         end
 
+        data['template-url'] = PDK::Util::TemplateURI.default_template_uri.metadata_format if PDK::Util.package_install? && data['template-url'] == PDK::Util::TemplateURI::PACKAGED_TEMPLATE_KEYWORD
         new(data)
       end
 

data/lib/pdk/module/templatedir.rb

@@ -9,6 +9,7 @@ module PDK
   module Module
     class TemplateDir
       attr_accessor :module_metadata
+      attr_reader :uri
 
       # Initialises the TemplateDir object with the path or URL to the template
       # and the block of code to run to be run while the template is available.
@@ -61,7 +62,7 @@ module PDK
             }
           end
         end
-        @cloned_from = uri.metadata_format
+        @uri = uri
 
         @init = init
         @moduleroot_dir = File.join(@path, 'moduleroot')
@@ -74,6 +75,9 @@ module PDK
 
         @module_metadata = module_metadata
 
+        template_type = uri.default? ? 'default' : 'custom'
+        PDK.analytics.event('TemplateDir', 'initialize', label: template_type)
+
         yield self
       ensure
         # If we cloned a git repo to get the template, remove the clone once
@@ -94,7 +98,7 @@ module PDK
       def metadata
         {
           'pdk-version'  => PDK::Util::Version.version_string,
-          'template-url' => @cloned_from,
+          'template-url' => uri.metadata_format,
           'template-ref' => cache_template_ref(@path),
         }
       end
@@ -212,6 +216,7 @@ module PDK
           raise ArgumentError, _("The template at '%{path}' does not contain a 'moduleroot_init/' directory, which indicates you are using an older style of template. Before continuing please use the --template-url flag when running the pdk new commands to pass a new style template.") % { path: @path }
           # rubocop:enable Metrics/LineLength Style/GuardClause
         end
+        # rubocop:enable Style/GuardClause
       end
 
       # Get a list of template files in the template directory.
@@ -254,14 +259,28 @@ module PDK
 
         if @config.nil?
           conf_defaults = read_config(config_path)
-          sync_config = read_config(sync_config_path) unless sync_config_path.nil?
+          @sync_config = read_config(sync_config_path) unless sync_config_path.nil?
           @config = conf_defaults
-          @config.deep_merge!(sync_config, knockout_prefix: '---') unless sync_config.nil?
+          @config.deep_merge!(@sync_config, knockout_prefix: '---') unless @sync_config.nil?
         end
         file_config = @config.fetch(:global, {})
         file_config['module_metadata'] = @module_metadata
         file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
-        file_config.merge!(@config)
+        file_config.merge!(@config).tap do |c|
+          if uri.default?
+            file_value = if c['unmanaged']
+                           'unmanaged'
+                         elsif c['delete']
+                           'deleted'
+                         elsif @sync_config && @sync_config.key?(dest_path)
+                           'customized'
+                         else
+                           'default'
+                         end
+
+            PDK.analytics.event('TemplateDir', 'file', label: dest_path, value: file_value)
+          end
+        end
       end
 
       # Generates a hash of data from a given yaml file location.

data/lib/pdk/module/update_manager.rb

@@ -73,7 +73,7 @@ module PDK
       def changed?(path)
         changes[:added].any? { |add| add[:path] == path } ||
           changes[:removed].include?(path) ||
-          changes[:modified].keys.include?(path)
+          changes[:modified].key?(path)
       end
 
       # Apply any pending changes stored in the UpdateManager to the module.
@@ -174,7 +174,7 @@ module PDK
 
         diffs = Diff::LCS.diff(old_lines, new_lines)
 
-        return nil if diffs.empty?
+        return if diffs.empty?
 
         file_mtime = File.stat(path).mtime.localtime.strftime('%Y-%m-%d %H:%M:%S.%N %z')
         now = Time.now.localtime.strftime('%Y-%m-%d %H:%M:%S.%N %z')

data/lib/pdk/report/event.rb

@@ -267,7 +267,7 @@ module PDK
       # @return [Integer] the provided value, converted into an Integer if
       #   necessary.
       def sanitise_line(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [String, Integer]
         if RUBY_VERSION.split('.')[0..1].join('.').to_f < 2.4
@@ -292,7 +292,7 @@ module PDK
       # @return [Integer] the provided value, converted into an Integer if
       #   necessary.
       def sanitise_column(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [String, Integer]
         if RUBY_VERSION.split('.')[0..1].join('.').to_f < 2.4
@@ -317,7 +317,7 @@ module PDK
       #
       # @return [Array] Array of stack trace lines with less relevant lines excluded
       def sanitise_trace(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [Array]
 

data/lib/pdk/template_file.rb

@@ -45,7 +45,7 @@ module PDK
     end
 
     def config_for(path)
-      return nil unless respond_to?(:template_dir)
+      return unless respond_to?(:template_dir)
 
       template_dir.config_for(path)
     end