r10k 3.5.2

data/lib/r10k/action/deploy/module.rb

@@ -0,0 +1,84 @@
+require 'r10k/deployment'
+require 'r10k/action/visitor'
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+
+module R10K
+  module Action
+    module Deploy
+      class Module < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+
+        attr_reader :force
+
+        def initialize(opts, argv, settings = nil)
+          settings ||= {}
+
+          super
+
+          # @force here is used to make it easier to reason about
+          @force = !@no_force
+        end
+
+        def call
+          @visit_ok = true
+
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
+          check_write_lock!(@settings)
+
+          deployment.accept(self)
+          @visit_ok
+        end
+
+        include R10K::Action::Visitor
+
+        private
+
+        def visit_deployment(deployment)
+          yield
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          if @opts[:environment] && (@opts[:environment] != environment.dirname)
+            logger.debug1(_("Only updating modules in environment %{opt_env} skipping environment %{env_path}") % {opt_env: @opts[:environment], env_path: environment.path})
+          else
+            logger.debug1(_("Updating modules %{modules} in environment %{env_path}") % {modules: @argv.inspect, env_path: environment.path})
+            yield
+          end
+        end
+
+        def visit_puppetfile(puppetfile)
+          puppetfile.load
+          yield
+        end
+
+        def visit_module(mod)
+          if @argv.include?(mod.name)
+            logger.info _("Deploying module %{mod_path}") % {mod_path: mod.path}
+            mod.sync(force: @force)
+            if mod.environment && @generate_types
+              logger.debug("Generating puppet types for environment '#{mod.environment.dirname}'...")
+              mod.environment.generate_types!
+            end
+          else
+            logger.debug1(_("Only updating modules %{modules}, skipping module %{mod_name}") % {modules: @argv.inspect, mod_name: mod.name})
+          end
+        end
+
+        def allowed_initialize_opts
+          super.merge(environment: true,
+                      cachedir: :self,
+                      'no-force': :self,
+                      'generate-types': :self,
+                      'puppet-path': :self)
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/puppetfile.rb

@@ -0,0 +1,10 @@
+module R10K
+  module Action
+    module Puppetfile
+      require 'r10k/action/puppetfile/cri_runner'
+      require 'r10k/action/puppetfile/install'
+      require 'r10k/action/puppetfile/check'
+      require 'r10k/action/puppetfile/purge'
+    end
+  end
+end

data/lib/r10k/action/puppetfile/check.rb

@@ -0,0 +1,31 @@
+require 'r10k/puppetfile'
+require 'r10k/action/base'
+require 'r10k/errors/formatting'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Check < R10K::Action::Base
+
+        def call
+          pf = R10K::Puppetfile.new(@root, @moduledir, @puppetfile)
+          begin
+            pf.load!
+            $stderr.puts _("Syntax OK")
+            true
+          rescue => e
+            $stderr.puts R10K::Errors::Formatting.format_exception(e, @trace)
+            false
+          end
+        end
+
+        private
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self)
+        end
+      end
+    end
+  end
+end
+

data/lib/r10k/action/puppetfile/cri_runner.rb

@@ -0,0 +1,26 @@
+require 'r10k/action/cri_runner'
+
+module R10K
+  module Action
+    module Puppetfile
+      # Extend the default Cri Runner with Puppetfile specific opts
+      #
+      # @api private
+      class CriRunner < R10K::Action::CriRunner
+
+        include R10K::Logging
+
+        def handle_opts(opts)
+          opts[:root]       ||= wd
+          super(opts)
+        end
+
+        private
+
+        def wd
+          Dir.getwd
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/puppetfile/install.rb

@@ -0,0 +1,45 @@
+require 'r10k/puppetfile'
+require 'r10k/errors/formatting'
+require 'r10k/action/visitor'
+require 'r10k/action/base'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Install < R10K::Action::Base
+
+        def call
+          @visit_ok = true
+          pf = R10K::Puppetfile.new(@root, @moduledir, @puppetfile, nil , @force)
+          pf.accept(self)
+          @visit_ok
+        end
+
+        private
+
+        include R10K::Action::Visitor
+
+        def visit_puppetfile(pf)
+          pf.load!
+          yield
+          pf.purge!
+        end
+
+        def visit_module(mod)
+          @force ||= false
+          logger.info _("Updating module %{mod_path}") % {mod_path: mod.path}
+
+          if mod.respond_to?(:desired_ref) && mod.desired_ref == :control_branch
+            logger.warn _("Cannot track control repo branch for content '%{name}' when not part of a 'deploy' action, will use default if available." % {name: mod.name})
+          end
+
+          mod.sync(force: @force)
+        end
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self, force: :self )
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/puppetfile/purge.rb

