r10k 1.4.2 → 1.5.1

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

@@ -0,0 +1,110 @@
+require 'git_utils'
+require 'r10k_utils'
+require 'master_manipulator'
+test_name 'CODEMGMT-48 - C59263 - Multiple Environments with Adding, Removing and Re-adding Same Branch Name'
+
+#Init
+master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
+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')
+
+initial_env_names = ['production', 'stage']
+
+#Verification
+notify_message_regex = /I am in the production environment/
+stage_env_error_message_regex = /Error:.*Could not find environment 'stage'/
+
+#Manifest
+site_pp_path = File.join(git_environments_path, 'manifests', 'site.pp')
+site_pp = create_site_pp(master_certname, '  include helloworld')
+
+#Teardown
+teardown do
+  clean_up_r10k(master, last_commit, git_environments_path)
+end
+
+#Setup
+initial_env_names.each do |env|
+  if env == 'production'
+    step "Checkout \"#{env}\" Branch"
+    git_on(master, "checkout #{env}", git_environments_path)
+
+    step "Copy \"helloworld\" Module to \"#{env}\" Environment Git Repo"
+    scp_to(master, helloworld_module_path, File.join(git_environments_path, "site", 'helloworld'))
+
+    step "Inject New \"site.pp\" to the \"#{env}\" Environment"
+    inject_site_pp(master, site_pp_path, site_pp)
+
+    step "Push Changes to \"#{env}\" Environment"
+    git_add_commit_push(master, env, 'Update site.pp and add module.', git_environments_path)
+  else
+    step "Create \"#{env}\" Branch from \"production\""
+    git_on(master, 'checkout production', git_environments_path)
+    git_on(master, "checkout -b #{env}", git_environments_path)
+
+    step "Push Changes to \"#{env}\" Environment"
+    git_push(master, env, git_environments_path)
+  end
+end
+
+#Tests
+step 'Deploy Environments via r10k'
+on(master, 'r10k deploy environment -v')
+
+#Initial Verification
+initial_env_names.each do |env|
+  agents.each do |agent|
+    step "Run Puppet Agent Against \"#{env}\" Environment"
+    on(agent, puppet('agent', '--test', "--environment #{env}"), :acceptable_exit_codes => 2) do |result|
+      assert_no_match(/Error:/, result.stderr, 'Unexpected error was detected!')
+      assert_match(/I am in the #{env} environment/, result.stdout, 'Expected message not found!')
+    end
+  end
+end
+
+#Remove "stage" Environment
+step 'Delete the "stage" Environment'
+git_on(master, 'checkout production', git_environments_path)
+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')
+
+#Second Pass Verification
+agents.each do |agent|
+  step 'Run Puppet Agent Against "production" Environment'
+  on(agent, puppet('agent', '--test', '--environment production'), :acceptable_exit_codes => 2) do |result|
+    assert_no_match(/Error:/, result.stderr, 'Unexpected error was detected!')
+    assert_match(notify_message_regex, result.stdout, 'Expected message not found!')
+  end
+
+  step 'Attempt to Run Puppet Agent Against "stage" Environment'
+  on(agent, puppet('agent', '--test', '--environment stage'), :acceptable_exit_codes => 1) do |result|
+    assert_match(stage_env_error_message_regex, result.stderr, 'Expected error was not detected!')
+  end
+end
+
+#Create the "stage" Environment Again
+step 'Create "stage" Branch from "production"'
+git_on(master, 'checkout production', git_environments_path)
+git_on(master, 'checkout -b stage', git_environments_path)
+
+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')
+
+#Final Verification
+initial_env_names.each do |env|
+  agents.each do |agent|
+    step "Run Puppet Agent Against \"#{env}\" Environment"
+    on(agent, puppet('agent', '--test', "--environment #{env}"), :acceptable_exit_codes => 2) do |result|
+      assert_no_match(/Error:/, result.stderr, 'Unexpected error was detected!')
+      assert_match(/I am in the #{env} environment/, result.stdout, 'Expected message not found!')
+    end
+  end
+end

data/lib/r10k/action/cri_runner.rb

@@ -41,19 +41,16 @@ module R10K
 
       # @return [Hash] The adapted options for the runner
       def handle_opts(opts)
-        # Translate from the Cri verbose logging option to the internal logging setting.
-        loglevel = opts.delete(:verbose)
-        case loglevel
-        when String, Numeric
-          opts[:loglevel] = loglevel
-        when TrueClass
-          opts[:loglevel] = 'INFO'
-        when NilClass
-          # pass
-        else
-          # When the type is unsure just pass it in as-is and let the internals
-          # raise the appropriate errors.
-          opts[:loglevel] = loglevel
+        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

data/lib/r10k/cli.rb

@@ -31,14 +31,9 @@ module R10K::CLI
       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}" do |value, cmd|
-        case value
-        when true
-          R10K::Logging.level = 'INFO'
-        when String
-          R10K::Logging.level = value
-        end
-      end
+      optional :v, :verbose, "Set log verbosity. Valid values: #{loglevels}"
+
+      flag nil, :color, 'Enable colored log messages'
 
       required :c, :config, 'Specify a global configuration file (deprecated, use `r10k deploy -c`)' do |value, cmd|
         logger.warn "Calling `r10k --config <action>` as a global option is deprecated; use r10k <action> --config"

data/lib/r10k/cli/version.rb

@@ -12,7 +12,16 @@ module R10K::CLI
         summary 'Print the version of r10k'
 
         run do |opts, args, cmd|
-          puts R10K::VERSION
+          puts "r10k #{R10K::VERSION}"
+          if opts[:verbose]
+            puts RUBY_DESCRIPTION
+            cmdpath = caller.last.slice(/\A.*#{$PROGRAM_NAME}/)
+            puts "Command path: #{cmdpath}"
+            puts "Interpreter path: #{Gem.ruby}"
+            if RUBY_VERSION >= '1.9'
+              puts "Default encoding: #{Encoding.default_external.name}"
+            end
+          end
           exit 0
         end
       end

data/lib/r10k/deployment/config.rb

@@ -1,5 +1,7 @@
 require 'r10k/deployment'
 require 'r10k/deployment/config/loader'
+require 'r10k/util/symbolize_keys'
+require 'r10k/errors'
 require 'yaml'
 
 module R10K
@@ -52,17 +54,35 @@ class Config
 
   private
 
-  # Apply config settings to the relevant classes after a config has been loaded.
-  #
-  # @note this is hack. And gross. And terribad. I am sorry.
+  def with_setting(key, &block)
+    value = setting(key)
+    block.call(value) unless value.nil?
+  end
+
+  # Apply global configuration settings.
   def apply_config_settings
-    cachedir = setting(:cachedir)
-    if cachedir
+    with_setting(:cachedir) do |cachedir|
       R10K::Git::Cache.settings[:cache_root] = cachedir
     end
+
+    with_setting(:git) do |git_settings|
+      R10K::Util::SymbolizeKeys.symbolize_keys!(git_settings)
+      provider = git_settings[:provider]
+      if provider
+        R10K::Git.provider = provider.to_sym
+      end
+
+      if git_settings[:private_key]
+        R10K::Git.settings[:private_key] = git_settings[:private_key]
+      end
+
+      if git_settings[:username]
+        R10K::Git.settings[:username] = git_settings[:username]
+      end
+    end
   end
 
-  class ConfigError < StandardError
+  class ConfigError < R10K::Error
   end
 end
 end

data/lib/r10k/deployment/config/loader.rb

@@ -1,43 +1,52 @@
+require 'r10k/logging'
 
 module R10K
-class Deployment
-class Config
-class Loader
-  # Search for a deployment configuration file (r10k.yaml) in all parent
-  # directories and in /etc/r10k.yaml
+  class Deployment
+    class Config
+      class Loader
 
-  def initialize
-    @loadpath = []
+        include R10K::Logging
 
-    populate_loadpath
-  end
+        attr_reader :loadpath
 
-  # @return [String] The path to the first valid configfile
-  def search
-    first = @loadpath.find {|filename| File.file? filename}
-  end
+        CONFIG_FILE = 'r10k.yaml'
+        DEFAULT_LOCATION = File.join('/etc/puppetlabs/r10k', CONFIG_FILE)
+        OLD_DEFAULT_LOCATION = File.join('/etc', CONFIG_FILE)
 
-  private
+        # Search for a deployment configuration file (r10k.yaml) in several locations
+        def initialize
+          @loadpath = []
+          populate_loadpath
+        end
 
-  def populate_loadpath
+        # @return [String] The path to the first valid configfile
+        def search
 
-    # Scan all parent directories for r10k
-    dir_components = Dir.getwd.split(File::SEPARATOR)
+          # If both default files are present, issue a warning.
+          if (File.file? DEFAULT_LOCATION) && (File.file? OLD_DEFAULT_LOCATION)
+            logger.warn "Both #{DEFAULT_LOCATION} and #{OLD_DEFAULT_LOCATION} configuration files exist."
+            logger.warn "#{DEFAULT_LOCATION} will be used."
+          end
 
-    dir_components.each_with_index do |dirname, index|
-      full_path = [''] # Shim case for root directory
-      full_path << dir_components[0...index]
-      full_path << dirname << 'r10k.yaml'
+          first = @loadpath.find {|filename| File.file? filename}
+        end
 
-      @loadpath << File.join(full_path)
-    end
+        private
+
+        def populate_loadpath
+
+          # Add the current directory for r10k.yaml
+          @loadpath << File.join(Dir.getwd, CONFIG_FILE)
 
-    # Always check /etc/r10k.yaml
-    @loadpath << '/etc/r10k.yaml'
+          # Add the AIO location for of r10k.yaml
+          @loadpath << DEFAULT_LOCATION
 
-    @loadpath
+          # Add the old default location last.
+          @loadpath << OLD_DEFAULT_LOCATION
+
+          @loadpath
+        end
+      end
+    end
   end
 end
-end
-end
-end

data/lib/r10k/deployment/source.rb

@@ -1,5 +1,5 @@
 require 'r10k/source'
-require 'r10k/util/core_ext/hash_ext'
+require 'r10k/util/symbolize_keys'
 
 module R10K
 class Deployment
@@ -18,9 +18,7 @@ class Source
   # @deprecated
   # @return [R10K::Source::Base]
   def self.vivify(name, attrs)
-
-    attrs.extend R10K::Util::CoreExt::HashExt::SymbolizeKeys
-    attrs.symbolize_keys!
+    R10K::Util::SymbolizeKeys.symbolize_keys!(attrs)
 
     remote  = attrs.delete(:remote)
     basedir = attrs.delete(:basedir)

data/lib/r10k/environment/git.rb

@@ -1,6 +1,7 @@
 require 'r10k/logging'
 require 'r10k/puppetfile'
-require 'r10k/git/working_dir'
+require 'r10k/git/stateful_repository'
+require 'forwardable'
 
 # This class implements an environment based on a Git branch.
 #
@@ -17,10 +18,10 @@ class R10K::Environment::Git < R10K::Environment::Base
   #   @return [String] The git reference to use for this environment
   attr_reader :ref
 
-  # @!attribute [r] working_dir
+  # @!attribute [r] repo
   #   @api private
-  #   @return [R10K::Git::WorkingDir] The git working directory backing this environment
-  attr_reader :working_dir
+  #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
+  attr_reader :repo
 
   # Initialize the given SVN environment.
   #
@@ -36,7 +37,7 @@ class R10K::Environment::Git < R10K::Environment::Base
     @remote = options[:remote]
     @ref    = options[:ref]
 
-    @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @basedir, @dirname)
+    @repo = R10K::Git::StatefulRepository.new(@ref, @remote, @basedir, @dirname)
   end
 
   # Clone or update the given Git environment.
@@ -47,23 +48,13 @@ class R10K::Environment::Git < R10K::Environment::Base
   # @api public
   # @return [void]
   def sync
-    @working_dir.sync
+    @repo.sync
     @synced = true
   end
 
-  def status
-    if !@working_dir.exist?
-      :absent
-    elsif !@working_dir.git?
-      :mismatched
-    elsif !(@remote == @working_dir.remote)
-      :mismatched
-    elsif !@synced
-      :outdated
-    else
-      :insync
-    end
-  end
+  extend Forwardable
+
+  def_delegators :@repo, :status
 
   # @deprecated
   # @api private

data/lib/r10k/environment/name.rb

@@ -0,0 +1,86 @@
+module R10K
+  module Environment
+    # Handle environment name validation and modification.
+    #
+    # @api private
+    class Name
+
+      # @!attribute [r] name
+      #   @return [String] The unmodified name of the environment
+      attr_reader :name
+
+      INVALID_CHARACTERS = %r[\W]
+
+      def initialize(name, opts)
+        @name   = name
+        @opts   = opts
+
+        @source  = opts[:source]
+        @prefix  = opts[:prefix]
+        @invalid = opts[:invalid]
+
+        case @invalid
+        when 'correct_and_warn'
+          @validate = true
+          @correct  = true
+        when 'correct'
+          @validate = false
+          @correct  = true
+        when 'error'
+          @validate = true
+          @correct  = false
+        when NilClass
+          @validate = opts[:validate]
+          @correct = opts[:correct]
+        end
+      end
+
+      # Should the environment name have invalid characters removed?
+      def correct?
+        @correct
+      end
+
+      def validate?
+        @validate
+      end
+
+      def valid?
+        if @validate
+          ! @name.match(INVALID_CHARACTERS)
+        else
+          true
+        end
+      end
+
+      # The directory name for the environment, modified as necessary to remove
+      # invalid characters.
+      #
+      # @return [String]
+      def dirname
+        dir = @name.dup
+
+        prefix = derive_prefix(@source,@prefix)
+
+        if @correct
+          dir.gsub!(INVALID_CHARACTERS, '_')
+        end
+
+        "#{prefix}#{dir}"
+      end
+
+
+      private
+
+      def derive_prefix(source,prefix)
+
+        if prefix == true
+          "#{source}_"
+        elsif prefix.is_a? String
+          "#{prefix}_"
+        else
+          nil
+        end
+      end
+    end
+  end
+end