r10k 2.3.1 → 2.4.0

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

@@ -26,7 +26,7 @@ module R10K
         end
 
         def visit_module(mod)
-          logger.info "Updating module #{mod.path}"
+          logger.info _("Updating module %{mod_path}") % {mod_path: mod.path}
           mod.sync
         end
 

data/lib/r10k/action/runner.rb

@@ -46,7 +46,7 @@ module R10K
         overrides.delete_if { |_, val| val.nil? }
 
         with_overrides = config_settings.merge(overrides) do |key, oldval, newval|
-          logger.debug2 "Overriding config file setting '#{key}': '#{oldval}' -> '#{newval}'"
+          logger.debug2 _("Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'") % {key: key, old_val: oldval, new_val: newval}
           newval
         end
 
@@ -79,10 +79,10 @@ module R10K
 
         if path
           @opts[:config] = path
-          logger.debug2 "Reading configuration from #{path.inspect}"
+          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."
+          logger.debug2 _("No config file explicitly given and no default config file could be found, default settings will be used.")
         end
 
         results

data/lib/r10k/deployment.rb

@@ -87,9 +87,13 @@ module R10K
         source.environments.each do |environment|
           if hash.key?(environment.path)
             osource, oenvironment = hash[environment.path]
-            msg = ""
-            msg << "Environment collision at #{environment.path} between "
-            msg << "#{source.name}:#{environment.name} and #{osource.name}:#{oenvironment.name}"
+            msg = _("Environment collision at %{env_path} between %{source}:%{env_name} and %{osource}:%{oenv_name}") % 
+              {env_path: environment.path,
+               source: source.name,
+               env_name: environment.name,
+               osource: osource.name,
+               oenv_name: oenvironment.name}
+
             raise R10K::Error, msg
           else
             hash[environment.path] = [source, environment]
@@ -111,7 +115,7 @@ module R10K
     def load_sources
       sources = @config[:sources]
       if sources.nil? || sources.empty?
-        raise R10K::Error, "Unable to load sources; the supplied configuration does not define the 'sources' key"
+        raise R10K::Error, _("Unable to load sources; the supplied configuration does not define the 'sources' key")
       end
       @_sources = sources.map do |(name, hash)|
         R10K::Source.from_hash(name, hash)

data/lib/r10k/deployment/config.rb

@@ -39,7 +39,7 @@ class Config
     hash = loader.read(@configfile)
 
     with_overrides = hash.merge(@overrides) do |key, oldval, newval|
-      logger.debug2 "Overriding config file setting '#{key}': '#{oldval}' -> '#{newval}'"
+      logger.debug2 _("Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'") % {key: key, old_val: oldval, new_val: newval}
       newval
     end
 

data/lib/r10k/environment/base.rb

@@ -39,7 +39,9 @@ class R10K::Environment::Base
 
     @full_path = File.join(@basedir, @dirname)
     @path = Pathname.new(File.join(@basedir, @dirname))
+
     @puppetfile  = R10K::Puppetfile.new(@full_path)
+    @puppetfile.environment = self
   end
 
   # Synchronize the given environment.
@@ -48,7 +50,7 @@ class R10K::Environment::Base
   # @abstract
   # @return [void]
   def sync
-    raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__}
   end
 
   # Determine the current status of the environment.
@@ -64,7 +66,7 @@ class R10K::Environment::Base
   # @abstract
   # @return [Symbol]
   def status
-    raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__}
   end
 
   # Returns a unique identifier for the environment's current state.
@@ -73,7 +75,7 @@ class R10K::Environment::Base
   # @abstract
   # @return [String]
   def signature
-    raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") %{class: self.class, method: __method__}
   end
 
   # Returns a hash describing the current state of the environment.
@@ -98,4 +100,31 @@ class R10K::Environment::Base
       puppetfile.accept(visitor)
     end
   end