@@ -0,0 +1,28 @@
+require 'r10k/puppetfile'
+require 'r10k/action/base'
+require 'r10k/errors/formatting'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Purge < R10K::Action::Base
+
+        def call
+          pf = R10K::Puppetfile.new(@root, @moduledir, @puppetfile)
+          pf.load!
+          pf.purge!
+          true
+        rescue => e
+          logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+          false
+        end
+
+        private
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self)
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/runner.rb

@@ -0,0 +1,96 @@
+require 'r10k/logging'
+require 'r10k/errors'
+require 'r10k/util/license'
+require 'puppet_forge/connection'
+
+module R10K
+  module Action
+    class Runner
+      include R10K::Logging
+
+      def initialize(opts, argv, klass)
+        @opts = opts
+        @argv = argv
+        @klass = klass
+
+        @settings = {}
+      end
+
+      def instance
+        if @_instance.nil?
+          iopts = @opts.dup
+          iopts.delete(:loglevel)
+          @_instance = @klass.new(iopts, @argv, @settings)
+        end
+        @_instance
+      end
+
+      def call
+        setup_logging
+        setup_settings
+        # @todo check arguments
+        setup_authorization
+        instance.call
+      end
+
+      def setup_logging
+        if @opts.key?(:loglevel)
+          R10K::Logging.level = @opts[:loglevel]
+        end
+      end
+
+      def setup_settings
+        config_settings = settings_from_config(@opts[:config])
+
+        overrides = {}
+        overrides[:cachedir] = @opts[:cachedir] if @opts.key?(:cachedir)
+        overrides[:deploy] = {} if @opts.key?(:'puppet-path') || @opts.key?(:'generate-types')
+        overrides[:deploy][:puppet_path] = @opts[:'puppet-path'] if @opts.key?(:'puppet-path')
+        overrides[:deploy][:generate_types] = @opts[:'generate-types'] if @opts.key?(:'generate-types')
+
+        with_overrides = config_settings.merge(overrides) do |key, oldval, newval|
+          newval = oldval.merge(newval) if oldval.is_a? Hash
+          logger.debug2 _("Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'") % {key: key, old_val: oldval, new_val: newval}
+          newval
+        end
+
+        @settings = R10K::Settings.global_settings.evaluate(with_overrides)
+
+        R10K::Initializers::GlobalInitializer.new(@settings).call
+      rescue R10K::Settings::Collection::ValidationError => e
+        logger.error e.format
+        exit(8)
+      end
+
+      def setup_authorization
+        begin
+          license = R10K::Util::License.load
+
+          if license.respond_to?(:authorization_token)
+            PuppetForge::Connection.authorization = license.authorization_token
+          end
+        rescue R10K::Error => e
+          logger.warn e.message
+        end
+      end
+
+      private
+
+      def settings_from_config(override_path)
+        loader = R10K::Settings::Loader.new
+        path = loader.search(override_path)
+        results = {}
+
+        if path
+          @opts[:config] = path
+          logger.debug2 _("Reading configuration from %{config_path}") % {config_path: path.inspect}
+          results = loader.read(path)
+        else
+          logger.debug2 _("No config file explicitly given and no default config file could be found, default settings will be used.")
+        end
+
+        results
+      end
+    end
+  end
+end

data/lib/r10k/action/visitor.rb

@@ -0,0 +1,31 @@
+require 'r10k/errors/formatting'
+
+module R10K
+  module Action
+    # Implement the Visitor pattern via pseudo double dispatch.
+    #
+    # Visitor classes must implement #visit_type methods for each type that may
+    # be visited. If the visitor should descend into child objects the #visit_
+    # method should yield to the passed block.
+    #
+    # Visitor classes must implement #logger so that error messages can be logged.
+    #
+    # @api private
+    module Visitor
+
+      # Dispatch to the type specific visitor method
+      #
+      # @param type [Symbol] The object type to dispatch for
+      # @param other [Object] The actual object to pass to the visitor method
+      # @param block [Proc] The block that the called visitor method may yield
+      #   to in case recursion is desired.
+      # @return [void]
+      def visit(type, other, &block)
+        send("visit_#{type}", other, &block)
+      rescue => e
+        logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+        @visit_ok = false
+      end
+    end
+  end
+end

data/lib/r10k/cli.rb

