pdk 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9b3de42650b7bdd05b69c6bb9ee6b0150f628c6e6eb9fb22ff938fcf095cd6f2
-  data.tar.gz: 13c89a19fb58166b235d75259d72e391e66cf3a86269cbaf8257bfdd69761b64
+SHA1:
+  metadata.gz: 9ccc8605ca4505c8e57540dafa991de341002352
+  data.tar.gz: b6f8526bbc058be672452fc714b2647d38dbd1a8
 SHA512:
-  metadata.gz: 150e3a0047aaca9f19ee203bda23b07e49b177b91f266bfd63a159bac0772c1888a161a671b7b57d3eccbacbad5aec21f794d4eccd175a0ef0717714d322e81c
-  data.tar.gz: a146f216b223a1f93c362dd646d145cdc6149753981ec266fc78f72b181dd34e1279775d317d9eae5e801e6d94d1094f12f07234e2340cadda675774797966a4
+  metadata.gz: 9479fdc94261aa410a8ca51c6752386bc24379ffc840e1910c930a830d47b5d544cf8b548a5a06bf44b31239c5d19b60f16c7f0eb224d5b3e1d1afda8d30d056
+  data.tar.gz: 20e678cb7755ad127c93e0429a944a7407399e4b42a24566ae0aad02b05ba87b13f849929d3e54dcf80d30a8d0148c92ecc07e11be6582b662ccc458fa2ad7b3

data/CHANGELOG.md

