r10k 1.3.0 → 1.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWI1YTM1NWFjOTc0OWYzZTY4MzY0Y2YzY2JiOGE2ZjJhMWNiYTkxMg==
+    ZGE0OGNlNWExOWY4OWQ4NjE2NjM1MjQ5MDYzYjc2MjMxN2JkYzQwYw==
   data.tar.gz: !binary |-
-    NWEwY2EwNjg0ZjUyNDFiNjRkMTFkMWFiYTc5ZmIwZGM1ZDdlYTJkOQ==
+    MDg5MWRkNTVlODMyNzlmNzI1Zjk1NzhmOWYwMzc1YWY4NjA1YTJiOA==
 SHA512:
   metadata.gz: !binary |-
-    NmJhMWRmNWNlMmI5OTAzZDU5MWViZDc2N2FkOGRiZjY4NzRkM2YzZGI5ZmUw
-    MWVhOWQ0MmUzYzNmOTU0YWI3MzdhOThjZjkxOTM3ZGQyZmM4MjRjYzM3YjE4
-    MTBkODRlZTkwMzRiMTVkZDU2ZWVlZDllOGZmYTJkMjlhZDk0MTc=
+    YTkxMjk0Y2I1NDVhMDI4NGUwN2EwMjc2NTc2ZTg0YjYzMDlkNDE1ZGUxODk3
+    OGEwY2FlZGU4ZGI3YmU2YzE3N2U4YTc5NjAyZmIzMTU4NWJhZGY0M2QzNmVj
+    NTA4MGQyNWJiMWQ3MjhhZjE1MmZkMDExOGQ3NmRjM2Y4MjE0ZDY=
   data.tar.gz: !binary |-
-    ZTVlZWU3NTY1ZjhjYmMyZjEzMTRkOGU1NDk3MmNjOGZkOWIyZDVjOWY2YzQw
-    MDQyZjZkYTEwM2VmNTMwNWU5YWJmMjIxY2E1YThhYTRiOTAyNWE1ZjAzZDk0
-    MjRhMTUyYzdiZmQ4NzgxN2NlZjAyMmZiMWQ0OTFjNTYwZjE0YjI=
+    ZDNmNmE2NTY1YTVkYjY2YWMzMGMzMDIwOTQ2MGQ4YjQ1NmExODdjNjE0NzI2
+    YjE4NGZlYTUwZWRiM2ZlZWJjMDIyZTAyOTgyYjhhZTYzZTgxMTA4Y2JjZTkz
+    YWI3ZDI3MzViMzY1Yjc1OWRjNjMwYjY3ZDhmZjE3OGY3NWU0YWI=

data/CHANGELOG.mkd

@@ -1,6 +1,27 @@
 CHANGELOG
 =========
 
+1.3.1
+-----
+
+2014/07/16
+
+### User notes
+
+(GH-161) Deployments fail where a branch has \W in the git branch name
+
+In 1.3.0 environment naming was partially reworked to allow better handling of
+per-environment deployment, but unfortunately this caused a regression where
+environments would be differently named in 1.3.0. This fix changes the
+environment deployment on a per-name basis to use the normalized name instead
+of the raw Git branch name.
+
+This bugfix release also incorporates all fixes added in 1.2.2.
+
+### Thanks
+
+Thanks to Chris Spence for his work on this release.
+
 1.3.0
 -----
 
@@ -64,6 +85,41 @@ long run r10k will add a plugin system for loading additional code from
 Rubygems and other sources, so r10k will be extensible without requiring
 modifications to the source.
 
+1.2.2
+-----
+
+2014/07/16
+
+### User Notes
+
+(GH-165) `r10k puppetfile` only consumes handled command line options.
+
+Previously, passing `-v` or other commands when running `r10k puppetfile *`
+could result in this error:
+
+    r10k puppetfile install --help --trace
+    Error while running: #<RuntimeError: Unrecognized options: help>
+
+This was due to overly greedy code passing in all options from the command line
+to the TaskRunner. This has been fixed so only known options are passed along,
+and options that aren't relevant (such as :verbose) will be ignored.
+
+(GH-158) Log levels are now documented in the command line --help pages.
+
+(GH-137) Git remotes are now correctly updated.
+
+A regression in the Git remote handling meant that git remotes would never be
+properly updated when switching Git environments and modules from one remote
+to another, and the git alternates file was never updated properly. This has
+been fixed so that when the Git remote is updated, all references to the
+remotes and alternates will be updated.
+
+(GH-163) All Git tags are deleted when switching Git remotes
+
+Git tags cannot necessarily be transferred from one Git repository to another,
+so when a Git repo has its remotes changed all tags are deleted to prevent stale
+tags from overwriting tags from the new repo.
+
 1.2.1
 -----
 

