r10k 1.3.5 → 1.4.0

data/spec/unit/environment/svn_spec.rb

@@ -35,17 +35,15 @@ describe R10K::Environment::SVN do
   end
 
   describe "synchronizing the environment" do
-    it "updates all modules when creating a new environment" do
+    it "checks out the working directory when creating a new environment" do
       allow(working_dir).to receive(:is_svn?).and_return(false)
       expect(working_dir).to receive(:checkout)
-      expect(subject).to receive(:sync_modules)
       subject.sync
     end
 
-    it "does not update all modules when updating an existing environment" do
+    it "updates the working directory when updating an existing environment" do
       allow(working_dir).to receive(:is_svn?).and_return(true)
       expect(working_dir).to receive(:update)
-      expect(subject).to_not receive(:sync_modules)
       subject.sync
     end
   end
@@ -73,4 +71,43 @@ describe R10K::Environment::SVN do
       expect(subject.modules).to eq([:modules])
     end
   end
+
+  describe "determining the status" do
+    it "is absent if the working directory is absent" do
+      expect(subject.path).to receive(:exist?).and_return(false)
+      expect(subject.status).to eq :absent
+    end
+
+    it "is mismatched if the working directory is not an SVN repo" do
+      expect(subject.path).to receive(:exist?).and_return(true)
+      expect(working_dir).to receive(:is_svn?).and_return(false)
+      expect(subject.status).to eq :mismatched
+    end
+
+    it "is mismatched if the working directory remote doesn't match the expected remote" do
+      expect(subject.path).to receive(:exist?).and_return(true)
+      expect(working_dir).to receive(:is_svn?).and_return(true)
+      expect(working_dir).to receive(:url).and_return 'https://svn-server.site/another-svn-repo/trunk'
+      expect(subject.status).to eq :mismatched
+    end
+
+    it "is outdated when the the working directory has not synced" do
+      expect(subject.path).to receive(:exist?).and_return(true)
+      expect(working_dir).to receive(:is_svn?).and_return(true)
+      expect(working_dir).to receive(:url).and_return 'https://svn-server.site/svn-repo/trunk'
+      expect(subject.status).to eq :outdated
+    end
+
+    it "is insync when the working directory has been synced" do
+      expect(subject.path).to receive(:exist?).and_return(true)
+      expect(working_dir).to receive(:is_svn?).twice.and_return(true)
+      expect(working_dir).to receive(:url).and_return 'https://svn-server.site/svn-repo/trunk'
+
+      expect(working_dir).to receive(:update)
+
+      subject.sync
+
+      expect(subject.status).to eq :insync
+    end
+  end
 end

data/spec/unit/errors/formatting_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'r10k/errors/formatting'
+
+describe R10K::Errors::Formatting do
+
+  describe "without a nested exception" do
+    let(:exc) do
+      ArgumentError.new("ArgumentError message").tap do |a|
+        a.set_backtrace(%w[/backtrace/line:1 /backtrace/line:2])
+      end
+    end
+
+    describe "and without a backtrace" do
+      subject do
+        described_class.format_exception(exc, false)
+      end
+
+      it "formats the exception with the message" do
+        expect(subject).to eq("ArgumentError message")
+      end
+    end
+
+    describe "and with a backtrace" do
+      subject do
+        described_class.format_exception(exc, true)
+      end
+
+      it "formats the exception with the message and backtrace" do
+        expect(subject).to eq([
+          "ArgumentError message",
+          "/backtrace/line:1",
+          "/backtrace/line:2",
+        ].join("\n"))
+      end
+    end
+  end
+
+  describe "with a nested exception" do
+
+    let(:nestee) do
+      ArgumentError.new("ArgumentError message").tap do |a|
+        a.set_backtrace(%w[/backtrace/line:1 /backtrace/line:2])
+      end
+    end
+
+    let(:exc) do
+      R10K::Error.wrap(nestee, "R10K::Error message").tap do |r|
+        r.set_backtrace(%w[/another/backtrace/line:1 /another/backtrace/line:2])
+      end
+    end
+
+    describe "and without a backtrace" do
+      subject do
+        described_class.format_exception(exc, false)
+      end
+
+      it "formats the exception with the message and original message" do
+        expect(subject).to eq([
+          "R10K::Error message",
+          "Original exception:",
+          "ArgumentError message"
+        ].join("\n"))
+      end
+    end
+
+    describe "and with a backtrace" do
+      subject do
+        described_class.format_exception(exc, true)
+      end
+
+      it "formats the exception with the message, backtrace, original message, and original backtrace" do
+        expect(subject).to eq([
+          "R10K::Error message",
+          "/another/backtrace/line:1",
+          "/another/backtrace/line:2",
+          "Original exception:",
+          "ArgumentError message",
+          "/backtrace/line:1",
+          "/backtrace/line:2",
+        ].join("\n"))
+      end
+    end
+  end
+end

