pdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcc06dd1bb15914599e1f9549ce2e32c8e405956
-  data.tar.gz: e55eea6fef1c132bb4f8e768f831027c915e78b8
+  metadata.gz: daa54ac61ef8e82a47ab9d6b0cbd190b2261a8a9
+  data.tar.gz: f90e5b3f2c554d1da7594967e9b3a500f28f1869
 SHA512:
-  metadata.gz: 967bf04aec5d1e9f9fc2a6d9c3ae1c71d571ccbe4d29558a6c4582f5656866e1bdd68b3824edc036bb2fc2766cff78fce79513433401746adbb4cbfe73e37822
-  data.tar.gz: fad2d24ea55c88ebcbaee911c731e374d96d5f4e3d1d6c8e66229e5f256e5a7fb985534deffb8312698cdcf266bddc95788d58c5cd893d34d6fc3316394049bb
+  metadata.gz: b2d4b1f197c7ca9d8acd269aa4a1ad83760a6b3238cc6dcd2330bc91324687fe370aeccc6a5756bea99ff812f2f6603f7eac1541c21fd6a01660acddd0bb7d41
+  data.tar.gz: 81515d3bf458e1e432fe985c47cb1f481267886a0a525bb5209af81925e4868c7f27b5df35069bcb1b554d145f9d6f74a823b0ada33c8f2c1f431098319e4bff

data/CHANGELOG.md

@@ -3,6 +3,32 @@
 All notable changes to this project will be documented in this file.
 
 