data/lib/r10k/cli.rb

@@ -15,10 +15,23 @@ module R10K::CLI
         complex environments.
       EOD
 
-      flag :h, :help, 'Show help for this command'
+
+      flag :h, :help, 'Show help for this command' do |value, cmd|
+        # This is evil because we may not necessarily be called from the
+        # command line and have a meaningful ARGV to scan. However the best
+        # way of having a globally useful --help command is to define the
+        # behavior in the block of the option to immediately handle it and exit
+        # and we don't have access to the verbose option, so the simple method
+        # is to simply scan ARGV.
+        verbose = (ARGV.include?('-v') || ARGV.include?('--verbose'))
+        puts cmd.help(:verbose => verbose)
+        exit 0
+      end
+
       flag :t, :trace, 'Display stack traces on application crash'
 
-      optional :v, :verbose, 'Set verbosity level' do |value, cmd|
+      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'

data/lib/r10k/cli/deploy.rb

@@ -51,10 +51,6 @@ scheduled. On subsequent deployments, Puppetfile deployment will default to off.
           DESCRIPTION
 
           flag :p, :puppetfile, 'Deploy modules from a puppetfile'
-          flag :h, :help, 'Show help for this command' do |value, cmd|
-            puts cmd.help
-            exit 0
-          end
 
           run do |opts, args, cmd|
             deploy = R10K::Deployment.load_config(opts[:config])
@@ -90,10 +86,6 @@ It will load the Puppetfile configurations out of all environments, and will
 try to deploy the given module names in all environments.
           DESCRIPTION
 
-          flag :h, :help, 'Show help for this command' do |value, cmd|
-            puts cmd.help
-            exit 0
-          end
           required :e, :environment, 'Update the modules in the given environment'
 
           run do |opts, args, cmd|
@@ -122,10 +114,6 @@ try to deploy the given module names in all environments.
           summary 'Display environments and modules in the deployment'
 
           flag :p, :puppetfile, 'Display Puppetfile modules'
-          flag :h, :help, 'Show help for this command' do |value, cmd|
-            puts cmd.help
-            exit 0
-          end
 
           run do |opts, args, cmd|
             deploy = R10K::Deployment.load_config(opts[:config])

data/lib/r10k/cli/puppetfile.rb

@@ -37,7 +37,7 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
 
             puppetfile = R10K::Puppetfile.new(puppetfile_root, puppetfile_path, puppetfile)
 
-            runner = R10K::TaskRunner.new(opts)
+            runner = R10K::TaskRunner.new(:trace => opts[:trace])
             task   = R10K::Task::Puppetfile::Sync.new(puppetfile)
             runner.append_task task
 
@@ -90,7 +90,7 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
 
             puppetfile = R10K::Puppetfile.new(puppetfile_root, puppetfile_path, puppetfile)
 
-            runner = R10K::TaskRunner.new(opts)
+            runner = R10K::TaskRunner.new(:trace => opts[:trace])
             task   = R10K::Task::Puppetfile::Purge.new(puppetfile)
             runner.append_task task
 

data/lib/r10k/git.rb

@@ -10,6 +10,7 @@ module R10K
 
     require 'r10k/git/repository'
     require 'r10k/git/cache'
+    require 'r10k/git/alternates'
     require 'r10k/git/working_dir'
   end
 end

data/lib/r10k/git/alternates.rb

