r10k 2.0.3 → 2.1.0

data/integration/tests/user_scenario/basic_workflow/single_env_purge_unmanaged_modules.rb

@@ -7,6 +7,7 @@ test_name 'CODEMGMT-73 - C63184 - Single Environment Purge Unmanaged Modules'
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
+r10k_fqp = get_r10k_fqp(master)
 
 #Verification
 motd_path = '/etc/motd'
@@ -61,7 +62,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add module.', git_
 
 #Tests
 step 'Deploy Environments via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 step 'Plug-in Sync Agents'
 on(agents, puppet("plugin download --server #{master}"))
@@ -79,7 +80,7 @@ agents.each do |agent|
 end
 
 step 'Use r10k to Purge Unmanaged Modules'
-on(master, 'r10k puppetfile purge -v', :acceptable_exit_codes => 1)
+on(master, "#{r10k_fqp} puppetfile purge -v", :acceptable_exit_codes => 1)
 
 #Agent will fail because r10k will purge the "motd" module
 agents.each do |agent|

data/integration/tests/user_scenario/basic_workflow/single_env_switch_forge_git_module.rb

@@ -7,6 +7,7 @@ test_name 'CODEMGMT-111 - C63600 - Single Environment Switch Between Forge and G
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
 prod_env_modules_path = File.join(env_path, 'production', 'modules')
+r10k_fqp = get_r10k_fqp(master)
 
 git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
@@ -73,7 +74,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add modules.', git
 
 #Tests
 step 'Deploy "production" Environment via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 step 'Update MOTD Template'
 create_remote_file(master, motd_template_path, motd_template_contents_forge)
@@ -101,7 +102,7 @@ step 'Push Changes'
 git_add_commit_push(master, 'production', 'Update site.pp and Puppetfile.', git_environments_path)
 
 step 'Deploy "production" Environment Again via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 agents.each do |agent|
   step 'Run Puppet Agent'

data/integration/tests/user_scenario/basic_workflow/single_env_unicode_paths.rb

@@ -7,6 +7,7 @@ test_name 'CODEMGMT-62 - C59260 - Single Environment with Unicode File Paths'
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 environment_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
 prod_env_modules_path = File.join(environment_path, 'production', 'modules')
+r10k_fqp = get_r10k_fqp(master)
 
 git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
@@ -47,7 +48,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add modules.', git
 
 #Tests
 step 'Deploy "production" Environment via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 #Note: Usually a full Puppet Run would be performed for verification.
 #Since Puppet has problems with Unicode, this test will verify the file

data/integration/tests/user_scenario/basic_workflow/single_env_upgrade_forge_mod_revert_change.rb

@@ -10,6 +10,7 @@ prod_env_modules_path = File.join(env_path, 'production', 'modules')
 
 git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
+r10k_fqp = get_r10k_fqp(master)
 
 #Verification
 motd_path = '/etc/motd'
@@ -76,7 +77,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add modules.', git
 
 #Tests
 step 'Deploy "production" Environment via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 step 'Update MOTD Template'
 create_remote_file(master, motd_template_path, motd_template_contents)
@@ -112,7 +113,7 @@ step 'Push Changes'
 git_add_commit_push(master, 'production', 'Update site.pp and Puppetfile.', git_environments_path)
 
 step 'Deploy "production" Environment Again via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 agents.each do |agent|
   step 'Run Puppet Agent'
@@ -141,7 +142,7 @@ step 'Push Changes'
 git_add_commit_push(master, 'production', 'Update site.pp and add modules.', git_environments_path)
 
 step 'Deploy "production" Environment Again via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 step 'Update MOTD Template'
 create_remote_file(master, motd_template_path, motd_template_contents)

data/integration/tests/user_scenario/complex_workflow/multi_env_add_change_remove.rb

@@ -9,6 +9,7 @@ git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
 local_files_root_path = ENV['FILES'] || 'files'
 helloworld_module_path = File.join(local_files_root_path, 'modules', 'helloworld')
+r10k_fqp = get_r10k_fqp(master)
 
 initial_env_names = ['production', 'stage', 'test']
 
@@ -92,7 +93,7 @@ end
 
 #Tests
 step 'Deploy Environments via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 #Initial Verification
 initial_env_names.each do |env|
@@ -128,7 +129,7 @@ git_on(master, 'branch -D test', git_environments_path)
 git_on(master, 'push origin --delete test', git_environments_path)
 
 step 'Re-deploy Environments via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 #Second Pass Verification
 agents.each do |agent|

