pdk 1.17.0 → 2.1.1

data/README.md

@@ -1,4 +1,4 @@
-# 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) [![Coverage Status](https://coveralls.io/repos/github/puppetlabs/pdk/badge.svg?branch=master)](https://coveralls.io/github/puppetlabs/pdk?branch=master)
+# pdk [![Build Status](https://travis-ci.org/puppetlabs/pdk.svg?branch=main)](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) [![Coverage Status](https://coveralls.io/repos/github/puppetlabs/pdk/badge.svg?branch=main)](https://coveralls.io/github/puppetlabs/pdk?branch=main)
 
 * [Installation](#installation)
 * [Basic usage](#basic-usage)

data/lib/pdk.rb

@@ -11,7 +11,7 @@ module PDK
   autoload :Logger, 'pdk/logger'
   autoload :Module, 'pdk/module'
   autoload :Report, 'pdk/report'
-  autoload :TemplateFile, 'pdk/template_file'
+  autoload :Template, 'pdk/template'
   autoload :TEMPLATE_REF, 'pdk/version'
   autoload :Util, 'pdk/util'
   autoload :Validate, 'pdk/validate'

data/lib/pdk/cli.rb

@@ -5,7 +5,10 @@ require 'pdk/cli/errors'
 
 module TTY
   autoload :Prompt, 'tty/prompt'
-  autoload :TestPrompt, 'tty/test_prompt'
+
+  class Prompt
+    autoload :Test, 'tty/prompt/test'
+  end
 end
 
 class Cri::Command::CriExitException
@@ -156,14 +159,17 @@ module PDK::CLI
   require 'pdk/cli/build'
   require 'pdk/cli/config'
   require 'pdk/cli/convert'
+  require 'pdk/cli/env'
   require 'pdk/cli/get'
   require 'pdk/cli/new'
+  require 'pdk/cli/set'
   require 'pdk/cli/test'
   require 'pdk/cli/update'
   require 'pdk/cli/validate'
   require 'pdk/cli/module'
   require 'pdk/cli/console'
   require 'pdk/cli/release'
+  require 'pdk/cli/remove'
 
   @base_cmd.add_command Cri::Command.new_basic_help
 end

data/lib/pdk/cli/convert.rb

@@ -14,14 +14,12 @@ module PDK::CLI
     flag nil, :'default-template', _('Convert the module to use the default PDK template.')
 
     run do |opts, _args, _cmd|
-      require 'pdk/module/convert'
-      require 'pdk/cli/util'
+      # Write the context information to the debug log
+      PDK.context.to_debug_log
 
-      PDK::CLI::Util.ensure_in_module!(
-        check_module_layout: true,
-        message:             _('`pdk convert` can only be run from inside a valid module directory.'),
-        log_level:           :info,
-      )
+      unless PDK.context.is_a?(PDK::Context::Module)
+        raise PDK::CLI::ExitWithError, _('`pdk convert` can only be run from inside a valid module directory.')
+      end
 
       if opts[:noop] && opts[:force]
         raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when converting a module')
@@ -31,7 +29,7 @@ module PDK::CLI
         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.config.user['module_defaults']['template-url'] = nil
+        PDK.config.set(%w[user module_defaults template-url], nil)
       end
 
       PDK::CLI::Util.validate_template_opts(opts)
@@ -48,7 +46,7 @@ module PDK::CLI
         opts[:'full-interview'] = false
       end
 
-      PDK::Module::Convert.invoke(PDK::Util.module_root, opts)
+      PDK::Module::Convert.invoke(PDK.context.root_path, opts)
     end
   end
 end

data/lib/pdk/cli/env.rb

@@ -0,0 +1,52 @@
+module PDK::CLI
+  @env_cmd = @base_cmd.define_command do
+    name 'env'
+    usage _('env')
+    summary _('(Experimental) Output environment variables for specific Puppet context')
+    description _(<<-EOF
+[experimental] Aids in setting a CLI context for a specified version of Puppet by outputting export commands for necessary environment variables.
+EOF
+                 )
+
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+
+    run do |opts, _args, _cmd|
+      require 'pdk/util'
+      require 'pdk/util/ruby_version'
+
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
+      PDK::CLI::Util.analytics_screen_view('env')
+
+      # Ensure that the correct Ruby is activated before running command.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      resolved_env = {
+        'PDK_RESOLVED_PUPPET_VERSION' => puppet_env[:gemset][:puppet],
+        'PDK_RESOLVED_RUBY_VERSION' => puppet_env[:ruby_version],
+      }
+
+      resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
+      gem_path = PDK::Util::RubyVersion.gem_path
+      resolved_env['GEM_PATH'] = gem_path.empty? ? resolved_env['GEM_HOME'] : gem_path
+
+      # Make sure invocation of Ruby prefers our private installation.
+      package_binpath = PDK::Util.package_install? ? File.join(PDK::Util.pdk_package_basedir, 'bin') : nil
+
+      resolved_env['PATH'] = [
+        PDK::Util::RubyVersion.bin_path,
+        File.join(resolved_env['GEM_HOME'], 'bin'),
+        PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
+        package_binpath,
+        PDK::Util::Env['PATH'],
+      ].compact.flatten.join(File::PATH_SEPARATOR)
+
+      resolved_env.each do |var, val|
+        puts "export #{var}=\"#{val}\""
+      end
+      exit 0
+    end
+  end
+end

data/lib/pdk/cli/exec/command.rb

@@ -27,7 +27,17 @@ module PDK
           @argv = argv
 
           @process = ChildProcess.build(*@argv)
-          @process.leader = true
+          # https://github.com/puppetlabs/pdk/issues/1083:
+          # When @process.leader is set, childprocess will set the CREATE_BREAKAWAY_FROM_JOB
+          # and JOB_OBJECT_LIMIT_BREAKAWAY_OK flags in the Win32 API calls. This will cause
+          # issues on systems > Windows 7 / Server 2008, if the JOB_OBJECT_LIMIT_BREAKAWAY_OK
+          # flag is set and the Task Scheduler is trying to kick off a job, it can sometimes
+          # result in ACCESS_DENIED being returned by the Win32 API, depending on the permission
+          # levels / user account this user.
+          # The resolution for pdk/issues/1083 is to ensure @process.leader is not set.
+          # This will potentially cause issues on older Windows systems, in which case we may
+          # need to revisit and conditionally set this param depending on what OS we're on
+          # @process.leader = true
 
           @stdout = Tempfile.new('stdout', mode: TEMPFILE_MODE).tap { |io| io.sync = true }
           @stderr = Tempfile.new('stderr', mode: TEMPFILE_MODE).tap { |io| io.sync = true }

data/lib/pdk/cli/new.rb

@@ -17,3 +17,5 @@ require 'pdk/cli/new/provider'
 require 'pdk/cli/new/task'
 require 'pdk/cli/new/test'
 require 'pdk/cli/new/transport'
+require 'pdk/cli/new/fact'
+require 'pdk/cli/new/function'

data/lib/pdk/cli/new/class.rb

@@ -25,7 +25,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_class', opts)
 
-      PDK::Generate::PuppetClass.new(PDK::Util.module_root, class_name, opts).run
+      updates = PDK::Generate::PuppetClass.new(PDK.context, class_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/new/defined_type.rb

@@ -25,7 +25,8 @@ module PDK::CLI
 
       require 'pdk/generate/defined_type'
 
-      PDK::Generate::DefinedType.new(PDK::Util.module_root, defined_type_name, opts).run
+      updates = PDK::Generate::DefinedType.new(PDK.context, defined_type_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/new/fact.rb

@@ -0,0 +1,29 @@
+module PDK::CLI
+  @new_fact_cmd = @new_cmd.define_command do
+    name 'fact'
+    usage _('fact [options] <name>')
+    summary _('Create a new custom fact named <name> using given options')
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      fact_name = args[0]
+
+      if fact_name.nil? || fact_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_fact_name?(fact_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid fact name") % { name: fact_name }
+      end
+
+      PDK::CLI::Util.analytics_screen_view('new_fact', opts)
+
+      require 'pdk/generate/fact'
+
+      updates = PDK::Generate::Fact.new(PDK.context, fact_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+    end
+  end
+end

data/lib/pdk/cli/new/function.rb

@@ -0,0 +1,29 @@
+module PDK::CLI
+  @new_function_cmd = @new_cmd.define_command do
+    name 'function'
+    usage _('function [options] <name>')
+    summary _('Create a new function named <name> using given options')
+    option :t, :type, _('The function type, (native or v4)'), argument: :required, default: 'native'
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      function_name = args[0]
+
+      if function_name.nil? || function_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_function_name?(function_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid function name") % { name: function_name }
+      end
+
+      PDK::CLI::Util.analytics_screen_view('new_function', opts)
+
+      require 'pdk/generate/function'
+      updates = PDK::Generate::Function.new(PDK.context, function_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+    end
+  end
+end

data/lib/pdk/cli/new/provider.rb

@@ -22,7 +22,8 @@ module PDK::CLI
 
       require 'pdk/generate/provider'
 
-      PDK::Generate::Provider.new(PDK::Util.module_root, provider_name, opts).run
+      updates = PDK::Generate::Provider.new(PDK.context, provider_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/new/task.rb

@@ -27,7 +27,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_task', opts)
 
-      PDK::Generate::Task.new(PDK::Util.module_root, task_name, opts).run
+      updates = PDK::Generate::Task.new(PDK.context, task_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/new/test.rb

@@ -40,7 +40,8 @@ module PDK::CLI
 
         PDK::CLI::Util.analytics_screen_view('new_test', opts)
 
-        generator.new(PDK::Util.module_root, obj['name'], opts.merge(spec_only: true)).run
+        updates = generator.new(PDK.context, obj['name'], opts.merge(spec_only: true)).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
       rescue PDK::Util::PuppetStrings::NoObjectError
         raise PDK::CLI::ExitWithError, _('Unable to find anything called "%{object}" to generate unit tests for.') % { object: object_name }
       rescue PDK::Util::PuppetStrings::NoGeneratorError => e

data/lib/pdk/cli/new/transport.rb

@@ -20,7 +20,8 @@ module PDK::CLI
 
       require 'pdk/generate/transport'
 
-      PDK::Generate::Transport.new(PDK::Util.module_root, transport_name, opts).run
+      updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/release.rb

@@ -22,7 +22,7 @@ module PDK::CLI
     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, :'forge-token', _('Set Forge API token.'), 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

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

@@ -11,7 +11,7 @@ module PDK::CLI
     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, :'forge-token', _('Set Forge API token (you may also set via environment variable PDK_FORGE_TOKEN)'), argument: :required
 
     run do |opts, _args, cmd|
       # Make sure build is being run in a valid module directory with a metadata.json
@@ -27,6 +27,16 @@ module PDK::CLI
       opts[:'skip-build'] = true
       opts[:'skip-versionset'] = true
       opts[:force] = true unless PDK::CLI::Util.interactive?
+      opts[:'forge-token'] ||= PDK::Util::Env['PDK_FORGE_TOKEN']
+
+      if opts[:'forge-token'].nil? || opts[:'forge-token'].empty?
+        PDK.logger.error _(
+          'You must supply a Forge API token either via `--forge-token` option ' \
+          'or PDK_FORGE_TOKEN environment variable.',
+        )
+
+        exit 1
+      end
 
       Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
 

data/lib/pdk/cli/remove.rb

@@ -0,0 +1,20 @@
+module PDK::CLI
+  @remove_cmd = @base_cmd.define_command do
+    name 'remove'
+    usage _('remove [subcommand] [options]')
+    summary _('Remove or delete information about the PDK or current project.')
+    default_subcommand 'help'
+
+    run do |_opts, args, _cmd|
+      if args == ['help']
+        PDK::CLI.run(%w[remove --help])
+        exit 0
+      end
+
+      PDK::CLI.run(%w[remove help]) if args.empty?
+    end
+  end
+  @remove_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/remove/config'

data/lib/pdk/cli/remove/config.rb

@@ -0,0 +1,80 @@
+module PDK::CLI
+  module Remove
+    module Config
+      def self.run(opts, args)
+        item_name = (args.count > 0) ? args[0] : nil
+        item_value = (args.count > 1) ? args[1].strip : nil
+        item_value = nil if !item_value.nil? && item_value.empty?
+
+        force = opts[:force] || false
+
+        raise PDK::CLI::ExitWithError, _('Configuration name is required') if item_name.nil?
+
+        current_value = PDK.config.get(item_name)
+        raise PDK::CLI::ExitWithError, _("The configuration item '%{name}' can not be removed.") % { name: item_name } if current_value.is_a?(PDK::Config::Namespace)
+        if current_value.nil?
+          PDK.logger.info(_("Could not remove '%{name}' as it has not been set") % { name: item_name })
+          return 0
+        end
+
+        PDK.logger.info(_("Ignoring the item value '%{value}' as --force has been set") % { value: item_value }) if current_value.is_a?(Array) && !item_value.nil? && force
+        PDK.logger.info(_('Ignoring --force as the setting is not multi-valued')) if !current_value.is_a?(Array) && force
+
+        # FIXME: It'd be nice to shortcircuit deleting default values.  This causes the configuration file
+        # to be saved, even though nothing actually changes
+
+        # For most value types, just changing the value to nil is enough, however Arrays are a special case.
+        # Unless they're forced, array removal with either remove a single entry (matched by .to_s) or clear the
+        # array.  When forced, the array is completed removed just like a string or number.
+        if current_value.is_a?(Array) && !force
+          # If the user didn't set a value then set the array as empty, otherwise remove that one item
+          new_value = item_value.nil? ? [] : current_value.reject { |item| item.to_s == item_value }
+          if current_value.count == new_value.count
+            if item_value.nil?
+              PDK.logger.info(_("Could not remove '%{name}' as it is already empty") % { name: item_name })
+            else
+              PDK.logger.info(_("Could not remove '%{value}' from '%{name}' as it has not been set") % { value: item_value, name: item_name })
+            end
+            return 0
+          end
+          PDK.config.set(item_name, new_value, force: true)
+        else
+          # Set the value to nil for deleting.
+          PDK.config.set(item_name, nil, force: true)
+        end
+
+        # Output the result to the user
+        new_value = PDK.config.get(item_name)
+        if current_value.is_a?(Array) && !force
+          # Arrays have a special output format. If item_value is nil then the user wanted to empty/clear
+          # the array otherwise they just wanted to remove a single entry.
+          if item_value.nil?
+            PDK.logger.info(_("Cleared '%{name}' which had a value of '%{from}'") % { name: item_name, from: current_value })
+          else
+            PDK.logger.info(_("Removed '%{value}' from '%{name}'") % { value: item_value, name: item_name })
+          end
+        elsif !new_value.nil?
+          PDK.logger.info(_("Could not remove '%{name}' as it using a default value of '%{to}'") % { name: item_name, to: new_value })
+        else
+          PDK.logger.info(_("Removed '%{name}' which had a value of '%{from}'") % { name: item_name, from: current_value })
+        end
+
+        # Same output as `get config`
+        $stdout.puts _('%{name}=%{value}') % { name: item_name, value: new_value }
+        0
+      end
+    end
+  end
+
+  @remove_config_cmd = @remove_cmd.define_command do
+    name 'config'
+    usage _('config [name] [value]')
+    summary _('Remove or delete the configuration for <name>')
+
+    option :f, :force, _('Force multi-value configuration settings to be removed instead of emptied.'), argument: :forbidden
+
+    run do |opts, args, _cmd|
+      exit PDK::CLI::Remove::Config.run(opts, args)
+    end
+  end
+end

data/lib/pdk/cli/set.rb

@@ -0,0 +1,20 @@
+module PDK::CLI
+  @set_cmd = @base_cmd.define_command do
+    name 'set'
+    usage _('set [subcommand] [options]')
+    summary _('Set or update information about the PDK or current project.')
+    default_subcommand 'help'
+
+    run do |_opts, args, _cmd|
+      if args == ['help']
+        PDK::CLI.run(%w[set --help])
+        exit 0
+      end
+
+      PDK::CLI.run(%w[set help]) if args.empty?
+    end
+  end
+  @set_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/set/config'