+## [v1.1.0](https://github.com/puppetlabs/pdk/tree/v1.1.0) (2017-09-13)
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.0.1...v1.1.0)
+
+**Implemented enhancements:**
+
+- \(PDK-369\) Improve error context for pdk test unit failures [\#294](https://github.com/puppetlabs/pdk/pull/294) ([rodjek](https://github.com/rodjek))
+- \(PDK-415\) Convert user-input related problems from FATAL to ERROR [\#293](https://github.com/puppetlabs/pdk/pull/293) ([rodjek](https://github.com/rodjek))
+- \(PDK-465\) Improve output from spec\_prep/spec\_clean failures [\#290](https://github.com/puppetlabs/pdk/pull/290) ([rodjek](https://github.com/rodjek))
+- \(PDK-465\) Add vendored git to PATH for package installs [\#287](https://github.com/puppetlabs/pdk/pull/287) ([rodjek](https://github.com/rodjek))
+- \(PDK-370\) Adds a 'pdk module generate' redirect to 'pdk new module'. [\#286](https://github.com/puppetlabs/pdk/pull/286) ([bmjen](https://github.com/bmjen))
+- \(PDK-459\) Improve error message when the generation target exists [\#285](https://github.com/puppetlabs/pdk/pull/285) ([DavidS](https://github.com/DavidS))
+- \(PDK-461\) Update childprocess to current version [\#282](https://github.com/puppetlabs/pdk/pull/282) ([DavidS](https://github.com/DavidS))
+- \(PDK-459\) Add defined type generator [\#280](https://github.com/puppetlabs/pdk/pull/280) ([rodjek](https://github.com/rodjek))
+- \(MAINT\) Copy-edited all the user-visible messages [\#276](https://github.com/puppetlabs/pdk/pull/276) ([jbondpdx](https://github.com/jbondpdx))
+- \(PDK-365\) Inform and prompt user following new module generate [\#270](https://github.com/puppetlabs/pdk/pull/270) ([bmjen](https://github.com/bmjen))
+- \(maint\) Debug output GEM\_HOME and GEM\_PATH before executing module commands [\#268](https://github.com/puppetlabs/pdk/pull/268) ([james-stocks](https://github.com/james-stocks))
+- \(SDK-336\) Add operating system question to the new module interview [\#262](https://github.com/puppetlabs/pdk/pull/262) ([rodjek](https://github.com/rodjek))
+
+**Fixed bugs:**
+
+- Remove EOL style cop from default configuration [\#267](https://github.com/puppetlabs/pdk/issues/267)
+- \(PDK-450\) remove stdlib dependency [\#278](https://github.com/puppetlabs/pdk/pull/278) ([DavidS](https://github.com/DavidS))
+- \(PDK-420\) Ensure Puppet and Puppet::Util modules are defined [\#277](https://github.com/puppetlabs/pdk/pull/277) ([rodjek](https://github.com/rodjek))
+- \(PDK-430\) Do not cache template-url answer if using the default template [\#265](https://github.com/puppetlabs/pdk/pull/265) ([rodjek](https://github.com/rodjek))
+
 ## [v1.0.1](https://github.com/puppetlabs/pdk/tree/v1.0.1) (2017-08-17)
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.0.0...v1.0.1)

data/README.md

@@ -56,6 +56,17 @@ pdk new class class_name
 
 PDK creates the new class manifest and a test file (as `class_name_spec.rb`) in your module's `/spec/classes` directory. 
 
+### Generate a defined type
+
+To generate a defined type in your module, use the `pdk new defined_type` command, specifying the name of your new defined type.
+
+1. From the command line, in your module's directory, run: 
+```
+pdk new defined_type defined_type_name
+```
+
+PDK creates the new defined\_type manifest and a test file (as `defined_type_name_spec.rb`) in your module's `/spec/defines` directory. 
+
 
 ### Validating a module
 

data/lib/pdk/answer_file.rb

@@ -53,7 +53,7 @@ module PDK
     # @raise (see #save_to_disk)
     def update!(new_answers = {})
       unless new_answers.is_a?(Hash)
-        raise PDK::CLI::FatalError, _('Answer file can only be updated with a Hash')
+        raise PDK::CLI::FatalError, _('Answer file can be updated only with a Hash')
       end
 
       answers.merge!(new_answers)

data/lib/pdk/cli.rb

@@ -2,6 +2,7 @@ require 'cri'
 
 require 'pdk/cli/errors'
 require 'pdk/cli/util'
+require 'pdk/cli/util/command_redirector'
 require 'pdk/cli/util/option_normalizer'
 require 'pdk/cli/util/option_validator'
 require 'pdk/cli/exec_group'
@@ -14,6 +15,10 @@ require 'pdk/util/version'
 module PDK::CLI
   def self.run(args)
     @base_cmd.run(args)
+  rescue PDK::CLI::ExitWithError => e
+    PDK.logger.error(e.message)
+
+    exit e.exit_code
   rescue PDK::CLI::FatalError => e
     PDK.logger.fatal(e.message) if e.message
 
@@ -33,7 +38,11 @@ module PDK::CLI
   end
 
   def self.template_url_option(dsl)
-    dsl.option nil, 'template-url', _('Specifies the URL to the template to use when creating new modules, and other parts.'), argument: :required, default: PDK::Generate::Module.default_template_url
+    dsl.option nil, 'template-url', _('Specifies the URL to the template to use when creating new modules or classes.'), argument: :required, default: PDK::Generate::Module.default_template_url
+  end
+
+  def self.skip_interview_option(dsl)
+    dsl.option nil, 'skip-interview', _('When specified, skips interactive querying of metadata.')
   end
 
   @base_cmd = Cri::Command.define do
@@ -43,21 +52,21 @@ module PDK::CLI
     description _('The shortest path to better modules.')
     default_subcommand 'help'
 
-    flag nil, :version, _('show version of pdk') do |_, _|
+    flag nil, :version, _('Show version of pdk.') do |_, _|
       puts PDK::Util::Version.version_string
       exit 0
     end
 
-    flag :h, :help, _('show help for this command') do |_, c|
+    flag :h, :help, _('Show help for this command.') do |_, c|
       puts c.help
       exit 0
     end
 
     format_desc = _(
       "Specify desired output format. Valid formats are '%{available_formats}'. " \
-      'You may also specify a file to which the formatted output will be directed, ' \
+      'You may also specify a file to which the formatted output is sent, ' \
       "for example: '--format=junit:report.xml'. This option may be specified " \
-      'multiple times as long as each option specifies a distinct target file.',
+      'multiple times if each option specifies a distinct target file.',
     ) % { available_formats: PDK::Report.formats.join("', '") }
 
     option :f, :format, format_desc, argument: :required, multiple: true do |values|
@@ -68,7 +77,7 @@ module PDK::CLI
       PDK.logger.enable_debug_output
     end
 
-    option nil, 'answer-file', _('Path to an answer file'), argument: :required, hidden: true do |value|
+    option nil, 'answer-file', _('Path to an answer file.'), argument: :required, hidden: true do |value|
       PDK.answer_file = value
     end
   end
@@ -77,6 +86,7 @@ module PDK::CLI
   require 'pdk/cli/new'
   require 'pdk/cli/test'
   require 'pdk/cli/validate'
+  require 'pdk/cli/module'
 
   @base_cmd.add_command Cri::Command.new_basic_help
 end

data/lib/pdk/cli/bundle.rb

@@ -3,9 +3,11 @@ module PDK::CLI
   @bundle_cmd = @base_cmd.define_command do
     name 'bundle'
     usage _('bundle -- [bundler_options]')
-    summary _('escape hatch to bundler')
-    description _('[experimental] For advanced users, this allows to run arbitrary commands in the bundler environment that the pdk manages. ' \
-      'Careless use of this command can lead to errors later which can\'t be recovered by the pdk itself.')
+    summary _('(Experimental) Command pass-through to bundler')
+    description _('[experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.' \
+      'Careless use of this command can lead to errors that pdk can\'t help recover from.')
+
+    be_hidden
 
     run do |_opts, args, _cmd|
       PDK::CLI::Util.ensure_in_module!

data/lib/pdk/cli/errors.rb

@@ -3,7 +3,16 @@ module PDK
     class FatalError < StandardError
       attr_reader :exit_code
 
-      def initialize(msg = _('An unexpected error has occurred, try running the command again with --debug'), exit_code = 1)
+      def initialize(msg = _('An unexpected error has occurred. Try running the command again with --debug'), exit_code = 1)
+        @exit_code = exit_code
+        super(msg)
+      end
+    end
+
+    class ExitWithError < StandardError
+      attr_reader :exit_code
+
+      def initialize(msg, exit_code = 1)
         @exit_code = exit_code
         super(msg)
       end

data/lib/pdk/cli/exec.rb

@@ -53,15 +53,15 @@ module PDK
 
       def self.try_vendored_bin(vendored_bin_path, fallback)
         unless PDK::Util.package_install?
-          PDK.logger.debug(_("PDK package installation not found, trying '%{fallback}' from the system PATH instead") % { fallback: fallback })
+          PDK.logger.debug(_("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.") % { fallback: fallback })
           return fallback
         end
 
         if File.exist?(File.join(PDK::Util.pdk_package_basedir, vendored_bin_path))
-          PDK.logger.debug(_("Using '%{vendored_bin_path}' from PDK package") % { vendored_bin_path: vendored_bin_path })
+          PDK.logger.debug(_("Using '%{vendored_bin_path}' from PDK package.") % { vendored_bin_path: vendored_bin_path })
           File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
         else
-          PDK.logger.debug(_("Could not find '%{vendored_bin_path}' in PDK package, trying '%{fallback}' from the system PATH instead") % { fallback: fallback, vendored_bin_path: vendored_bin_path })
+          PDK.logger.debug(_("Could not find '%{vendored_bin_path}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % { fallback: fallback, vendored_bin_path: vendored_bin_path })
           fallback
         end
       end
@@ -99,7 +99,7 @@ module PDK
 
         def context=(new_context)
           unless [:system, :module].include?(new_context)
-            raise ArgumentError, _("Expected execution context to be :system or :module but got '%{context}'") % { context: new_context }
+            raise ArgumentError, _("Expected execution context to be :system or :module but got '%{context}'.") % { context: new_context }
           end
 
           @context = new_context
@@ -154,6 +154,7 @@ module PDK
               File.join(@process.environment['GEM_HOME'], 'bin'),
               File.join(@process.environment['GEM_PATH'], 'bin'),
               package_binpath,
+              PDK::Util.package_install? ? PDK::CLI::Exec.git_bindir : nil,
               ENV['PATH'],
             ].compact.join(File::PATH_SEPARATOR)
 
@@ -217,6 +218,10 @@ module PDK
         def run_process!
           command_string = argv.join(' ')
           PDK.logger.debug(_("Executing '%{command}'") % { command: command_string })
+          if context == :module
+            PDK.logger.debug(_("Command environment: GEM_HOME is '%{gem_home}' and GEM_PATH is '%{gem_path}'") % { gem_home: @process.environment['GEM_HOME'],
+                                                                                                                   gem_path: @process.environment['GEM_PATH'] })
+          end
           start_time = Time.now
           begin
             @process.start

data/lib/pdk/cli/module.rb

@@ -0,0 +1,14 @@
+module PDK::CLI
+  @module_cmd = @base_cmd.define_command do
+    name 'module'
+    usage _('module [options]')
+    summary _('Perform administrative tasks on your module.')
+    description _('Perform tasks on the module project.')
+    default_subcommand 'help'
+    be_hidden
+  end
+
+  @module_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/module/generate'

data/lib/pdk/cli/module/generate.rb

@@ -0,0 +1,40 @@
+require 'tty-prompt'
+
+module PDK::CLI
+  @module_generate_cmd = @module_cmd.define_command do
+    name 'generate'
+    usage _('generate [options] <module_name>')
+    summary _('This command is now \'pdk new module\'.')
+    be_hidden
+
+    PDK::CLI.template_url_option(self)
+    PDK::CLI.skip_interview_option(self)
+
+    run do |opts, args, _cmd|
+      require 'pdk/generators/module'
+
+      module_name = args[0]
+
+      if module_name.nil? || module_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      PDK.logger.info(_('New modules are created using the ‘pdk new module’ command.'))
+      prompt = TTY::Prompt.new(help_color: :cyan)
+      redirect = PDK::CLI::Util::CommandRedirector.new(prompt)
+      redirect.target_command('pdk new module')
+      answer = redirect.run
+
+      if answer
+        opts[:name] = module_name
+        opts[:target_dir] = module_name
+
+        PDK.logger.info(_('Creating new module: %{modname}') % { modname: module_name })
+        PDK::Generate::Module.invoke(opts)
+      else
+        exit 1
+      end
+    end
+  end
+end

data/lib/pdk/cli/new.rb

@@ -4,7 +4,7 @@ module PDK::CLI
     name 'new'
     usage _('new <type> [options]')
     summary _('create a new module, etc.')
-    description _('Creates a new instance of <type> using the options relevant to that type of thing')
+    description _('Creates a new instance of <type> using relevant options.')
     default_subcommand 'help'
   end
 
@@ -12,4 +12,5 @@ module PDK::CLI
 end
 
 require 'pdk/cli/new/class'
+require 'pdk/cli/new/defined_type'
 require 'pdk/cli/new/module'

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

@@ -20,7 +20,7 @@ module PDK::CLI
       end
 
       unless Util::OptionValidator.valid_class_name?(class_name)
-        raise PDK::CLI::FatalError, _("'%{name}' is not a valid class name") % { name: class_name }
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid class name") % { name: class_name }
       end
 
       PDK::Generate::PuppetClass.new(module_dir, class_name, opts).run

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

@@ -0,0 +1,27 @@
+module PDK::CLI
+  @new_define_cmd = @new_cmd.define_command do
+    name 'defined_type'
+    usage _('defined_type [options] <name>')
+    summary _('Create a new defined type named <name> using given options')
+
+    PDK::CLI.template_url_option(self)
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      defined_type_name = args[0]
+      module_dir = Dir.pwd
+
+      if defined_type_name.nil? || defined_type_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_defined_type_name?(defined_type_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid defined type name") % { name: defined_type_name }
+      end
+
+      PDK::Generate::DefinedType.new(module_dir, defined_type_name, opts).run
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-
 module PDK::CLI
   @new_module_cmd = @new_cmd.define_command do
     name 'module'
@@ -6,12 +5,11 @@ module PDK::CLI
     summary _('Create a new module named <module_name> using given options')
 
     PDK::CLI.template_url_option(self)
+    PDK::CLI.skip_interview_option(self)
 
     option nil, 'license', _('Specifies the license this module is written under. ' \
       "This should be a identifier from https://spdx.org/licenses/. Common values are 'Apache-2.0', 'MIT', or 'proprietary'."), argument: :required
 
-    flag nil, 'skip-interview', _('When specified, skips interactive querying of metadata.')
-
     run do |opts, args, _cmd|
       require 'pdk/generators/module'
 
@@ -23,14 +21,6 @@ module PDK::CLI
         exit 1
       end
 
-      unless Util::OptionValidator.valid_module_name?(module_name)
-        error_msg = _(
-          "'%{module_name}' is not a valid module name.\n" \
-          'Module names must begin with a lowercase letter and can only include lowercase letters, digits, and underscores.',
-        ) % { module_name: module_name }
-        raise PDK::CLI::FatalError, error_msg
-      end
-
       opts[:name] = module_name
       opts[:target_dir] = target_dir.nil? ? module_name : target_dir
 

data/lib/pdk/cli/util.rb

@@ -3,11 +3,11 @@ module PDK
     module Util
       # Ensures the calling code is being run from inside a module directory.
       #
-      # @raise [PDK::CLI::FatalError] if the current directory or parents do
+      # @raise [PDK::CLI::ExitWithError] if the current directory or parents do
       #   not contain a `metadata.json` file.
       def ensure_in_module!
-        message = _('This command must be run from inside a module (no metadata.json found)')
-        raise PDK::CLI::FatalError, message if PDK::Util.module_root.nil?
+        message = _('This command must be run from inside a valid module (no metadata.json found).')
+        raise PDK::CLI::ExitWithError, message if PDK::Util.module_root.nil?
       end
       module_function :ensure_in_module!
 

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

@@ -0,0 +1,26 @@
+require 'tty-prompt'
+
+module PDK
+  module CLI
+    module Util
+      class CommandRedirector < TTY::Prompt::AnswersCollector
+        attr_accessor :command
+
+        def pastel
+          @pastel ||= Pastel.new
+        end
+
+        def target_command(cmd)
+          @command = cmd
+        end
+
+        def run
+          @prompt.puts _('Did you mean \'%{command}\'?') % { command: pastel.bold(@command) }
+          @prompt.yes?('-->')
+        rescue TTY::Prompt::Reader::InputInterrupt
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -29,15 +29,26 @@ module PDK
             @name = question_name
             @prompt.print pastel.bold(_('[Q %{current_number}/%{questions_total}]') % { current_number: i, questions_total: num_questions }) + ' '
             @prompt.puts pastel.bold(question[:question])
-            @prompt.puts question[:help]
-            ask(_('-->')) do |q|
-              q.required(question.fetch(:required, false))
+            @prompt.puts question[:help] if question.key?(:help)
+            if question.key?(:choices)
+              multi_select(_('-->'), per_page: question[:choices].count) do |q|
+                q.enum ')'
+                q.default(*question[:default]) if question.key?(:default)
 
-              if question.key?(:validate_pattern)
-                q.validate(question[:validate_pattern], question[:validate_message])
+                question[:choices].each do |text, metadata|
+                  q.choice text, metadata
+                end
               end
+            else
+              ask(_('-->')) do |q|
+                q.required(question.fetch(:required, false))
 
-              q.default(question[:default]) if question.key?(:default)
+                if question.key?(:validate_pattern)
+                  q.validate(question[:validate_pattern], question[:validate_message])
+                end
+
+                q.default(question[:default]) if question.key?(:default)
+              end
             end
             i += 1
             @prompt.puts ''