data/integration/tests/user_scenario/complex_workflow/multi_env_remove_re-add.rb

@@ -9,6 +9,7 @@ git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
 local_files_root_path = ENV['FILES'] || 'files'
 helloworld_module_path = File.join(local_files_root_path, 'modules', 'helloworld')
+r10k_fqp = get_r10k_fqp(master)
 
 initial_env_names = ['production', 'stage']
 
@@ -51,7 +52,7 @@ end
 
 #Tests
 step 'Deploy Environments via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 #Initial Verification
 initial_env_names.each do |env|
@@ -71,7 +72,7 @@ git_on(master, 'branch -D stage', git_environments_path)
 git_on(master, 'push origin --delete stage', git_environments_path)
 
 step 'Re-deploy Environments via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 #Second Pass Verification
 agents.each do |agent|
@@ -96,7 +97,7 @@ step 'Push Changes to "stage" Environment'
 git_push(master, 'stage', git_environments_path)
 
 step 'Re-deploy Environments via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 #Final Verification
 initial_env_names.each do |env|

data/integration/tests/user_scenario/complex_workflow/multi_env_unamanaged.rb

@@ -6,6 +6,7 @@ test_name 'CODEMGMT-155 - C62421 - Multiple Environments with Existing Unmanaged
 #Init
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 environment_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
+r10k_fqp = get_r10k_fqp(master)
 
 git_environments_path = '/root/environments'
 last_commit = git_last_commit(master, git_environments_path)
@@ -43,7 +44,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add module.', git_
 
 #Tests
 step 'Deploy "production" Environment via r10k'
-on(master, 'r10k deploy environment -v')
+on(master, "#{r10k_fqp} deploy environment -v")
 
 agents.each do |agent|
   step 'Run Puppet Agent'
@@ -65,7 +66,7 @@ agents.each do |agent|
 end
 
 step 'Re-deploy Environments via r10k'
-on(master, 'r10k deploy environment -v') do |result|
+on(master, "#{r10k_fqp} deploy environment -v") do |result|
   assert_match(removal_message_test_env_regex, result.output, 'Unexpected error was detected!')
 end
 

data/integration/tests/user_scenario/complex_workflow/single_env_git_module_update.rb

@@ -6,6 +6,7 @@ test_name 'CODEMGMT-155 - C64588 - Single Environment with Git Module Using a Br
 #Init
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 environment_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
+r10k_fqp = get_r10k_fqp(master)
 
 git_repo_parent_path = '/git_repos'
 git_repo_module_name = 'helloworld_module'
@@ -72,7 +73,7 @@ git_add_commit_push(master, 'production', 'Update site.pp and add module.', git_
 
 #Tests
 step 'Deploy "production" Environment via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 agents.each do |agent|
   step 'Run Puppet Agent'
@@ -88,7 +89,7 @@ on(master, "chmod -R 644 #{git_module_clone_path}")
 git_add_commit_push(master, 'master', 'Update module.', git_module_clone_path)
 
 step 'Deploy "production" Environment Again via r10k'
-on(master, 'r10k deploy environment -v -p')
+on(master, "#{r10k_fqp} deploy environment -v -p")
 
 agents.each do |agent|
   step 'Run Puppet Agent'

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/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}")
+            exit(16)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,102 +1,84 @@
-require 'r10k/util/setopts'
 require 'r10k/deployment'
-require 'r10k/logging'
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
 
 module R10K
   module Action
     module Deploy
-      class Display
-
-        include R10K::Util::Setopts
-        include R10K::Logging
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv
-          setopts(opts, {
-            :config     => :self,
-            :puppetfile => :self,
-            :detail     => :self,
-            :trace      => :self
-          })
-
-          @level  = 4
-          @indent = 0
-        end
+      class Display < R10K::Action::Base
+
+        include R10K::Action::Deploy::DeployHelpers
 
         def call
-          @visit_ok = true
-          deployment = R10K::Deployment.load_config(@config)
-          deployment.accept(self)
-          @visit_ok
-        end
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
 
-        include R10K::Action::Visitor
+          if @fetch
+            deployment.preload!
+          end
 
-        private
+          output = { :sources => deployment.sources.map { |source| source_info(source, @argv) } }
 