+
+  def whitelist(user_whitelist=[])
+    user_whitelist.collect { |pattern| File.join(@full_path, pattern) }
+  end
+
+  def purge_exclusions
+    list = [File.join(@full_path, '.r10k-deploy.json')].to_set
+
+    list += @puppetfile.managed_directories
+
+    list += @puppetfile.desired_contents.flat_map do |item|
+      desired_tree = []
+
+      if File.directory?(item)
+        desired_tree << File.join(item, '**', '*')
+      end
+
+      Pathname.new(item).ascend do |path|
+        break if path.to_s == @full_path
+        desired_tree << path.to_s
+      end
+
+      desired_tree
+    end
+
+    list.to_a
+  end
 end

data/lib/r10k/environment/git.rb

@@ -23,7 +23,7 @@ class R10K::Environment::Git < R10K::Environment::Base
   #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
   attr_reader :repo
 
-  # Initialize the given SVN environment.
+  # Initialize the given Git environment.
   #
   # @param name [String] The unique name describing this environment.
   # @param basedir [String] The base directory where this environment will be created.
@@ -37,7 +37,7 @@ class R10K::Environment::Git < R10K::Environment::Base
     @remote = options[:remote]
     @ref    = options[:ref]
 
-    @repo = R10K::Git::StatefulRepository.new(@ref, @remote, @basedir, @dirname)
+    @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
   end
 
   # Clone or update the given Git environment.
@@ -48,8 +48,11 @@ class R10K::Environment::Git < R10K::Environment::Base
   # @api public
   # @return [void]
   def sync
-    @repo.sync
-    @synced = true
+    @repo.sync(@ref)
+  end
+
+  def status
+    @repo.status(@ref)
   end
 
   # Return a sting which uniquely identifies (per source) the current state of the
@@ -61,7 +64,17 @@ class R10K::Environment::Git < R10K::Environment::Base
     @repo.head
   end
 
-  extend Forwardable
+  include R10K::Util::Purgeable
 
-  def_delegators :@repo, :status
+  def managed_directories
+    [@full_path]
+  end
+
+  # Returns an array of the full paths to all the content being managed.
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def desired_contents
+    desired = [File.join(@full_path, '.git')]
+    desired += @repo.tracked_paths.map { |entry| File.join(@full_path, entry) }
+  end
 end

data/lib/r10k/feature.rb

@@ -24,29 +24,29 @@ module R10K
 
     # @return [true, false] Is this feature available?
     def available?
-      logger.debug1 { "Testing to see if feature #{@name} is available." }
+      logger.debug1 { _("Testing to see if feature %{name} is available.") % {name: @name} }
       rv = @libraries.all? { |lib| library_available?(lib) } && proc_available?
       msg = rv ? "is" : "is not"
-      logger.debug1 { "Feature #{@name} #{msg} available." }
+      logger.debug1 { _("Feature %{name} %{message} available.") % {name: @name, message: msg} }
       rv
     end
 
     private
 
     def library_available?(lib)
-      logger.debug2 { "Attempting to load library '#{lib}' for feature #{@name}" }
+      logger.debug2 { _("Attempting to load library '%{lib}' for feature %{name}") % {lib: lib, name: @name} }
       require lib
       true
     rescue ScriptError => e
-      logger.debug2 { "Error while loading library #{lib} for feature #{@name}: #{e.message}" }
+      logger.debug2 { _("Error while loading library %{lib} for feature %{name}: %{error_msg}") % {lib: lib, name: @name, error_msg: e.message} }
       false
     end
 
     def proc_available?
       if @block
-        logger.debug2 { "Evaluating proc #{@block.inspect} to test for feature #{@name}" }
+        logger.debug2 { _("Evaluating proc %{block} to test for feature %{name}") % {block: @block.inspect, name: @name} }
         output = @block.call
-        logger.debug2 { "Proc #{@block.inspect} for feature #{@name} returned #{output.inspect}" }
+        logger.debug2 { _("Proc %{block} for feature %{name} returned %{output}") % {block: @block.inspect, name: @name, output: output.inspect } }
         !!output
       else
         true

data/lib/r10k/forge/module_release.rb

@@ -91,16 +91,14 @@ module R10K
       #   should be unpacked/installed into.
       # @return [void]
       def unpack(target_dir)
