pdk 1.2.1 → 1.3.0

data/lib/pdk/cli/bundle.rb

@@ -16,8 +16,6 @@ Note that for PowerShell the '--' needs to be escaped using a backtick: '`--' to
 EOF
                  )
 
-    be_hidden
-
     run do |_opts, args, _cmd|
       PDK::CLI::Util.ensure_in_module!
 

data/lib/pdk/cli/convert.rb

@@ -0,0 +1,25 @@
+require 'pdk/cli/util'
+
+module PDK::CLI
+  @convert_cmd = @base_cmd.define_command do
+    name 'convert'
+    usage _('convert [options]')
+    summary _('Convert an existing module to be compatible with the PDK.')
+
+    PDK::CLI.template_url_option(self)
+    PDK::CLI.skip_interview_option(self)
+    flag nil, :noop, _('Do not convert the module, just output what would be done.')
+    flag nil, :force, _('Convert the module automatically, with no prompts.')
+
+    run do |opts, _args, _cmd|
+      require 'pdk/module/convert'
+      PDK::CLI::Util.ensure_in_module!(check_module_layout: true)
+
+      if opts[:noop] && opts[:force]
+        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when converting a module')
+      end
+
+      PDK::Module::Convert.invoke(opts)
+    end
+  end
+end

data/lib/pdk/cli/exec.rb

@@ -5,6 +5,7 @@ require 'tty-spinner'
 require 'tty-which'
 
 require 'pdk/util'
+require 'pdk/util/git'
 
 module PDK
   module CLI
@@ -21,37 +22,6 @@ module PDK
         raise PDK::CLI::FatalError, message unless TTY::Which.exist?(bin_path)
       end
 
-      def self.git_bindir
-        @git_dir ||= File.join('private', 'git', Gem.win_platform? ? 'cmd' : 'bin')
-      end
-
-      def self.git_paths
-        @paths ||= begin
-          paths = [File.join(PDK::Util.pdk_package_basedir, git_bindir)]
-
-          if Gem.win_platform?
-            paths << File.join(PDK::Util.pdk_package_basedir, 'private', 'git', 'mingw64', 'bin')
-            paths << File.join(PDK::Util.pdk_package_basedir, 'private', 'git', 'mingw64', 'libexec', 'git-core')
-            paths << File.join(PDK::Util.pdk_package_basedir, 'private', 'git', 'usr', 'bin')
-          end
-
-          paths
-        end
-      end
-
-      def self.git_bin
-        git_bin = Gem.win_platform? ? 'git.exe' : 'git'
-        vendored_bin_path = File.join(git_bindir, git_bin)
-
-        try_vendored_bin(vendored_bin_path, git_bin)
-      end
-
-      def self.git(*args)
-        ensure_bin_present!(git_bin, 'git')
-
-        execute(git_bin, *args)
-      end
-
       def self.bundle(*args)
         ensure_bin_present!(bundle_bin, 'bundler')
 
@@ -120,7 +90,7 @@ module PDK
         end
 
         def register_spinner(spinner, opts = {})
-          return if PDK.logger.debug?
+          return unless PDK::CLI::Util.interactive?
           @success_message = opts.delete(:success)
           @failure_message = opts.delete(:failure)
 
@@ -128,7 +98,7 @@ module PDK
         end
 
         def add_spinner(message, opts = {})
-          return if PDK.logger.debug?
+          return unless PDK::CLI::Util.interactive?
           @success_message = opts.delete(:success)
           @failure_message = opts.delete(:failure)
 
@@ -169,7 +139,7 @@ module PDK
               File.join(@process.environment['GEM_PATH'], 'bin'),
               package_binpath,
               ENV['PATH'],
-              PDK::Util.package_install? ? PDK::CLI::Exec.git_paths : nil,
+              PDK::Util.package_install? ? PDK::Util::Git.git_paths : nil,
             ].compact.flatten.join(File::PATH_SEPARATOR)
 
             mod_root = PDK::Util.module_root

data/lib/pdk/cli/exec_group.rb

