pdk 0.6.0 → 1.0.0

data/lib/pdk/cli/exec_group.rb

@@ -0,0 +1,53 @@
+require 'tty-spinner'
+require 'tty-which'
+
+require 'pdk/util'
+
+module PDK
+  module CLI
+    class ExecGroup
+      attr_reader :commands
+
+      def initialize(message, opts = {})
+        @options = opts.merge(PDK::CLI::Util.spinner_opts_for_platform)
+
+        unless PDK.logger.debug?
+          @multi_spinner = TTY::Spinner::Multi.new("[:spinner] #{message}", @options)
+          @multi_spinner.auto_spin
+        end
+
+        @threads = []
+        @exit_codes = []
+      end
+
+      def register
+        raise PDK::CLI::FatalError, 'No block registered' unless block_given?
+
+        @threads << Thread.new do
+          GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
+          GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
+          @exit_codes << yield
+        end
+      end
+
+      def add_spinner(message, opts = {})
+        return if PDK.logger.debug?
+        @multi_spinner.register("[:spinner] #{message}", @options.merge(opts).merge(PDK::CLI::Util.spinner_opts_for_platform))
+      end
+
+      def exit_code
+        @threads.each(&:join)
+
+        exit_code = @exit_codes.max
+
+        if exit_code.zero? && @multi_spinner
+          @multi_spinner.success
+        elsif @multi_spinner
+          @multi_spinner.error
+        end
+
+        exit_code
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module PDK::CLI
   @new_class_cmd = @new_cmd.define_command do
     name 'class'
-    usage _('class [options] <class_name> [parameter[:type]] [parameter[:type]] ...')
+    usage _('class [options] <class_name>')
     summary _('Create a new class named <class_name> using given options')
 
     PDK::CLI.template_url_option(self)
@@ -23,10 +23,6 @@ module PDK::CLI
         raise PDK::CLI::FatalError, _("'%{name}' is not a valid class name") % { name: class_name }
       end
 
-      if args.length > 1
-        opts[:params] = args[1..-1].map { |r| Util::OptionNormalizer.parameter_specification(r) }
-      end
-
       PDK::Generate::PuppetClass.new(module_dir, class_name, opts).run
     end
   end

data/lib/pdk/cli/util.rb

@@ -10,6 +10,17 @@ module PDK
         raise PDK::CLI::FatalError, message if PDK::Util.module_root.nil?
       end
       module_function :ensure_in_module!
+
+      def spinner_opts_for_platform
+        windows_opts = {
+          success_mark: '*',
+          error_mark: 'X',
+        }
+
+        return windows_opts if Gem.win_platform?
+        {}
+      end
+      module_function :spinner_opts_for_platform
     end
   end
 end

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

@@ -1,4 +1,5 @@
 require 'tty-prompt'
+require 'pdk/monkey_patches'
 
 module PDK
   module CLI

data/lib/pdk/cli/validate.rb

@@ -15,6 +15,7 @@ module PDK::CLI
 
     flag nil, :list, _('list all available validators')
     flag :a, 'auto-correct', _('automatically correct problems (where possible)')
+    flag nil, :parallel, _('run validations in parallel')
 
     run do |opts, args, _cmd|
       if args == ['help']
@@ -76,14 +77,25 @@ module PDK::CLI
       options = targets.empty? ? {} : { targets: targets }
       options[:auto_correct] = true if opts.key?(:'auto-correct')
 
-      exit_code = 0
-
       # Ensure that the bundle is installed and tools are available before running any validations.
       PDK::Util::Bundler.ensure_bundle!
 
-      validators.each do |validator|
-        validator_exit_code = validator.invoke(report, options)
-        exit_code = validator_exit_code if validator_exit_code != 0
+      exit_code = 0
+      if opts[:parallel]
+        exec_group = PDK::CLI::ExecGroup.new(_('Validating module using %{num_of_threads} threads' % { num_of_threads: validators.count }), opts)
+
+        validators.each do |validator|
+          exec_group.register do
+            validator.invoke(report, options.merge(exec_group: exec_group))
+          end
+        end
+
+        exit_code = exec_group.exit_code
+      else
+        validators.each do |validator|
+          validator_exit_code = validator.invoke(report, options.dup)
+          exit_code = validator_exit_code if validator_exit_code != 0
+        end
       end
 
       report_formats.each do |format|

