pdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6475b9cccfedb258b4accc3ce84b407f4f530480
-  data.tar.gz: 29aeb6521f3b3ee7bd41e2ade024e9a75a79692d
+  metadata.gz: f22acd513e00856fbadcd4c5090b2787df655426
+  data.tar.gz: 6636287e1acef4c9ba87f52b4b853c922e4ce92b
 SHA512:
-  metadata.gz: bead00ff5d38bdf51ea0035b60a1d9a0f4ef111c982e14295dc4dbbe47a2bec0fd9d1d160c3267c98c73fde9ccd9beec9d3e95aae340b12ae9232649c3b27502
-  data.tar.gz: ac72b4f88da4a89fdda9377e430b040f0cb3dbba59aa4d7f6cfab3879abd3005ac00bdff70ee2b4bc7ea1e307da1b94eccaa62387e8b76fab79487cd563177ba
+  metadata.gz: 2ce7e0faffaac9a2484c23dc1e88f9b240e0d768d63c8c793439f9a560a95cfa31a8745b510d4c84b83e410639bae7eb004f9d91732fd7740b4650581f71969a
+  data.tar.gz: d7a9e5bae06899f4972add88c8bc49053b257ce7aa10fb38537ea5101ea0e9ceae56e62e212bff6e07e372c558b6f38e9a9dc8ae290a6048d8fb7f72a64ddd0d

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+## [v0.2.0](https://github.com/puppetlabs/pdk/tree/v0.2.0) (2017-06-21)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+
+- \(SDK-137\) Adds Puppet Parser syntax validation [\#94](https://github.com/puppetlabs/pdk/pull/94) ([bmjen](https://github.com/bmjen))
+- \(SDK-274\) Adds --version option [\#90](https://github.com/puppetlabs/pdk/pull/90) ([bmjen](https://github.com/bmjen))
+- \(SDK-244\) Add rubocop validation subcommand [\#75](https://github.com/puppetlabs/pdk/pull/75) ([rodjek](https://github.com/rodjek))
+- \(maint\) Add hints for gem installation [\#74](https://github.com/puppetlabs/pdk/pull/74) ([DavidS](https://github.com/DavidS))
+- \(SDK-240\) Adds puppet-lint validation subcommand [\#71](https://github.com/puppetlabs/pdk/pull/71) ([bmjen](https://github.com/bmjen))
+- \(SDK-261\) Manage basic bundler operations for module dev [\#62](https://github.com/puppetlabs/pdk/pull/62) ([scotje](https://github.com/scotje))
+- \(SDK-232\) Add operatingsystem\_support defaults [\#58](https://github.com/puppetlabs/pdk/pull/58) ([DavidS](https://github.com/DavidS))
+
+**Fixed bugs:**
+
+- pdk expects missing git binaries [\#61](https://github.com/puppetlabs/pdk/issues/61)
+- \(maint\) avoid interfering with local ruby configs [\#86](https://github.com/puppetlabs/pdk/pull/86) ([DavidS](https://github.com/DavidS))
+- \(SDK-262\) Populate default metadata to match interview defaults [\#63](https://github.com/puppetlabs/pdk/pull/63) ([rodjek](https://github.com/rodjek))
+- \(maint\) nokogiri: avoid versions without ruby 2.1 support [\#60](https://github.com/puppetlabs/pdk/pull/60) ([DavidS](https://github.com/DavidS))
+
+## [v0.1.0](https://github.com/puppetlabs/pdk/tree/v0.1.0) (2017-06-05)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/2be9329bed4715c888f273814b99f2cf37ee9341...v0.1.0)
+
+**Implemented enhancements:**
+
+- \(maint\) update Contributing section [\#56](https://github.com/puppetlabs/pdk/pull/56) ([DavidS](https://github.com/DavidS))
+- \(SDK-197\) Add 'new class' generator command [\#48](https://github.com/puppetlabs/pdk/pull/48) ([rodjek](https://github.com/rodjek))
+- \(SDK-201\) Add 'new module' generator command [\#41](https://github.com/puppetlabs/pdk/pull/41) ([rodjek](https://github.com/rodjek))
+- \(maint\) make debug output optional [\#40](https://github.com/puppetlabs/pdk/pull/40) ([rodjek](https://github.com/rodjek))
+- \(maint\) Print help for 'new' command if no type provided [\#35](https://github.com/puppetlabs/pdk/pull/35) ([rodjek](https://github.com/rodjek))
+- \(SDK-214\) Add gettext and externalize strings [\#32](https://github.com/puppetlabs/pdk/pull/32) ([scotje](https://github.com/scotje))
+- \(SDK-178\) interactive license and module name query [\#30](https://github.com/puppetlabs/pdk/pull/30) ([DavidS](https://github.com/DavidS))
+- \(SDK-200\) Add user interview for `new module` info gathering [\#26](https://github.com/puppetlabs/pdk/pull/26) ([whopper](https://github.com/whopper))
+- \(maint\) Replace --report-\* options with --format. [\#24](https://github.com/puppetlabs/pdk/pull/24) ([whopper](https://github.com/whopper))
+- \(SDK-191\) Allow validators and targets as arguments rather than options [\#22](https://github.com/puppetlabs/pdk/pull/22) ([whopper](https://github.com/whopper))
+- \(SDK-185\) Include the command in usage help output [\#19](https://github.com/puppetlabs/pdk/pull/19) ([james-stocks](https://github.com/james-stocks))
+
+**Fixed bugs:**
+
+- \(maint\) use correct basedir for windows execs [\#51](https://github.com/puppetlabs/pdk/pull/51) ([DavidS](https://github.com/DavidS))
+- \(maint\) Update pdk.gemspec to not depend on git to assign files. [\#27](https://github.com/puppetlabs/pdk/pull/27) ([scotje](https://github.com/scotje))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -1,4 +1,4 @@
-# pdk [![Travis Build Status](https://travis-ci.com/puppetlabs/pdk.svg?token=kFfyquZWxwxpgSetpypR&branch=master)](https://travis-ci.com/puppetlabs/pdk) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/x70e2fqllbaootpd?svg=true)](https://ci.appveyor.com/project/puppetlabs/pdk)
+# pdk [![Build Status](https://travis-ci.org/puppetlabs/pdk.svg?branch=master)](https://travis-ci.org/puppetlabs/pdk) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/x70e2fqllbaootpd?svg=true)](https://ci.appveyor.com/project/puppetlabs/pdk)
 
 
 A CLI to facilitate easy, unified development workflows for Puppet modules. pdk is a key part of the Puppet Development Kit, the shortest path to better modules.
@@ -11,6 +11,8 @@ A CLI to facilitate easy, unified development workflows for Puppet modules. pdk
 $ gem install pdk
 ```
 
+For default usage, you'll also need to have `git`, and `bundle` (from [bundler](http://bundler.io/)) on your system PATH.
+
 ## Usage
 
 ### Generate a new module
@@ -252,14 +254,6 @@ Specifies options to pass through to the actual test-runner. In the default temp
 
 ## Contributing
 
-To run the `pdk` tool directly from the repository, set the environment variable `PDK_USE_SYSTEM_BINARIES` to `true`. This causes it to use the system installed binaries, instead of relying on the puppet-sdk-vanagon packaging. Currently required is a ruby (2.1, or later), and git.
-
-```
-PowerShell: $env:PDK_USE_SYSTEM_BINARIES = "true"
-cmd.exe:    set PDK_USE_SYSTEM_BINARIES=true
-bash:       export PDK_USE_SYSTEM_BINARIES=true
-```
-
 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.
 
 ```

data/exe/pdk

@@ -2,4 +2,4 @@
 
 require 'pdk/cli'
 
-PDK::CLI.run(ARGV.dup)
+PDK::CLI.run(ARGV)

data/lib/pdk.rb

@@ -1,8 +1,9 @@
-require 'pdk/version'
-require 'pdk/logger'
-require 'pdk/i18n'
 require 'pdk/generate'
-require 'pdk/validate'
+require 'pdk/i18n'
+require 'pdk/logger'
 require 'pdk/report'
+require 'pdk/template_file'
+require 'pdk/validate'
+require 'pdk/version'
 
 module PDK; end

data/lib/pdk/cli.rb

@@ -1,80 +1,83 @@
 require 'cri'
 
 require 'pdk/cli/errors'
-require 'pdk/cli/util/option_validator'
 require 'pdk/cli/util/option_normalizer'
+require 'pdk/cli/util/option_validator'
+require 'pdk/generators/module'
+require 'pdk/i18n'
 require 'pdk/logger'
 require 'pdk/report'
+require 'pdk/util/version'
 
-require 'pdk/cli/new'
-require 'pdk/cli/validate'
-require 'pdk/cli/test'
-
-module PDK
-  module CLI
-    def self.base_command
-      @base ||= Cri::Command.new.tap do |cmd|
-        cmd.modify do
-          name 'pdk'
-          usage _("pdk command [options]")
-          summary _("Puppet Development Kit")
-          description _("The shortest path to better modules.")
-
-          flag :h, :help, _("show help for this command") do |_, c|
-            puts c.help
-            exit 0
-          end
+module PDK::CLI
+  def self.run(args)
+    @base_cmd.run(args)
+  rescue PDK::CLI::FatalError => e
+    PDK.logger.fatal(e.message) if e.message
 
-          format_desc = _(
-            "Specify desired output format. Valid formats are '%{available_formats}'. " +
-            "You may also specify a file to which the formatted output will be directed, " +
-            "for example: '--format=junit:report.xml'. This option may be specified " +
-            "multiple times as long as each option specifies a distinct target file."
-          ) % {available_formats: PDK::Report.formats.join("', '")}
+    # If FatalError was raised as the result of another exception, send the
+    # details of that exception to the debug log. If there was no cause
+    # (FatalError raised on its own outside a rescue block), send the details
+    # of the FatalError exception to the debug log.
+    cause = e.cause
+    if cause.nil?
+      e.backtrace.each { |line| PDK.logger.debug(line) }
+    else
+      PDK.logger.debug("#{cause.class}: #{cause.message}")
+      cause.backtrace.each { |line| PDK.logger.debug(line) }
+    end
 
-          option :f, :format, format_desc, { argument: :required, multiple: true } do |values|
-            values.compact.each do |v|
-              if v.include?(':')
-                format = v.split(':', 2).first
+    exit e.exit_code
+  end
 
-                PDK::CLI::Util::OptionValidator.enum(format, PDK::Report.formats)
-              else
-                PDK::CLI::Util::OptionValidator.enum(v, PDK::Report.formats)
-              end
-            end
-          end
+  def self.template_url_option(dsl)
+    dsl.option nil, 'template-url', _('Specifies the URL to the template to use when creating new modules, and other parts.'), argument: :required, default: PDK::Generate::Module::DEFAULT_TEMPLATE
+  end
 
-          flag :d, :debug, _("Enable debug output.") do |_, _|
-            PDK.logger.enable_debug_output
-          end
-        end
+  @base_cmd = Cri::Command.define do
+    name 'pdk'
+    usage _('pdk command [options]')
+    summary _('Puppet Development Kit')
+    description _('The shortest path to better modules.')
+    default_subcommand 'help'
 
-        cmd.add_command(Cri::Command.new_basic_help)
+    flag nil, :version, _('show version of pdk') do |_, _|
+      puts PDK::Util::Version.version_string
+      exit 0
+    end
 
-        cmd.add_command(PDK::CLI::New.command)
-        cmd.add_command(PDK::CLI::Validate.command)
-        cmd.add_command(PDK::CLI::Test.command)
-      end
+    flag :h, :help, _('show help for this command') do |_, c|
+      puts c.help
+      exit 0
     end
 
-    def self.run(args)
-      base_command.run(args)
-    rescue PDK::CLI::FatalError => e
-      PDK.logger.fatal(e.message) if e.message
+    format_desc = _(
+      "Specify desired output format. Valid formats are '%{available_formats}'. " \
+      'You may also specify a file to which the formatted output will be directed, ' \
+      "for example: '--format=junit:report.xml'. This option may be specified " \
+      'multiple times as long as each option specifies a distinct target file.',
+    ) % { available_formats: PDK::Report.formats.join("', '") }
 
-      # If FatalError was raised as the result of another exception, send the
-      # details of that exception to the debug log. If there was no cause
-      # (FatalError raised on its own outside a rescue block), send the details
-      # of the FatalError exception to the debug log.
-      cause = e.cause
-      if cause.nil?
-        e.backtrace.each { |line| PDK.logger.debug(line) }
-      else
-        PDK.logger.debug("#{cause.class}: #{cause.message}")
-        cause.backtrace.each { |line| PDK.logger.debug(line) }
+    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
+    end
 
-      exit e.exit_code
+    flag :d, :debug, _('Enable debug output.') do |_, _|
+      PDK.logger.enable_debug_output
     end
   end
+
+  require 'pdk/cli/new'
+  require 'pdk/cli/test'
+  require 'pdk/cli/validate'
+
+  @base_cmd.add_command Cri::Command.new_basic_help
 end

data/lib/pdk/cli/errors.rb

@@ -3,7 +3,7 @@ module PDK
     class FatalError < StandardError
       attr_reader :exit_code
 
-      def initialize(msg = _("An unexpected error has occurred, try running the command again with --debug"), exit_code=1)
+      def initialize(msg = _('An unexpected error has occurred, try running the command again with --debug'), exit_code = 1)
         @exit_code = exit_code
         super(msg)
       end

data/lib/pdk/cli/exec.rb

@@ -1,50 +1,175 @@
+require 'bundler'
 require 'childprocess'
 require 'tempfile'
+require 'tty-spinner'
 
 module PDK
   module CLI
     module Exec
-      # TODO: decide how to handle multiple output targets when underlying tool doesn't support that
-      # TODO: decide what this method should return
-      # TODO: decide how/when to connect stdin to child process for things like pry
       def self.execute(*cmd)
-        process = ChildProcess.build(*cmd)
+        Command.new(*cmd).execute!
+      end
 
-        process.io.stdout = Tempfile.new('stdout')
-        process.io.stderr = Tempfile.new('stderr')
+      def self.pdk_basedir
+        @pdk_basedir ||= Gem.win_platform? ? 'C:/Program Files/Puppet Labs/DevelopmentKit' : '/opt/puppetlabs/sdk'
+      end
 
-        begin
-          # start the process
-          process.start
+      def self.git_bindir
+        @git_dir ||= File.join(pdk_basedir, 'private', 'git', Gem.win_platform? ? 'cmd' : 'bin')
+      end
 
-          # wait indefinitely for process to exit...
-          process.wait
+      def self.git(*args)
+        git_bin = Gem.win_platform? ? 'git.exe' : 'git'
+        vendored_bin_path = File.join(git_bindir, git_bin)
 
-          stdout = process.io.stdout.open.read
-          stderr = process.io.stderr.open.read
-        ensure
-          process.io.stdout.close
-          process.io.stderr.close
-        end
+        execute(try_vendored_bin(vendored_bin_path, git_bin), *args)
+      end
+
+      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)
 
-        {
-          :exit_code => process.exit_code,
-          :stdout => stdout,
-          :stderr => stderr
-        }
+        execute(try_vendored_bin(vendored_bin_path, bundle_bin), *args)
       end
 
-      def self.pdk_basedir
-        @pdk_basedir ||= Gem.win_platform? ? 'C:/Program Files/Puppet Labs/DevelopmentKit' : '/opt/puppetlabs/sdk'
+      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)
+
+        try_vendored_bin(vendored_bin_path, bundle_bin)
       end
 
-      def self.git_bindir
-        @git_dir ||= File.join(pdk_basedir, 'private', 'git', 'bin')
+      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
+        else
+          PDK.logger.debug(_("Trying '%{fallback}' from the system PATH, instead of '%{vendored_bin_path}'") % { fallback: fallback, vendored_bin_path: vendored_bin_path })
+          fallback
+        end
       end
 
-      def self.git(*args)
-        git_path = ENV['PDK_USE_SYSTEM_BINARIES'].nil? ? File.join(git_bindir, 'git') : 'git'
-        execute(git_path, *args)
+      # TODO: decide how/when to connect stdin to child process for things like pry
+      # TODO: need a way to set callbacks on new stdout/stderr data
+      class Command
+        attr_reader :argv
+        attr_reader :context
+        attr_accessor :timeout
+
+        def initialize(*argv)
+          @argv = argv
+
+          @process = ChildProcess.build(*@argv)
+          @process.leader = true
+
+          @stdout = Tempfile.new('stdout').tap { |io| io.sync = true }
+          @stderr = Tempfile.new('stderr').tap { |io| io.sync = true }
+
+          @process.io.stdout = @stdout
+          @process.io.stderr = @stderr
+
+          # Default to running things in the system context.
+          @context = :system
+        end
+
+        def context=(new_context)
+          unless [:system, :module].include?(new_context)
+            raise ArgumentError, _("Expected execution context to be :system or :module but got '%{context}'") % { context: new_contenxt }
+          end
+
+          @context = new_context
+        end
+
+        def add_spinner(message, opts = {})
+          @success_message = opts.delete(:success)
+          @failure_message = opts.delete(:failure)
+
+          @spinner = TTY::Spinner.new("[:spinner] #{message}", opts)
+        end
+
+        def execute!
+          # Start spinning if configured.
+          @spinner.auto_spin if @spinner
+
+          if context == :module
+            # 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
+
+            Dir.chdir(PDK::Util.module_root) do
+              ::Bundler.with_clean_env do
+                run_process!
+              end
+            end
+          else
+            run_process!
+          end
+
+          # Stop spinning when done (if configured).
+          if @spinner
+            if @process.exit_code.zero?
+              @spinner.success(@success_message || '')
+            else
+              @spinner.error(@failure_message || '')
+            end
+          end
+
+          @stdout.rewind
+          @stderr.rewind
+
+          process_data = {
+            stdout: @stdout.read,
+            stderr: @stderr.read,
+            exit_code: @process.exit_code,
+          }
+
+          return process_data
+        ensure
+          @stdout.close
+          @stderr.close
+        end
+
+        protected
+
+        def run_process!
+          begin
+            @process.start
+          rescue ChildProcess::LaunchError => e
+            msg = if @process.respond_to?(:argv)
+                    _("Failed to execute '%{command}': %{message}") % { command: @process.argv.join(' '), message: e.message }
+                  else
+                    _('Failed to execute process: %{message}') % { message: e.message }
+                  end
+            raise PDK::CLI::FatalError, msg
+          end
+
+          if timeout
+            begin
+              @process.poll_for_exit(timeout)
+            rescue ChildProcess::TimeoutError
+              @process.stop # tries increasingly harsher methods to kill the process.
+            end
+          else
+            # Wait indfinitely if no timeout set.
+            @process.wait
+          end
+        end
+
+        def pdk_gem_path
+          @pdk_gem_path ||= find_pdk_gem_path
+        end
+
+        def find_pdk_gem_path
+          # /opt/puppetlabs/sdk/private/ruby/2.1.9/lib/ruby/gems/2.1.0
+          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
     end
   end