@@ -11,7 +11,7 @@ module PDK
       def initialize(message, opts = {})
         @options = opts.merge(PDK::CLI::Util.spinner_opts_for_platform)
 
-        unless PDK.logger.debug?
+        if PDK::CLI::Util.interactive?
           @multi_spinner = TTY::Spinner::Multi.new("[:spinner] #{message}", @options)
           @multi_spinner.auto_spin
         end
@@ -31,7 +31,7 @@ module PDK
       end
 
       def add_spinner(message, opts = {})
-        return if PDK.logger.debug?
+        return unless PDK::CLI::Util.interactive?
         @multi_spinner.register("[:spinner] #{message}", @options.merge(opts).merge(PDK::CLI::Util.spinner_opts_for_platform))
       end
 

data/lib/pdk/cli/module.rb

@@ -2,10 +2,9 @@ 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.')
+    summary _('Provide CLI-backwards compatibility to the puppet module tool.')
+    description _('This command is only for reminding you how to accomplish tasks with the PDK, when you were previously doing them with the puppet module command.')
     default_subcommand 'help'
-    be_hidden
   end
 
   @module_cmd.add_command Cri::Command.new_basic_help

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

@@ -5,13 +5,12 @@ module PDK::CLI
     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'
+      require 'pdk/generate/module'
 
       module_name = args[0]
 
@@ -27,8 +26,14 @@ module PDK::CLI
       answer = redirect.run
 
       if answer
-        opts[:name] = module_name
-        opts[:target_dir] = module_name
+        module_name_parts = module_name.split('-', 2)
+        if module_name_parts.size > 1
+          opts[:username] = module_name_parts[0]
+          opts[:module_name] = module_name_parts[1]
+        else
+          opts[:module_name] = module_name
+        end
+        opts[:target_dir] = opts[:module_name]
 
         PDK.logger.info(_('Creating new module: %{modname}') % { modname: module_name })
         PDK::Generate::Module.invoke(opts)

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

@@ -7,7 +7,7 @@ module PDK::CLI
     PDK::CLI.template_url_option(self)
 
     run do |opts, args, _cmd|
-      require 'pdk/generators/puppet_class'
+      require 'pdk/generate/puppet_class'
 
       PDK::CLI::Util.ensure_in_module!
 

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

@@ -1,8 +1,8 @@
 module PDK::CLI
   @new_module_cmd = @new_cmd.define_command do
     name 'module'
-    usage _('module [options] <module_name> [target_dir]')
-    summary _('Create a new module named <module_name> using given options')
+    usage _('module [options] [module_name] [target_dir]')
+    summary _('Create a new module named [module_name] using given options')
 
     PDK::CLI.template_url_option(self)
     PDK::CLI.skip_interview_option(self)
@@ -11,19 +11,22 @@ module PDK::CLI
       "This should be a identifier from https://spdx.org/licenses/. Common values are 'Apache-2.0', 'MIT', or 'proprietary'."), argument: :required
 
     run do |opts, args, _cmd|
-      require 'pdk/generators/module'
+      require 'pdk/generate/module'
 
       module_name = args[0]
       target_dir = args[1]
 
-      if module_name.nil? || module_name.empty?
-        puts command.help
-        exit 1
+      unless module_name.nil? || module_name.empty?
+        module_name_parts = module_name.split('-', 2)
+        if module_name_parts.size > 1
+          opts[:username] = module_name_parts[0]
+          opts[:module_name] = module_name_parts[1]
+        else
+          opts[:module_name] = module_name
+        end
+        opts[:target_dir] = target_dir.nil? ? opts[:module_name] : target_dir
       end
 
-      opts[:name] = module_name
-      opts[:target_dir] = target_dir.nil? ? module_name : target_dir
-
       PDK.logger.info(_('Creating new module: %{modname}') % { modname: module_name })
       PDK::Generate::Module.invoke(opts)
     end

data/lib/pdk/cli/test/unit.rb

@@ -7,10 +7,11 @@ module PDK::CLI
     usage _('unit [options]')
     summary _('Run unit tests.')
 
-    flag nil, :list, _('list all available unit tests and their descriptions')
-    flag nil, :parallel, _('run unit tests in parallel'), hidden: true
+    flag nil, :list, _('List all available unit test files.')
+    flag nil, :parallel, _('Run unit tests in parallel.'), hidden: true
+    flag :v, :verbose, _('More verbose output. Displays examples in each unit test file.')
 
-    option nil, :tests, _('a comma-separated list of tests to run'), argument: :required, default: '' do |values|
+    option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
       PDK::CLI::Util::OptionValidator.comma_separated_list?(values)
     end
 
@@ -27,11 +28,19 @@ module PDK::CLI
       if opts[:list]
         examples = PDK::Test::Unit.list
         if examples.empty?
-          puts _('No examples found.')
+          puts _('No unit test files with examples were found.')
         else
-          puts _('Examples:')
-          examples.each do |example|
-            puts _("%{id}\t%{description}" % { id: example[:id], description: example[:full_description] })
+          puts _('Unit Test Files:')
+          files = examples.map { |example| example[:file_path] }
+          files.uniq.each do |file|
+            puts _(file)
+
+            next unless opts[:verbose]
+
+            file_examples = examples.select { |example| example[:file_path] == file }
+            file_examples.each do |file_example|
+              puts _("\t%{id}\t%{description}" % { id: file_example[:id], description: file_example[:full_description] })
+            end
           end
         end
       else

data/lib/pdk/cli/util.rb

@@ -1,13 +1,30 @@
 module PDK
   module CLI
     module Util
+      MODULE_FOLDERS = %w[
+        manifests
+        lib
+        tasks
+        facts.d
+        functions
+        types
+      ].freeze
+
       # Ensures the calling code is being run from inside a module directory.
       #
-      # @raise [PDK::CLI::ExitWithError] if the current directory or parents do
-      #   not contain a `metadata.json` file.
-      def ensure_in_module!
+      # @param opts [Hash] options to change the behavior of the check logic.
+      # @option opts [Boolean] :check_module_layout Set to true to check for
+      #   stardard module folder layout if the module does not contain
+      #   a metadata.json file.
+      #
+      # @raise [PDK::CLI::ExitWithError] if the current directory does not
+      #   contain a Puppet module.
+      def ensure_in_module!(opts = {})
+        return unless PDK::Util.module_root.nil?
+        return if opts[:check_module_layout] && PDK::CLI::Util::MODULE_FOLDERS.any? { |dir| File.directory?(dir) }
+
         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?
+        raise PDK::CLI::ExitWithError, message
       end
       module_function :ensure_in_module!
 
@@ -21,6 +38,32 @@ module PDK
         {}
       end
       module_function :spinner_opts_for_platform
+
+      def prompt_for_yes(question_text, opts = {})
+        prompt = opts[:prompt] || TTY::Prompt.new(help_color: :cyan)
+        validator = proc { |value| [true, false].include?(value) || value =~ %r{\A(?:yes|y|no|n)\Z}i }
+        response = nil
+
+        begin
+          response = prompt.yes?(question_text) do |q|
+            q.validate(validator, _('Answer "Y" to continue or "n" to cancel.'))
+          end
+        rescue TTY::Prompt::Reader::InputInterrupt
+          PDK.logger.info opts[:cancel_message] if opts[:cancel_message]
+        end
+
+        response
+      end
+      module_function :prompt_for_yes
+
+      def interactive?
+        return false if PDK.logger.debug?
+        return !ENV['PDK_FRONTEND'].casecmp('noninteractive').zero? if ENV['PDK_FRONTEND']
+        return false unless $stderr.isatty
+
+        true
+      end
+      module_function :interactive?
     end
   end
 end

data/lib/pdk/generate.rb

@@ -1,7 +1,7 @@
-require 'pdk/generators/module'
-require 'pdk/generators/defined_type'
-require 'pdk/generators/puppet_class'
-require 'pdk/generators/task'
+require 'pdk/generate/module'
+require 'pdk/generate/defined_type'
+require 'pdk/generate/puppet_class'
+require 'pdk/generate/task'
 require 'pdk/module/metadata'
 require 'pdk/module/templatedir'
 

data/lib/pdk/{generators → generate}/defined_type.rb

@@ -1,4 +1,4 @@
-require 'pdk/generators/puppet_object'
+require 'pdk/generate/puppet_object'
 
 module PDK
   module Generate

data/lib/pdk/{generators → generate}/module.rb

@@ -8,6 +8,7 @@ require 'pdk/logger'
 require 'pdk/module/metadata'
 require 'pdk/module/templatedir'
 require 'pdk/cli/exec'
+require 'pdk/cli/util'
 require 'pdk/cli/util/interview'
 require 'pdk/cli/util/option_validator'
 require 'pdk/util'
@@ -16,40 +17,25 @@ require 'pdk/util/version'
 module PDK
   module Generate
     class Module
-      def self.default_template_url
-        if !PDK.answers['template-url'].nil?
-          PDK.answers['template-url']
-        else
-          puppetlabs_template_url
-        end
-      end
-
-      def self.puppetlabs_template_url
-        if 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.validate_options(opts)
-        unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[:name])
+        unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[: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: opts[:name] }
+          ) % { module_name: opts[:module_name] }
           raise PDK::CLI::ExitWithError, error_msg
         end
 
         target_dir = File.expand_path(opts[:target_dir])
-
         raise PDK::CLI::ExitWithError, _("The destination directory '%{dir}' already exists") % { dir: target_dir } if File.exist?(target_dir)
       end
 
       def self.invoke(opts = {})
-        validate_options(opts)
+        validate_options(opts) unless opts[:module_name].nil?
 
-        target_dir = File.expand_path(opts[:target_dir])
+        metadata = prepare_metadata(opts)
+
+        target_dir = File.expand_path(opts[:target_dir] || opts[:module_name])
         parent_dir = File.dirname(target_dir)
 
         begin
@@ -62,15 +48,13 @@ module PDK
           }
         end
 
-        metadata = prepare_metadata(opts)
-
         temp_target_dir = PDK::Util.make_tmpdir_name('pdk-module-target')
 
         prepare_module_directory(temp_target_dir)
 
-        template_url = opts.fetch(:'template-url', default_template_url)
+        template_url = opts.fetch(:'template-url', PDK::Util.default_template_url)
 
-        PDK::Module::TemplateDir.new(template_url, metadata.data) do |templates|
+        PDK::Module::TemplateDir.new(template_url, metadata.data, true) do |templates|
           templates.render do |file_path, file_content|
             file = Pathname.new(temp_target_dir) + file_path
             file.dirname.mkpath
@@ -81,12 +65,10 @@ module PDK
           # metadata (for a future update command).
           metadata.update!(templates.metadata)
 
-          File.open(File.join(temp_target_dir, 'metadata.json'), 'w') do |metadata_file|
-            metadata_file.puts metadata.to_json
-          end
+          metadata.write!(File.join(temp_target_dir, 'metadata.json'))
         end
 
-        if template_url == puppetlabs_template_url
+        if template_url == PDK::Util.puppetlabs_template_url
           # If the user specifies our template via the command line, remove the
           # saved template-url answer.
           PDK.answers.update!('template-url' => nil) if opts.key?(:'template-url')
@@ -98,7 +80,7 @@ module PDK
 
         begin
           if FileUtils.mv(temp_target_dir, target_dir)
-            PDK.logger.info(_('Module \'%{name}\' generated at path \'%{path}\'.') % { name: opts[:name], path: target_dir })
+            PDK.logger.info(_('Module \'%{name}\' generated at path \'%{path}\', from template \'%{template_url}\'.') % { name: opts[:module_name], path: target_dir, template_url: template_url })
             PDK.logger.info(_('In your module directory, add classes with the \'pdk new class\' command.'))
           end
         rescue Errno::EACCES => e
@@ -112,7 +94,7 @@ module PDK
 
       def self.username_from_login
         login = Etc.getlogin || ''
