r10k 3.5.2

data/lib/r10k.rb

@@ -0,0 +1,11 @@
+require 'gettext-setup'
+
+module R10K
+  GettextSetup.initialize(File.absolute_path('../locales', File.dirname(__FILE__)))
+
+  # Attempt to set the R10k error and log message locale
+  FastGettext.locale = ENV["LANG"]
+end
+
+require 'r10k/version'
+require 'r10k/logging'

data/lib/r10k/action/base.rb

@@ -0,0 +1,31 @@
+require 'r10k/util/setopts'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    class Base
+
+      include R10K::Logging
+      include R10K::Util::Setopts
+
+      attr_accessor :settings
+
+      def initialize(opts, argv, settings = {})
+        @opts = opts
+        @argv = argv
+        @settings = settings
+
+        setopts(opts, allowed_initialize_opts)
+      end
+
+      private
+
+      def allowed_initialize_opts
+        {
+          :config => true,
+          :trace  => true,
+        }
+      end
+    end
+  end
+end

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.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/deploy/deploy_helpers.rb

@@ -0,0 +1,34 @@
+module R10K
+  module Action
+    module Deploy
+      module DeployHelpers
+
+        # 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,89 @@
+require 'r10k/deployment'
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+
+module R10K
+  module Action
+    module Deploy
+      class Display < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+
+        def call
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
+
+          if @fetch
+            deployment.preload!
+          end
+
+          output = { :sources => deployment.sources.map { |source| source_info(source, @argv) } }
+
+          case @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, @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, argv=[])
+          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)
+
+          env_list = source.environments.select { |env| argv.empty? || argv.include?(env.name) }
+          source_info[:environments] = env_list.map { |env| environment_info(env) }
+
+          source_info
+        end
+
+        def environment_info(env)
+          if !@puppetfile && !@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 @puppetfile
+
+            env_info
+          end
+        end
+
+        def module_info(mod)
+          if @detail
+            { :name => mod.title, :properties => mod.properties }
+          else
+            mod.title
+          end
+        end
+
+        def allowed_initialize_opts
+          super.merge(puppetfile: :self, detail: :self, format: :self, fetch: :self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,196 @@
+require 'r10k/util/setopts'
+require 'r10k/deployment'
+require 'r10k/logging'
+require 'r10k/action/visitor'
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
+require 'json'
+
+module R10K
+  module Action
+    module Deploy
+      class Environment < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
+
+        attr_reader :force
+
+        def initialize(opts, argv, settings = nil)
+          settings ||= {}
+          @purge_levels = settings.fetch(:deploy, {}).fetch(:purge_levels, [])
+          @user_purge_whitelist = settings.fetch(:deploy, {}).fetch(:purge_whitelist, [])
+          @generate_types = settings.fetch(:deploy, {}).fetch(:generate_types, false)
+
+          super
+
+          # @force here is used to make it easier to reason about
+          @force = !@no_force
+          @argv = @argv.map { |arg| arg.gsub(/\W/,'_') }
+        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)
+          # 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.
+          deployment.preload!
+          deployment.validate!
+
+          undeployable = undeployable_environment_names(deployment.environments, @argv)
+          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 @purge_levels.include?(:deployment)
+            logger.debug("Purging unmanaged environments for deployment...")
+            deployment.purge!
+          end
+        ensure
+          if (postcmd = @settings[:postrun])
+            if postcmd.grep('$modifiedenvs').any?
+              envs = deployment.environments.map { |e| e.dirname }
+              envs.reject! { |e| !@argv.include?(e) } if @argv.any?
+              postcmd = postcmd.map { |e| e.gsub('$modifiedenvs', envs.join(' ')) }
+            end
+            subproc = R10K::Util::Subprocess.new(postcmd)
+            subproc.logger = logger
+            subproc.execute
+          end
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          if !(@argv.empty? || @argv.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 || @puppetfile
+            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
+            yield
+            @environment_ok = @visit_ok
+            @visit_ok &&= previous_ok
+          end
+
+          if @purge_levels.include?(:environment)
+            if @visit_ok
+              logger.debug("Purging unmanaged content for environment '#{environment.dirname}'...")
+              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@user_purge_whitelist))
+            else
+              logger.debug("Not purging unmanaged content for environment '#{environment.dirname}' due to prior deploy failures.")
+            end
+          end
+
+          if @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 visit_puppetfile(puppetfile)
+          puppetfile.load(@opts[:'default-branch-override'])
+
+          yield
+
+          if @purge_levels.include?(:puppetfile)
+            logger.debug("Purging unmanaged Puppetfile content for environment '#{puppetfile.environment.dirname}'...")
+            puppetfile.purge!
+          end
+        end
+
+        def visit_module(mod)
+          logger.info _("Deploying %{origin} content %{path}") % {origin: mod.origin, path: mod.path}
+          mod.sync(force: @force)
+        end
+
+        def write_environment_info!(environment, started_at, success)
+          module_deploys = []
+          begin
+            environment.modules.each do |mod|
+              name = mod.name
+              version = mod.version
+              sha = mod.repo.head rescue nil
+              module_deploys.push({:name => name, :version => version, :sha => sha})
+            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: :self,
+                      cachedir: :self,
+                      'no-force': :self,
+                      'generate-types': :self,
+                      'puppet-path': :self,
+                      'default-branch-override': :self)
+        end
+      end
+    end
+  end
+end