data/spec/unit/git/alternates_spec.rb

@@ -61,7 +61,7 @@ describe R10K::Git::Alternates do
 
       before do
         expect(subject.file).to receive(:open).with('w').and_yield(io)
-        subject.file.stub_chain(:parent, :directory?).and_return true
+        expect(subject.file).to receive_message_chain(:parent, :directory?).and_return true
       end
 
 

data/spec/unit/git/head_spec.rb

@@ -14,7 +14,7 @@ describe R10K::Git::Head do
 
   describe "determining if the head needs to be fetched" do
     it "is always true" do
-      expect(subject.fetch?).to be_true
+      expect(subject.fetch?).to be_truthy
     end
   end
 

data/spec/unit/git/ref_spec.rb

@@ -16,7 +16,7 @@ describe R10K::Git::Ref do
 
     it "raises an error if the SHA1 could not be resolved" do
       subject.repository = repo
-      expect(repo).to receive(:rev_parse).with(ref).and_raise(R10K::Git::UnresolvableRefError)
+      expect(repo).to receive(:rev_parse).with(ref).and_raise(R10K::Git::UnresolvableRefError, "Couldn't resolve")
 
       expect {
         subject.sha1

data/spec/unit/git/working_dir_spec.rb

@@ -7,7 +7,7 @@ describe R10K::Git::WorkingDir do
   describe "initializing" do
     it "generates a new cache for the remote" do
       wd = described_class.new('master', 'git://github.com/adrienthebo/r10k-fixture-repo', '/some/nonexistent/dir')
-      wd.cache.should be_kind_of R10K::Git::Cache
+      expect(wd.cache).to be_kind_of(R10K::Git::Cache)
     end
 
     it "uses the provided ref as the dirname when no dirname is given" do

data/spec/unit/module/base_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'r10k/module/base'
+
+describe R10K::Module::Base do
+  describe "parsing the title" do
+    it "parses titles with no owner" do
+      m = described_class.new('eight_hundred', '/moduledir', [])
+      expect(m.name).to eq 'eight_hundred'
+      expect(m.owner).to be_nil
+    end
+
+    it "parses forward slash separated titles" do
+      m = described_class.new('branan/eight_hundred', '/moduledir', [])
+      expect(m.name).to eq 'eight_hundred'
+      expect(m.owner).to eq 'branan'
+    end
+
+    it "parses hyphen separated titles" do
+      m = described_class.new('branan-eight_hundred', '/moduledir', [])
+      expect(m.name).to eq 'eight_hundred'
+      expect(m.owner).to eq 'branan'
+    end
+
+    it "raises an error when the title is not correctly formatted" do
+      expect {
+        described_class.new('branan!eight_hundred', '/moduledir', [])
+      }.to raise_error(ArgumentError, "Module names must match either 'modulename' or 'owner/modulename'")
+    end
+  end
+
+  describe "path variables" do
+    it "uses the module name as the name" do
+      m = described_class.new('eight_hundred', '/moduledir', [])
+      expect(m.dirname).to eq '/moduledir'
+      expect(m.path).to eq(Pathname.new('/moduledir/eight_hundred'))
+    end
+
+    it "does not include the owner in the path" do
+      m = described_class.new('branan/eight_hundred', '/moduledir', [])
+      expect(m.dirname).to eq '/moduledir'
+      expect(m.path).to eq(Pathname.new('/moduledir/eight_hundred'))
+    end
+  end
+
+  describe "with alternate variable names" do
+    subject do
+      described_class.new('branan/eight_hundred', '/moduledir', [])
+    end
+
+    it "aliases full_name to title" do
+      expect(subject.full_name).to eq 'branan/eight_hundred'
+    end
+
+    it "aliases author to owner" do
+      expect(subject.author).to eq 'branan'
+    end
+
+    it "aliases basedir to dirname" do
+      expect(subject.basedir).to eq '/moduledir'
+    end
+  end
+
+  describe "accepting a visitor" do
+    subject { described_class.new('branan/eight_hundred', '/moduledir', []) }
+
+    it "passes itself to the visitor" do
+      visitor = spy('visitor')
+      expect(visitor).to receive(:visit).with(:module, subject)
+      subject.accept(visitor)
+    end
+  end
+end

data/spec/unit/module/forge_spec.rb

@@ -4,7 +4,6 @@ require 'spec_helper'
 
 describe R10K::Module::Forge do
 
-  include_context 'stub logging'
   include_context 'fail on execution'
 
   let(:fixture_modulepath) { File.expand_path('spec/fixtures/module/forge', PROJECT_ROOT) }
@@ -15,8 +14,12 @@ describe R10K::Module::Forge do
       expect(described_class).to be_implement('branan/eight_hundred', '8.0.0')
     end
 
-    it "should fail with an invalid full name" do
-      expect(described_class).to_not be_implement('branan-eight_hundred', '8.0.0')
+    it "should implement 'branan-eight_hundred', '8.0.0'" do
+      expect(described_class).to be_implement('branan/eight_hundred', '8.0.0')
+    end
+
+    it "should fail with an invalid title" do
+      expect(described_class).to_not be_implement('branan!eight_hundred', '8.0.0')
     end
 
     it "should fail with an invalid version" do
@@ -27,11 +30,49 @@ describe R10K::Module::Forge do
   describe "setting attributes" do
     subject { described_class.new('branan/eight_hundred', '/moduledir', '8.0.0') }
 
-    its(:name) { should eq 'eight_hundred' }
-    its(:author) { should eq 'branan' }
-    its(:full_name) { should eq 'branan/eight_hundred' }
-    its(:basedir) { should eq '/moduledir' }
-    its(:full_path) { should eq '/moduledir/eight_hundred' }
+    it "sets the name" do
+      expect(subject.name).to eq 'eight_hundred'
+    end
+
+    it "sets the author" do
+      expect(subject.author).to eq 'branan'
+    end
+
+    it "sets the dirname" do
+      expect(subject.dirname).to eq '/moduledir'
+    end
+
+    it "sets the title" do
+      expect(subject.title).to eq 'branan/eight_hundred'
+    end
+  end
+
+  describe "fetching the current version" do
+    subject { described_class.new('branan/eight_hundred', '/moduledir', '8.0.0') }
+
+    it "reads the metadata before returning the version from the metadata" do
+      metadata = subject.metadata
+      expect(metadata).to receive(:read)
+      expect(metadata).to receive(:version).and_return(R10K::SemVer.new('1.2.3'))
+      expect(subject.current_version).to eq(R10K::SemVer.new('1.2.3'))
+    end
+  end
+
+  describe "properties" do
+    subject { described_class.new('branan/eight_hundred', '/moduledir', '8.0.0') }
+
+    it "sets the module type to :forge" do
+      expect(subject.properties).to include(:type => :forge)
+    end
+
+    it "sets the expected version" do
+      expect(subject.properties).to include(:expected => R10K::SemVer.new('8.0.0'))
+    end
+
+    it "sets the actual version" do
+      expect(subject).to receive(:current_version).and_return(R10K::SemVer.new('0.8.0'))
+      expect(subject.properties).to include(:actual => R10K::SemVer.new('0.8.0'))
+    end
   end
 
   describe "when syncing" do

data/spec/unit/module/git_spec.rb

@@ -3,6 +3,84 @@ require 'r10k/module/git'
 
 describe R10K::Module::Git do
 
+  describe "setting the owner and name" do
+    describe "with a title of 'branan/eight_hundred'" do
+      subject do
+        described_class.new(
+          'branan/eight_hundred',
+          '/moduledir',
+          {
+            :git => 'git://git-server.site/branan/puppet-eight_hundred',
+          }
+        )
+      end
+
+      it "sets the owner to 'branan'" do
+        expect(subject.owner).to eq 'branan'
+      end
+
+      it "sets the name to 'eight_hundred'" do
+        expect(subject.name).to eq 'eight_hundred'
+      end
+
+      it "sets the path to '/moduledir/eight_hundred'" do
+        expect(subject.path).to eq(Pathname.new('/moduledir/eight_hundred'))
+      end
+    end
+
+    describe "with a title of 'modulename'" do
+      subject do
+        described_class.new(
+          'eight_hundred',
+          '/moduledir',
+          {
+            :git => 'git://git-server.site/branan/puppet-eight_hundred',
+          }
+        )
+      end
+
+      it "sets the owner to nil" do
+        expect(subject.owner).to be_nil
+      end
+
+      it "sets the name to 'eight_hundred'" do
+        expect(subject.name).to eq 'eight_hundred'
+      end
+
+      it "sets the path to '/moduledir/eight_hundred'" do
+        expect(subject.path).to eq(Pathname.new('/moduledir/eight_hundred'))
+      end
+    end
+  end
+
+  describe "properties" do
+    subject do
+      described_class.new('boolean', '/moduledir', {:git => 'git://github.com/adrienthebo/puppet-boolean'})
+    end
+
+    it "sets the module type to :git" do
+      expect(subject.properties).to include(:type => :git)
+    end
+
+    it "sets the expected version" do
+      expect(subject.properties).to include(:expected => instance_of(R10K::Git::Ref))
+    end
+
+    it "sets the actual version to the revision when the revision is available" do
+      head = double('head')
+      expect(subject.working_dir).to receive(:current).and_return(head)
+      expect(head).to receive(:sha1).and_return('35d3517e67ceeb4b485b56d4a14d38fb95516c92')
+      expect(subject.properties).to include(:actual => '35d3517e67ceeb4b485b56d4a14d38fb95516c92')
+    end
+
+    it "sets the actual version (unresolvable) when the revision is unavailable" do
+      head = double('head')
+      expect(subject.working_dir).to receive(:current).and_return(head)
+      expect(head).to receive(:sha1).and_raise(ArgumentError)
+      expect(subject.properties).to include(:actual => '(unresolvable)')
+    end
+  end
+
   describe "determining the status" do
     subject do
       described_class.new(

data/spec/unit/module/svn_spec.rb

@@ -13,6 +13,25 @@ describe R10K::Module::SVN do
     end
   end
 
+  describe "path variables" do
+    it "uses the module name as the name" do
+      svn = described_class.new('foo', '/moduledir', :rev => 'r10')
+      expect(svn.name).to eq 'foo'
+      expect(svn.owner).to be_nil
+      expect(svn.dirname).to eq '/moduledir'
+      expect(svn.path).to eq Pathname.new('/moduledir/foo')
+    end
+
+    it "does not include the owner in the path" do
+      svn = described_class.new('bar/foo', '/moduledir', :rev => 'r10')
+      expect(svn.name).to eq 'foo'
+      expect(svn.owner).to eq 'bar'
+      expect(svn.dirname).to eq '/moduledir'
+      expect(svn.path).to eq Pathname.new('/moduledir/foo')
+    end
+  end
+
+
   describe "instantiating based on Puppetfile configuration" do
     it "can specify a revision with the :rev key" do
       svn = described_class.new('foo', '/moduledir', :rev => 'r10')
@@ -23,10 +42,27 @@ describe R10K::Module::SVN do
       svn = described_class.new('foo', '/moduledir', :revision => 'r10')
       expect(svn.expected_revision).to eq 'r10'
     end
+  end
+
+  describe "properties" do
+    subject { described_class.new('foo', '/moduledir', :svn => 'https://github.com/adrienthebo/r10k-fixture-repo', :rev => 123) }
+
+    it "sets the module type to :svn" do
+      expect(subject.properties).to include(:type => :svn)
+    end
+
+    it "sets the expected version" do
+      expect(subject.properties).to include(:expected => 123)
+    end
+
+    it "sets the actual version to the revision when the revision is available" do
+      expect(subject.working_dir).to receive(:revision).and_return(12)
+      expect(subject.properties).to include(:actual => 12)
+    end
 
-    it "can specify a path within the SVN repo" do
-      svn = described_class.new('foo', '/moduledir', :svn_path => 'branches/something/foo')
-      expect(svn.svn_path).to eq 'branches/something/foo'
+    it "sets the actual version (unresolvable) when the revision is unavailable" do
+      expect(subject.working_dir).to receive(:revision).and_raise(ArgumentError)
+      expect(subject.properties).to include(:actual => "(unresolvable)")
     end
   end
 
@@ -114,7 +150,7 @@ describe R10K::Module::SVN do
       end
 
       it "removes the existing directory" do
-        expect(subject.full_path).to receive(:rmtree)
+        expect(subject.path).to receive(:rmtree)
         allow(subject).to receive(:install)
 
         subject.sync