pdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5501e7effa501cd2ba488735cc9abb8257ffef6a
-  data.tar.gz: e4f7a88496280db89b0ee46a42a7b8feacc24594
+  metadata.gz: eaa8d8a0b82102681c9b61fe39ba2222cd252a3a
+  data.tar.gz: 586bc04ec9a42581020f88a03d5ed58f01b52d62
 SHA512:
-  metadata.gz: 736c543069aa1b1d3eb79c8de901e91cf2491328fc3104f7bd660c37cafd88712583d471cbd2f4afd37b9c49890bfcb60c5b2857121f3cabb81841662fa53557
-  data.tar.gz: 5b5b03c6ac83fca4d730cba0db0277441d9bb062ed5f13ebecf24836d237db11856e6811f276ec2dcfafe28fd5c86a009958ef9e894021d14ba8a1e4d0a15af8
+  metadata.gz: 33b02d12161649fd01c1b5e9c259646cfff45e0b0ffd4625ac28caea26aa995ce0346866eb81042c29f900d8dd99a5cb1f71d5347416da332a0376cf9f6ed166
+  data.tar.gz: 9f17d85f76f08d2feb31a9b6e5c2f8c7c39240be48f6a9c51f06cf3f441dddaf239b6da10d45ae075ce38b15d356c3a9572b9305691f3d069e4af5d83fb2576a

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 
 
+## [v0.4.0](https://github.com/puppetlabs/pdk/tree/v0.4.0) (2017-07-14)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v0.3.0...v0.4.0)
+
+**Implemented enhancements:**
+
+- \(SDK-299\) Check metadata.json syntax before linting [\#133](https://github.com/puppetlabs/pdk/pull/133) ([rodjek](https://github.com/rodjek))
+- \(SDK-305\) Answer file to cache module interview answers, template-url etc [\#132](https://github.com/puppetlabs/pdk/pull/132) ([rodjek](https://github.com/rodjek))
+- \(SDK-296\) Allow target selection for the metadata validator [\#124](https://github.com/puppetlabs/pdk/pull/124) ([rodjek](https://github.com/rodjek))
+
+**Fixed bugs:**
+
+- \(SDK-298\) Handle exception raised when an invalid report format is specified on the CLI [\#125](https://github.com/puppetlabs/pdk/pull/125) ([rodjek](https://github.com/rodjek))
+
 ## [v0.3.0](https://github.com/puppetlabs/pdk/tree/v0.3.0) (2017-06-29)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v0.2.0...v0.3.0)
 

data/README.md

@@ -25,21 +25,7 @@ To get started, generate a new module from the default template.
 pdk new module my_module
 ```
 
-This generates the basic components of a new module and initializes Git for you. The `pdk new module` command sets some default values based on your environment. Check the `metadata.json` to make sure that these values are correct. The new module now contains all the infrastructure to use the other capabilities of `pdk`.
-
-### Add a new resource provider
-
-If you need to manage a specific resource that is not covered by either Puppet's basic resource types or an existing module, create a new resource provider.
-
-1. From within an existing module, run `pdk add provider`, specifying the new provider name as well as any attributes along with their data types.
-
-For example:
-
-```
-pdk add provider new_provider String:content 'Enum[absent, present]:ensure'
-```
-
-This creates all the files required to define a resource type, its provider, and the associated basic tests. In this example, the resource type has an `ensure` property with the expected values, and a `String` property named `content`. If your types use Bash special characters, such as 'Enum[absent, present]:ensure' above, you must quote to avoid issues with the shell.
+This generates the basic components of a new module. The `pdk new module` command sets some default metadata values based on your environment. Check the `metadata.json` to make sure that these values are correct. The new module now contains all the infrastructure to use the other capabilities of `pdk`.
 
 ### Running validations
 
@@ -299,6 +285,31 @@ bundle binstubs pdk --path ~/bin
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/pdk.
 
+### Running tests
+
+pdk has three testing rake tasks
+
+#### spec
+
+Run unit tests.
+
+#### acceptance:local
+
+Run acceptance tests on the current pdk code. These tests are executed on commits and pull requests to this repo using both travis and appveyor.
+
+#### acceptance:package
+
+Run acceptance tests against a package install. This task is for Puppet's packaging CI, and contributors outside of Puppet, Inc. don't need to worry about executing it. It uses [beaker](https://github.com/puppetlabs/beaker) to provision a VM, fetch and install a pdk installation package, and then run the acceptance tests on that VM.
+It requires some environment variables to be set in order to specify what beaker will set up:
+
+Environment Variable | Usage
+---------------------|------
+**SHA** | The SHA or tag of a package build i.e. the folder name on the build server that packages will be found in.
+**TEST_TARGET** | A beaker-hostgenerator string for the OS of the VM you want to test on e.g. _redhat7-64workstation._ or _windows2012r2-64workstation._ (The period character after workstation is required by beaker-hostgenerator).
+**BUILD_SERVER** | (Only required if the tests will run on a Windows VM). The hostname of the build server that hosts packages. A Puppet JIRA ticket ([BKR-1109](https://tickets.puppetlabs.com/browse/BKR-1109)) has been filed to update beaker so this would never be required.
+
+On completion of this testing task, the results from the VM will be available in a folder named _archive_.
+
 ### Release Process
 
 1. Bump the version in `lib/pdk/version.rb`.
@@ -307,4 +318,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/puppet
 1. Commit and PR the changes.
 1. When the PR is merged, get a clean checkout of the merged commit, and run `bundle exec rake release[upstream]` (where "upstream" is your local name of the puppetlabs remote)
 1. Profit!
-1. Update `lib/pdk/version.rb` with `x.y.z-pre`, commit, and PR to prepare for next release.
+1. Update `lib/pdk/version.rb` with `x.y.z.pre` version bump, commit, and PR to prepare for next release.

data/lib/pdk.rb

@@ -1,3 +1,4 @@
+require 'pdk/answer_file'
 require 'pdk/generate'
 require 'pdk/i18n'
 require 'pdk/logger'

data/lib/pdk/answer_file.rb

@@ -0,0 +1,120 @@
+require 'json'
+
+module PDK
+  # Singleton accessor to the current answer file being used by the PDK.
+  #
+  # @return [PDK::AnswerFile] The AnswerFile instance currently being used by
+  #   the PDK.
+  def self.answers
+    @answer_file ||= PDK::AnswerFile.new
+  end
+
+  # Specify the path to a custom answer file that the PDK should use.
+  #
+  # @param path [String] A path on disk to the file where the PDK should store
+  #   answers to interactive questions.
+  def self.answer_file=(value)
+    @answer_file = PDK::AnswerFile.new(value)
+  end
+
+  class AnswerFile
+    attr_reader :answers
+    attr_reader :answer_file_path
+
+    # Initialises the AnswerFile object, which stores the responses to certain
+    # interactive questions.
+    #
+    # @param answer_file_path [String, nil] The path on disk to the file where
+    #   the answers will be stored and read from. If not specified (or `nil`),
+    #   the default path will be used (see #default_answer_file_path).
+    #
+    # @raise (see #read_from_disk)
+    def initialize(answer_file_path = nil)
+      @answer_file_path = answer_file_path || default_answer_file_path
+      @answers = read_from_disk
+    end
+
+    # Retrieve the stored answer to a question.
+    #
+    # @param question [String] The question name/identifying string.
+    #
+    # @return [Object] The answer to the question, or `nil` if no answer found.
+    def [](question)
+      answers[question]
+    end
+
+    # Update the stored answers in memory and then save them to disk.
+    #
+    # @param new_answers [Hash{String => Object}] The new questions and answers
+    #   to be merged into the existing answers.
+    #
+    # @raise [PDK::CLI::FatalError] if the new answers are not provided as
+    #   a Hash.
+    # @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')
+      end
+
+      answers.merge!(new_answers)
+
+      save_to_disk
+    end
+
+    private
+
+    # Determine the default path to the answer file.
+    #
+    # @return [String] The path on disk to the default answer file.
+    def default_answer_file_path
+      File.join(PDK::Util.cachedir, 'answers.json')
+    end
+
+    # Read existing answers into memory from the answer file on disk.
+    #
+    # @raise [PDK::CLI::FatalError] If the answer file exists but can not be
+    #   read.
+    #
+    # @return [Hash{String => Object}] The existing questions and answers.
+    def read_from_disk
+      return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
+
+      unless File.readable?(answer_file_path)
+        raise PDK::CLI::FatalError, _("Unable to open '%{file}' for reading") % {
+          file: answer_file_path,
+        }
+      end
+
+      answers = JSON.parse(File.read(answer_file_path))
+      if answers.is_a?(Hash)
+        answers
+      else
+        PDK.logger.warn _("Answer file '%{path}' did not contain a valid set of answers, recreating it") % {
+          path: answer_file_path,
+        }
+        {}
+      end
+    rescue JSON::JSONError
+      PDK.logger.warn _("Answer file '%{path}' did not contain valid JSON, recreating it") % {
+        path: answer_file_path,
+      }
+      {}
+    end
+
+    # Save the in memory answer set to the answer file on disk.
+    #
+    # @raise [PDK::CLI::FatalError] if the answer file can not be written to.
+    def save_to_disk
+      FileUtils.mkdir_p(File.dirname(answer_file_path))
+
+      File.open(answer_file_path, 'w') do |answer_file|
+        answer_file.puts JSON.pretty_generate(answers)
+      end
+    rescue SystemCallError, IOError => e
+      raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
+        file: answer_file_path,
+        msg:  e.message,
+      }
+    end
+  end
+end

data/lib/pdk/cli.rb

@@ -60,20 +60,16 @@ module PDK::CLI
     ) % { available_formats: PDK::Report.formats.join("', '") }
 
     option :f, :format, format_desc, argument: :required, multiple: true do |values|
-      values.compact.each do |v|
-        if v.include?(':')
-          format = v.split(':', 2).first
-
-          Util::OptionValidator.enum(format, PDK::Report.formats)
-        else
-          Util::OptionValidator.enum(v, PDK::Report.formats)
-        end
-      end
+      PDK::CLI::Util::OptionNormalizer.report_formats(values.compact)
     end
 
     flag :d, :debug, _('Enable debug output.') do |_, _|
       PDK.logger.enable_debug_output
     end
+
+    option nil, 'answer-file', _('Path to an answer file'), argument: :required, hidden: true do |value|
+      PDK.answer_file = value
+    end
   end
 
   require 'pdk/cli/new'

data/lib/pdk/cli/exec.rb

@@ -3,6 +3,8 @@ require 'childprocess'
 require 'tempfile'
 require 'tty-spinner'
 
+require 'pdk/util'
+
 module PDK
   module CLI
     module Exec
@@ -10,12 +12,8 @@ module PDK
         Command.new(*cmd).execute!
       end
 
-      def self.pdk_basedir
-        @pdk_basedir ||= Gem.win_platform? ? 'C:/Program Files/Puppet Labs/DevelopmentKit' : '/opt/puppetlabs/sdk'
-      end
-
       def self.git_bindir
-        @git_dir ||= File.join(pdk_basedir, 'private', 'git', Gem.win_platform? ? 'cmd' : 'bin')
+        @git_dir ||= File.join('private', 'git', Gem.win_platform? ? 'cmd' : 'bin')
       end
 
       def self.git(*args)
@@ -27,24 +25,29 @@ module PDK
 
       def self.bundle(*args)
         bundle_bin = Gem.win_platform? ? 'bundle.bat' : 'bundle'
-        vendored_bin_path = File.join(pdk_basedir, 'private', 'ruby', '2.1.9', 'bin', bundle_bin)
+        vendored_bin_path = File.join('private', 'ruby', '2.1.9', 'bin', bundle_bin)
 
         execute(try_vendored_bin(vendored_bin_path, bundle_bin), *args)
       end
 
       def self.bundle_bin
         bundle_bin = Gem.win_platform? ? 'bundle.bat' : 'bundle'
-        vendored_bin_path = File.join(pdk_basedir, 'private', 'ruby', '2.1.9', 'bin', bundle_bin)
+        vendored_bin_path = File.join('private', 'ruby', '2.1.9', 'bin', bundle_bin)
 
         try_vendored_bin(vendored_bin_path, bundle_bin)
       end
 
       def self.try_vendored_bin(vendored_bin_path, fallback)
-        if File.exist?(vendored_bin_path)
-          PDK.logger.debug(_("Using '%{vendored_bin_path}'") % { fallback: fallback, vendored_bin_path: vendored_bin_path })
-          vendored_bin_path
+        unless PDK::Util.package_install?
+          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 })
+          File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
         else
-          PDK.logger.debug(_("Trying '%{fallback}' from the system PATH, instead of '%{vendored_bin_path}'") % { 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
@@ -101,9 +104,17 @@ module PDK
           end
 
           if context == :module
+            # Subprocesses use their own set of gems which are managed by pdk or installed with the package.
+            @process.environment['GEM_HOME'] = File.join(PDK::Util.cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
+
+            if PDK::Util.gem_install?
+              # This allows the subprocess to find the 'bundler' gem, which isn't in the cachedir above for gem installs.
+              # bundler_gem_path = File.absolute_path(File.join(Gem.loaded_specs['bundler'].gem_dir, '..', '..', '..', '..', '..'))
+              bundler_gem_path = File.absolute_path(File.join(`bundle show bundler`, '..', '..'))
+              @process.environment['GEM_PATH'] = bundler_gem_path
+            end
+
             # TODO: we should probably more carefully manage PATH and maybe other things too
-            @process.environment['GEM_HOME'] = File.join(PDK::Util.cachedir, 'bundler', 'ruby', RbConfig::CONFIG['ruby_version'])
-            @process.environment['GEM_PATH'] = pdk_gem_path
 
             mod_root = PDK::Util.module_root
 
@@ -168,21 +179,6 @@ module PDK
             @process.wait
           end
         end
-
-        def pdk_gem_path
-          @pdk_gem_path ||= find_pdk_gem_path
-        end
-
-        def find_pdk_gem_path
-          package_gem_path = File.join(PDK::CLI::Exec.pdk_basedir, 'private', 'ruby', RUBY_VERSION, 'lib', 'ruby', 'gems', RbConfig::CONFIG['ruby_version'])
-
-          if File.directory?(package_gem_path)
-            package_gem_path
-          else
-            # FIXME: calculate this more reliably
-            File.absolute_path(File.join(`bundle show bundler`, '..', '..'))
-          end
-        end
       end
 
       # This is a placeholder until we integrate ansicon into Windows packaging

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

@@ -27,9 +27,9 @@ module PDK
           num_questions = @questions.count
           @questions.each do |question_name, question|
             @name = question_name
-            puts pastel.bold(_('[Q %{current_number}/%{questions_total}]') % { current_number: i, questions_total: num_questions })
-            puts pastel.bold(question[:question])
-            puts question[:help]
+            @prompt.print pastel.bold(_('[Q %{current_number}/%{questions_total}]') % { current_number: i, questions_total: num_questions })
+            @prompt.print pastel.bold(question[:question])
+            @prompt.print question[:help]
             ask(_('-->')) do |q|
               q.required(question.fetch(:required, false))
 
@@ -40,7 +40,7 @@ module PDK
               q.default(question[:default]) if question.key?(:default)
             end
             i += 1
-            puts ''
+            @prompt.print ''
           end
           @answers
         rescue TTY::Prompt::Reader::InputInterrupt

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

@@ -28,7 +28,7 @@ module PDK
 
             begin
               OptionValidator.enum(format, PDK::Report.formats)
-            rescue
+            rescue ArgumentError
               raise PDK::CLI::FatalError, _("'%{name}' is not a valid report format (%{valid})") % {
                 name:  format,
                 valid: PDK::Report.formats.join(', '),
@@ -40,6 +40,8 @@ module PDK
               target = $stdout
             when 'stderr'
               target = $stderr
+            when nil
+              target = PDK::Report.default_target
             end
 
             { method: "write_#{format}".to_sym, target: target }

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

@@ -11,7 +11,7 @@ module PDK
           invalid_entries = vals.reject { |e| valid_entries.include?(e) }
 
           unless invalid_entries.empty?
-            raise _('Error: the following values are invalid: %{invalid_entries}') % { invalid_entries: invalid_entries }
+            raise ArgumentError, _('Error: the following values are invalid: %{invalid_entries}') % { invalid_entries: invalid_entries }
           end
 
           val

data/lib/pdk/generators/module.rb

@@ -30,7 +30,7 @@ module PDK
 
         prepare_module_directory(temp_target_dir)
 
-        template_url = opts.fetch(:'template-url', DEFAULT_TEMPLATE)
+        template_url = opts.fetch(:'template-url', PDK.answers['template-url'] || DEFAULT_TEMPLATE)
 
         PDK::Module::TemplateDir.new(template_url) do |templates|
           templates.render do |file_path, file_content|
@@ -48,16 +48,28 @@ module PDK
           end
         end
 
+        PDK.answers.update!('template-url' => template_url)
+
         FileUtils.mv(temp_target_dir, target_dir)
       end
 
-      def self.prepare_metadata(opts)
-        username = Etc.getlogin.gsub(%r{[^0-9a-z]}i, '')
-        username = 'username' if username == ''
-        if Etc.getlogin != username
-          PDK.logger.warn(_('Your username is not a valid Forge username, proceeding with the username %{username}' % { username: username }))
+      def self.username_from_login
+        login = Etc.getlogin
+        login_clean = login.gsub(%r{[^0-9a-z]}i, '')
+        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}') % {
+            username: login_clean,
+          }
         end
 
+        login_clean
+      end
+
+      def self.prepare_metadata(opts)
+        username = PDK.answers['forge-username'] || username_from_login
+
         defaults = {
           'name'         => "#{username}-#{opts[:name]}",
           'version'      => '0.1.0',
@@ -65,11 +77,13 @@ module PDK
             { 'name' => 'puppetlabs-stdlib', 'version_requirement' => '>= 4.13.1 < 5.0.0' },
           ],
         }
+        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'] # @todo Build way to get info by answers file
+        module_interview(metadata, opts) unless opts[:'skip-interview']
 
         metadata.update!('pdk-version' => PDK::Util::Version.version_string)
 
@@ -98,7 +112,7 @@ module PDK
             required:         true,
             validate_pattern: %r{\A[a-z0-9]+\Z}i,
             validate_message: _('Forge usernames can only contain lowercase letters and numbers'),
-            default:          metadata.data['author'],
+            default:          PDK.answers['forge-username'] || metadata.data['author'],
           },
           {
             name:             'version',
@@ -167,11 +181,13 @@ module PDK
         answers = interview.run
 
         if answers.nil?
-          puts _('Interview cancelled, aborting...')
+          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)
         metadata.update!(answers)
 
         puts '-' * 40
@@ -181,10 +197,16 @@ module PDK
         puts '-' * 40
         puts
 
-        unless prompt.yes?(_('About to generate this module; continue?')) # rubocop:disable Style/GuardClause
-          puts _('Aborting...')
+        unless prompt.yes?(_('About to generate this module; continue?'))
+          PDK.logger.info _('Module not generated.')
           exit 0
         end
+
+        PDK.answers.update!(
+          'forge-username' => forge_username,
+          'author'         => answers['author'],
+          'license'        => answers['license'],
+        )
       end
     end
   end

data/lib/pdk/module/metadata.rb

@@ -67,7 +67,7 @@ module PDK
       end
 
       def to_json
-        JSON.pretty_generate(@data)
+        JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? })
       end
 
       private

data/lib/pdk/report.rb

@@ -48,9 +48,6 @@ module PDK
     # @param target [#write] an IO object that the report will be written to.
     #   Defaults to PDK::Report.default_target.
     def write_junit(target = self.class.default_target)
-      # Extra defaulting here, b/c the Class.send method will pass in nil
-      target ||= self.class.default_target
-
       # Open a File Object for IO if target is a string containing a filename or path
       target = File.open(target, 'w') if target.is_a? String
 
@@ -94,9 +91,6 @@ module PDK
     # @param target [#write] an IO object that the report will be written to.
     #   Defaults to PDK::Report.default_target.
     def write_text(target = self.class.default_target)
-      # Extra defaulting here, b/c the Class.send method will pass in nil
-      target ||= self.class.default_target
-
       # Open a File Object for IO if target is a string containing a filename or path
       target = File.open(target, 'w') if target.is_a? String
 

data/lib/pdk/util.rb

@@ -2,17 +2,20 @@ require 'tmpdir'
 require 'tempfile'
 require 'puppet/util/windows'
 
+require 'pdk/util/version'
+
 module PDK
   module Util
     # Searches upwards from current working directory for the given target file.
     #
     # @param target [String] Name of file to search for.
+    # @param start_dir [String] Directory to start searching from, defaults to Dir.pwd
     #
     # @return [String, nil] Fully qualified path to the given target file if found,
     #   nil if the target file could not be found.
-    def find_upwards(target)
+    def find_upwards(target, start_dir = nil)
       previous = nil
-      current  = File.expand_path(Dir.pwd)
+      current  = File.expand_path(start_dir || Dir.pwd)
 
       until !File.directory?(current) || current == previous
         filename = File.join(current, target)
@@ -50,17 +53,34 @@ module PDK
     end
     module_function :canonical_path
 
+    def package_install?
+      !PDK::Util::Version.version_file.nil?
+    end
+    module_function :package_install?
+
+    def gem_install?
+      !package_install?
+    end
+    module_function :gem_install?
+
+    def pdk_package_basedir
+      raise PDK::CLI::FatalError, _('Package basedir requested for non-package install') unless package_install?
+
+      File.dirname(PDK::Util::Version.version_file)
+    end
+    module_function :pdk_package_basedir
+
     # Returns the fully qualified path to a per-user PDK cachedir.
     #
     # @return [String] Fully qualified path to per-user PDK cachedir.
     def cachedir
-      basedir = if Gem.win_platform?
-                  ENV['LOCALAPPDATA']
-                else
-                  Dir.home
-                end
-
-      File.join(basedir, '.pdk', 'cache')
+      if package_install?
+        File.join(pdk_package_basedir, 'share', 'cache')
+      elsif Gem.win_platform?
+        File.join(ENV['LOCALAPPDATA'], 'PDK', 'cache')
+      else
+        File.join(Dir.home, '.pdk', 'cache')
+      end
     end
     module_function :cachedir
 

data/lib/pdk/util/bundler.rb

@@ -62,7 +62,10 @@ module PDK
         end
 
         def installed?
-          command = bundle_command('check', "--gemfile=#{gemfile}", "--path=#{bundle_cachedir}").tap do |c|
+          argv = ['check', "--gemfile=#{gemfile}"]
+          argv << "--path=#{bundle_cachedir}" if PDK::Util.gem_install?
+
+          command = bundle_command(*argv).tap do |c|
             c.add_spinner(_('Checking for missing Gemfile dependencies'))
           end
 
@@ -92,7 +95,10 @@ module PDK
         end
 
         def install!
-          command = bundle_command('install', "--gemfile=#{gemfile}", "--path=#{bundle_cachedir}").tap do |c|
+          argv = ['install', "--gemfile=#{gemfile}"]
+          argv << "--path=#{bundle_cachedir}" if PDK::Util.gem_install?
+
+          command = bundle_command(*argv).tap do |c|
             c.add_spinner(_('Installing missing Gemfile dependencies'))
           end
 
@@ -107,7 +113,10 @@ module PDK
         end
 
         def binstubs!(gems)
-          command = bundle_command('binstubs', gems.join(' '), '--force')
+          binstub_dir = File.join(File.dirname(gemfile), 'bin')
+          return true if gems.all? { |gem| File.file?(File.join(binstub_dir, gem)) }
+
+          command = bundle_command('binstubs', *gems, '--force')
 
           result = command.execute!
 
@@ -137,7 +146,7 @@ module PDK
         end
 
         def bundle_cachedir
-          @bundle_cachedir ||= File.join(PDK::Util.cachedir, 'bundler')
+          @bundle_cachedir ||= File.join(PDK::Util.cachedir)
         end
       end
     end

data/lib/pdk/util/version.rb

@@ -14,11 +14,9 @@ module PDK
       end
 
       def self.pkg_sha
-        version_file = File.join(File.expand_path('../../..', File.dirname(__FILE__)), 'VERSION')
-
-        if File.exist? version_file
+        if version_file && File.exist?(version_file)
           ver = File.read(version_file)
-          sha = ver.strip.split('.')[-1] unless ver.nil?
+          sha = ver.strip.split('.')[5] unless ver.nil?
         end
 
         sha
@@ -29,6 +27,10 @@ module PDK
 
         ref_result[:stdout].strip if ref_result[:exit_code].zero?
       end
+
+      def self.version_file
+        PDK::Util.find_upwards('PDK_VERSION', File.dirname(__FILE__))
+      end
     end
   end
 end

data/lib/pdk/validate.rb

@@ -1,11 +1,11 @@
-require 'pdk/validators/metadata'
+require 'pdk/validators/metadata_validator'
 require 'pdk/validators/puppet_validator'
 require 'pdk/validators/ruby_validator'
 
 module PDK
   module Validate
     def self.validators
-      @validators ||= [Metadata, PuppetValidator, RubyValidator].freeze
+      @validators ||= [MetadataValidator, PuppetValidator, RubyValidator].freeze
     end
   end
 end

data/lib/pdk/validators/base_validator.rb

@@ -4,6 +4,14 @@ require 'pdk/cli/exec'
 module PDK
   module Validate
     class BaseValidator
+      # Controls how many times the validator is invoked.
+      #
+      #   :once -       The validator will be invoked once and passed all the
+      #                 targets.
+      #   :per_target - The validator will be invoked for each target
+      #                 separately.
+      INVOKE_STYLE = :once
+
       def self.cmd_path
         File.join(PDK::Util.module_root, 'bin', cmd)
       end
@@ -34,7 +42,7 @@ module PDK
         targets
       end
 
-      def self.spinner_text
+      def self.spinner_text(_targets = nil)
         _('Invoking %{cmd}') % { cmd: cmd }
       end
 
@@ -44,19 +52,31 @@ module PDK
         return 0 if targets.empty?
 
         PDK::Util::Bundler.ensure_binstubs!(cmd)
-        cmd_argv = parse_options(options, targets).unshift(cmd_path)
-        cmd_argv.unshift('ruby', '-W0') if Gem.win_platform?
 
-        command = PDK::CLI::Exec::Command.new(*cmd_argv).tap do |c|
-          c.context = :module
-          c.add_spinner(spinner_text)
-        end
+        # If invoking :per_target, split the targets array into an array of
+        # single element arrays (one per target). If invoking :once, wrap the
+        # targets array in another array. This is so we can loop through the
+        # invokes with the same logic, regardless of which invoke style is
+        # needed.
+        targets = (self::INVOKE_STYLE == :per_target) ? targets.combination(1).to_a : Array[targets]
+        exit_codes = []
+
+        targets.each do |invokation_targets|
+          cmd_argv = parse_options(options, invokation_targets).unshift(cmd_path)
+          cmd_argv.unshift('ruby', '-W0') if Gem.win_platform?
 
-        result = command.execute!
+          command = PDK::CLI::Exec::Command.new(*cmd_argv).tap do |c|
+            c.context = :module
+            c.add_spinner(spinner_text(invokation_targets))
+          end
+
+          result = command.execute!
+          exit_codes << result[:exit_code]
 
-        parse_output(report, result, targets)
+          parse_output(report, result, invokation_targets)
+        end
 
-        result[:exit_code]
+        exit_codes.sort.last
       end
     end
   end

data/lib/pdk/validators/{metadata.rb → metadata/metadata_json_lint.rb}

@@ -2,24 +2,31 @@ require 'pdk'
 require 'pdk/cli/exec'
 require 'pdk/validators/base_validator'
 require 'pdk/util/bundler'
+require 'pathname'
 
 module PDK
   module Validate
-    class Metadata < BaseValidator
+    class MetadataJSONLint < BaseValidator
+      # Validate each metadata file separately, as metadata-json-lint does not
+      # support multiple targets.
+      INVOKE_STYLE = :per_target
+
       def self.name
-        'metadata'
+        'metadata-json-lint'
       end
 
       def self.cmd
         'metadata-json-lint'
       end
 
-      def self.spinner_text
-        _('Checking metadata.json')
+      def self.spinner_text(targets = nil)
+        _('Checking metadata (%{targets})') % {
+          targets: targets.map { |t| Pathname.new(t).absolute? ? Pathname.new(t).relative_path_from(Pathname.pwd) : t }.join(' '),
+        }
       end
 
-      def self.parse_targets(_options)
-        [File.join(PDK::Util.module_root, 'metadata.json')]
+      def self.pattern
+        'metadata.json'
       end
 
       def self.parse_options(_options, targets)
@@ -28,16 +35,18 @@ module PDK
         cmd_options.concat(targets)
       end
 
-      def self.parse_output(report, result, _targets)
+      def self.parse_output(report, result, targets)
         begin
           json_data = JSON.parse(result[:stdout])
         rescue JSON::ParserError
           json_data = []
         end
 
+        raise ArgumentError, 'More that 1 target provided to PDK::Validate::MetadataJSONLint' if targets.count > 1
+
         if json_data.empty?
           report.add_event(
-            file:     'metadata.json',
+            file:     targets.first,
             source:   cmd,
             state:    :passed,
             severity: :ok,
@@ -52,7 +61,7 @@ module PDK
               event_type = type[%r{\A(.+?)s?\Z}, 1]
 
               report.add_event(
-                file:     'metadata.json',
+                file:     targets.first,
                 source:   cmd,
                 message:  offense['msg'],
                 test:     offense['check'],

data/lib/pdk/validators/metadata/metadata_syntax.rb

@@ -0,0 +1,89 @@
+require 'pdk'
+require 'pdk/cli/exec'
+require 'pdk/validators/base_validator'
+require 'pathname'
+
+module PDK
+  module Validate
+    class MetadataSyntax < BaseValidator
+      def self.name
+        'metadata-syntax'
+      end
+
+      def self.pattern
+        'metadata.json'
+      end
+
+      def self.invoke(report, options = {})
+        targets = parse_targets(options)
+
+        return 0 if targets.empty?
+
+        return_val = 0
+
+        # The pure ruby JSON parser gives much nicer parse error messages than
+        # the C extension at the cost of slightly slower parsing. We require it
+        # here and restore the C extension at the end of the method (if it was
+        # being used).
+        require 'json/pure'
+        JSON.parser = JSON::Pure::Parser
+
+        targets.each do |target|
+          unless File.file?(target)
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  _('not a file'),
+            )
+            return_val = 1
+            next
+          end
+
+          unless File.readable?(target)
+            report.add_event(
+              file: target,
+              source: name,
+              state: :failure,
+              severity: 'error',
+              message: _('could not be read'),
+            )
+            return_val = 1
+            next
+          end
+
+          begin
+            JSON.parse(File.read(target))
+
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :passed,
+              severity: 'ok',
+            )
+          rescue JSON::ParserError => e
+            # Because the message contains a raw segment of the file, we use
+            # String#dump here to unescape any escape characters like newlines.
+            # We then strip out the surrounding quotes and the exclaimation
+            # point that json_pure likes to put in exception messages.
+            sane_message = e.message.dump[%r{\A"(.+?)!?"\Z}, 1]
+
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  sane_message,
+            )
+            return_val = 1
+          end
+        end
+
+        return_val
+      ensure
+        JSON.parser = JSON::Ext::Parser if defined?(JSON::Ext::Parser)
+      end
+    end
+  end
+end

data/lib/pdk/validators/metadata_validator.rb

@@ -0,0 +1,30 @@
+require 'pdk'
+require 'pdk/cli/exec'
+require 'pdk/validators/base_validator'
+require 'pdk/validators/metadata/metadata_json_lint'
+require 'pdk/validators/metadata/metadata_syntax'
+
+module PDK
+  module Validate
+    class MetadataValidator < BaseValidator
+      def self.name
+        'metadata'
+      end
+
+      def self.metadata_validators
+        [MetadataSyntax, MetadataJSONLint]
+      end
+
+      def self.invoke(report, options = {})
+        exit_code = 0
+
+        metadata_validators.each do |validator|
+          exit_code = validator.invoke(report, options)
+          break if exit_code != 0
+        end
+
+        exit_code
+      end
+    end
+  end
+end

data/lib/pdk/validators/puppet/puppet_lint.rb

@@ -18,7 +18,7 @@ module PDK
         '**/*.pp'
       end
 
-      def self.spinner_text
+      def self.spinner_text(_targets = nil)
         _('Checking Puppet manifest style')
       end
 
@@ -32,7 +32,7 @@ module PDK
 
       def self.parse_output(report, result, targets)
         begin
-          json_data = JSON.parse(result[:stdout])
+          json_data = JSON.parse(result[:stdout]).flatten
         rescue JSON::ParserError
           json_data = []
         end

data/lib/pdk/validators/puppet/puppet_syntax.rb

@@ -17,7 +17,7 @@ module PDK
         '**/**.pp'
       end
 
-      def self.spinner_text
+      def self.spinner_text(_targets = nil)
         _('Checking Puppet manifest syntax')
       end
 

data/lib/pdk/validators/ruby/rubocop.rb

@@ -16,7 +16,7 @@ module PDK
         'rubocop'
       end
 
-      def self.spinner_text
+      def self.spinner_text(_targets = nil)
         _('Checking Ruby code style')
       end
 
@@ -31,10 +31,12 @@ module PDK
       end
 
       def self.parse_output(report, result, _targets)
+        return if result[:stdout].empty?
+
         begin
           json_data = JSON.parse(result[:stdout])
         rescue JSON::ParserError
-          json_data = []
+          json_data = {}
         end
 
         return unless json_data.key?('files')

data/lib/pdk/version.rb

@@ -1,3 +1,3 @@
 module PDK
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +135,7 @@ files:
 - README.md
 - exe/pdk
 - lib/pdk.rb
+- lib/pdk/answer_file.rb
 - lib/pdk/cli.rb
 - lib/pdk/cli/errors.rb
 - lib/pdk/cli/exec.rb
@@ -151,7 +166,9 @@ files:
 - lib/pdk/util/version.rb
 - lib/pdk/validate.rb
 - lib/pdk/validators/base_validator.rb
-- lib/pdk/validators/metadata.rb
+- lib/pdk/validators/metadata/metadata_json_lint.rb
+- lib/pdk/validators/metadata/metadata_syntax.rb
+- lib/pdk/validators/metadata_validator.rb
 - lib/pdk/validators/puppet/puppet_lint.rb
 - lib/pdk/validators/puppet/puppet_syntax.rb
 - lib/pdk/validators/puppet_validator.rb
@@ -184,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules