pdk 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae821da6d24883d0df5ffda8ffa0bba0b8943552
-  data.tar.gz: 8408717624413c4535373e6db19fbb877957c6bd
+  metadata.gz: b878e02d3bef0909854556bea786e90c9046e19d
+  data.tar.gz: 57f154d05abdef54e0c658529664cfe4eeedc3d3
 SHA512:
-  metadata.gz: 9382d4e0a2b841b5a35c0e0031767139613be448a3e7876e21c0fc6757553cc154210d55a13ae35355e9e791c1d12498b35bacdae8b4cf850a082d3c85f0d993
-  data.tar.gz: b8c75c0a94b62659e09ec743429ec8c608827880d447001994f9eb4c11ac547bf0ae07719a4d974b8eca46e8c859753c09a725297d77901ecf6a4a9a8a08fdb0
+  metadata.gz: 5334b857cda21c8a2383cded335f22e8fdd16752305db1d3b52bb1f61c98d8ccca6acf33724085e79b4492e0c083a44732acd6b081f75ce20eba8af5bc01a0af
+  data.tar.gz: ff431dd53fa3ebe9d4b5f0ab95d0e3d49101c0bb7cebcd80720d4bf007440df216f03d573f257994d3cb33f0f39a225f4918ff23438276c0c28cceef9c377999

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 
 
+## [v0.5.0](https://github.com/puppetlabs/pdk/tree/v0.5.0) (2017-07-20)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v0.4.4...v0.5.0)
+
+**Implemented enhancements:**
+
+- \(SDK-329\) implement running arbitrary commands in PDK's environment [\#179](https://github.com/puppetlabs/pdk/pull/179) ([DavidS](https://github.com/DavidS))
+- \(maint\) Add 2.1.9 as the minimum required ruby version in the gemspec [\#176](https://github.com/puppetlabs/pdk/pull/176) ([rodjek](https://github.com/rodjek))
+
+**Fixed bugs:**
+
+- \(SDK-331\) allow additional gems to be installed [\#178](https://github.com/puppetlabs/pdk/pull/178) ([DavidS](https://github.com/DavidS))
+
 ## [v0.4.4](https://github.com/puppetlabs/pdk/tree/v0.4.4) (2017-07-18)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v0.4.3...v0.4.4)
 

data/README.md

@@ -238,7 +238,7 @@ Running validations on `new_module/lib`:
 * puppet syntax: (no puppet manifests found)
 ```
 
-#### `pdk test unit` command
+### `pdk test unit` command
 
 Runs unit tests. Any errors are displayed to the console and reported in the report-file, if requested. The exitcode is non-zero when errors occur.
 
@@ -270,13 +270,36 @@ Multiple `--format` options can be specified as long as they all have distinct o
 
 Specifies options to pass through to the actual test-runner. In the default template (and most commonly across modules), this is [rspec](https://relishapp.com/rspec/rspec-core/docs/command-line).
 
+### `pdk bundle` command
+
+This experimental command allows advanced users to execute arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. Careless use of this command can lead to errors later which can't be recovered by the pdk itself.
+
+Note that for most advanced uses it is required to use the `--` to separate bundler options from pdk options. Compare the following two commands:
+
+```
+$ pdk bundle exec rake -T
+bundle: illegal option -- T
+
+```
+
+and
+
+```
+$ pdk bundle -- exec rake -T
+rake beaker                # Run beaker acceptance tests
+rake beaker:sets           # List available beaker nodesets
+rake beaker:ssh[set,node]  # Try to use vagrant to login to the Beaker node
+rake build                 # Build puppet module package
+[...]
+```
+
 ## Contributing
 
 In cases where `pdk` needs to run in a working directory outside the cloned repository, either set `BUNDLE_GEMFILE` to the pdk's Gemfile location, or install and use the [binstubs of bundler](http://bundler.io/v1.15/bundle_binstubs.html), which are small proxy binaries, that set up the environment for running the tool.
 
 ```
 # assuming ~/bin is already on your path:
-bundle binstubs pdk --path ~/bin
+$ bundle binstubs pdk --path ~/bin
 ```
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/pdk/issues.

data/lib/pdk/cli.rb

@@ -72,6 +72,7 @@ module PDK::CLI
     end
   end
 
+  require 'pdk/cli/bundle'
   require 'pdk/cli/new'
   require 'pdk/cli/test'
   require 'pdk/cli/validate'

data/lib/pdk/cli/bundle.rb

@@ -0,0 +1,25 @@
+
+module PDK::CLI
+  @bundle_cmd = @base_cmd.define_command do
+    name 'bundle'
+    usage _('bundle -- [bundler_options]')
+    summary _('escape hatch to bundler')
+    description _('[experimental] For advanced users, this allows to run arbitrary commands in the bundler environment that the pdk manages. ' \
+      'Careless use of this command can lead to errors later which can\'t be recovered by the pdk itself.')
+
+    run do |_opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      command = PDK::CLI::Exec::Command.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
+        c.context = :module
+      end
+
+      result = command.execute!
+
+      $stderr.puts result[:stdout]
+      $stderr.puts result[:stderr]
+
+      exit result[:exit_code]
+    end
+  end
+end

data/lib/pdk/cli/exec.rb

@@ -104,13 +104,17 @@ module PDK
           end
 
           if context == :module
+            # `bundle install --path` ignores all "system" installed gems and causes unnecessary package installs
+            # `bundle install` (without --path) installs into GEM_HOME, which by default is non-user writeable
+            # To still use the pre-installed packages, but allow folks to install additional gems
+            # we set GEM_HOME to the user's cachedir, and put all other cache locations onto GEM_PATH
+            # See https://stackoverflow.com/a/11277228 for background
+            @process.environment['GEM_HOME'] = File.join(PDK::Util.cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
+
             if PDK::Util.package_install?
               # 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.package_cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
+              @process.environment['GEM_PATH'] = File.join(PDK::Util.package_cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
             else
-              # 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'])
-
               # 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 which bundler`, '..', '..', '..', '..'))
               @process.environment['GEM_PATH'] = bundler_gem_path

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

@@ -36,18 +36,33 @@ module PDK
       end
 
       def self.parse_output(report, result, targets)
-        begin
-          json_data = JSON.parse(result[:stdout])
-        rescue JSON::ParserError
-          json_data = []
-        end
+        raise ArgumentError, 'More than 1 target provided to PDK::Validate::MetadataJSONLint' if targets.count > 1
 
-        raise ArgumentError, 'More that 1 target provided to PDK::Validate::MetadataJSONLint' if targets.count > 1
+        if result[:stdout].strip.empty?
+          # metadata-json-lint will print nothing if there are no problems with
+          # the file being linted. This should be handled separately to
+          # metadata-json-lint generating output that can not be parsed as JSON
+          # (unhandled exception in metadata-json-lint).
+          json_data = {}
+        else
+          begin
+            json_data = JSON.parse(result[:stdout])
+          rescue JSON::ParserError
+            report.add_event(
+              file:     targets.first,
+              source:   name,
+              state:    :error,
+              severity: :error,
+              message:  result[:stdout],
+            )
+            return
+          end
+        end
 
         if json_data.empty?
           report.add_event(
             file:     targets.first,
-            source:   cmd,
+            source:   name,
             state:    :passed,
             severity: :ok,
           )
@@ -62,7 +77,7 @@ module PDK
 
               report.add_event(
                 file:     targets.first,
-                source:   cmd,
+                source:   name,
                 message:  offense['msg'],
                 test:     offense['check'],
                 severity: event_type,

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

@@ -43,7 +43,7 @@ module PDK
         targets.reject { |target| json_data.any? { |j| j['path'] == target } }.each do |target|
           report.add_event(
             file:     target,
-            source:   'puppet-lint',
+            source:   name,
             severity: 'ok',
             state:    :passed,
           )
@@ -52,7 +52,7 @@ module PDK
         json_data.each do |offense|
           report.add_event(
             file:     offense['path'],
-            source:   'puppet-lint',
+            source:   name,
             line:     offense['line'],
             column:   offense['column'],
             message:  offense['message'],

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

@@ -44,7 +44,7 @@ module PDK
           attributes = {
             source:  name,
             message: message.strip,
-            state:  'failure',
+            state:  :failure,
           }
           attributes[:severity] = severity.strip unless severity.nil?
 
@@ -57,14 +57,14 @@ module PDK
           results_data << attributes
         end
 
-        # puppet-lint does not include files without problems in its JSON
+        # puppet parser validate does not include files without problems in its
         # output, so we need to go through the list of targets and add passing
-        # events to the report for any target not listed in the JSON output.
+        # events to the report for any target not listed in the output.
         targets.reject { |target| results_data.any? { |j| j[:file] == target } }.each do |target|
           report.add_event(
             file:     target,
-            source:   'puppet-syntax',
-            severity: 'ok',
+            source:   name,
+            severity: :ok,
             state:    :passed,
           )
         end

data/lib/pdk/version.rb

@@ -1,3 +1,3 @@
 module PDK
-  VERSION = '0.4.4'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,7 @@ files:
 - lib/pdk.rb
 - lib/pdk/answer_file.rb
 - lib/pdk/cli.rb
+- lib/pdk/cli/bundle.rb
 - lib/pdk/cli/errors.rb
 - lib/pdk/cli/exec.rb
 - lib/pdk/cli/new.rb
@@ -193,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -201,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules