pdk 1.0.1 → 1.1.0

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

@@ -29,7 +29,7 @@ module PDK
             begin
               OptionValidator.enum(format, PDK::Report.formats)
             rescue ArgumentError
-              raise PDK::CLI::FatalError, _("'%{name}' is not a valid report format (%{valid})") % {
+              raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid report format (%{valid})") % {
                 name:  format,
                 valid: PDK::Report.formats.join(', '),
               }
@@ -53,13 +53,13 @@ module PDK
           param_type = 'String' if param_type.nil?
 
           unless PDK::CLI::Util::OptionValidator.valid_param_name?(param_name)
-            raise PDK::CLI::FatalError, _("'%{name}' is not a valid parameter name") % {
+            raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid parameter name") % {
               name: param_name,
             }
           end
 
           unless PDK::CLI::Util::OptionValidator.valid_data_type?(param_type)
-            raise PDK::CLI::FatalError, _("'%{type}' is not a valid data type") % {
+            raise PDK::CLI::ExitWithError, _("'%{type}' is not a valid data type") % {
               type: param_type,
             }
           end

data/lib/pdk/cli/validate.rb

@@ -6,16 +6,16 @@ module PDK::CLI
     usage _('validate [validators] [options] [targets]')
     summary _('Run static analysis tests.')
     description _(
-      "Run metadata, puppet, or ruby validation.\n\n" \
-      '[validators] is an optional comma separated list of validators to use. ' \
-      "If not specified, all validators will be used.\n\n" \
-      '[targets] is an optional space separated list of files or directories to be validated. ' \
-      'If not specified, the validators will be run against all applicable files in the module.',
+      "Run metadata, Puppet, or Ruby validation.\n\n" \
+      '[validators] is an optional comma-separated list of validators to use. ' \
+      "If not specified, all validators are used.\n\n" \
+      '[targets] is an optional space-separated list of files or directories to be validated. ' \
+      'If not specified, validators are run against all applicable files in the module.',
     )
 
-    flag nil, :list, _('list all available validators')
-    flag :a, 'auto-correct', _('automatically correct problems (where possible)')
-    flag nil, :parallel, _('run validations in parallel')
+    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']
@@ -44,7 +44,7 @@ module PDK::CLI
 
           invalid = vals.reject { |v| validator_names.include?(v) }
           invalid.each do |v|
-            PDK.logger.warn(_("Unknown validator '%{v}'. Available validators: %{validators}") % { v: v, validators: validator_names.join(', ') })
+            PDK.logger.warn(_("Unknown validator '%{v}'. Available validators: %{validators}.") % { v: v, validators: validator_names.join(', ') })
           end
         else
           # This is a single item. Check if it's a known validator, or otherwise treat it as a target.

data/lib/pdk/generate.rb

@@ -1,4 +1,5 @@
 require 'pdk/generators/module'
+require 'pdk/generators/defined_type'
 require 'pdk/generators/puppet_class'
 require 'pdk/module/metadata'
 require 'pdk/module/templatedir'

data/lib/pdk/generators/defined_type.rb

@@ -0,0 +1,49 @@
+require 'pdk/generators/puppet_object'
+
+module PDK
+  module Generate
+    class DefinedType < PuppetObject
+      OBJECT_TYPE = :defined_type
+
+      # Prepares the data needed to render the new defined type template.
+      #
+      # @return [Hash{Symbol => Object}] a hash of information that will be
+      # provided to the defined type and defined type spec templates during
+      # rendering.
+      def template_data
+        data = { name: object_name }
+
+        data
+      end
+
+      # Calculates the path to the .pp file that the new defined type will be
+      # written to.
+      #
+      # @return [String] the path where the new defined type will be written.
+      def target_object_path
+        @target_pp_path ||= begin
+          define_name_parts = object_name.split('::')[1..-1]
+          define_name_parts << 'init' if define_name_parts.empty?
+
+          "#{File.join(module_dir, 'manifests', *define_name_parts)}.pp"
+        end
+      end
+
+      # Calculates the path to the file where the tests for the new defined
+      # type will be written.
+      #
+      # @return [String] the path where the tests for the new defined type
+      # will be written.
+      def target_spec_path
+        @target_spec_path ||= begin
+          define_name_parts = object_name.split('::')
+
+          # drop the module name if the object name contains multiple parts
+          define_name_parts.delete_at(0) if define_name_parts.length > 1
+
+          "#{File.join(module_dir, 'spec', 'defines', *define_name_parts)}_spec.rb"
+        end
+      end
+    end
+  end
+end

data/lib/pdk/generators/module.rb

@@ -9,6 +9,7 @@ require 'pdk/module/metadata'
 require 'pdk/module/templatedir'
 require 'pdk/cli/exec'
 require 'pdk/cli/util/interview'
+require 'pdk/cli/util/option_validator'
 require 'pdk/util'
 require 'pdk/util/version'
 
@@ -18,20 +19,37 @@ module PDK
       def self.default_template_url
         if !PDK.answers['template-url'].nil?
           PDK.answers['template-url']
-        elsif PDK::Util.package_install?
+        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.invoke(opts = {})
+      def self.validate_options(opts)
+        unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[: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] }
+          raise PDK::CLI::ExitWithError, error_msg
+        end
+
         target_dir = File.expand_path(opts[:target_dir])
 
-        if File.exist?(target_dir)
-          raise PDK::CLI::FatalError, _("The destination directory '%{dir}' already exists") % { dir: target_dir }
-        end
+        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)
 
+        target_dir = File.expand_path(opts[:target_dir])
         parent_dir = File.dirname(target_dir)
 
         begin
@@ -68,10 +86,21 @@ module PDK
           end
         end
 
-        PDK.answers.update!('template-url' => template_url)
+        if template_url == 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')
+        else
+          # Save the template-url answer if the module was generated using
+          # a template other than ours.
+          PDK.answers.update!('template-url' => template_url)
+        end
 
         begin
-          FileUtils.mv(temp_target_dir, target_dir)
+          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(_('In your module directory, add classes with the \'pdk new class\' command.'))
+          end
         rescue Errno::EACCES => e
           raise PDK::CLI::FatalError, _("Failed to move '%{source}' to '%{target}': %{message}") % {
             source:  temp_target_dir,
@@ -87,7 +116,7 @@ module PDK
         login_clean = 'username' if login_clean.empty?
 
         if login_clean != login
-          PDK.logger.warn _('Your username is not a valid Forge username, proceeding with the username %{username}. You can fix this afterwards in metadata.json.') % {
+          PDK.logger.warn _('Your username is not a valid Forge username. Proceeding with the username %{username}. You can fix this later in metadata.json.') % {
             username: login_clean,
           }
         end
@@ -101,9 +130,7 @@ module PDK
         defaults = {
           'name'         => "#{username}-#{opts[:name]}",
           'version'      => '0.1.0',
-          'dependencies' => [
-            { 'name' => 'puppetlabs-stdlib', 'version_requirement' => '>= 4.13.1 < 5.0.0' },
-          ],
+          'dependencies' => [],
           'requirements' => [
             { 'name' => 'puppet', 'version_requirement' => '>= 4.7.0 < 6.0.0' },
           ],
@@ -160,7 +187,7 @@ module PDK
           {
             name:     'author',
             question: _('Who wrote this module?'),
-            help:     _('This will be used to credit the module\'s author.'),
+            help:     _('This is used to credit the module\'s author.'),
             required: true,
             default:  metadata.data['author'],
           },
@@ -171,30 +198,87 @@ module PDK
             required: true,
             default:  metadata.data['license'],
           },
+          {
+            name:     'operatingsystem_support',
+            question: _('What operating systems does this module support?'),
+            help:     _('Use the up and down keys to move between the choices, space to select and enter to continue.'),
+            required: true,
+            choices:  {
+              'RedHat based Linux' => [
+                {
+                  'operatingsystem'        => 'CentOS',
+                  'operatingsystemrelease' => ['7'],
+                },
+                {
+                  'operatingsystem'        => 'OracleLinux',
+                  'operatingsystemrelease' => ['7'],
+                },
+                {
+                  'operatingsystem'        => 'RedHat',
+                  'operatingsystemrelease' => ['7'],
+                },
+                {
+                  'operatingsystem'        => 'Scientific',
+                  'operatingsystemrelease' => ['7'],
+                },
+              ],
+              'Debian based Linux' => [
+                {
+                  'operatingsystem'        => 'Debian',
+                  'operatingsystemrelease' => ['8'],
+                },
+                {
+                  'operatingsystem'        => 'Ubuntu',
+                  'operatingsystemrelease' => ['16.04'],
+                },
+              ],
+              'Fedora' => {
+                'operatingsystem'        => 'Fedora',
+                'operatingsystemrelease' => ['25'],
+              },
+              'OSX' => {
+                'operatingsystem'        => 'Darwin',
+                'operatingsystemrelease' => ['16'],
+              },
+              'SLES' => {
+                'operatingsystem'        => 'SLES',
+                'operatingsystemrelease' => ['12'],
+              },
+              'Solaris' => {
+                'operatingsystem'        => 'Solaris',
+                'operatingsystemrelease' => ['11'],
+              },
+              'Windows' => {
+                'operatingsystem'        => 'windows',
+                'operatingsystemrelease' => ['2008 R2', '2012 R2', '10'],
+              },
+            },
+            default: [1, 2, 7],
+          },
           {
             name:     'summary',
-            question: _('Please summarize the purpose of this module in a single sentence.'),
-            help:     _('This will help other Puppet users understand what the module does.'),
+            question: _('Summarize the purpose of this module in a single sentence.'),
+            help:     _('This helps other Puppet users understand what the module does.'),
             required: true,
             default:  metadata.data['summary'],
           },
           {
             name:     'source',
             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.'),
+            help:     _('Skip this if no repository exists yet. You can update this later in the metadata.json.'),
             required: true,
             default:  metadata.data['source'],
           },
           {
             name:     'project_page',
             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.'),
+            help:     _('Optional. You can update this later in the metadata.json.'),
             default:  metadata.data['project_page'],
           },
           {
             name:     'issues_url',
             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.'),
+            help:     _('Optional. You can update this later in the metadata.json.'),
             default:  metadata.data['issues_url'],
           },
         ]
@@ -208,23 +292,24 @@ 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 " \
+          "\nWe need to create a metadata.json file for this module, so we\'re going to ask you %{count} " \
           "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 ' \
+          'If the question is not applicable to this module, accept the default option ' \
+          'shown after each question. You can modify any answers at any time by manually updating ' \
           "the metadata.json file.\n\n",
         ) % { count: interview.num_questions }
 
         answers = interview.run
 
         if answers.nil?