@@ -0,0 +1,49 @@
+require 'pathname'
+
+# Manage `$GIT_DIR/objects/info/alternates`
+#
+# @see man gitrepository-layout(5)
+class R10K::Git::Alternates
+
+  # @attribute [r] file
+  #   @return [Pathname] The alternates file
+  attr_reader :file
+
+  # @param git_dir [String] The path to the git repository
+  def initialize(git_dir)
+    @file = Pathname.new(File.join(git_dir, 'objects', 'info', 'alternates'))
+  end
+
+  def to_a
+    read()
+  end
+
+  def <<(path)
+    write(to_a << path)
+  end
+
+  def include?(path)
+    to_a.include?(path)
+  end
+
+  private
+
+  def write(entries)
+    if ! @file.parent.directory?
+      raise R10K::Git::GitError, "Cannot write #{@file.to_path}; parent directory does not exist"
+    end
+    @file.open("w") do |fh|
+      entries.each do |entry|
+        fh.puts(entry)
+      end
+    end
+  end
+
+  def read
+    entries = []
+    if @file.file?
+      entries = @file.readlines.map(&:chomp)
+    end
+    entries
+  end
+end

data/lib/r10k/git/repository.rb

@@ -84,7 +84,7 @@ class R10K::Git::Repository
 
     ret = {}
     output.stdout.each_line do |line|
-      next if line.match /\(push\)/
+      next if line.match(/\(push\)/)
       name, url, _ = line.split(/\s+/)
       ret[name] = url
     end
@@ -92,6 +92,13 @@ class R10K::Git::Repository
     ret
   end
 
+  def tags
+    entries = []
+    output = git(['tag', '-l'], :git_dir => @git_dir).stdout
+    output.each_line { |line| entries << line.chomp }
+    entries
+  end
+
   private
 
   # Fetch objects and refs from the given git remote

data/lib/r10k/git/working_dir.rb

@@ -40,7 +40,8 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
     @full_path = File.join(@basedir, @dirname)
     @git_dir   = File.join(@full_path, '.git')
 
-    @cache = R10K::Git::Cache.generate(@remote)
+    @alternates = R10K::Git::Alternates.new(@git_dir)
+    @cache      = R10K::Git::Cache.generate(@remote)
 
     if ref.is_a? String
       @ref = R10K::Git::Ref.new(ref, self)
@@ -60,7 +61,9 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
   end
 
   def update
-    if fetch?
+    update_remotes if update_remotes?
+
+    if ref_needs_fetch?
       fetch_from_cache
       checkout(@ref)
     elsif needs_checkout?
@@ -113,22 +116,17 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
 
   private
 
-  def fetch?
+  # Do we need to fetch additional objects and refs in order to resolve the given ref?
+  # @return [true, false]
+  def ref_needs_fetch?
     @ref.fetch?
   end
 
   def fetch_from_cache
-    set_cache_remote
     @cache.sync
     fetch('cache')
   end
 
-  def set_cache_remote
-    if self.remote != @cache.remote
-      git ["remote", "set-url", "cache", @cache.git_dir], :path => @full_path
-    end
-  end
-
   # Perform a non-bare clone of a git repository.
   def clone
     @cache.sync
@@ -150,6 +148,30 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
     expected = ref.sha1
     actual   = rev_parse('HEAD')
 
-    ! (expected == actual)
+    !(expected == actual)
+  end
+
+  def update_remotes?
+    real_remotes = remotes
+
+    expected_origin = @remote
+    expected_cache  = @cache.git_dir
+
+    !(expected_origin == real_remotes['origin'] and expected_cache == real_remotes['cache'])
+  end
+
+  def update_remotes
+    # todo: remove all existing refs as they may belong to the old remote
+    git ['remote', 'set-url', 'origin', remote], :path => @full_path
+    git ['remote', 'set-url', 'cache', @cache.git_dir], :path => @full_path
+    @alternates << File.join(@cache.git_dir, 'objects')
+    logger.debug("Removing stale git tags from #{@full_path}")
+    remove_tags
+  end
+
+  def remove_tags
+    tags.each do |tag|
+      git ['tag', '-d', tag], :path => @full_path
+    end
   end
 end

data/lib/r10k/task/deployment.rb

@@ -23,8 +23,14 @@ module Deployment
         # while this should be optimized that optimization can wait a while.
         names.each do |env_name|
 
+          # Elsewhere, we sanitise the env.dirname to sub any \W to _
+          # For this to match here (a single environment deploy where the 
+          # branch name has \W we need to sanitise the branch name to match
+
+          safe_branch_name = env_name.gsub(/\W/,'_')
+
           matching = all_environments.select do |env|
-            env.dirname == env_name
+            env.dirname == safe_branch_name
           end
 
           if matching.empty?

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/spec/unit/git/alternates_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'stringio'
+require 'r10k/git'
+
+describe R10K::Git::Alternates do
+  subject { described_class.new("/some/nonexistent/path/.git") }
+
+  it "interacts with the alternates file in the given git repository" do
+    expect(subject.file.to_path).to eq("/some/nonexistent/path/.git/objects/info/alternates")
+  end
+
+  describe "reading alternate object entries" do
+    it "reads the alternates file and splits on lines" do
+      expect(subject.file).to receive(:file?).and_return true
+      expect(subject.file).to receive(:readlines).and_return([
+        "/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git\n",
+        "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git\n",
+      ])
+
+      expect(subject.to_a).to eq([
+        "/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+        "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+      ])
+    end
+
+    it "returns an empty array when the file is not present" do
+      expect(subject.file).to receive(:file?).and_return false
+      expect(subject.file).to receive(:readlines).never
+      expect(subject.to_a).to eq([])
+    end
+  end
+
+  describe "determining if an entry is already present" do
+    before do
+      allow(subject).to receive(:to_a).and_return([
+        "/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+        "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+      ])
+    end
+
+    it "is true if the element is in the array of read entries" do
+      expect(subject).to include("/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git")
+    end
+
+    it "is false if the element is not in the array of read entries" do
+      expect(subject).to_not include("/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git")
+    end
+  end
+
+  describe "appending a new alternate object entry" do
+    describe "and the git objects/info directory does not exist" do
+      it "raises an error when the parent directory does not exist" do
+        expect {
+          subject << "/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git"
+        }.to raise_error(R10K::Git::GitError,"Cannot write /some/nonexistent/path/.git/objects/info/alternates; parent directory does not exist")
+      end
+    end
+
+    describe "and the git objects/info directory exists" do
+      let(:io) { StringIO.new }
+
+      before do
+        expect(subject.file).to receive(:open).with('w').and_yield(io)
+        subject.file.stub_chain(:parent, :directory?).and_return true
+      end
+
+
+      it "creates the alternates file with the new entry when not present" do
+        expect(subject).to receive(:to_a).and_return([])
+        subject << "/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git"
+
+        expect(io.string).to eq("/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git\n")
+      end
+
+      it "rewrites the file with all alternate entries" do
+        expect(subject).to receive(:to_a).and_return([
+          "/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+          "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+        ])
+        subject << "/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git"
+
+        expect(io.string).to eq(<<-EOD)
+/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git
+/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git
+/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git
+        EOD
+      end
+    end
+  end
+end

data/spec/unit/git/repository_spec.rb

@@ -21,4 +21,14 @@ describe R10K::Git::Repository do
       })
     end
   end
+
+  describe "tags" do
+    let(:tags) { %w[0.1.1 0.1.2 0.1.3 0.1.4 0.2.0 0.3.0 2.0.0] }
+    let(:output) { tags.map {|x| x + "\n"}.join }
+
+    it "returns a list of tags for this repo" do
+      expect(subject).to receive(:git).with(%w[tag -l], anything).and_return(double(:stdout => output))
+      expect(subject.tags).to eq(tags)
+    end
+  end
 end

data/spec/unit/git/working_dir_spec.rb

@@ -2,11 +2,120 @@ require 'spec_helper'
 require 'r10k/git'
 
 describe R10K::Git::WorkingDir do
+  include_context "fail on execution"
 
   describe "initializing" do
     it "generates a new cache for the remote" do
-      wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/tmp')
+      wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir')
       wd.cache.should be_kind_of R10K::Git::Cache
     end
