akerl-r10k 3.14.2.1

data/lib/r10k/action/cri_runner.rb

@@ -0,0 +1,72 @@
+require 'r10k/action/runner'
+
+module R10K
+  module Action
+
+    # Adapt the Cri runner interface to the R10K::Action::Runner interface
+    #
+    # This class provides the necessary glue to translate behavior specific
+    # to Cri and the CLI component in general to the interface agnostic runner
+    # class.
+    #
+    # @api private
+    class CriRunner
+
+      def self.wrap(klass)
+        new(klass)
+      end
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # Intercept any instatiations of klass
+      #
+      # Defining #new allows this object to proxy method calls on the wrapped
+      # runner and decorate various methods. Doing so allows this class to
+      # manage CLI specific behaviors and isolate the underlying code from
+      # having to deal with those particularities
+      #
+      # @param opts [Hash]
+      # @param argv [Array<String>]
+      # @param _cmd [Cri::Command] The command that was invoked. This value
+      #   is not used and is only present to adapt the Cri interface to r10k.
+      # @return [self]
+      def new(opts, argv, _cmd = nil)
+        handle_opts(opts)
+        handle_argv(argv)
+        @runner = R10K::Action::Runner.new(@opts, @argv, @klass)
+        self
+      end
+
+      # @return [Hash] The adapted options for the runner
+      def handle_opts(opts)
+        if opts[:verbose]
+          # Translate from the Cri verbose logging option to the internal logging setting.
+          opts[:loglevel] = opts.delete(:verbose)
+        end
+
+        # Colored logging is only appropriate for CLI interactions, so we
+        # handle this while we're still in CLI specific code.
+        use_color = opts.delete(:color)
+        if use_color
+          R10K::Logging.use_color = use_color
+        end
+
+        @opts = opts
+      end
+
+      # @return [Array] The adapted arguments for the runner
+      def handle_argv(argv)
+        @argv = argv
+      end
+
+      # Invoke the wrapped behavior, determine if it succeeded, and exit with
+      # the resulting exit code.
+      def call
+        rv = @runner.call
+        exit(rv ? 0 : 1)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Deploy
+      module DeployHelpers
+
+        include R10K::Logging
+
+        # Ensure that a config file has been found (and presumably loaded) and exit
+        # with a helpful error if it hasn't.
+        #
+        # @raise [SystemExit] If no config file was loaded
+        def expect_config!
+          if @config.nil?
+            logger.fatal(_("No configuration file given, no config file found in current directory, and no global config present"))
+            exit(8)
+          end
+        end
+
+        # Check to see if the deploy write_lock setting has been set, and log the lock message
+        # and exit if it has been set.
+        #
+        # @param config [Hash] The r10k config hash
+        #
+        # @raise [SystemExit] if the deploy write_lock setting has been set
+        def check_write_lock!(config)
+          write_lock = config.fetch(:deploy, {})[:write_lock]
+          if write_lock
+            logger.fatal(_("Making changes to deployed environments has been administratively disabled."))
+            logger.fatal(_("Reason: %{write_lock}") % {write_lock: write_lock})
+            exit(16)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+require 'r10k/deployment'
+
+module R10K
+  module Action
+    module Deploy
+      class Display < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+
+        # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
+        #   and managed by the SetOps mixin within the Action::Base class.
+        #   Corresponds to the CLI flags and options.
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
+        # @param settings [Hash] A hash of configuration loaded from the relevant
+        #   config (r10k.yaml).
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
+          super
+
+          @settings = @settings.merge({
+            overrides: {
+              environments: {
+                preload_environments: @fetch,
+                requested_environments: @argv.map { |arg| arg.gsub(/\W/, '_') }
+              },
+              modules: {},
+              output: {
+                format: @format,
+                trace: @trace,
+                detail: @detail
+              },
+              purging: {}
+            }
+          })
+        end
+
+        def call
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
+
+          if @settings.dig(:overrides, :environments, :preload_environments)
+            deployment.preload!
+            deployment.validate!
+          end
+
+          output = { :sources => deployment.sources.map { |source| source_info(source, @settings.dig(:overrides, :environments, :requested_environments)) } }
+
+          case @settings.dig(:overrides, :output, :format)
+          when 'json' then json_format(output)
+          else yaml_format(output)
+          end
+
+          # exit 0
+          true
+        rescue => e
+          logger.error R10K::Errors::Formatting.format_exception(e, @settings.dig(:overrides, :output, :trace))
+          false
+        end
+
+        private
+
+        def json_format(output)
+          require 'json'
+          puts JSON.pretty_generate(output)
+        end
+
+        def yaml_format(output)
+          require 'yaml'
+          puts output.to_yaml
+        end
+
+        def source_info(source, requested_environments = [])
+          source_info = {
+            :name => source.name,
+            :basedir => source.basedir,
+          }
+
+          source_info[:prefix] = source.prefix if source.prefix
+          source_info[:remote] = source.remote if source.respond_to?(:remote)
+
+          select_all_envs = requested_environments.empty?
+          env_list = source.environments.select { |env| select_all_envs || requested_environments.include?(env.name) }
+          source_info[:environments] = env_list.map { |env| environment_info(env) }
+
+          source_info
+        end
+
+        def environment_info(env)
+          modules = @settings.dig(:overrides, :environments, :deploy_modules)
+          if !modules && !@settings.dig(:overrides, :output, :detail)
+            env.dirname
+          else
+            env_info = env.info.merge({
+              :status => (env.status rescue nil),
+            })
+
+            env_info[:modules] = env.modules.map { |mod| module_info(mod) } if modules
+
+            env_info
+          end
+        end
+
+        def module_info(mod)
+          if @settings.dig(:overrides, :output, :detail)
+            { :name => mod.title, :properties => mod.properties }
+          else
+            mod.title
+          end
+        end
+
+        def allowed_initialize_opts
+          super.merge({
+            puppetfile: :modules,
+            modules: :self,
+            detail: :self,
+            format: :self,
+            fetch: :self
+          })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,260 @@
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+require 'r10k/action/visitor'
+require 'r10k/deployment'
+require 'r10k/util/setopts'
+
+require 'json'
+
+module R10K
+  module Action
+    module Deploy
+      class Environment < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+        include R10K::Action::Visitor
+
+        # Deprecated
+        attr_reader :force
+
+        attr_reader :settings
+
+        # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
+        #   and managed by the SetOps mixin within the Action::Base class.
+        #   Corresponds to the CLI flags and options.
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
+        # @param settings [Hash] A hash of configuration loaded from the relevant
+        #   config (r10k.yaml).
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
+          super
+
+          # instance variables below are set by the super class based on the
+          # spec of #allowed_initialize_opts and any command line flags. This
+          # gives a preference order of cli flags > config files > defaults.
+          @settings = @settings.merge({
+            overrides: {
+              environments: {
+                requested_environments: @argv.map { |arg| arg.gsub(/\W/,'_') },
+                default_branch_override: @default_branch_override,
+                generate_types: @generate_types || settings.dig(:deploy, :generate_types) || false,
+                preload_environments: true,
+                incremental: @incremental
+              },
+              modules: {
+                exclude_spec: settings.dig(:deploy, :exclude_spec),
+                requested_modules: [],
+                deploy_modules: @modules,
+                pool_size: @settings[:pool_size] || 4,
+                force: !@no_force, # force here is used to make it easier to reason about
+              },
+              purging: {
+                purge_levels: settings.dig(:deploy, :purge_levels) || [],
+                purge_allowlist: read_purge_allowlist(settings.dig(:deploy, :purge_whitelist) || [],
+                                                      settings.dig(:deploy, :purge_allowlist) || [])
+              },
+              forge: {
+                allow_puppetfile_override: settings.dig(:forge, :allow_puppetfile_override) || false
+              },
+              output: {}
+            }
+          })
+        end
+
+        def call
+          @visit_ok = true
+
+          begin
+            expect_config!
+            deployment = R10K::Deployment.new(@settings)
+            check_write_lock!(@settings)
+
+            deployment.accept(self)
+          rescue => e
+            @visit_ok = false
+            logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+          end
+
+          @visit_ok
+        end
+
+        private
+
+        def read_purge_allowlist (whitelist, allowlist)
+          whitelist_has_content = !whitelist.empty?
+          allowlist_has_content = !allowlist.empty?
+          case
+          when whitelist_has_content == false && allowlist_has_content == false
+            []
+          when whitelist_has_content && allowlist_has_content
+            raise R10K::Error.new "Values found for both purge_whitelist and purge_allowlist. Setting " <<
+                                  "purge_whitelist is deprecated, please only use purge_allowlist."
+          when allowlist_has_content
+            allowlist
+          else
+            logger.warn "Setting purge_whitelist is deprecated; please use purge_allowlist instead."
+            whitelist
+          end
+        end
+
+        def visit_deployment(deployment)
+          # Ensure that everything can be preloaded. If we cannot preload all
+          # sources then we can't fully enumerate all environments which
+          # could be dangerous. If this fails then an exception will be raised
+          # and execution will be halted.
+          if @settings.dig(:overrides, :environments, :preload_environments)
+            deployment.preload!
+            deployment.validate!
+          end
+
+          undeployable = undeployable_environment_names(deployment.environments, @settings.dig(:overrides, :environments, :requested_environments))
+          if !undeployable.empty?
+            @visit_ok = false
+            logger.error _("Environment(s) \'%{environments}\' cannot be found in any source and will not be deployed.") % {environments: undeployable.join(", ")}
+          end
+
+          yield
+
+          if @settings.dig(:overrides, :purging, :purge_levels).include?(:deployment)
+            logger.debug("Purging unmanaged environments for deployment...")
+            deployment.sources.each do |source|
+              source.reload!
+            end
+            deployment.purge!
+          end
+        ensure
+          if (postcmd = @settings[:postrun])
+            if postcmd.grep('$modifiedenvs').any?
+              envs = deployment.environments.map { |e| e.dirname }
+              requested_envs = @settings.dig(:overrides, :environments, :requested_environments)
+              envs.reject! { |e| !requested_envs.include?(e) } if requested_envs.any?
+              postcmd = postcmd.map { |e| e.gsub('$modifiedenvs', envs.join(' ')) }
+            end
+            logger.debug _("Executing postrun command.")
+            subproc = R10K::Util::Subprocess.new(postcmd)
+            subproc.logger = logger
+            subproc.execute
+          end
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          requested_envs = @settings.dig(:overrides, :environments, :requested_environments)
+          if !(requested_envs.empty? || requested_envs.any? { |name| environment.dirname == name })
+            logger.debug1(_("Environment %{env_dir} does not match environment name filter, skipping") % {env_dir: environment.dirname})
+            return
+          end
+
+          started_at = Time.new
+          @environment_ok = true
+
+          status = environment.status
+          logger.info _("Deploying environment %{env_path}") % {env_path: environment.path}
+
+          environment.sync
+          logger.info _("Environment %{env_dir} is now at %{env_signature}") % {env_dir: environment.dirname, env_signature: environment.signature}
+
+          if status == :absent || @settings.dig(:overrides, :modules, :deploy_modules)
+            if status == :absent
+              logger.debug(_("Environment %{env_dir} is new, updating all modules") % {env_dir: environment.dirname})
+            end
+
+            previous_ok = @visit_ok
+            @visit_ok = true
+
+            environment.deploy
+
+            @environment_ok = @visit_ok
+            @visit_ok &&= previous_ok
+          end
+
+
+          if @settings.dig(:overrides, :purging, :purge_levels).include?(:environment)
+            if @visit_ok
+              logger.debug("Purging unmanaged content for environment '#{environment.dirname}'...")
+              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@settings.dig(:overrides, :purging, :purge_allowlist)))
+            else
+              logger.debug("Not purging unmanaged content for environment '#{environment.dirname}' due to prior deploy failures.")
+            end
+          end
+
+          if @settings.dig(:overrides, :environments, :generate_types)
+            if @environment_ok
+              logger.debug("Generating puppet types for environment '#{environment.dirname}'...")
+              environment.generate_types!
+            else
+              logger.debug("Not generating puppet types for environment '#{environment.dirname}' due to puppetfile failures.")
+            end
+          end
+
+          write_environment_info!(environment, started_at, @visit_ok)
+        end
+
+        def write_environment_info!(environment, started_at, success)
+          module_deploys =
+            begin
+              environment.modules.map do |mod|
+                props = mod.properties
+                {
+                  name: mod.name,
+                  version: props[:expected],
+                  sha: props[:type] == :git ? props[:actual] : nil
+                }
+              end
+            rescue
+              logger.debug("Unable to get environment module deploy data for .r10k-deploy.json at #{environment.path}")
+              []
+            end
+
+          # make this file write as atomic as possible in pure ruby
+          final   = "#{environment.path}/.r10k-deploy.json"
+          staging = "#{environment.path}/.r10k-deploy.json~"
+          File.open(staging, 'w') do |f|
+            deploy_info = environment.info.merge({
+              :started_at => started_at,
+              :finished_at => Time.new,
+              :deploy_success => success,
+              :module_deploys => module_deploys,
+            })
+
+            f.puts(JSON.pretty_generate(deploy_info))
+          end
+          FileUtils.mv(staging, final)
+        end
+
+        def undeployable_environment_names(environments, expected_names)
+          if expected_names.empty?
+            []
+          else
+            known_names = environments.map(&:dirname)
+            expected_names - known_names
+          end
+        end
+
+        def allowed_initialize_opts
+          super.merge(puppetfile: :modules,
+                      modules: :self,
+                      cachedir: :self,
+                      incremental: :self,
+                      'no-force': :self,
+                      'exclude-spec': :self,
+                      'generate-types': :self,
+                      'puppet-path': :self,
+                      'puppet-conf': :self,
+                      'private-key': :self,
+                      'oauth-token': :self,
+                      'default-branch-override': :self,
+                      'github-app-id': :self,
+                      'github-app-key': :self,
+                      'github-app-ttl': :self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+require 'r10k/action/visitor'
+require 'r10k/deployment'
+
+module R10K
+  module Action
+    module Deploy
+      class Module < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+        include R10K::Action::Visitor
+
+        # Deprecated
+        attr_reader :force
+
+        attr_reader :settings
+
+        # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
+        #   and managed by the SetOps mixin within the Action::Base class.
+        #   Corresponds to the CLI flags and options.
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
+        # @param settings [Hash] A hash of configuration loaded from the relevant
+        #   config (r10k.yaml).
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
+          super
+
+          requested_env = @opts[:environment] ? [@opts[:environment].gsub(/\W/, '_')] : []
+          @modified_envs = []
+
+          @settings = @settings.merge({
+            overrides: {
+              environments: {
+                requested_environments: requested_env,
+                generate_types: @generate_types
+              },
+              modules: {
+                exclude_spec: settings.dig(:deploy, :exclude_spec),
+                pool_size: @settings[:pool_size] || 4,
+                requested_modules: @argv.map.to_a,
+                # force here is used to make it easier to reason about
+                force: !@no_force
+              },
+              forge: {
+                allow_puppetfile_override: settings.dig(:forge, :allow_puppetfile_override) || false
+              },
+              purging: {},
+              output: {}
+            }
+          })
+        end
+
+        def call
+          @visit_ok = true
+          begin
+            expect_config!
+            deployment = R10K::Deployment.new(@settings)
+            check_write_lock!(@settings)
+
+            deployment.accept(self)
+          rescue => e
+            @visit_ok = false
+            logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+          end
+
+          @visit_ok
+        end
+
+        private
+
+        def visit_deployment(deployment)
+          yield
+        ensure
+          if (postcmd = @settings[:postrun])
+            if @modified_envs.any?
+              envs_to_run = @modified_envs.join(' ')
+              logger.debug _("Running postrun command for environments: %{envs_to_run}.") % { envs_to_run: envs_to_run }
+
+              if postcmd.grep('$modifiedenvs').any?
+                postcmd = postcmd.map { |e| e.gsub('$modifiedenvs', envs_to_run) }
+              end
+
+              subproc = R10K::Util::Subprocess.new(postcmd)
+              subproc.logger = logger
+              subproc.execute
+            else
+              logger.debug _("No environments were modified, not executing postrun command.")
+            end
+          end
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          requested_envs = @settings.dig(:overrides, :environments, :requested_environments)
+          if !requested_envs.empty? && !requested_envs.include?(environment.dirname)
+            logger.debug1(_("Only updating modules in environment(s) %{opt_env} skipping environment %{env_path}") % {opt_env: requested_envs.inspect, env_path: environment.path})
+          else
+            logger.debug1(_("Updating modules %{modules} in environment %{env_path}") % {modules: @settings.dig(:overrides, :modules, :requested_modules).inspect, env_path: environment.path})
+
+            updated_modules = environment.deploy
+
+            # We actually synced a module in this env
+            if !updated_modules.nil? && !updated_modules.empty?
+              # Record modified environment for postrun command
+              @modified_envs << environment.dirname
+
+              if generate_types = @settings.dig(:overrides, :environments, :generate_types)
+                logger.debug("Generating puppet types for environment '#{environment.dirname}'...")
+                environment.generate_types!
+              end
+            end
+          end
+        end
+
+        def allowed_initialize_opts
+          super.merge(environment: true,
+                      cachedir: :self,
+                      'exclude-spec': :self,
+                      'no-force': :self,
+                      'generate-types': :self,
+                      'puppet-path': :self,
+                      'puppet-conf': :self,
+                      'private-key': :self,
+                      'oauth-token': :self,
+                      'github-app-id': :self,
+                      'github-app-key': :self,
+                      'github-app-ttl': :self)
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/deploy.rb

@@ -0,0 +1,9 @@
+module R10K
+  module Action
+    module Deploy
+      require 'r10k/action/deploy/environment'
+      require 'r10k/action/deploy/module'
+      require 'r10k/action/deploy/display'
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'r10k/action/base'
+require 'r10k/errors/formatting'
+require 'r10k/module_loader/puppetfile'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Check < R10K::Action::Base
+
+        def call
+          options = { basedir: @root }
+          options[:moduledir] = @moduledir if @moduledir
+          options[:puppetfile] = @puppetfile if @puppetfile
+
+          loader = R10K::ModuleLoader::Puppetfile.new(**options)
+          begin
+            loader.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
+