data/lib/pdk/generators/module.rb

@@ -15,7 +15,15 @@ require 'pdk/util/version'
 module PDK
   module Generate
     class Module
-      DEFAULT_TEMPLATE = 'https://github.com/puppetlabs/pdk-module-template'.freeze
+      def self.default_template_url
+        if !PDK.answers['template-url'].nil?
+          PDK.answers['template-url']
+        elsif PDK::Util.package_install?
+          'file://' + File.join(PDK::Util.package_cachedir, 'pdk-module-template.git')
+        else
+          'https://github.com/puppetlabs/pdk-module-template'
+        end
+      end
 
       def self.invoke(opts = {})
         target_dir = File.expand_path(opts[:target_dir])
@@ -42,9 +50,9 @@ module PDK
 
         prepare_module_directory(temp_target_dir)
 
-        template_url = opts.fetch(:'template-url', PDK.answers['template-url'] || DEFAULT_TEMPLATE)
+        template_url = opts.fetch(:'template-url', default_template_url)
 
-        PDK::Module::TemplateDir.new(template_url) do |templates|
+        PDK::Module::TemplateDir.new(template_url, metadata.data) do |templates|
           templates.render do |file_path, file_content|
             file = Pathname.new(temp_target_dir) + file_path
             file.dirname.mkpath
@@ -79,7 +87,7 @@ module PDK
         login_clean = 'username' if login_clean.empty?
 
         if login_clean != login
-          PDK.logger.warn _('You username is not a valid Forge username, proceeding with the username %{username}') % {
+          PDK.logger.warn _('Your username is not a valid Forge username, proceeding with the username %{username}. You can fix this afterwards in metadata.json.') % {
             username: login_clean,
           }
         end
@@ -96,6 +104,9 @@ module PDK
           'dependencies' => [
             { 'name' => 'puppetlabs-stdlib', 'version_requirement' => '>= 4.13.1 < 5.0.0' },
           ],
+          'requirements' => [
+            { 'name' => 'puppet', 'version_requirement' => '>= 4.7.0 < 6.0.0' },
+          ],
         }
         defaults['author'] = PDK.answers['author'] unless PDK.answers['author'].nil?
         defaults['license'] = PDK.answers['license'] unless PDK.answers['license'].nil?
@@ -130,8 +141,8 @@ module PDK
         questions = [
           {
             name:             'name',
-            question:         _('What is your Puppet Forge username?'),
-            help:             _('This will be used when uploading your module to the Forge. You can opt out of this at any time.'),
+            question:         _('If you have a Puppet Forge username, add it here.'),
+            help:             _('We can use this to upload your module to the Forge when it\'s complete.'),
             required:         true,
             validate_pattern: %r{\A[a-z0-9]+\Z}i,
             validate_message: _('Forge usernames can only contain lowercase letters and numbers'),
@@ -149,7 +160,7 @@ module PDK
           {
             name:     'author',
             question: _('Who wrote this module?'),
-            help:     _('The person who gets credit for creating the module. '),
+            help:     _('This will be used to credit the module\'s author.'),
             required: true,
             default:  metadata.data['author'],
           },
@@ -162,28 +173,28 @@ module PDK
           },
           {
             name:     'summary',
-            question: _('How would you describe this module in a single sentence?'),
-            help:     _('To help other Puppet users understand what the module does.'),
+            question: _('Please summarize the purpose of this module in a single sentence.'),
+            help:     _('This will help other Puppet users understand what the module does.'),
             required: true,
             default:  metadata.data['summary'],
           },
           {
             name:     'source',
-            question: _("Where is this modules's source code repository?"),
-            help:     _('Usually a GitHub URL'),
+            question: _('If there is a source code repository for this module, enter the URL here.'),
+            help:     _('Skip this if none exists yet, you can update this later in the metadata.json.'),
             required: true,
             default:  metadata.data['source'],
           },
           {
             name:     'project_page',
-            question: _('Where can others go to learn more about this module?'),
-            help:     _('A web site that offers full information about your module.'),
+            question: _('If there is a URL where others can learn more about this module, enter it here.'),
+            help:     _('Optional. As with all questions above, you can update this later in the metadata.json.'),
             default:  metadata.data['project_page'],
           },
           {
             name:     'issues_url',
-            question: _('Where can others go to file issues about this module?'),
-            help:     _('A web site with a public bug tracker for your module.'),
+            question: _('If there is a public issue tracker for this module, enter its URL here.'),
+            help:     _('Optional. As with all questions above, you can update this later in the metadata.json.'),
             default:  metadata.data['issues_url'],
           },
         ]
@@ -197,8 +208,11 @@ module PDK
         interview.add_questions(questions)
 
         puts _(
-          "\nWe need to create a metadata.json file for this module, so we're going to ask you %{count} quick questions.\n" \
-          "If the question is not applicable to this module, just leave the answer blank.\n\n",
+          "\nWe need to create a metadata.json file for this module, so we\'re going to ask you %{count} quick " \
+          "questions.\n" \
+          'If the question is not applicable to this module, simply leave the answer blank and skip. A default option ' \
+          'is shown after each question. You can modify this or any other answers at any time by manually updating ' \
+          "the metadata.json file.\n\n",
         ) % { count: interview.num_questions }
 
         answers = interview.run
@@ -220,7 +234,11 @@ module PDK
         puts '-' * 40
         puts
 
-        unless prompt.yes?(_('About to generate this module; continue?'))
+        continue = prompt.yes?(_('About to generate this module; continue?')) do |q|
+          q.validate(proc { |value| [true, false].include?(value) || value =~ %r{\A(?:yes|y|no|n)\Z}i }, 'Please answer "yes" or "no"')
+        end
+
+        unless continue
           PDK.logger.info _('Module not generated.')
           exit 0
         end

data/lib/pdk/generators/puppet_class.rb

@@ -11,10 +11,7 @@ module PDK
       # provided to the class and class spec templates during rendering.
       def template_data
         data = { name: object_name }
-        if @options.key?(:params)
-          data[:params] = @options[:params]
-          data[:max_type_length] = @options[:params].map { |r| r[:type].length }.max
-        end
+
         data
       end
 

data/lib/pdk/generators/puppet_object.rb

@@ -197,7 +197,7 @@ module PDK
         @templates ||= [
           { type: 'CLI', url: @options[:'template-url'], allow_fallback: false },
           { type: 'metadata', url: module_metadata.data['template-url'], allow_fallback: true },
-          { type: 'default', url: PDK::Generate::Module::DEFAULT_TEMPLATE, allow_fallback: false },
+          { type: 'default', url: PDK::Generate::Module.default_template_url, allow_fallback: false },
         ]
       end
 

data/lib/pdk/logger.rb

@@ -20,5 +20,9 @@ module PDK
     def enable_debug_output
       self.level = ::Logger::DEBUG
     end
+
+    def debug?
+      level == ::Logger::DEBUG
+    end
   end
 end

data/lib/pdk/module/metadata.rb

@@ -34,6 +34,7 @@ module PDK
             'operatingsystemrelease' => ['2012 R2'],
           },
         ],
+        'requirements' => Set.new.freeze,
       }.freeze
 
       def initialize(params = {})

data/lib/pdk/module/templatedir.rb

@@ -15,6 +15,8 @@ module PDK
       #
       # @param path_or_url [String] The path to a directory to use as the
       # template or a URL to a git repository.
+      # @param module_metadata [Hash] A Hash containing the module metadata.
+      # Defaults to an empty Hash.
       # @yieldparam self [PDK::Module::TemplateDir] The initialised object with
       # the template available on disk.
       #
@@ -34,7 +36,7 @@ module PDK
       # @raise [ArgumentError] (see #validate_module_template!)
       #
       # @api public
-      def initialize(path_or_url)
+      def initialize(path_or_url, module_metadata = {})
         if File.directory?(path_or_url)
           @path = path_or_url
         else
@@ -61,6 +63,8 @@ module PDK
         @object_dir = File.join(@path, 'object_templates')
         validate_module_template!
 
+        @module_metadata = module_metadata
+
         yield self
       ensure
         # If we cloned a git repo to get the template, remove the clone once
@@ -81,7 +85,7 @@ module PDK
       def metadata
         return {} unless @repo
 
-        ref_result = PDK::CLI::Exec.git('--git-dir', File.join(@path, '.git'), 'describe', '--all', '--long')
+        ref_result = PDK::CLI::Exec.git('--git-dir', File.join(@path, '.git'), 'describe', '--all', '--long', '--always')
         if ref_result[:exit_code].zero?
           { 'template-url' => @repo, 'template-ref' => ref_result[:stdout].strip }
         else
@@ -231,7 +235,9 @@ module PDK
         end
 
         file_config = @config.fetch(:global, {})
-        file_config.merge(@config.fetch(dest_path, {})) unless dest_path.nil?
+        file_config['module_metadata'] = @module_metadata
+        file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
+        file_config
       end
     end
   end

data/lib/pdk/monkey_patches.rb

@@ -0,0 +1,13 @@
+require 'tty-prompt'
+
+module TTY
+  class Prompt
+    class Reader
+      class WinConsole
+        def get_char_non_blocking # rubocop:disable Style/AccessorMethodName
+          WinAPI.getch.chr
+        end
+      end
+    end
+  end
+end

data/lib/pdk/report/event.rb

@@ -96,7 +96,7 @@ module PDK
         location = nil if location.empty?
 
         # TODO: maybe add trace
-        [location, severity, message].compact.join(': ')
+        [severity, source, location, message].compact.join(': ')
       end
 
       # Renders the event as a JUnit XML testcase.
@@ -170,7 +170,9 @@ module PDK
 
         if path.absolute?
           module_root = Pathname.new(PDK::Util.module_root)
-          path.relative_path_from(module_root).to_path
+          path = path.relative_path_from(module_root).to_path
+          path << '/' if path == '.'
+          path
         else
           path.to_path
         end

data/lib/pdk/util.rb

@@ -152,5 +152,19 @@ module PDK
       json_result
     end
     module_function :find_valid_json_in
+
+    # Returns the targets' paths relative to the working directory
+    #
+    # @return [Array<String>] The absolute or path to the target
+    def targets_relative_to_pwd(targets)
+      targets.map do |t|
+        if Pathname.new(t).absolute?
+          Pathname.new(t).relative_path_from(Pathname.pwd)
+        else
+          t
+        end
+      end
+    end
+    module_function :targets_relative_to_pwd
   end
 end

data/lib/pdk/util/bundler.rb

@@ -1,6 +1,5 @@
 require 'bundler'
 require 'fileutils'
-require 'tty-spinner'
 require 'pdk/util'
 require 'pdk/cli/exec'
 
@@ -83,8 +82,7 @@ module PDK
           result = bundle_command(*argv).execute!
 
           unless result[:exit_code].zero?
-            $stderr.puts result[:stdout]
-            $stderr.puts result[:stderr]
+            PDK.logger.debug(result.values_at(:stdout, :stderr).join("\n"))
           end
 
           result[:exit_code].zero?
@@ -98,15 +96,14 @@ module PDK
           result = command.execute!
 
           unless result[:exit_code].zero?
-            $stderr.puts result[:stdout]
-            $stderr.puts result[:stderr]
+            PDK.logger.fatal(result.values_at(:stdout, :stderr).join("\n"))
           end
 
           result[:exit_code].zero?
         end
 
         def install!
-          argv = ['install', "--gemfile=#{gemfile}"]
+          argv = ['install', "--gemfile=#{gemfile}", '-j4']
           argv << "--path=#{bundle_cachedir}" if PDK::Util.gem_install?
 
           command = bundle_command(*argv).tap do |c|
@@ -116,8 +113,7 @@ module PDK
           result = command.execute!
 
           unless result[:exit_code].zero?
-            $stderr.puts result[:stdout]
-            $stderr.puts result[:stderr]
+            PDK.logger.fatal(result.values_at(:stdout, :stderr).join("\n"))
           end
 
           result[:exit_code].zero?
@@ -132,9 +128,7 @@ module PDK
           result = command.execute!
 
           unless result[:exit_code].zero?
-            PDK.logger.error(_('Failed to generate binstubs for %{gems}') % { gems: gems.join(' ') })
-            $stderr.puts result[:stdout]
-            $stderr.puts result[:stderr]
+            PDK.logger.fatal(_("Failed to generate binstubs for '%{gems}':\n%{output}") % { gems: gems.join(' '), output: result.values_at(:stdout, :stderr).join("\n") })
           end
 
           result[:exit_code].zero?