pdk-akerl 1.8.0.1

data/lib/pdk/cli/exec_group.rb

@@ -0,0 +1,67 @@
+require 'tty-spinner'
+require 'tty-which'
+
+require 'pdk/util'
+
+module PDK
+  module CLI
+    class ExecGroup
+      def initialize(message, opts = {})
+        @options = opts.merge(PDK::CLI::Util.spinner_opts_for_platform)
+
+        if PDK::CLI::Util.interactive?
+          @spinner = if parallel?
+                       TTY::Spinner::Multi.new("[:spinner] #{message}", @options)
+                     else
+                       TTY::Spinner.new("[:spinner] #{message}", @options)
+                     end
+          @spinner.auto_spin
+        end
+
+        @threads_or_procs = []
+        @exit_codes = []
+      end
+
+      def parallel?
+        @options[:parallel].nil? ? true : @options[:parallel]
+      end
+
+      def register(&block)
+        raise PDK::CLI::FatalError, 'No block registered' unless block_given?
+
+        @threads_or_procs << if parallel?
+                               Thread.new do
+                                 GettextSetup.initialize(File.absolute_path('../../../locales', File.dirname(__FILE__)))
+                                 GettextSetup.negotiate_locale!(GettextSetup.candidate_locales)
+                                 @exit_codes << yield
+                               end
+                             else
+                               block
+                             end
+      end
+
+      def add_spinner(message, opts = {})
+        return unless PDK::CLI::Util.interactive?
+        @spinner.register("[:spinner] #{message}", @options.merge(opts).merge(PDK::CLI::Util.spinner_opts_for_platform))
+      end
+
+      def exit_code
+        if parallel?
+          @threads_or_procs.each(&:join)
+        else
+          @exit_codes = @threads_or_procs.map(&:call)
+        end
+
+        exit_code = @exit_codes.max
+
+        if exit_code.zero? && @spinner
+          @spinner.success
+        elsif @spinner
+          @spinner.error
+        end
+
+        exit_code
+      end
+    end
+  end
+end

data/lib/pdk/cli/module.rb

@@ -0,0 +1,14 @@
+module PDK::CLI
+  @module_cmd = @base_cmd.define_command do
+    name 'module'
+    usage _('module [options]')
+    summary _('Provide CLI-backwards compatibility to the puppet module tool.')
+    description _('This command is only for reminding you how to accomplish tasks with the PDK, when you were previously doing them with the puppet module command.')
+    default_subcommand 'help'
+  end
+
+  @module_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/module/build'
+require 'pdk/cli/module/generate'

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

@@ -0,0 +1,14 @@
+require 'tty-prompt'
+
+module PDK::CLI
+  @module_build_cmd = @module_cmd.define_command do
+    name 'build'
+    usage _('build')
+    summary _('This command is now \'pdk build\'.')
+
+    run do |_opts, _args, _cmd|
+      PDK.logger.warn(_('Modules are built using the ‘pdk build’ command.'))
+      exit 1
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'tty-prompt'
+
+module PDK::CLI
+  @module_generate_cmd = @module_cmd.define_command do
+    name 'generate'
+    usage _('generate [options] <module_name>')
+    summary _('This command is now \'pdk new module\'.')
+
+    PDK::CLI.template_url_option(self)
+    PDK::CLI.skip_interview_option(self)
+
+    run do |opts, args, _cmd|
+      require 'pdk/generate/module'
+
+      module_name = args[0]
+
+      if module_name.nil? || module_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      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')
+      answer = redirect.run
+
+      if answer
+        module_name_parts = module_name.split('-', 2)
+        if module_name_parts.size > 1
+          opts[:username] = module_name_parts[0]
+          opts[:module_name] = module_name_parts[1]
+        else
+          opts[:module_name] = module_name
+        end
+        opts[:target_dir] = opts[:module_name]
+
+        PDK.logger.info(_('Creating new module: %{modname}') % { modname: module_name })
+        PDK::Generate::Module.invoke(opts)
+      else
+        exit 1
+      end
+    end
+  end
+end

data/lib/pdk/cli/new.rb