-        logger.debug1 "Unpacking #{download_path} to #{target_dir} (with tmpdir #{unpack_path})"
+        logger.debug1 _("Unpacking %{download_path} to %{target_dir} (with tmpdir %{tmp_path})") % {download_path: download_path, target_dir: target_dir, tmp_path: unpack_path}
         file_lists = PuppetForge::Unpacker.unpack(download_path.to_s, target_dir.to_s, unpack_path.to_s)
-        logger.debug2 "Valid files unpacked: #{file_lists[:valid]}"
+        logger.debug2 _("Valid files unpacked: %{valid_files}") % {valid_files: file_lists[:valid]}
         if !file_lists[:invalid].empty?
-          logger.debug1 "These files existed in the module's tar file, but are invalid filetypes and were not " +
-                        "unpacked: #{file_lists[:invalid]}"
+          logger.debug1 _("These files existed in the module's tar file, but are invalid filetypes and were not unpacked: %{invalid_files}") % {invalid_files: file_lists[:invalid]}
         end
         if !file_lists[:symlinks].empty?
-          raise R10K::Error, "Symlinks are unsupported and were not unpacked from the module tarball. " +
-                             "#{@forge_release.slug} contained these ignored symlinks: #{file_lists[:symlinks]}"
+          logger.warn _("Symlinks are unsupported and were not unpacked from the module tarball. %{release_slug} contained these ignored symlinks: %{symlinks}") % {release_slug: @forge_release.slug, symlinks: file_lists[:symlinks]}
         end
       end
 

data/lib/r10k/git.rb

@@ -29,7 +29,7 @@ module R10K
           :on_set  => proc do
             [:ssh, :https].each do |transport|
               if !::Rugged.features.include?(transport)
-                logger.warn "Rugged has been compiled without support for #{transport}; Git repositories will not be reachable via #{transport}."
+                logger.warn _("Rugged has been compiled without support for %{transport}; Git repositories will not be reachable via %{transport}.") % {transport: transport}
               end
             end
           end
@@ -65,7 +65,7 @@ module R10K
     def self.default_name
       name, _ = @providers.find { |(_, hash)| R10K::Features.available?(hash[:feature]) }
       if name.nil?
-        raise R10K::Error, "No Git providers are functional."
+        raise R10K::Error, _("No Git providers are functional.")
       end
       name
     end
@@ -82,18 +82,18 @@ module R10K
       _, attrs = @providers.find { |(providername, _)| name == providername }
       if attrs.nil?
         @provider = NULL_PROVIDER
-        raise R10K::Error, "No Git provider named '#{name}'."
+        raise R10K::Error, _("No Git provider named '%{name}'.") % {name: name}
       end
       if !R10K::Features.available?(attrs[:feature])
         @provider = NULL_PROVIDER
-        raise R10K::Error, "Git provider '#{name}' is not functional."
+        raise R10K::Error, _("Git provider '%{name}' is not functional.") % {name: name}
       end
       if attrs[:on_set]
         attrs[:on_set].call
       end
 
       @provider = attrs[:module]
-      logger.debug1 { "Setting Git provider to #{@provider.name}" }
+      logger.debug1 { _("Setting Git provider to %{provider}") % {provider: @provider.name} }
     end
 
     # @return [Module] The namespace of the first available Git implementation.
@@ -101,10 +101,10 @@ module R10K
     def self.provider
       case @provider
       when NULL_PROVIDER
-        raise R10K::Error, "No Git provider set."
+        raise R10K::Error, _("No Git provider set.")
       when UNSET_PROVIDER
         self.provider = default_name
-        logger.debug1 { "Setting Git provider to default provider #{default_name}" }
+        logger.debug1 { _("Setting Git provider to default provider %{name}") % {name: default_name} }
       end
 
       @provider

data/lib/r10k/git/alternates.rb

@@ -43,7 +43,7 @@ class R10K::Git::Alternates
 
   def write(entries)
     if ! @file.parent.directory?
-      raise R10K::Git::GitError, "Cannot write #{@file}; parent directory does not exist"
+      raise R10K::Git::GitError, _("Cannot write %{file}; parent directory does not exist") % {file: @file}
     end
     @file.open("w") do |fh|
       entries.each do |entry|