+
+    it "uses the provided ref as the dirname when no dirname is given" do
+      wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir')
+      expect(wd.dirname).to eq('master')
+    end
+
+    it "uses an explicit dirname when given" do
+      wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir', 'mydir')
+      expect(wd.dirname).to eq('mydir')
+    end
+  end
+
+  describe "synchronizing the working directory" do
+    subject { described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir') }
+    it "clones the repository when the repository doesn't exist" do
+      expect(subject).to receive(:cloned?).and_return false
+      expect(subject).to receive(:clone)
+      subject.sync
+    end
+
+    it "updates the repository when the repository already exists" do
+      expect(subject).to receive(:cloned?).and_return true
+      expect(subject).to receive(:update)
+      subject.sync
+    end
+  end
+
+  describe "when cloning a new repository" do
+    subject { described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir') }
+
+    before do
+      allow(subject).to receive(:cloned?).and_return false
+    end
+
+    it "updates the cache before cloning" do
+      expect(subject.cache).to receive(:sync)
+      allow(subject).to receive(:git)
+      allow(subject).to receive(:checkout)
+      subject.sync
+    end
+
+    it "clones the repository and uses the cache git dir as an object reference" do
+      allow(subject.cache).to receive(:sync)
+      expect(subject).to receive(:git).with(['clone', '--reference', subject.cache.git_dir,
+                                             'git://github.com/adrienthebo/r10k-fixture-repo',
+                                             '/some/nonexistent/dir/master'])
+      expect(subject).to receive(:git).with(['remote', 'add', 'cache', subject.cache.git_dir],
+                                            an_instance_of(Hash))
+
+      expect(subject).to receive(:git).with(['fetch', 'cache'], an_instance_of(Hash))
+      allow(subject).to receive(:checkout)
+      subject.sync
+    end
+
+    it 'checks out the specific ref after the clone' do
+      allow(subject.cache).to receive(:sync)
+      allow(subject).to receive(:git)
+      expect(subject).to receive(:checkout)
+      subject.sync
+    end
+  end
+
+  describe "updating an existing repository" do
+    subject { described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir') }
+
+    before do
+      allow(subject).to receive(:cloned?).and_return true
+    end
+
+    it "updates the remotes when they are out of sync" do
+      allow(subject).to receive(:ref_needs_fetch?).and_return false
+      allow(subject).to receive(:needs_checkout?).and_return false
+
+      expect(subject).to receive(:update_remotes?).and_return true
+      expect(subject).to receive(:update_remotes)
+
+      subject.sync
+    end
+
+    it "updates the cache when the ref requires an update" do
+      allow(subject).to receive(:update_remotes?).and_return false
+
+      expect(subject).to receive(:ref_needs_fetch?).and_return true
+      expect(subject).to receive(:fetch_from_cache)
+      expect(subject).to receive(:checkout).with(an_instance_of(R10K::Git::Ref))
+
+      subject.sync
+    end
+
+    it "checks out the ref when the wrong commit is checked out" do
+      allow(subject).to receive(:update_remotes?).and_return false
+      allow(subject).to receive(:ref_needs_fetch?).and_return false
+
+      expect(subject).to receive(:needs_checkout?).and_return true
+      expect(subject).to receive(:checkout).with(an_instance_of(R10K::Git::Ref))
+
+      subject.sync
+    end
+
+    it "doesn't update the repo when everything is in sync" do
+      allow(subject).to receive(:update_remotes?).and_return false
+      allow(subject).to receive(:ref_needs_fetch?).and_return false
+      allow(subject).to receive(:needs_checkout?).and_return false
+
+      expect(subject).to_not receive(:checkout)
+
+      subject.sync
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -231,6 +231,7 @@ files:
 - lib/r10k/errors.rb
 - lib/r10k/execution.rb
 - lib/r10k/git.rb
+- lib/r10k/git/alternates.rb
 - lib/r10k/git/cache.rb
 - lib/r10k/git/commit.rb
 - lib/r10k/git/errors.rb
@@ -311,6 +312,7 @@ files:
 - spec/unit/deployment/source_spec.rb
 - spec/unit/environment/git_spec.rb
 - spec/unit/environment/svn_spec.rb
+- spec/unit/git/alternates_spec.rb
 - spec/unit/git/cache_spec.rb
 - spec/unit/git/commit_spec.rb
 - spec/unit/git/head_spec.rb
@@ -407,6 +409,7 @@ test_files:
 - spec/unit/git/commit_spec.rb
 - spec/unit/git/repository_spec.rb
 - spec/unit/git/head_spec.rb
+- spec/unit/git/alternates_spec.rb
 - spec/unit/git/tag_spec.rb
 - spec/unit/keyed_factory_spec.rb
 - spec/unit/deployment/environment_spec.rb