@@ -4,6 +4,39 @@ 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.13.0](https://github.com/puppetlabs/pdk/tree/v1.13.0) (2019-08-29)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.12.0...v1.13.0)
+
+**Implemented enhancements:**
+
+- Don't buffer output from bundle commands [\#364](https://github.com/puppetlabs/pdk/issues/364)
+- Provide official docker image with pdk [\#336](https://github.com/puppetlabs/pdk/issues/336)
+- \(PDK-1175\) pdk new unit\_test [\#735](https://github.com/puppetlabs/pdk/pull/735) ([rodjek](https://github.com/rodjek))
+- \(PDK-871\) Relax dependencies on tty-\* gems [\#730](https://github.com/puppetlabs/pdk/pull/730) ([rodjek](https://github.com/rodjek))
+- \(PDK-1363\) Apply init templates during module convert [\#729](https://github.com/puppetlabs/pdk/pull/729) ([rodjek](https://github.com/rodjek))
+- \(PDK-1107\) Add pdk config get CLI command [\#715](https://github.com/puppetlabs/pdk/pull/715) ([glennsarti](https://github.com/glennsarti))
+
+**Fixed bugs:**
+
+- Problem running "pdk validate manifests/" with pdk 1.12.0 [\#722](https://github.com/puppetlabs/pdk/issues/722)
+- Windows MSI installer fails with PDK 1.12.0 [\#721](https://github.com/puppetlabs/pdk/issues/721)
+- Handle deleted template files for new module [\#725](https://github.com/puppetlabs/pdk/pull/725) ([seanmil](https://github.com/seanmil))
+- \(GH-722\) Do not emit nil targets for validators against a directory [\#724](https://github.com/puppetlabs/pdk/pull/724) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) avoid interfering with local ruby configs [\#86](https://github.com/puppetlabs/pdk/pull/86) ([DavidS](https://github.com/DavidS))
+
+**Merged pull requests:**
+
+- \(FIXUP\) Remove nokogiri version pin from package-testing [\#738](https://github.com/puppetlabs/pdk/pull/738) ([scotje](https://github.com/scotje))
+- \(PDK-1464\) Update nokogiri due to CVE-2019-5477 [\#733](https://github.com/puppetlabs/pdk/pull/733) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1465\) Remove net-ssh from gemspec [\#732](https://github.com/puppetlabs/pdk/pull/732) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1384\) Updates to be compatible with latest Cri [\#731](https://github.com/puppetlabs/pdk/pull/731) ([scotje](https://github.com/scotje))
+- \(docs\) minor fixups to README [\#727](https://github.com/puppetlabs/pdk/pull/727) ([jbondpdx](https://github.com/jbondpdx))
+- \(PDK-1107\) Config fetch and \[\] should have no side effects [\#726](https://github.com/puppetlabs/pdk/pull/726) ([glennsarti](https://github.com/glennsarti))
+- \(MAINT\) Bump version to 1.13.0.pre [\#720](https://github.com/puppetlabs/pdk/pull/720) ([scotje](https://github.com/scotje))
+- \(MAINT\) Allow use of RSPEC\_PATTERN env var when running package tests [\#719](https://github.com/puppetlabs/pdk/pull/719) ([scotje](https://github.com/scotje))
+- \(maint\) Remove Hipchat notifications [\#716](https://github.com/puppetlabs/pdk/pull/716) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1432\) Autogenerate PowerShell modules from code [\#701](https://github.com/puppetlabs/pdk/pull/701) ([glennsarti](https://github.com/glennsarti))
+
 ## [v1.12.0](https://github.com/puppetlabs/pdk/tree/v1.12.0) (2019-07-31)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.11.1...v1.12.0)
 

data/README.md

@@ -107,13 +107,11 @@ This command runs all available unit tests.
 
 ### `pdk bundle` command
 
-This command executes arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. This command is experimental  and can lead to errors that can't be resolved by the pdk itself.
-
-Note that for most uses, you must use the `--` to separate bundler options from pdk options. Compare the following two commands:
+This command executes arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. This command is experimental  and can lead to errors that can't be resolved by PDK itself.
 
 ## Module Compatibility
 
-**PDK Version Compatibility:** Modules created with PDK version validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)
+**PDK Version Compatibility:** Modules created with PDK validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)
 
 ## Contributing
 

data/lib/pdk/cli.rb

@@ -143,6 +143,7 @@ module PDK::CLI
 
   require 'pdk/cli/bundle'
   require 'pdk/cli/build'
+  require 'pdk/cli/config'
   require 'pdk/cli/convert'
   require 'pdk/cli/new'
   require 'pdk/cli/test'

data/lib/pdk/cli/config.rb

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

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

@@ -0,0 +1,24 @@
+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')
+
+    run do |_opts, args, _cmd|
+      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
+      if resolved_config.empty? && !item_name.nil?
+        PDK.logger.error(_("Configuration item '%{name}' does not exist") % { name: item_name })
+        exit 1
+      end
+      # If the user requested a setting and it's the only one resolved, then just output the value
+      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
+        puts _('%{value}') % { value: resolved_config.values[0] }
+        exit 0
+      end
+      # Otherwise just output everything
+      resolved_config.keys.sort.each { |key| puts _('%{name}=%{value}') % { name: key, value: resolved_config[key] } }
+    end
+  end
+end

data/lib/pdk/cli/exec.rb

@@ -2,12 +2,12 @@ require 'bundler'
 require 'childprocess'
 require 'English'
 require 'tempfile'
-require 'tty-spinner'
 require 'tty-which'
 
 require 'pdk/util'
 require 'pdk/util/git'
 require 'pdk/util/ruby_version'
+require 'pdk/cli/util/spinner'
 
 module PDK
   module CLI

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

@@ -2,12 +2,12 @@ require 'bundler'
 require 'childprocess'
 require 'English'
 require 'tempfile'
-require 'tty-spinner'
 require 'tty-which'
 
 require 'pdk/util'
 require 'pdk/util/git'
 require 'pdk/util/ruby_version'
+require 'pdk/cli/util/spinner'
 
 module PDK
   module CLI

data/lib/pdk/cli/exec_group.rb

@@ -1,7 +1,7 @@
-require 'tty-spinner'
 require 'tty-which'
 
 require 'pdk/util'
+require 'pdk/cli/util/spinner'
 
 module PDK
   module CLI

data/lib/pdk/cli/new.rb

@@ -16,3 +16,4 @@ require 'pdk/cli/new/module'
 require 'pdk/cli/new/provider'
 require 'pdk/cli/new/task'
 require 'pdk/cli/new/transport'
+require 'pdk/cli/new/unit_test'

data/lib/pdk/cli/new/unit_test.rb

@@ -0,0 +1,49 @@
+module PDK::CLI
+  @new_define_cmd = @new_cmd.define_command do
+    name 'unit_test'
+    usage _('unit_test [options] <name>')
+    summary _('(Experimental) Create a new unit test for the object named <name>')
+    description _(<<-EOF
+Generate a new rspec-puppet unit test for an existing class or defined type.
+
+Please note, this is an experimental feature; the functionality and UX is
+subject to change in future releases.
+EOF
+                 )
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+      PDK::CLI::Util.ensure_in_module!(
+        message: _('Unit tests can only be created from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      object_name = args[0]
+      module_dir = Dir.pwd
+
+      if object_name.nil? || object_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+      PDK::Util::PuppetVersion.fetch_puppet_dev if opts[:'puppet-dev']
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+
+      begin
+        generator, obj = PDK::Util::PuppetStrings.find_object(object_name)
+
+        PDK::CLI::Util.analytics_screen_view('new_unit_test', opts)
+
+        generator.new(module_dir, obj['name'], opts.merge(spec_only: true)).run
+      rescue PDK::Util::PuppetStrings::NoObjectError
+        raise PDK::CLI::ExitWithError, _('Unable to find anything called "%{object}" to generate unit tests for.') % { object: object_name }
+      rescue PDK::Util::PuppetStrings::NoGeneratorError => e
+        raise PDK::CLI::ExitWithError, _('PDK does not support generating unit tests for "%{object_type}" objects.') % { object_type: e.message }
+      end
+    end
+  end
+end

data/lib/pdk/cli/util/interview.rb

@@ -4,6 +4,8 @@ module PDK
   module CLI
     module Util
       class Interview < TTY::Prompt::AnswersCollector
+        READER = defined?(TTY::Reader) ? TTY::Reader : TTY::Prompt::Reader
+
         def pastel
           @pastel ||= Pastel.new
         end
@@ -60,7 +62,7 @@ module PDK
             @prompt.puts ''
           end
           @answers
-        rescue TTY::Prompt::Reader::InputInterrupt
+        rescue READER::InputInterrupt
           nil
         end
       end

data/lib/pdk/cli/util/spinner.rb

@@ -0,0 +1,13 @@
+require 'tty-spinner'
+
+require 'pdk/cli/util'
+
+# Replace the built-in tty check in tty-spinner with our own implementation
+# that allows us to mock the behaviour during acceptance tests.
+module TTY
+  class Spinner
+    def tty?
+      PDK::CLI::Util.interactive?
+    end
+  end
+end

data/lib/pdk/config.rb

@@ -15,7 +15,7 @@ module PDK
       @user ||= PDK::Config::JSON.new('user', file: PDK::Config.user_config_path) do
         mount :module_defaults, PDK::Config::JSON.new(file: PDK.answers.answer_file_path)
 
-        mount :analytics, PDK::Config::YAML.new(file: PDK::Config.analytics_config_path) do
+        mount :analytics, PDK::Config::YAML.new(file: PDK::Config.analytics_config_path, persistent_defaults: true) do
           value :disabled do
             validate PDK::Config::Validator.boolean
             default_to { PDK::Config.bolt_analytics_config.fetch('disabled', true) }
@@ -33,6 +33,14 @@ module PDK
       end
     end
 
+    # Resolves *all* filtered settings from all namespaces
+    #
+    # @param filter [String] Only resolve setting names which match the filter. See PDK::Config::Namespace.be_resolved? for matching rules
+    # @return [Hash{String => Object}] All resolved settings for example {'user.module_defaults.author' => 'johndoe'}
+    def resolve(filter = nil)
+      user.resolve(filter)
+    end
+
     def self.bolt_analytics_config
       file = File.expand_path('~/.puppetlabs/bolt/analytics.yaml')
       PDK::Config::YAML.new(file: file)

data/lib/pdk/config/namespace.rb

@@ -20,12 +20,16 @@ module PDK
       #   contents of the namespace (defaults to nil).
       # @option params [self] :parent the parent {self} that this namespace is
       #   a child of (defaults to nil).
+      # @option params [self] :persistent_defaults whether default values should be persisted
+      #   to disk when evaluated. By default they are not persisted to disk. This is typically
+      #   used for settings which a randomly generated, instead of being deterministic, e.g. analytics user-id
       # @param block [Proc] a block that is evaluated within the new instance.
-      def initialize(name = nil, file: nil, parent: nil, &block)
+      def initialize(name = nil, file: nil, parent: nil, persistent_defaults: false, &block)
         @file = File.expand_path(file) unless file.nil?
         @values = {}
         @name = name.to_s
         @parent = parent
+        @persistent_defaults = persistent_defaults
 
         instance_eval(&block) if block_given?
       end
@@ -104,11 +108,6 @@ module PDK
         data.fetch(key.to_s, default_value)
       end
 
-      # Set the value of the named key.
-      #
-      # If the key has been pre-configured with {#value}, then the value of the
-      # key will be validated against any validators that have been configured.
-      #
       # After the value has been set in memory, the value will then be
       # persisted to disk.
       #
@@ -117,9 +116,8 @@ module PDK
       #
       # @return [nil]
       def []=(key, value)
-        @values[key.to_s].validate!([name, key.to_s].join('.'), value) if @values.key?(key.to_s)
-
-        data[key.to_s] = value
+        set_volatile_value(key, value)
+        # Persist the change
         save_data
       end
 
@@ -143,6 +141,28 @@ module PDK
         end
       end
 
+      # Resolves all filtered settings, including child namespaces, fully namespaced and filling in default values.
+      #
+      # @param filter [String] Only resolve setting names which match the filter. See #be_resolved? for matching rules
+      # @return [Hash{String => Object}] All resolved settings for example {'user.module_defaults.author' => 'johndoe'}
+      def resolve(filter = nil)
+        # Explicitly force values to be loaded if they have not already
+        # done so. This will not cause them to be persisted to disk
+        (@values.keys - data.keys).each { |key_name| self[key_name] }
+        resolved = {}
+        data.each do |data_name, obj|
+          case obj
+          when PDK::Config::Namespace
+            # Query the child namespace
+            resolved.merge!(obj.resolve(filter))
+          else
+            setting_name = [name, data_name.to_s].join('.')
+            resolved[setting_name] = self[data_name] if be_resolved?(setting_name, filter)
+          end
+        end
+        resolved
+      end
+
       # @return [Boolean] true if the namespace has a parent, otherwise false.
       def child_namespace?
         !parent.nil?
@@ -173,6 +193,21 @@ module PDK
 
       private
 
+      # Determines whether a setting name should be resolved using the filter
+      #  Returns true when filter is nil.
+      #  Returns true if the filter is exactly the same name as the setting.
+      #  Returns true if the name is a sub-key of the filter e.g.
+      #    Given a filter of user.module_defaults, `user.module_defaults.author` will return true, but `user.analytics.disabled` will return false.
+      #
+      # @param name [String] The setting name to test.
+      # @param filter [String] The filter used to test on the name.
+      # @return [Boolean] Whether the name passes the filter.
+      def be_resolved?(name, filter = nil)
+        return true if filter.nil? # If we're not filtering, this value should always be resolved
+        return true if name == filter # If it's exactly the same name then it should be resolved
+        name.start_with?(filter + '.') # If name is a subkey of the filter then it should be resolved
+      end
+
       # @abstract Subclass and override {#parse_data} to implement parsing logic
       #   for a particular config file format.
       #
@@ -185,6 +220,19 @@ module PDK
         {}
       end
 
+      # Set the value of the named key.
+      #
+      # If the key has been pre-configured with {#value}, then the value of the
+      # key will be validated against any validators that have been configured.
+      #
+      # @param key [String,Symbol] the name of the configuration value.
+      # @param value [Object] the value of the configuration value.
+      def set_volatile_value(key, value)
+        @values[key.to_s].validate!([name, key.to_s].join('.'), value) if @values.key?(key.to_s)
+
+        data[key.to_s] = value
+      end
+
       # Read the file associated with the namespace.
       #
       # @raise [PDK::Config::LoadError] if the file is removed during read.
@@ -228,7 +276,7 @@ module PDK
       def save_data
         return if file.nil?
 
-        FileUtils.mkdir_p(File.dirname(file))
+        PDK::Util::Filesystem.mkdir_p(File.dirname(file))
 
         PDK::Util::Filesystem.write_file(file, serialize_data(to_h))
       rescue Errno::EACCES
@@ -243,24 +291,27 @@ module PDK
       #
       # @return [Hash<String => Object>] the contents of the namespace.
       def data
+        # It's possible for parse_data to return nil, so just return an empty hash
         @data ||= parse_data(load_data, file).tap do |h|
-          h.default_proc = default_config_value
-        end
+          h.default_proc = default_config_value unless h.nil?
+        end || {}
       end
 
       # The default behaviour of the namespace when the requested value does
       # not exist.
       #
       # If the value has been pre-configured with {#value} to have a default
-      # value, resolve the default value and set it in the namespace
-      # (triggering a call to {#save_data}. Otherwise, set the value to a new
-      # Hash to allow for arbitrary level of nested values.
+      # value, resolve the default value and set it in the namespace and optionally
+      # save the new default.
+      # Otherwise, set the value to a new Hash to allow for arbitrary level of nested values.
       #
       # @return [Proc] suitable for use by {Hash#default_proc}.
       def default_config_value
         ->(hash, key) do
           if @values.key?(key) && @values[key].default?
-            self[key] = @values[key].default
+            set_volatile_value(key, @values[key].default)
+            save_data if @persistent_defaults
+            hash[key]
           else
             hash[key] = {}.tap do |h|
               h.default_proc = default_config_value

data/lib/pdk/generate.rb

@@ -8,5 +8,13 @@ require 'pdk/module/metadata'
 require 'pdk/module/templatedir'
 
 module PDK
-  module Generate; end
+  module Generate
+    GENERATORS = [
+      PDK::Generate::DefinedType,
+      PDK::Generate::Provider,
+      PDK::Generate::PuppetClass,
+      PDK::Generate::Task,
+      PDK::Generate::Transport,
+    ].freeze
+  end
 end