@@ -0,0 +1,17 @@
+module PDK::CLI
+  @new_cmd = @base_cmd.define_command do
+    name 'new'
+    usage _('new <thing> [options]')
+    summary _('create a new module, etc.')
+    description _('Creates a new <thing> using relevant options.')
+    default_subcommand 'help'
+  end
+
+  @new_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/new/class'
+require 'pdk/cli/new/defined_type'
+require 'pdk/cli/new/module'
+require 'pdk/cli/new/provider'
+require 'pdk/cli/new/task'

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

@@ -0,0 +1,32 @@
+module PDK::CLI
+  @new_class_cmd = @new_cmd.define_command do
+    name 'class'
+    usage _('class [options] <class_name>')
+    summary _('Create a new class named <class_name> using given options')
+
+    PDK::CLI.template_url_option(self)
+
+    run do |opts, args, _cmd|
+      require 'pdk/generate/puppet_class'
+
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('Classes can only be created from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      class_name = args[0]
+      module_dir = Dir.pwd
+
+      if class_name.nil? || class_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_class_name?(class_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid class name") % { name: class_name }
+      end
+
+      PDK::Generate::PuppetClass.new(module_dir, class_name, opts).run
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module PDK::CLI
+  @new_define_cmd = @new_cmd.define_command do
+    name 'defined_type'
+    usage _('defined_type [options] <name>')
+    summary _('Create a new defined type named <name> using given options')
+
+    PDK::CLI.template_url_option(self)
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!(
+        message: _('Defined types can only be created from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      defined_type_name = args[0]
+      module_dir = Dir.pwd
+
+      if defined_type_name.nil? || defined_type_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_defined_type_name?(defined_type_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid defined type name") % { name: defined_type_name }
+      end
+
+      PDK::Generate::DefinedType.new(module_dir, defined_type_name, opts).run
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module PDK::CLI
+  @new_module_cmd = @new_cmd.define_command do
+    name 'module'
+    usage _('module [options] [module_name] [target_dir]')
+    summary _('Create a new module named [module_name] using given options')
+
+    PDK::CLI.template_url_option(self)
+    PDK::CLI.skip_interview_option(self)
+    PDK::CLI.full_interview_option(self)
+
+    option nil, 'license', _('Specifies the license this module is written under. ' \
+      "This should be a identifier from https://spdx.org/licenses/. Common values are 'Apache-2.0', 'MIT', or 'proprietary'."), argument: :required
+    option nil, 'skip-bundle-install', _('Do not automatically run `bundle install` after creating the module.'), hidden: true
+
+    run do |opts, args, _cmd|
+      require 'pdk/generate/module'
+
+      module_name = args[0]
+      target_dir = args[1]
+
+      if opts[:'skip-interview'] && opts[:'full-interview']
+        PDK.logger.info _('Ignoring --full-interview and continuing with --skip-interview.')
+        opts[:'full-interview'] = false
+      end
+
+      unless module_name.nil? || module_name.empty?
+        module_name_parts = module_name.split('-', 2)
+        if module_name_parts.size > 1
+          opts[:username] = module_name_parts[0]
+          opts[:module_name] = module_name_parts[1]
+        else
+          opts[:module_name] = module_name
+        end
+        opts[:target_dir] = target_dir.nil? ? opts[:module_name] : target_dir
+      end
+
+      PDK.logger.info(_('Creating new module: %{modname}') % { modname: module_name })
+      PDK::Generate::Module.invoke(opts)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module PDK::CLI
+  @new_provider_cmd = @new_cmd.define_command do
+    name 'provider'
+    usage _('provider [options] <name>')
+    summary _('[experimental] Create a new ruby provider named <name> using given options')
+
+    PDK::CLI.template_url_option(self)
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      provider_name = args[0]
+      module_dir = Dir.pwd
+
+      if provider_name.nil? || provider_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_provider_name?(provider_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid provider name") % { name: provider_name }
+      end
+
+      PDK::Generate::Provider.new(module_dir, provider_name, opts).run
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module PDK::CLI
+  @new_task_cmd = @new_cmd.define_command do
+    name 'task'
+    usage _('task [options] <name>')
+    summary _('Create a new task named <name> using given options')
+
+    PDK::CLI.template_url_option(self)
+    option nil, :description, _('A short description of the purpose of the task'), argument: :required
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('Tasks can only be created from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      task_name = args[0]
+      module_dir = Dir.pwd
+
+      if task_name.nil? || task_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_task_name?(task_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid task name") % { name: task_name }
+      end
+
+      PDK::Generate::Task.new(module_dir, task_name, opts).run
+    end
+  end
+end

data/lib/pdk/cli/test.rb

@@ -0,0 +1,12 @@
+
+module PDK::CLI
+  @test_cmd = @base_cmd.define_command do
+    name 'test'
+    usage _('test [subcommand] [options]')
+    summary _('Run tests.')
+    default_subcommand 'help'
+  end
+  @test_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/test/unit'

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

@@ -0,0 +1,88 @@
+require 'pdk/cli/util/option_validator'
+require 'pdk/report'
+
+module PDK::CLI
+  @test_unit_cmd = @test_cmd.define_command do
+    name 'unit'
+    usage _('unit [options]')
+    summary _('Run unit tests.')
+
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+    flag nil, :list, _('List all available unit test files.')
+    flag nil, :parallel, _('Run unit tests in parallel.')
+    flag :v, :verbose, _('More verbose --list output. Displays a list of examples in each unit test file.')
+    flag :c, 'clean-fixtures', _('Clean up downloaded fixtures after the test run.')
+
+    option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
+      PDK::CLI::Util::OptionValidator.comma_separated_list?(values)
+    end
+
+    # TODO
+    # option nil, :runner_options, _("options to pass through to the actual test-runner"), argument: :required
+
+    run do |opts, _args, _cmd|
+      require 'pdk/tests/unit'
+
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('Unit tests can only be run from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      PDK::CLI::Util.module_version_check
+
+      report = nil
+
+      if opts[:list]
+        examples = PDK::Test::Unit.list
+        if examples.empty?
+          puts _('No unit test files with examples were found.')
+        else
+          puts _('Unit Test Files:')
+          files = examples.map { |example| example[:file_path] }
+          files.uniq.each do |file|
+            puts _(file)
+
+            next unless opts[:verbose]
+
+            file_examples = examples.select { |example| example[:file_path] == file }
+            file_examples.each do |file_example|
+              puts _("\t%{id}\t%{description}" % { id: file_example[:id], description: file_example[:full_description] })
+            end
+          end
+        end
+      else
+        PDK.logger.info _('--verbose has no effect when not used with --list') if opts[:verbose]
+
+        report = PDK::Report.new
+        report_formats = if opts[:format]
+                           PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
+                         else
+                           [{
+                             method: PDK::Report.default_format,
+                             target: PDK::Report.default_target,
+                           }]
+                         end
+
+        # Ensure that the bundled gems are up to date and correct Ruby is activated before running tests.
+        puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+        PDK::Util::PuppetVersion.fetch_puppet_dev if opts.key?(:'puppet-dev')
+        PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+        opts.merge!(puppet_env[:gemset])
+
+        PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+
+        exit_code = PDK::Test::Unit.invoke(report, opts)
+
+        report_formats.each do |format|
+          report.send(format[:method], format[:target])
+        end
+
+        exit exit_code
+      end
+    end
+  end
+end

data/lib/pdk/cli/update.rb

@@ -0,0 +1,32 @@
+require 'pdk/cli/util'
+require 'pdk/util'
+
+module PDK::CLI
+  @update_cmd = @base_cmd.define_command do
+    name 'update'
+    usage _('update [options]')
+    summary _('Update a module that has been created by or converted for use by PDK.')
+
+    flag nil, :noop, _('Do not update the module, just output what would be done.')
+    flag nil, :force, _('Update the module automatically, with no prompts.')
+
+    run do |opts, _args, _cmd|
+      require 'pdk/module/update'
+
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('`pdk update` can only be run from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      raise PDK::CLI::ExitWithError, _('This module does not appear to be PDK compatible. To make the module compatible with PDK, run `pdk convert`.') unless PDK::Util.module_pdk_compatible?
+
+      if opts[:noop] && opts[:force]
+        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when updating a module')
+      end
+
+      updater = PDK::Module::Update.new(opts)
+
+      updater.run
+    end
+  end
+end