pdk 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7118858cde5b6a4ea492a22683a8a077386d31e00157469186a373f91d8559
-  data.tar.gz: 4feab9cf89fd58a0c4023d04905efaccb56021dc7f44d0110b332de0fd1c7781
+  metadata.gz: d1b4321e6c37cde43ae58cb4ca94cd578254270065c698c87455aa37976cea36
+  data.tar.gz: 054d826aefa38e7697d7b45e6f9c6733f4ad2f36501c9cb34dab7c1c6e47d2af
 SHA512:
-  metadata.gz: 63e8e385a5f17a12dd36d3d6938ee601e0020b0e8b55603ec409d111cd0add4f5b748c1cc493b7612d02381d1832d56ab7de7c933ab85c9773eee463e9c60dc9
-  data.tar.gz: 33063bc92b0d8678cf2ac33333e23a1c3ca2d51bfece32eb326376f8681334e8b9574cf9a9df9c19da931248afc88197c0367e4659a81df9b96fca3ab6ba74fa
+  metadata.gz: 6ab2eba8dc386d45b6894a4aac0e17ff24208890fd73932cdebc10e9ffa0405e30280de45fc6190f24e3042b2ad7b208714171f581922be1a7bc601d6d212934
+  data.tar.gz: 52da98af48384e23b1fb2ca97dc1ad77d4811aa9f5dc6d9eaa89f9894e6d33a7e533b3b612699a33f9bbb02a3b29bd64a9b9b498cf04130288d16c78399f8b8b

data/CHANGELOG.md

@@ -4,6 +4,33 @@ All changes to this repo will be documented in this file.
 See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) for a high-level summary.
 
 
