pdk 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff9ce82e1ef158819f1089c8350fde37df2c9d8e105b09e4ecea52f542469bb
-  data.tar.gz: cff148b17b8175f7fe5401d5de87bebd36de18b939dcec7c456793d1da674ef7
+  metadata.gz: 474d162028588f81742d07449993c5d483a850f8752fd316753bf3bbdddc4e1f
+  data.tar.gz: 856f5d44b107853f0cebfce208d157d33200b74d3478eb8aaa1d3d6756744126
 SHA512:
-  metadata.gz: 0b8b0dc86dec798fcb51c8c1ab44ae0f591f84e0b6ee86ad6ede292e3fbd496495584ce83bcafdc6791bf93bdb134678033dbb695e9fb84519844bb7a776e69a
-  data.tar.gz: 365ba46da5e62d7519b9df797140cf75c904e2d64765b1ef72a6161e53a0e98bba5c2a8948404c6e2aff67b45678e842bd1621b86b8f334e4a7add46881948d3
+  metadata.gz: eed98a917574715ad9b01993a2b19137d8e3da107a17f5d3e19694619f19d117648aa89abffb4c8df09cd4e0fded23023e08fb395f2f5a80513e685a20b60185
+  data.tar.gz: c497f0dc4af2134bfaab6870b8b1bd4525c27629e4cc86295efd915aaef194f764717a83cd705c569b668a8a66f26087605b5dcfbbf8f6ae3e2e0f74b2c5f4b5

data/CHANGELOG.md

@@ -4,6 +4,30 @@ All changes to this repo will be documented in this file.
 See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) for a high-level summary.
 
 
+## [v1.17.0](https://github.com/puppetlabs/pdk/tree/v1.17.0) (2020-02-27)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.16.0...v1.17.0)
+
+**Implemented enhancements:**
+
+- \(PDK-1618\)\(PDK-1613\)\(PDK-1616\) Add Control Repo support to Validators [\#858](https://github.com/puppetlabs/pdk/pull/858) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1614\) Add project.environment settings [\#857](https://github.com/puppetlabs/pdk/pull/857) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1615\) Add Ini File configuration support [\#856](https://github.com/puppetlabs/pdk/pull/856) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1612\) Add PDK::Context and context detection [\#853](https://github.com/puppetlabs/pdk/pull/853) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1607\)\(PDK-1608\) Implement system-level settings for PDK configuration [\#841](https://github.com/puppetlabs/pdk/pull/841) ([glennsarti](https://github.com/glennsarti))
+
+**Fixed bugs:**
+
+- Unable to automatically generate the changelog [\#855](https://github.com/puppetlabs/pdk/issues/855)
+- 'pdk new module' bundler error with PDK-1.16 on macOS 10.14 [\#845](https://github.com/puppetlabs/pdk/issues/845)
+
+**Merged pull requests:**
+
+- \(\#855\) Use correct namespace for external Bundler call [\#860](https://github.com/puppetlabs/pdk/pull/860) ([rodjek](https://github.com/rodjek))
+- \(maint\) Use Ruby 2.5 on Travis for PDK as a library tests [\#849](https://github.com/puppetlabs/pdk/pull/849) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) Update for Ruby 2.3 and JSON Schema tests [\#847](https://github.com/puppetlabs/pdk/pull/847) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) Add basic tests for running PDK unprivileged [\#846](https://github.com/puppetlabs/pdk/pull/846) ([rodjek](https://github.com/rodjek))
+- \(PDK-1592\) Refactor PDK validators to be more singular purpose [\#831](https://github.com/puppetlabs/pdk/pull/831) ([glennsarti](https://github.com/glennsarti))
+
 ## [v1.16.0](https://github.com/puppetlabs/pdk/tree/v1.16.0) (2020-02-05)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.15.0...v1.16.0)
 

data/lib/pdk.rb

@@ -5,6 +5,7 @@ module PDK
   autoload :AnswerFile, 'pdk/answer_file'
   autoload :Bolt, 'pdk/bolt'
   autoload :Config, 'pdk/config'
+  autoload :Context, 'pdk/context'
   autoload :ControlRepo, 'pdk/control_repo'
   autoload :Generate, 'pdk/generate'
   autoload :Logger, 'pdk/logger'
@@ -30,35 +31,41 @@ module PDK
     autoload :Unit, 'pdk/tests/unit'
   end
 
-  # Singleton accessor to the current answer file being used by the PDK.
-  #
-  # @return [PDK::AnswerFile] The AnswerFile instance currently being used by
-  #   the PDK.
-  def self.answers
-    @answer_file ||= PDK::AnswerFile.new
+  def self.logger
+    @logger ||= PDK::Logger.new
   end
 
-  # Specify the path to a custom answer file that the PDK should use.
-  #
-  # @param path [String] A path on disk to the file where the PDK should store
-  #   answers to interactive questions.
-  def self.answer_file=(path)
-    @answer_file = PDK::AnswerFile.new(path)
+  def self.config
+    return @config unless @config.nil?
+    options = {}
+    options['user.module_defaults.path'] = PDK::Util::Env['PDK_ANSWER_FILE'] unless PDK::Util::Env['PDK_ANSWER_FILE'].nil?
+    @config = PDK::Config.new(options)
   end
 
-  def self.logger
-    @logger ||= PDK::Logger.new
+  def self.context
+    @context ||= PDK::Context.create(Dir.pwd)
   end
 
-  def self.config
-    @config ||= PDK::Config.new
+  def self.available_feature_flags
+    @available_feature_flags ||= %w[
+      controlrepo
+    ].freeze
+  end
+
+  def self.requested_feature_flags
+    @requested_feature_flags ||= (PDK::Util::Env['PDK_FEATURE_FLAGS'] || '').split(',').map { |flag| flag.strip }
+  end
+
+  def self.feature_flag?(flagname)
+    return false unless available_feature_flags.include?(flagname)
+    requested_feature_flags.include?(flagname)
   end
 
   def self.analytics
     @analytics ||= PDK::Analytics.build_client(
       logger:        PDK.logger,
-      disabled:      PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.user['analytics']['disabled'],
-      user_id:       PDK.config.user['analytics']['user-id'],
+      disabled:      PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.get_within_scopes('analytics.disabled', %w[user system]),
+      user_id:       PDK.config.get_within_scopes('analytics.user-id', %w[user system]),
       app_id:        "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
       client:        :google_analytics,
       app_name:      'pdk',

data/lib/pdk/answer_file.rb

@@ -1,103 +1,12 @@
 require 'pdk'
-autoload :JSON, 'json'
 
 module PDK
   class AnswerFile
-    attr_reader :answers
-    attr_reader :answer_file_path
-
-    # Initialises the AnswerFile object, which stores the responses to certain
-    # interactive questions.
-    #
-    # @param answer_file_path [String, nil] The path on disk to the file where
-    #   the answers will be stored and read from. If not specified (or `nil`),
-    #   the default path will be used (see #default_answer_file_path).
-    #
-    # @raise (see #read_from_disk)
-    def initialize(answer_file_path = nil)
-      @answer_file_path = answer_file_path || default_answer_file_path
-      @answers = read_from_disk
-    end
-
-    # Retrieve the stored answer to a question.
-    #
-    # @param question [String] The question name/identifying string.
-    #
-    # @return [Object] The answer to the question, or `nil` if no answer found.
-    def [](question)
-      answers[question]
-    end
-
-    # Update the stored answers in memory and then save them to disk.
-    #
-    # @param new_answers [Hash{String => Object}] The new questions and answers
-    #   to be merged into the existing answers.
-    #
-    # @raise [PDK::CLI::FatalError] if the new answers are not provided as
-    #   a Hash.
-    # @raise (see #save_to_disk)
-    def update!(new_answers = {})
-      unless new_answers.is_a?(Hash)
-        raise PDK::CLI::FatalError, _('Answer file can be updated only with a Hash')
-      end
-
-      answers.merge!(new_answers)
-
-      save_to_disk
-    end
-
-    private
-
     # Determine the default path to the answer file.
     #
     # @return [String] The path on disk to the default answer file.
-    def default_answer_file_path
-      File.join(PDK::Util.cachedir, 'answers.json')
-    end
-
-    # Read existing answers into memory from the answer file on disk.
-    #
-    # @raise [PDK::CLI::FatalError] If the answer file exists but can not be
-    #   read.
-    #
-    # @return [Hash{String => Object}] The existing questions and answers.
-    def read_from_disk
-      return {} if !PDK::Util::Filesystem.file?(answer_file_path) || PDK::Util::Filesystem.zero?(answer_file_path)
-
-      unless PDK::Util::Filesystem.readable?(answer_file_path)
-        raise PDK::CLI::FatalError, _("Unable to open '%{file}' for reading") % {
-          file: answer_file_path,
-        }
-      end
-
-      answers = JSON.parse(PDK::Util::Filesystem.read_file(answer_file_path))
-      if answers.is_a?(Hash)
-        answers
-      else
-        PDK.logger.warn _("Answer file '%{path}' did not contain a valid set of answers, recreating it") % {
-          path: answer_file_path,
-        }
-        {}
-      end
-    rescue JSON::JSONError
-      PDK.logger.warn _("Answer file '%{path}' did not contain valid JSON, recreating it") % {
-        path: answer_file_path,
-      }
-      {}
-    end
-
-    # Save the in memory answer set to the answer file on disk.
-    #
-    # @raise [PDK::CLI::FatalError] if the answer file can not be written to.
-    def save_to_disk
-      PDK::Util::Filesystem.mkdir_p(File.dirname(answer_file_path))
-
-      PDK::Util::Filesystem.write_file(answer_file_path, JSON.pretty_generate(answers))
-    rescue SystemCallError, IOError => e
-      raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
-        file: answer_file_path,
-        msg:  e.message,
-      }
+    def self.default_answer_file_path
+      PDK::Util::Filesystem.expand_path(File.join(PDK::Util.cachedir, 'answers.json'))
     end
   end
 end

data/lib/pdk/cli.rb

@@ -150,17 +150,13 @@ module PDK::CLI
     flag :d, :debug, _('Enable debug output.') do |_, _|
       PDK.logger.enable_debug_output
     end
-
-    option nil, 'answer-file', _('Path to an answer file.'), argument: :required, hidden: true do |value|
-      require 'pdk/answer_file'
-      PDK.answer_file = value
-    end
   end
 
   require 'pdk/cli/bundle'
   require 'pdk/cli/build'
   require 'pdk/cli/config'
   require 'pdk/cli/convert'
+  require 'pdk/cli/get'
   require 'pdk/cli/new'
   require 'pdk/cli/test'
   require 'pdk/cli/update'

data/lib/pdk/cli/config.rb

@@ -2,10 +2,12 @@ module PDK::CLI
   @config_cmd = @base_cmd.define_command do
     name 'config'
     usage _('config [subcommand] [options]')
-    summary _('Configure the Puppet Development Kit.')
+    summary _('(Deprecated) Configure the Puppet Development Kit.')
     default_subcommand 'help'
 
     run do |_opts, args, _cmd|
+      PDK.logger.warn _('The \'pdk config\' command is deprecated, please use \'pdk get config\' and \'pdk set config\' instead.')
+
       if args == ['help']
         PDK::CLI.run(%w[config --help])
         exit 0

data/lib/pdk/cli/config/get.rb

@@ -2,9 +2,11 @@ module PDK::CLI
   @config_get_cmd = @config_cmd.define_command do
     name 'get'
     usage _('config get [name]')
-    summary _('Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
+    summary _('(Deprecated) Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
 
     run do |_opts, args, _cmd|
+      PDK.logger.warn _('The \'pdk config get\' command is deprecated, please use \'pdk get config\' instead.')
+
       item_name = args[0]
       resolved_config = PDK.config.resolve(item_name)
       # If the user wanted to know a setting but it doesn't exist, raise an error

data/lib/pdk/cli/convert.rb

@@ -31,7 +31,7 @@ module PDK::CLI
         raise PDK::CLI::ExitWithError, _('You can not specify --template-url and --default-template.') if opts[:'template-url']
 
         opts[:'template-url'] = PDK::Util::TemplateURI.default_template_addressable_uri.to_s
-        PDK.answers.update!('template-url' => nil)
+        PDK.config.user['module_defaults']['template-url'] = nil
       end
 
       PDK::CLI::Util.validate_template_opts(opts)

data/lib/pdk/cli/exec/command.rb

@@ -10,6 +10,14 @@ module PDK
         attr_accessor :environment
         attr_writer :exec_group
 
+        # The spinner for this command.
+        # This should only be used for testing
+        #
+        # @return [TTY::Spinner, nil]
+        #
+        # @api private
+        attr_reader :spinner
+
         TEMPFILE_MODE = File::RDWR | File::BINARY | File::CREAT | File::TRUNC
 
         def initialize(*argv)
@@ -71,6 +79,11 @@ module PDK
           @environment.merge!(additional_env)
         end
 
+        # @return [Hash[Symbol => Object]] The result from executing the command
+        #   :stdout => String : The result of STDOUT
+        #   :stderr => String : The result of STDERR
+        #   :exit_code => Integer : The exit code from the command
+        #   :duration => Float : Number seconds it took to execute
         def execute!
           # Start spinning if configured.
           @spinner.auto_spin if @spinner

data/lib/pdk/cli/exec_group.rb

@@ -3,66 +3,101 @@ require 'pdk'
 module PDK
   module CLI
     class ExecGroup
-      def initialize(message, opts = {})
-        require 'pdk/cli/util'
-        @options = opts.merge(PDK::CLI::Util.spinner_opts_for_platform)
-
-        if PDK::CLI::Util.interactive?
-          require 'pdk/cli/util/spinner'
-
-          @spinner = if parallel?
-                       TTY::Spinner::Multi.new("[:spinner] #{message}", @options)
-                     else
-                       TTY::Spinner.new("[:spinner] #{message}", @options)
-                     end
-          @spinner.auto_spin
+      # Execution Group (ExecGroup) factory.
+      #
+      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
+      #
+      # @param create_options [Hash] A hash options used during creation of the ExecGroup.  This are not passed to the new object
+      # @option create_options :parallel [Boolean] Whether the group should be executed in Parallel (True) or Serial (False)
+      #
+      # @param group_opts [Hash] A hash of options used to configure the execution group.  Provided for backwards compatibility during refactor
+      #
+      # @return [ExecGroup]
+      def self.create(message, create_options = {}, group_opts = {})
+        if create_options[:parallel]
+          ParallelExecGroup.new(message, group_opts)
+        else
+          SerialExecGroup.new(message, group_opts)
         end
-
-        @threads_or_procs = []
-        @exit_codes = []
       end
 
-      def parallel?
-        @options[:parallel].nil? ? true : @options[:parallel]
+      # Base class for an Exection Group
+      #
+      # @param message [String] A name or message for this group. Provided for backwards compatibility during refactor
+      #
+      # @param opts [Hash] A hash of options used to configure the execution group. Provided for backwards compatibility during refactor
+      #
+      # @api private
+      def initialize(_message, opts = {})
+        @options = opts
       end
 
-      def register(&block)
+      # Register something to execute as a group
+      #
+      # @param block [Block] A block of ruby to execute
+      #
+      # @api private
+      def register(&_block)
         raise PDK::CLI::FatalError, _('No block registered') unless block_given?
+      end
+
+      # The return code of running all registered blocks
+      #
+      # @return [int] The highest exit code from the blocks
+      #
+      # @abstract
+      def exit_code; end
+    end
 
-        @threads_or_procs << if parallel?
-                               Thread.new do
-                                 GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
-                                 GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
-                                 @exit_codes << yield
-                               end
-                             else
-                               block
-                             end
+    # Executes registered blocks in serial
+    #
+    # @see PDK::CLI::ExecGroup
+    class SerialExecGroup < ExecGroup
+      def initialize(message, opts = {})
+        super(message, opts)
+        @procs = []
       end
 
-      def add_spinner(message, opts = {})
-        require 'pdk/cli/util'
+      def register(&block)
+        super(&block)
 
-        return unless PDK::CLI::Util.interactive?
-        @spinner.register("[:spinner] #{message}", @options.merge(opts).merge(PDK::CLI::Util.spinner_opts_for_platform))
+        @procs << block
       end
 
       def exit_code
-        if parallel?
-          @threads_or_procs.each(&:join)
-        else
-          @exit_codes = @threads_or_procs.map(&:call)
-        end
+        exit_codes = @procs.map(&:call)
+        exit_codes.nil? ? 0 : exit_codes.max
+      end
+    end
 
-        exit_code = @exit_codes.max
+    # Executes registered blocks in parallel using Ruby threads
+    #
+    # @see PDK::CLI::ExecGroup
+    class ParallelExecGroup < ExecGroup
+      def initialize(message, opts = {})
+        super(message, opts)
+        @threads = []
+        @exit_codes = []
+      end
+
+      def register(&block)
+        super(&block)
 
-        if exit_code.zero? && @spinner
-          @spinner.success
-        elsif @spinner
-          @spinner.error
+        # TODO: This executes the thread immediately, whereas the SerialExecGroup executes only when exit_code
+        # is called.  Need to change this so it uses a kind of ThreadPool to limit to number on concurrent jobs
+        # and only starts on the call to exit_code
+        # e.g. max_threads = No. of CPUs
+        @threads << Thread.new do
+          GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
+          GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
+          @exit_codes << yield
         end
+      end
 
-        exit_code
+      def exit_code
+        @threads.each(&:join)
+        return 0 if @exit_codes.empty?
+        @exit_codes.max
       end
     end
   end

data/lib/pdk/cli/get.rb

@@ -0,0 +1,20 @@
+module PDK::CLI
+  @get_cmd = @base_cmd.define_command do
+    name 'get'
+    usage _('get [subcommand] [options]')
+    summary _('Retrieve information about the PDK or current project.')
+    default_subcommand 'help'
+
+    run do |_opts, args, _cmd|
+      if args == ['help']
+        PDK::CLI.run(%w[get --help])
+        exit 0
+      end
+
+      PDK::CLI.run(%w[get help]) if args.empty?
+    end
+  end
+  @get_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/get/config'