-        def visit_deployment(deployment)
-          yield
-        end
+          case @format
+          when 'json' then json_format(output)
+          else yaml_format(output)
+          end
 
-        def visit_source(source)
-          source.generate_environments
-          display_text("#{source.name} (#{source.basedir})")
-          yield
+          # exit 0
+          true
         end
 
-        def visit_environment(environment)
-          if !(@argv.empty? || @argv.include?(environment.dirname))
-            return
-          end
+        private
 
-          indent do
-            display_text("- " + environment.dirname)
-            if @puppetfile
-              indent do
-                display_text("modules:")
-                yield
-              end
-            end
-          end
+        def json_format(output)
+          require 'json'
+          puts JSON.pretty_generate(output)
         end
 
-        def visit_puppetfile(puppetfile)
-          puppetfile.load
-          yield
+        def yaml_format(output)
+          require 'yaml'
+          puts output.to_yaml
         end
 
-        def visit_module(mod)
-          indent do
-            display_text("- " + mod.title)
-            if @detail
-              indent do
-                properties = mod.properties
-                str = properties.keys.sort.map do |key|
-                  "#{key}: #{properties[key]}"
-                end.join("\n")
-                display_text(str)
-              end
-            end
-          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 indent(&block)
-          @indent += @level
-          block.call
-        ensure
-          @indent -= @level
+        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 indent_text(str)
-          space = " " * @indent
-          str.lines.map do |line|
-            space + line
-          end.join
+        def module_info(mod)
+          if @detail
+            { :name => mod.title, :properties => mod.properties }
+          else
+            mod.title
+          end
         end
 
-        def display_text(str)
-          puts indent_text(str)
+        def allowed_initialize_opts
+          super.merge(puppetfile: :self, detail: :self, format: :self, fetch: :self)
         end
       end
     end

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

@@ -2,31 +2,30 @@ 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
+      class Environment < R10K::Action::Base
 
-        include R10K::Util::Setopts
-        include R10K::Logging
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv.map { |arg| arg.gsub(/\W/,'_') }
-          setopts(opts, {
-            :config     => :self,
-            :puppetfile => :self,
-            :purge      => :self,
-            :trace      => :self
-          })
+        include R10K::Action::Deploy::DeployHelpers
 
+        def initialize(opts, argv, settings = {})
           @purge = true
+          super
+          @argv = @argv.map { |arg| arg.gsub(/\W/,'_') }
         end
 
         def call
           @visit_ok = true
-          deployment = R10K::Deployment.load_config(@config)
+
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
+          check_write_lock!(@settings)
+
           deployment.accept(self)
           @visit_ok
         end
@@ -43,12 +42,18 @@ module R10K
           deployment.preload!
           deployment.validate!
 
+          undeployable = undeployable_environment_names(deployment.environments, @argv)
+          if !undeployable.empty?
+            @visit_ok = false
+            logger.error "Environment(s) \'#{undeployable.join(", ")}\' cannot be found in any source and will not be deployed."
+          end
+
           yield
 
           deployment.purge! if @purge
 
         ensure
-          if (postcmd = deployment.config.setting(:postrun))
+          if (postcmd = @settings[:postrun])
             subproc = R10K::Util::Subprocess.new(postcmd)
             subproc.logger = logger
             subproc.execute
@@ -64,16 +69,24 @@ module R10K
             logger.debug1("Environment #{environment.dirname} does not match environment name filter, skipping")
             return
           end
+
+          started_at = Time.new
+
           status = environment.status
           logger.info "Deploying environment #{environment.path}"
+
           environment.sync
+          logger.info "Environment #{environment.dirname} is now at #{environment.signature}"
 
           if status == :absent || @puppetfile
             if status == :absent
               logger.debug("Environment #{environment.dirname} is new, updating all modules")
             end
+
             yield
           end
+
+          write_environment_info!(environment, started_at)
         end
 
         def visit_puppetfile(puppetfile)
@@ -86,6 +99,30 @@ module R10K
           logger.info "Deploying module #{mod.path}"
           mod.sync
         end
+
+        def write_environment_info!(environment, started_at)
+          File.open("#{environment.path}/.r10k-deploy.json", 'w') do |f|
+            deploy_info = environment.info.merge({
+              :started_at => started_at,
+              :finished_at => Time.new,
+            })
+
+            f.puts(JSON.pretty_generate(deploy_info))
+          end
+        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, purge: true)
+        end
       end
     end
   end