+## [v1.15.0](https://github.com/puppetlabs/pdk/tree/v1.15.0) (2019-12-13)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.14.1...v1.15.0)
+
+**Implemented enhancements:**
+
+- \(PDK-1488\) Inform user if updating a pinned module [\#816](https://github.com/puppetlabs/pdk/pull/816) ([rodjek](https://github.com/rodjek))
+- \(PDK-1487\) Add --default-template flag to pdk convert [\#814](https://github.com/puppetlabs/pdk/pull/814) ([rodjek](https://github.com/rodjek))
+- \(GH-808\) Implement pdk release prep and publish subcommands [\#813](https://github.com/puppetlabs/pdk/pull/813) ([glennsarti](https://github.com/glennsarti))
+- \(GH-808\) Implement pdk release subcommand [\#809](https://github.com/puppetlabs/pdk/pull/809) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1364\) Allow non-git template directories to be used [\#803](https://github.com/puppetlabs/pdk/pull/803) ([glennsarti](https://github.com/glennsarti))
+
+**Fixed bugs:**
+
+- \(UI\) Remove UTF-8 "smart quotes" from PDK output [\#806](https://github.com/puppetlabs/pdk/issues/806)
+- \(GH-808\) Fix prompt for pdk release [\#812](https://github.com/puppetlabs/pdk/pull/812) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1169\) Add VMWare fallback to PDK::Util::Filesystem.mv [\#802](https://github.com/puppetlabs/pdk/pull/802) ([rodjek](https://github.com/rodjek))
+
+**Closed issues:**
+
+- Implement `pdk release` command as per RFC \(part 1\) [\#808](https://github.com/puppetlabs/pdk/issues/808)
+- Cannot install pdk 1.14.1.0-1xenial deb - Operation not permitted [\#798](https://github.com/puppetlabs/pdk/issues/798)
+
+**Merged pull requests:**
+
+- \(\#806\) Use ASCII quotes instead of Unicode quotes [\#807](https://github.com/puppetlabs/pdk/pull/807) ([rodjek](https://github.com/rodjek))
+- \(PDK-1523\) Refactor filesystem operations to use PDK::Util::Filesystem [\#799](https://github.com/puppetlabs/pdk/pull/799) ([rodjek](https://github.com/rodjek))
+
 ## [v1.14.1](https://github.com/puppetlabs/pdk/tree/v1.14.1) (2019-11-01)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.14.0...v1.14.1)
 

data/lib/pdk/answer_file.rb

@@ -6,8 +6,6 @@ module PDK
     attr_reader :answers
     attr_reader :answer_file_path
 
-    include PDK::Util::Filesystem
-
     # Initialises the AnswerFile object, which stores the responses to certain
     # interactive questions.
     #
@@ -64,15 +62,15 @@ module PDK
     #
     # @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)
+      return {} if !PDK::Util::Filesystem.file?(answer_file_path) || PDK::Util::Filesystem.zero?(answer_file_path)
 
-      unless File.readable?(answer_file_path)
+      unless PDK::Util::Filesystem.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))
+      answers = JSON.parse(PDK::Util::Filesystem.read_file(answer_file_path))
       if answers.is_a?(Hash)
         answers
       else
@@ -92,9 +90,9 @@ module PDK
     #
     # @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))
+      PDK::Util::Filesystem.mkdir_p(File.dirname(answer_file_path))
 
-      write_file(answer_file_path, JSON.pretty_generate(answers))
+      PDK::Util::Filesystem.write_file(answer_file_path, JSON.pretty_generate(answers))
     rescue SystemCallError, IOError => e
       raise PDK::CLI::FatalError, _("Unable to write '%{file}': %{msg}") % {
         file: answer_file_path,

data/lib/pdk/cli.rb

@@ -167,6 +167,7 @@ module PDK::CLI
   require 'pdk/cli/validate'
   require 'pdk/cli/module'
   require 'pdk/cli/console'
+  require 'pdk/cli/release'
 
   @base_cmd.add_command Cri::Command.new_basic_help
 end

data/lib/pdk/cli/console.rb

@@ -84,7 +84,7 @@ EOF
 
     def check_fixtures_dir
       existing_path = base_module_path.split(':').find do |path|
-        Dir.exist?(path) && Dir.entries(path).length > 2
+        PDK::Util::Filesystem.directory?(path) && Dir.entries(path).length > 2
       end
       PDK.logger.warn _('Module fixtures not found, please run pdk bundle exec rake spec_prep.') unless existing_path
     end

data/lib/pdk/cli/convert.rb

@@ -11,6 +11,7 @@ module PDK::CLI
     flag nil, :noop, _('Do not convert the module, just output what would be done.')
     flag nil, :force, _('Convert the module automatically, with no prompts.')
     flag nil, :'add-tests', _('Add any missing tests while converting the module.')
+    flag nil, :'default-template', _('Convert the module to use the default PDK template.')
 
     run do |opts, _args, _cmd|
       require 'pdk/module/convert'
@@ -22,12 +23,19 @@ module PDK::CLI
         log_level:           :info,
       )
 
-      PDK::CLI::Util.validate_template_opts(opts)
-
       if opts[:noop] && opts[:force]
         raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when converting a module')
       end
 
+      if opts[:'default-template']
+        raise PDK::CLI::ExitWithError, _('You can not specify --template-url and --default-template.') if opts[:'template-url']
+
+        opts[:'template-url'] = PDK::Util::TemplateURI.default_template_addressable_uri.to_s
+        PDK.answers.update!('template-url' => nil)
+      end
+
+      PDK::CLI::Util.validate_template_opts(opts)
+
       PDK::CLI::Util.analytics_screen_view('convert', opts)
 
       if opts[:'skip-interview'] && opts[:'full-interview']

data/lib/pdk/cli/exec.rb

@@ -67,7 +67,8 @@ module PDK
 
         vendored_bin_full_path = File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
 
-        unless File.exist?(vendored_bin_full_path)
+        require 'pdk/util/filesystem'
+        unless PDK::Util::Filesystem.exist?(vendored_bin_full_path)
           PDK.logger.debug(_("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % {
             fallback: fallback,
             vendored_bin: vendored_bin_full_path,

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

@@ -5,7 +5,7 @@ module PDK::CLI
     summary _('This command is now \'pdk build\'.')
 
     run do |_opts, _args, _cmd|
-      PDK.logger.warn(_('Modules are built using the ‘pdk build’ command.'))
+      PDK.logger.warn(_("Modules are built using the 'pdk build' command."))
       exit 1
     end
   end

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

@@ -21,7 +21,7 @@ module PDK::CLI
 
       PDK::CLI::Util.validate_template_opts(opts)
 
-      PDK.logger.info(_('New modules are created using the ‘pdk new module’ command.'))
+      PDK.logger.info(_("New modules are created using the 'pdk new module' command."))
       prompt = TTY::Prompt.new(help_color: :cyan)
       redirect = PDK::CLI::Util::CommandRedirector.new(prompt)
       redirect.target_command('pdk new module')

data/lib/pdk/cli/release.rb

@@ -0,0 +1,192 @@
+require 'pdk/cli/util'
+require 'pdk/validate'
+require 'pdk/util/bundler'
+require 'pdk/cli/util/interview'
+require 'pdk/util/changelog_generator'
+require 'pdk/module/build'
+
+module PDK::CLI
+  @release_cmd = @base_cmd.define_command do
+    name 'release'
+    usage _('release [options]')
+    summary _('(Experimental) Release a module to the Puppet Forge.')
+
+    flag nil, :force,                _('Release the module automatically, with no prompts.')
+    flag nil, :'skip-validation',    _('Skips the module validation check.')
+    flag nil, :'skip-changelog',     _('Skips the automatic changelog generation.')
+    flag nil, :'skip-dependency',    _('Skips the module dependency check.')
+    flag nil, :'skip-documentation', _('Skips the documentation update.')
+    flag nil, :'skip-build',         _('Skips module build.')
+    flag nil, :'skip-publish',       _('Skips publishing the module to the forge.')
+
+    option nil, :'forge-upload-url', _('Set forge upload url path.'),
+           argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
+
+    option nil, :'forge-token', _('Set Forge API token.'), argument: :required, default: nil
+
+    option nil, :version, _('Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.'),
+           argument: :required
+
+    option nil, :file, _('Path to the built module to push to the Forge. This option can only be used when --skip-build is also used. Defaults to pkg/<module version>.tar.gz'),
+           argument: :required
+
+    run do |opts, _args, _cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('`pdk release` can only be run from inside a valid module with a metadata.json.'),
+        log_level: :info,
+      )
+
+      Release.prepare_interview(opts) unless opts[:force]
+
+      Release.send_analytics('release', opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      Release.module_compatibility_checks!(release, opts)
+
+      release.run
+    end
+  end
+
+  module Release
+    # Checks whether the module is compatible with PDK release process
+    # @param release PDK::Module::Release Object representing the release
+    # @param opts Options Hash from Cri
+    def self.module_compatibility_checks!(release, opts)
+      unless release.module_metadata.forge_ready?
+        if opts[:force]
+          PDK.logger.warn _(
+            'This module is missing the following fields in the metadata.json: %{fields}. ' \
+            'These missing fields may affect the visibility of the module on the Forge.',
+          ) % {
+            fields: release.module_metadata.missing_fields.join(', '),
+          }
+        else
+          release.module_metadata.interview_for_forge!
+          release.write_module_metadata!
+        end
+      end
+
+      unless release.pdk_compatible? # rubocop:disable Style/GuardClause Nope!
+        if opts[:force]
+          PDK.logger.warn _('This module is not compatible with PDK, so PDK can not validate or test this build.')
+        else
+          PDK.logger.info _('This module is not compatible with PDK, so PDK can not validate or test this build. ' \
+                            'Unvalidated modules may have errors when uploading to the Forge. ' \
+                            'To make this module PDK compatible and use validate features, cancel the build and run `pdk convert`.')
+          unless PDK::CLI::Util.prompt_for_yes(_('Continue build without converting?'))
+            PDK.logger.info _('Build cancelled; exiting.')
+            PDK::Util.exit_process(1)
+          end
+        end
+      end
+    end
+
+    # Send_analytics for the given command and Cri options
+    def self.send_analytics(command, opts)
+      # Don't pass tokens to analytics
+      PDK::CLI::Util.analytics_screen_view(command, opts.reject { |k, _| k == :'forge-token' })
+    end
+
+    def self.prepare_interview(opts)
+      questions = []
+
+      unless opts[:'skip-validation']
+        questions << {
+          name:     'validation',
+          question: _('Do you want to run the module validation ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-changelog']
+        questions << {
+          name:     'changelog',
+          question: _('Do you want to run the automatic changelog generation ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:version]
+        questions << {
+          name:     'setversion',
+          question: _('Do you want to set the module version ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-dependency']
+        questions << {
+          name:     'dependency',
+          question: _('Do you want to run the dependency-checker on this module?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-documentation']
+        questions << {
+          name:     'documentation',
+          question: _('Do you want to update the documentation for this module?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-publish']
+        questions << {
+          name:     'publish',
+          question: _('Do you want to publish the module on the Puppet Forge?'),
+          type:     :yes,
+        }
+      end
+
+      prompt = TTY::Prompt.new(help_color: :cyan)
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      answers = interview.run
+
+      unless answers.nil?
+        opts[:'skip-validation'] = !answers['validation']
+        opts[:'skip-changelog'] = !answers['changelog']
+        opts[:'skip-dependency'] = !answers['dependency']
+        opts[:'skip-documentation'] = !answers['documentation']
+
+        prepare_version_interview(prompt, opts) if answers['setversion']
+
+        prepare_publish_interview(prompt, opts) if answers['publish']
+      end
+      answers
+    end
+
+    def self.prepare_version_interview(prompt, opts)
+      questions = [
+        {
+          name:             'version',
+          question:         _('Please set the module version'),
+          help:             _('This value is the version that will be used in the changelog generator and building of the module.'),
+          required:         true,
+          validate_pattern: %r{(\*|\d+(\.\d+){0,2}(\.\*)?)$}i,
+          validate_message: _('The version format should be in the format x.y.z where x represents the major version, y the minor version and z the build number.'),
+        },
+      ]
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      ver_answer = interview.run
+      opts[:version] = ver_answer['version']
+    end
+
+    def self.prepare_publish_interview(prompt, opts)
+      return if opts[:'forge-token']
+      questions = [
+        {
+          name:             'apikey',
+          question:         _('Please set the api key(authorization token) to upload on the Puppet Forge'),
+          help:             _('This value is used for authentication on the Puppet Forge to upload your module tarball.'),
+          required:         true,
+        },
+      ]
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      api_answer = interview.run
+      opts[:'forge-token'] = api_answer['apikey']
+    end
+  end
+end
+
+require 'pdk/cli/release/prep'
+require 'pdk/cli/release/publish'

data/lib/pdk/cli/release/prep.rb

@@ -0,0 +1,39 @@
+require 'pdk/cli/release'
+
+module PDK::CLI
+  @release_prep_cmd = @release_cmd.define_command do
+    name 'prep'
+    usage _('prep [options]')
+    summary _('(Experimental) Performs all the pre-release checks to ensure module is ready to be released')
+
+    flag nil, :force,                _('Prepare the module automatically, with no prompts.')
+    flag nil, :'skip-validation',    _('Skips the module validation check.')
+    flag nil, :'skip-changelog',     _('Skips the automatic changelog generation.')
+    flag nil, :'skip-dependency',    _('Skips the module dependency check.')
+    flag nil, :'skip-documentation', _('Skips the documentation update.')
+
+    option nil, :version, _('Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.'),
+           argument: :required
+
+    run do |opts, _args, cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _("`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json."),
+        log_level: :info,
+      )
+
+      opts[:'skip-build'] = true
+      opts[:'skip-publish'] = true
+
+      Release.prepare_interview(opts) unless opts[:force]
+
+      Release.send_analytics("release #{cmd.name}", opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      Release.module_compatibility_checks!(release, opts)
+
+      release.run
+    end
+  end
+end

data/lib/pdk/cli/release/publish.rb

@@ -0,0 +1,40 @@
+require 'pdk/cli/release'
+
+module PDK::CLI
+  @release_publish_cmd = @release_cmd.define_command do
+    name 'publish'
+    usage _('publish [options] <tarball>')
+    summary _('(Experimental) Publishes the module <tarball> to the Forge.')
+
+    flag nil, :force,                _('Publish the module automatically, with no prompts.')
+
+    option nil, :'forge-upload-url', _('Set forge upload url path.'),
+           argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
+
+    option nil, :'forge-token', _('Set Forge API token.'), argument: :required, default: nil
+
+    run do |opts, _args, cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _("`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json."),
+        log_level: :info,
+      )
+
+      opts[:'skip-validation'] = true
+      opts[:'skip-changelog'] = true
+      opts[:'skip-dependency'] = true
+      opts[:'skip-documentation'] = true
+      opts[:'skip-build'] = true
+      opts[:'skip-versionset'] = true
+      opts[:force] = true unless PDK::CLI::Util.interactive?
+
+      Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
+
+      Release.send_analytics("release #{cmd.name}", opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      release.run
+    end
+  end
+end

data/lib/pdk/cli/update.rb

@@ -48,6 +48,18 @@ module PDK::CLI
 
       updater = PDK::Module::Update.new(opts)
 
+      if updater.pinned_to_puppetlabs_template_tag?
+        PDK.logger.info _(
+          'This module is currently pinned to version %{current_version} ' \
+          'of the default template. If you would like to update your ' \
+          'module to the latest version of the template, please run `pdk ' \
+          'update --template-ref %{new_version}`.',
+        ) % {
+          current_version: updater.template_uri.uri_fragment,
+          new_version:     PDK::TEMPLATE_REF,
+        }
+      end
+
       updater.run
     end
   end