data/lib/r10k/git/cache.rb

@@ -52,7 +52,7 @@ class R10K::Git::Cache
   #   @deprecated
   #   @return [String] The path to the git cache repository
   def path
-    logger.warn "#{self.class}#path is deprecated; use #git_dir"
+    logger.warn _("%{class}#path is deprecated; use #git_dir") % {class: self.class}
     git_dir
   end
 
@@ -81,7 +81,7 @@ class R10K::Git::Cache
     if cached?
       @repo.fetch
     else
-      logger.debug1 "Creating new git cache for #{@remote.inspect}"
+      logger.debug1 _("Creating new git cache for %{remote}") % {remote: @remote.inspect}
 
       # TODO extract this to an initialization step
       if !File.exist?(settings[:cache_root])

data/lib/r10k/git/rugged/bare_repository.rb

@@ -31,7 +31,7 @@ class R10K::Git::Rugged::BareRepository < R10K::Git::Rugged::BaseRepository
   # @param remote [String] The URL of the Git remote to clone.
   # @return [void]
   def clone(remote)
-    logger.debug1 { "Cloning '#{remote}' into #{@path}" }
+    logger.debug1 { _("Cloning '%{remote}' into %{path}") % {remote: remote, path: @path} }
 
     @_rugged_repo = ::Rugged::Repository.init_at(@path.to_s, true).tap do |repo|
       config = repo.config
@@ -49,14 +49,9 @@ class R10K::Git::Rugged::BareRepository < R10K::Git::Rugged::BaseRepository
   #
   # @return [void]
   def fetch(remote_name='origin')
-    logger.debug1 { "Fetching remote '#{remote_name}' at #{@path}" }
-
-    # Check to see if we have a version of Rugged that supports "fetch --prune" and warn if not
-    if defined?(Rugged::Version) && !Gem::Dependency.new('rugged', '>= 0.24.0').match?('rugged', Rugged::Version)
-      logger.warn { "Rugged versions prior to 0.24.0 do not support pruning stale branches during fetch, please upgrade your \'rugged\' gem. (Current version is: #{Rugged::Version})" }
-    end
-
-    options = {:credentials => credentials, :prune => true}
+    backup_branches = wipe_branches
+    logger.debug1 { _("Fetching remote '%{remote_name}' at %{path}") % {remote_name: remote_name, path: @path } }
+    options = {:credentials => credentials}
     refspecs = ['+refs/*:refs/*']
 
     remote = remotes[remote_name]
@@ -69,12 +64,37 @@ class R10K::Git::Rugged::BareRepository < R10K::Git::Rugged::BaseRepository
 
     report_transfer(results, remote_name)
   rescue Rugged::SshError, Rugged::NetworkError => e
+    restore_branches(backup_branches)
     raise R10K::Git::GitError.new(e.message, :git_dir => git_dir, :backtrace => e.backtrace)
   rescue
+    restore_branches(backup_branches)
     raise
   end
 
   def exist?
     @path.exist?
   end
+
+  def wipe_branches
+    backup_branches = {}
+    with_repo do |repo|
+      repo.branches.each do |branch|
+        if !branch.head?
+          backup_branches[branch.name] = branch.target_id
+          repo.branches.delete(branch)
+        end
+      end
+    end
+    backup_branches
+  end
+
+  def restore_branches(backup_branches)
+    with_repo do |repo|
+      backup_branches.each_pair do |name, ref|
+        if !repo.branches.exist?(name)
+          repo.create_branch(name, ref)
+        end
+      end
+    end
+  end
 end

data/lib/r10k/git/rugged/credentials.rb

@@ -21,7 +21,7 @@ class R10K::Git::Rugged::Credentials
     # Break out of infinite HTTP auth retry loop introduced in libgit2/rugged 0.24.0, libssh
     # auth seems to already abort after ~50 attempts.
     if @called > 50
-      raise R10K::Git::GitError.new("Authentication failed for Git remote #{url.inspect}.")
+      raise R10K::Git::GitError.new(_("Authentication failed for Git remote %{url}.") % {url: url.inspect} )
     end
 
     if allowed_types.include?(:ssh_key)