@@ -0,0 +1,51 @@
+require 'r10k'
+require 'r10k/version'
+require 'r10k/cli/ext/logging'
+
+require 'cri'
+
+module R10K::CLI
+  def self.command
+    @cmd ||= Cri::Command.define do
+      name    'r10k'
+      usage   'r10k <subcommand> [options]'
+      summary 'Killer robot powered Puppet environment deployment'
+      description <<-EOD
+        r10k is a suite of commands to help deploy and manage puppet code for
+        complex environments.
+      EOD
+
+
+      flag :h, :help, 'Show help for this command' do |value, cmd|
+        # This is evil because we may not necessarily be called from the
+        # command line and have a meaningful ARGV to scan. However the best
+        # way of having a globally useful --help command is to define the
+        # behavior in the block of the option to immediately handle it and exit
+        # and we don't have access to the verbose option, so the simple method
+        # is to simply scan ARGV.
+        verbose = (ARGV.include?('-v') || ARGV.include?('--verbose'))
+        puts cmd.help(:verbose => verbose)
+        exit 0
+      end
+
+      flag :t, :trace, 'Display stack traces on application crash'
+
+      loglevels = R10K::Logging::LOG_LEVELS.reverse.map(&:downcase).join(", ")
+      optional :v, :verbose, "Set log verbosity. Valid values: #{loglevels}"
+
+      flag nil, :color, 'Enable colored log messages'
+
+      required :c, :config, 'Specify a global configuration file'
+
+      run do |opts, args, cmd|
+        puts cmd.help(:verbose => opts[:verbose])
+        exit 0
+      end
+    end
+  end
+end
+
+require 'r10k/cli/deploy'
+require 'r10k/cli/puppetfile'
+require 'r10k/cli/version'
+require 'r10k/cli/help'

data/lib/r10k/cli/deploy.rb

@@ -0,0 +1,114 @@
+require 'r10k/cli'
+require 'r10k/deployment'
+require 'r10k/deployment/config'
+
+require 'r10k/action/cri_runner'
+require 'r10k/action/deploy'
+
+
+require 'cri'
+
+module R10K::CLI
+  module Deploy
+    def self.command
+      @cmd ||= Cri::Command.define do
+        name    'deploy'
+        usage   'deploy <subcommand>'
+        summary 'Puppet dynamic environment deployment'
+
+        description <<-DESCRIPTION
+`r10k deploy` implements the Git branch to Puppet environment workflow
+(https://puppet.com/docs/puppet/latest/environments_about.html).
+        DESCRIPTION
+
+        required nil, :cachedir, 'Specify a cachedir, overriding the value in config'
+        flag nil, :'no-force', 'Prevent the overwriting of local module modifications'
+        flag nil, :'generate-types', 'Run `puppet generate types` after updating an environment'
+        option nil, :'puppet-path', 'Path to puppet executable', argument: :required do |value, cmd|
+          unless File.executable? value
+            $stderr.puts "The specified puppet executable #{value} is not executable."
+            puts cmd.help
+            exit 1
+          end
+        end
+
+        run do |opts, args, cmd|
+          puts cmd.help(:verbose => opts[:verbose])
+          exit 0
+        end
+      end
+    end
+
+    module Environment
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name    'environment'
+          usage   'environment <options> <environment> <...>'
+          summary 'Deploy environments and their dependent modules'
+
+          description <<-DESCRIPTION
+`r10k deploy environment` creates and updates Puppet environments based on Git
+branches.
+
+Environments can provide a Puppetfile at the root of the directory to deploy
+independent Puppet modules. To recursively deploy an environment, pass the
+`--puppetfile` flag to the command.
+
+**NOTE**: If an environment has a Puppetfile when it is instantiated a
+recursive update will be forced. It is assumed that environments are dependent
+on modules specified in the Puppetfile and an update will be automatically
+scheduled. On subsequent deployments, Puppetfile deployment will default to off.
+          DESCRIPTION
+
+          flag :p, :puppetfile, 'Deploy modules from a puppetfile'
+          required nil, :'default-branch-override', 'Specify a branchname to override the default branch in the puppetfile'
+
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Environment)
+        end
+      end
+    end
+
+    module Module
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name  'module'
+          usage 'module [module] <module ...>'
+          summary 'Deploy modules in all environments'
+
+          description <<-DESCRIPTION
+`r10k deploy module` Deploys and updates modules inside of Puppet environments.
+It will load the Puppetfile configurations out of all environments, and will
+try to deploy the given module names in all environments.
+          DESCRIPTION
+
+          required :e, :environment, 'Update the modules in the given environment'
+
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Module)
+        end
+      end
+    end
+
+    module Display
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name  'display'
+          aliases 'list'
+          usage 'display'
+          summary 'Display environments and modules in the deployment'
+
+          flag :p, :puppetfile, 'Display Puppetfile modules'
+          flag nil, :detail, 'Display detailed information'
+          flag nil, :fetch, 'Update available environment lists from all remote sources'
+          required nil, :format, 'Display output in a specific format. Valid values: json, yaml. Default: yaml'
+
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Display)
+        end
+      end
+    end
+  end
+end
+
+R10K::CLI.command.add_command(R10K::CLI::Deploy.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Environment.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Module.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Display.command)