-        login_clean = login.gsub(%r{[^0-9a-z]}i, '')
+        login_clean = login.downcase.gsub(%r{[^0-9a-z]}i, '')
         login_clean = 'username' if login_clean.empty?
 
         if login_clean != login
@@ -124,23 +106,23 @@ module PDK
         login_clean
       end
 
-      def self.prepare_metadata(opts)
-        username = PDK.answers['forge-username'] || username_from_login
+      def self.prepare_metadata(opts = {})
+        opts[:username] = (opts[:username] || PDK.answers['forge_username'] || username_from_login).downcase
 
         defaults = {
-          'name'         => "#{username}-#{opts[:name]}",
           'version'      => '0.1.0',
           'dependencies' => [],
           'requirements' => [
             { 'name' => 'puppet', 'version_requirement' => '>= 4.7.0 < 6.0.0' },
           ],
         }
+
+        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
 
         metadata = PDK::Module::Metadata.new(defaults)
-
         module_interview(metadata, opts) unless opts[:'skip-interview']
 
         metadata.update!('pdk-version' => PDK::Util::Version.version_string)
@@ -170,13 +152,21 @@ module PDK
       def self.module_interview(metadata, opts = {})
         questions = [
           {
-            name:             'name',
+            name:             'module_name',
+            question:         _('If you have a name for your module, add it here.'),
+            help:             _('This is the name that will be associated with your module, it should be relevant to the modules content.'),
+            required:         true,
+            validate_pattern: %r{\A[a-z0-9]+\Z}i,
+            validate_message: _('Module names can only contain lowercase letters and numbers'),
+          },
+          {
+            name:             'forge_username',
             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'),
-            default:          PDK.answers['forge-username'] || metadata.data['author'],
+            default:          opts[:username],
           },
           {
             name:             'version',
@@ -290,6 +280,7 @@ module PDK
 
         interview = PDK::CLI::Util::Interview.new(prompt)
 
+        questions.reject! { |q| q[:name] == 'module_name' } if opts.key?(:module_name)
         questions.reject! { |q| q[:name] == 'license' } if opts.key?(:license)
 
         interview.add_questions(questions)
@@ -305,39 +296,37 @@ module PDK
         answers = interview.run
 
         if answers.nil?
-          PDK.logger.info _('Interview cancelled; not generating the module.')
+          PDK.logger.info _('No answers given, interview cancelled.')
           exit 0
         end
 
-        forge_username = answers['name']
-        answers['name'] = "#{answers['name']}-#{opts[:name]}"
+        opts[:username] = answers['forge_username']
+        opts[:module_name] = answers['module_name'] unless answers['module_name'].nil?
+
+        answers['name'] = "#{opts[:username]}-" + (opts[:module_name])
         answers['license'] = opts[:license] if opts.key?(:license)
         answers['operatingsystem_support'].flatten!
+
+        answers.delete('forge_username')
+        answers.delete('module_name')
+
         metadata.update!(answers)
 
-        puts '-' * 40
-        puts _('SUMMARY')
-        puts '-' * 40
-        puts metadata.to_json
-        puts '-' * 40
-        puts
+        if opts[:prompt].nil? || opts[:prompt]
+          continue = PDK::CLI::Util.prompt_for_yes(
+            _('Metadata will be generated based on this information, continue?'),
+            prompt:         prompt,
+            cancel_message: _('Interview cancelled; exiting.'),
+          )
 
-        begin
-          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 }, _('Answer "Y" to continue or "n" to cancel.'))
+          unless continue
+            PDK.logger.info _('Process cancelled; exiting.')
+            exit 0
           end
-        rescue TTY::Prompt::Reader::InputInterrupt
-          PDK.logger.info _('Interview cancelled; not generating the module.')
-          exit 0
-        end
-
-        unless continue
-          PDK.logger.info _('Module not generated.')
-          exit 0
         end
 
         PDK.answers.update!(
-          'forge-username' => forge_username,
+          'forge_username' => opts[:username],
           'author'         => answers['author'],
           'license'        => answers['license'],
         )