-          PDK.logger.info _('Interview cancelled, not generating the module.')
+          PDK.logger.info _('Interview cancelled; not generating the module.')
           exit 0
         end
 
         forge_username = answers['name']
         answers['name'] = "#{answers['name']}-#{opts[:name]}"
         answers['license'] = opts[:license] if opts.key?(:license)
+        answers['operatingsystem_support'].flatten!
         metadata.update!(answers)
 
         puts '-' * 40
@@ -234,8 +319,13 @@ module PDK
         puts '-' * 40
         puts
 
-        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"')
+        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.'))
+          end
+        rescue TTY::Prompt::Reader::InputInterrupt
+          PDK.logger.info _('Interview cancelled; not generating the module.')
+          exit 0
         end
 
         unless continue

data/lib/pdk/generators/puppet_class.rb

@@ -28,8 +28,8 @@ module PDK
         end
       end
 
-      # Calculates the path to the file that the tests for the new class will
-      # be written to.
+      # Calculates the path to the file where the tests for the new class will
+      # be written.
       #
       # @return [String] the path where the tests for the new class will be
       # written.

data/lib/pdk/generators/puppet_object.rb

@@ -78,14 +78,14 @@ module PDK
       # and create the target files from the template. This is the main entry
       # point for the class.
       #
-      # @raise [PDK::CLI::FatalError] if the target files already exist.
+      # @raise [PDK::CLI::ExitWithError] if the target files already exist.
       # @raise [PDK::CLI::FatalError] (see #render_file)
       #
       # @api public
       def run
         [target_object_path, target_spec_path].each do |target_file|
           if File.exist?(target_file)
-            raise PDK::CLI::FatalError, _("Unable to generate class, '%{file}' already exists.") % { file: target_file }
+            raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % { file: target_file, object_type: object_type }
           end
         end
 
@@ -165,7 +165,7 @@ module PDK
               # TODO: refactor to a search-and-execute form instead
               return # work is done # rubocop:disable Lint/NonLocalExitFromIterator
             elsif template[:allow_fallback]
-              PDK.logger.debug(_('Unable to find a %{type} template in %{url}, trying next template directory') % { type: object_type, url: template[:url] })
+              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: object_type, url: template[:url] })
             else
               raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:url] }
             end

data/lib/pdk/module/metadata.rb

@@ -44,11 +44,11 @@ module PDK
 
       def self.from_file(metadata_json_path)
         unless File.file?(metadata_json_path)
-          raise ArgumentError, _("'%{file}' does not exist or is not a file") % { file: metadata_json_path }
+          raise ArgumentError, _("'%{file}' does not exist or is not a file.") % { file: metadata_json_path }
         end
 
         unless File.readable?(metadata_json_path)
-          raise ArgumentError, _("Unable to open '%{file}' for reading") % { file: metadata_json_path }
+          raise ArgumentError, _("Unable to open '%{file}' for reading.") % { file: metadata_json_path }
         end
 
         begin
@@ -90,16 +90,16 @@ module PDK
 
         err = case modname
               when nil, '', :namespace_missing
-                'the field must be a dash-separated username and module name'
+                _('Field must be a dash-separated user name and module name.')
               when %r{[^a-z0-9_]}i
-                'the module name contains non-alphanumeric (or underscore) characters'
+                _('Module name must contain only alphanumeric or underscore characters.')
               when %r{^[^a-z]}i
-                'the module name must begin with a letter'
+                _('Module name must begin with a letter.')
               else
-                'the namespace contains non-alphanumeric characters'
+                _('Namespace must contain only alphanumeric characters.')
               end
 
-        raise ArgumentError, "Invalid 'name' field in metadata.json: #{err}"
+        raise ArgumentError, _("Invalid 'name' field in metadata.json: %{err}") % { err: err }
       end
     end
   end

data/lib/pdk/module/templatedir.rb

@@ -52,7 +52,7 @@ module PDK
           unless clone_result[:exit_code].zero?
             PDK.logger.error clone_result[:stdout]
             PDK.logger.error clone_result[:stderr]
-            raise PDK::CLI::FatalError, _("Unable to clone git repository '%{repo}' to '%{dest}'") % { repo: path_or_url, dest: temp_dir }
+            raise PDK::CLI::FatalError, _("Unable to clone git repository '%{repo}' to '%{dest}'.") % { repo: path_or_url, dest: temp_dir }
           end
 
           @path = PDK::Util.canonical_path(temp_dir)
@@ -178,11 +178,11 @@ module PDK
       # @api private
       def validate_module_template!
         unless File.directory?(@path)
-          raise ArgumentError, _("The specified template '%{path}' is not a directory") % { path: @path }
+          raise ArgumentError, _("The specified template '%{path}' is not a directory.") % { path: @path }
         end
 
         unless File.directory?(@moduleroot_dir) # rubocop:disable Style/GuardClause
-          raise ArgumentError, _("The template at '%{path}' does not contain a 'moduleroot/' directory") % { path: @path }
+          raise ArgumentError, _("The template at '%{path}' does not contain a 'moduleroot/' directory.") % { path: @path }
         end
       end