@@ -45,16 +45,16 @@ class R10K::Git::Rugged::Credentials
 
     if per_repo_private_key
       private_key = per_repo_private_key
-      logger.debug2 "Using per-repository private key #{private_key} for URL #{url.inspect}"
+      logger.debug2 _("Using per-repository private key %{key} for URL %{url}") % {key: private_key, url: url.inspect}
     elsif global_private_key
       private_key = global_private_key
-      logger.debug2 "URL #{url.inspect} has no per-repository private key using '#{private_key}'."
+      logger.debug2 _("URL %{url} has no per-repository private key using '%{key}'." ) % {key: private_key, url: url.inspect}
     else
-      raise R10K::Git::GitError.new("Git remote #{url.inspect} uses the SSH protocol but no private key was given", :git_dir => @repository.path.to_s)
+      raise R10K::Git::GitError.new(_("Git remote %{url} uses the SSH protocol but no private key was given") % {url: url.inspect}, :git_dir => @repository.path.to_s)
     end
 
     if !File.readable?(private_key)
-      raise R10K::Git::GitError.new("Unable to use SSH key auth for #{url.inspect}: private key #{private_key.inspect} is missing or unreadable", :git_dir => @repository.path.to_s)
+      raise R10K::Git::GitError.new(_("Unable to use SSH key auth for %{url}: private key %{private_key} is missing or unreadable") % {url: url.inspect, private_key: private_key.inspect}, :git_dir => @repository.path.to_s)
     end
 
     Rugged::Credentials::SshKey.new(:username => user, :privatekey => private_key)
@@ -77,13 +77,13 @@ class R10K::Git::Rugged::Credentials
 
     if !username_from_url.nil?
       user = username_from_url
-      logger.debug2 "URL #{url.inspect} includes the username #{username_from_url}, using that user for authentication."
+      logger.debug2 _("URL %{url} includes the username %{username}, using that user for authentication.") % {url: url.inspect, username: username_from_url}
     elsif git_user
       user = git_user
-      logger.debug2 "URL #{url.inspect} did not specify a user, using #{user.inspect} from configuration"
+      logger.debug2 _("URL %{url} did not specify a user, using %{user} from configuration") % {url: url.inspect, user: user.inspect}
     else
       user = Etc.getlogin
-      logger.debug2 "URL #{url.inspect} did not specify a user, using current user #{user.inspect}"
+      logger.debug2 _("URL %{url} did not specify a user, using current user %{user}") % {url: url.inspect, user: user.inspect}
     end
 
     user

data/lib/r10k/git/rugged/thin_repository.rb

@@ -44,8 +44,8 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
     checkout(opts.fetch(:ref, 'HEAD'))
   end
 
-  def checkout(ref)
-    super(@cache_repo.resolve(ref))
+  def checkout(ref, opts = {})
+    super(@cache_repo.resolve(ref), opts)
   end
 
   # Fetch refs and objects from one of the Git remotes
@@ -61,6 +61,20 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
     with_repo { |repo| repo.config['remote.cache.url'] }
   end
 
+  def tracked_paths(ref="HEAD")
+    with_repo do |repo|
+      commit = repo.rev_parse(ref)
+
+      unless commit && commit.tree
+        raise R10K::Error.new("Unable to resolve '#{ref}' to a valid commit in repo #{@path}")
+      end
+
+      commit.tree.walk(:postorder).collect do |root, entry|
+        root.empty? ? entry[:name] : File.join(root, entry[:name])
+      end
+    end
+  end
+
   private
 
   # Override the parent class repo setup so that we can make sure the alternates file is up to date
@@ -68,7 +82,7 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
   def setup_rugged_repo
     entry_added = alternates.add?(@cache_repo.objects_dir.to_s)
     if entry_added
-      logger.debug2 { "Updated repo #{@path} to include alternate object db path #{@cache_repo.objects_dir}" }
+      logger.debug2 { _("Updated repo %{path} to include alternate object db path %{objects_dir}") % {path: @path, objects_dir: @cache_repo.objects_dir} }
     end
     super
   end