r10k 2.0.3 → 2.1.0

data/spec/unit/environment/svn_spec.rb

@@ -110,4 +110,24 @@ describe R10K::Environment::SVN do
       expect(subject.status).to eq :insync
     end
   end
+
+  describe "environment signature" do
+    it "returns the svn revision of the branch" do
+      expect(working_dir).to receive(:revision).and_return '1337'
+      expect(subject.signature).to eq '1337'
+    end
+  end
+
+  describe "info hash" do
+    let(:info_hash) { subject.info }
+
+    before(:each) do
+      expect(working_dir).to receive(:revision).and_return '1337'
+    end
+
+    it "includes name and signature" do
+      expect(info_hash.keys).to include :name, :signature
+      expect(info_hash).not_to have_value(nil)
+    end
+  end
 end

data/spec/unit/forge/module_release_spec.rb

@@ -1,10 +1,13 @@
 require 'spec_helper'
 require 'r10k/forge/module_release'
 require 'r10k/util/exec_env'
+require 'puppet_forge'
 
 describe R10K::Forge::ModuleRelease do
   subject { described_class.new('branan-eight_hundred', '8.0.0') }
 
+  let(:forge_release_class) { PuppetForge::V3::Release }
+
   let(:download_path) { instance_double('Pathname') }
   let(:unpack_path) { instance_double('Pathname') }
   let(:target_dir) { instance_double('Pathname') }
@@ -20,7 +23,7 @@ describe R10K::Forge::ModuleRelease do
       it "respects the #{env_var} environment variable" do
         R10K::Util::ExecEnv.withenv(env_var => "http://proxy.value") do
           subject = described_class.new('branan-eight_hundred', '8.0.0')
-          proxy_uri = subject.forge_release.conn.proxy.uri
+          proxy_uri = forge_release_class.conn.proxy.uri
           expect(proxy_uri.to_s).to eq "http://proxy.value"
         end
       end
@@ -32,14 +35,14 @@ describe R10K::Forge::ModuleRelease do
 
       it 'has a setting for the forge proxy' do
         subject = described_class.new('branan-eight_hundred', '8.0.0')
-        proxy_uri = subject.forge_release.conn.proxy.uri
+        proxy_uri = forge_release_class.conn.proxy.uri
         expect(proxy_uri.to_s).to eq "http://proxy.setting"
       end
 
       it 'prefers the proxy setting over an environment variable' do
         R10K::Util::ExecEnv.withenv('HTTPS_PROXY' => "http://proxy.from.env") do
           subject = described_class.new('branan-eight_hundred', '8.0.0')
-          proxy_uri = subject.forge_release.conn.proxy.uri
+          proxy_uri = forge_release_class.conn.proxy.uri
           expect(proxy_uri.to_s).to eq "http://proxy.setting"
         end
       end

data/spec/unit/git/alternates_spec.rb

@@ -17,7 +17,7 @@ describe R10K::Git::Alternates do
         "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git\n",
       ])
 
-      expect(subject.to_a).to eq([
+      expect(subject.read).to eq([
         "/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
         "/vagrant/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
       ])
@@ -47,11 +47,12 @@ describe R10K::Git::Alternates do
     end
   end
 
-  describe "appending a new alternate object entry" do
+
+  describe "writing alternate entries" 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"
+          subject.write(["/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
@@ -64,20 +65,15 @@ describe R10K::Git::Alternates do
         expect(subject.file).to receive_message_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"
-
+        subject.write(["/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"
+        subject.write(["/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"])
 
         expect(io.string).to eq(<<-EOD)
 /var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git
@@ -86,5 +82,35 @@ describe R10K::Git::Alternates do
         EOD
       end
     end
+
+    describe "appending a new alternate object entry" do
+      it "re-writes the file with the new entry concatenated to the file" 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"])
+
+        expect(subject).to receive(:write).with(["/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"])
+
+        subject.add("/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git")
+      end
+    end
+  end
+
+  describe "conditionally appending a new alternate object entry" do
+    before do
+      expect(subject).to receive(:read).and_return(%w[/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git])
+    end
+
+    it "adds the entry and returns true when the entry doesn't exist" do
+      expect(subject).to receive(:write).with(["/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git",
+                                               "/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git"])
+      expect(subject.add?("/tmp/.r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git")).to eq true
+    end
+
+    it "doesn't modify the file and returns false when the entry exists" do
+      expect(subject).to_not receive(:write)
+      expect(subject.add?("/var/cache/r10k/git/git---github.com-puppetlabs-puppetlabs-apache.git")).to eq false
+    end
   end
 end

data/spec/unit/git/cache_spec.rb

@@ -31,6 +31,10 @@ describe R10K::Git::Cache do
       expect_delegation(:git_dir)
     end
 
+    it "delegates #objects_dir" do
+      expect_delegation(:objects_dir)
+    end
+
     it "delegates #branches" do
       expect_delegation(:branches)
     end

data/spec/unit/git/rugged/credentials_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'r10k/git/rugged/credentials'
+require 'rugged/credentials'
+
+describe R10K::Git::Rugged::Credentials do
+
+  let(:repo) { R10K::Git::Rugged::BareRepository.new("/some/nonexistent/path", "repo.git") }
+
+  subject { described_class.new(repo) }
+
+  after(:all) { R10K::Git.settings.reset! }
+
+  describe "determining the username" do
+    before { R10K::Git.settings[:username] = "moderns" }
+    after { R10K::Git.settings.reset! }
+
+    it "prefers a username from the URL" do
+      user = subject.get_git_username("https://tessier-ashpool.freeside/repo.git", "ashpool")
+      expect(user).to eq "ashpool"
+    end
+
+    it "uses the username from the Git config when specified" do
+      user = subject.get_git_username("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(user).to eq "moderns"
+    end
+
+    it "falls back to the current user" do
+      R10K::Git.settings.reset!
+      expect(Etc).to receive(:getlogin).and_return("finn")
+      user = subject.get_git_username("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(user).to eq "finn"
+    end
+  end
+
+  describe "generating ssh key credentials" do
+    after { R10K::Git.settings.reset! }
+
+    it "raises an error if no key has been set" do
+      R10K::Git.settings[:private_key] = nil
+      expect {
+        subject.get_ssh_key_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      }.to raise_error(R10K::Git::GitError, /no private key was given/)
+    end
+
+    it "generates the rugged sshkey credential type" do
+      R10K::Git.settings[:private_key] = "/some/nonexistent/.ssh/key"
+      creds = subject.get_ssh_key_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(creds).to be_a_kind_of(Rugged::Credentials::SshKey)
+      expect(creds.instance_variable_get(:@privatekey)).to eq("/some/nonexistent/.ssh/key")
+    end
+  end
+
+  describe "generating default credentials" do
+    it "generates the rugged default credential type" do
+      creds = subject.get_default_credentials("https://azurediamond:hunter2@tessier-ashpool.freeside/repo.git", "azurediamond")
+      expect(creds).to be_a_kind_of(Rugged::Credentials::Default)
+    end
+  end
+
+  describe "generating credentials" do
+    it "creates ssh key credentials for the sshkey allowed type" do
+      R10K::Git.settings[:private_key] = "/some/nonexistent/.ssh/key"
+      expect(subject.call("https://tessier-ashpool.freeside/repo.git", nil, [:ssh_key])).to be_a_kind_of(Rugged::Credentials::SshKey)
+    end
+
+    it "creates user/password credentials for the default allowed type" do
+      expect(subject.call("https://tessier-ashpool.freeside/repo.git", nil, [:plaintext])).to be_a_kind_of(Rugged::Credentials::UserPassword)
+    end
+
+    it "creates default credentials when no other types are allowed" do
+      expect(subject.call("https://tessier-ashpool.freeside/repo.git", nil, [])).to be_a_kind_of(Rugged::Credentials::Default)
+    end
+  end
+end

data/spec/unit/initializers_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'r10k/initializers'
+
+describe R10K::Initializers::GitInitializer do
+  it "configures the Git provider" do
+    subject = described_class.new({:provider => :rugged})
+    expect(R10K::Git).to receive(:provider=).with(:rugged)
+    subject.call
+  end
+
+  it "configures the Git username" do
+    subject = described_class.new({:username => 'git'})
+    expect(R10K::Git.settings).to receive(:[]=).with(:username, 'git')
+    subject.call
+  end
+
+  it "configures the Git private key" do
+    subject = described_class.new({:private_key => '/etc/puppetlabs/r10k/id_rsa'})
+    expect(R10K::Git.settings).to receive(:[]=).with(:private_key, '/etc/puppetlabs/r10k/id_rsa')
+    subject.call
+  end
+end
+
+describe R10K::Initializers::ForgeInitializer do
+  it "configures the Forge proxy" do
+    subject = described_class.new({:proxy => 'http://my.site.proxy:3128'})
+    expect(R10K::Forge::ModuleRelease.settings).to receive(:[]=).with(:proxy, 'http://my.site.proxy:3128')
+    subject.call
+  end
+
+  it "configures the Forge baseurl" do
+    subject = described_class.new({:baseurl => 'https://my.site.forge'})
+    expect(R10K::Forge::ModuleRelease.settings).to receive(:[]=).with(:baseurl, 'https://my.site.forge')
+    subject.call
+  end
+end
+
+describe R10K::Initializers::GlobalInitializer do
+  it "logs a warning if purgedirs was set" do
+    subject = described_class.new({:purgedirs => 'This setting has been deprecated for over two years :('})
+    expect(subject.logger).to receive(:warn).with('the purgedirs key in r10k.yaml is deprecated. it is currently ignored.')
+    subject.call
+  end
+
+  it "sets the Git cache_root" do
+    subject = described_class.new({:cachedir => '/var/cache/r10k'})
+    expect(R10K::Git::Cache.settings).to receive(:[]=).with(:cache_root, '/var/cache/r10k')
+    subject.call
+  end
+
+  it "delegates git settings to the Git initializer" do
+    git = instance_double('R10K::Initializers::GitInitializer')
+    expect(git).to receive(:call)
+    expect(R10K::Initializers::GitInitializer).to receive(:new).and_return(git)
+
+    subject = described_class.new({:git => {}})
+    subject.call
+  end
+
+  it "delegates forge settings to the Forge initializer" do
+    forge = instance_double('R10K::Initializers::ForgeInitializer')
+    expect(forge).to receive(:call)
+    expect(R10K::Initializers::ForgeInitializer).to receive(:new).and_return(forge)
+
+    subject = described_class.new({:forge => {}})
+    subject.call
+  end
+end

data/spec/unit/module/base_spec.rb

@@ -48,7 +48,7 @@ describe R10K::Module::Base do
     end
 
     it "aliases full_name to title" do
-      expect(subject.full_name).to eq 'branan/eight_hundred'
+      expect(subject.full_name).to eq 'branan-eight_hundred'
     end
 
     it "aliases author to owner" do
@@ -61,7 +61,7 @@ describe R10K::Module::Base do
   end
 
   describe "accepting a visitor" do
-    subject { described_class.new('branan/eight_hundred', '/moduledir', []) }
+    subject { described_class.new('branan-eight_hundred', '/moduledir', []) }
 
     it "passes itself to the visitor" do
       visitor = spy('visitor')

data/spec/unit/module/forge_spec.rb

@@ -38,7 +38,7 @@ describe R10K::Module::Forge do
     end
 
     it "sets the title" do
-      expect(subject.title).to eq 'branan/eight_hundred'
+      expect(subject.title).to eq 'branan-eight_hundred'
     end
   end
 
@@ -67,7 +67,7 @@ describe R10K::Module::Forge do
 
     it "uses the latest version from the forge when the version is :latest" do
       subject = described_class.new('branan/eight_hundred', fixture_modulepath, :latest)
-      expect(subject.v3_module).to receive(:latest_version).and_return('8.8.8')
+      expect(subject.v3_module).to receive_message_chain(:current_release, :version).and_return('8.8.8')
       expect(subject.expected_version).to eq '8.8.8'
     end
   end
@@ -88,9 +88,16 @@ describe R10K::Module::Forge do
       expect(subject.status).to eq :mismatched
     end
 
+    it "is :mismatched if module was previously a git checkout" do
+      allow(File).to receive(:directory?).and_return true
+
+      expect(subject.status).to eq :mismatched
+    end
+
     it "is :mismatched if the metadata author doesn't match the expected author" do
       allow(subject).to receive(:exist?).and_return true
 
+      allow(subject.instance_variable_get(:@metadata_file)).to receive(:read).and_return subject.metadata
       allow(subject.metadata).to receive(:full_module_name).and_return 'blargh-blargh'
 
       expect(subject.status).to eq :mismatched
@@ -99,6 +106,7 @@ describe R10K::Module::Forge do
     it "is :outdated if the metadata version doesn't match the expected version" do
       allow(subject).to receive(:exist?).and_return true
 
+      allow(subject.instance_variable_get(:@metadata_file)).to receive(:read).and_return subject.metadata
       allow(subject.metadata).to receive(:version).and_return '7.0.0'
       expect(subject.status).to eq :outdated
     end
@@ -145,7 +153,7 @@ describe R10K::Module::Forge do
     it 'installs the module from the forge' do
       subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
       release = instance_double('R10K::Forge::ModuleRelease')
-      expect(R10K::Forge::ModuleRelease).to receive(:new).with('branan/eight_hundred', '8.0.0').and_return(release)
+      expect(R10K::Forge::ModuleRelease).to receive(:new).with('branan-eight_hundred', '8.0.0').and_return(release)
       expect(release).to receive(:install).with(subject.path)
       subject.install
     end

data/spec/unit/module/metadata_file_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'shared/puppet/module_tool/metadata'
 
 describe R10K::Module::MetadataFile do
 

data/spec/unit/puppetfile_spec.rb

@@ -55,6 +55,17 @@ describe R10K::Puppetfile do
         expect_wrapped_error(e, pf_path, LoadError)
       end
     end
+
+    it "wraps and re-raises argument errors" do
+      path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'argument-error')
+      pf_path = File.join(path, 'Puppetfile')
+      subject = described_class.new(path)
+      expect {
+        subject.load!
+      }.to raise_error do |e|
+        expect_wrapped_error(e, pf_path, ArgumentError)
+      end
+    end
   end
 
   describe "accepting a visitor" do

data/spec/unit/settings/collection_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'r10k/settings/collection'
+require 'r10k/settings/definition'
+
+describe R10K::Settings::Collection do
+
+  let(:symbol_defn) { R10K::Settings::Definition.new(:symbol_defn, :validate => lambda { |x| raise TypeError unless x.is_a?(Symbol) }) }
+  let(:default_defn) { R10K::Settings::Definition.new(:default_defn, :default => lambda { "Defaults are fun" }) }
+
+  subject do
+    described_class.new(:collection, [symbol_defn, default_defn])
+  end
+
+  describe "#evaluate" do
+    it "assigns values, validates them, and resolves a final value" do
+      expect(subject).to receive(:assign).with({:default_defn => :squid})
+      expect(subject).to receive(:validate)
+      expect(subject).to receive(:resolve)
+      subject.evaluate({:default_defn => :squid})
+    end
+  end
+
+
+  describe '#assign' do
+    it "assigns values to the appropriate setting" do
+      subject.assign({:symbol_defn => :hello})
+      expect(symbol_defn.value).to eq :hello
+    end
+
+    it "can accept invalid settings" do
+      subject.assign({:hardly_a_setting => "nope nope nope"})
+    end
+
+    it "silently ignores attempts to assign nil" do
+      subject.assign(nil)
+    end
+  end
+
+  describe '#validate' do
+    it "raises an error containing a hash of nested validation errors" do
+      subject.assign({:symbol_defn => "Definitely not a symbol"})
+      expect {
+        errors = subject.validate
+      }.to raise_error do |error|
+        expect(error).to be_a_kind_of(R10K::Settings::Collection::ValidationError)
+        errors = error.errors
+        expect(errors.size).to eq 1
+        expect(errors[:symbol_defn]).to be_a_kind_of(TypeError)
+      end
+    end
+
+    it "it does not raise an error if no errors were found" do
+      subject.assign({:default_defn => "yep"})
+      expect(subject.validate).to be_nil
+    end
+  end
+
+  describe '#resolve' do
+    it "returns a frozen hash of all settings" do
+      subject.assign({:symbol_defn => :some_value})
+      rv = subject.resolve
+      expect(rv).to be_frozen
+      expect(rv).to eq({:symbol_defn => :some_value, :default_defn => "Defaults are fun"})
+    end
+  end
+end
+
+describe R10K::Settings::Collection::ValidationError do
+
+
+  let(:flat_errors) do
+    described_class.new("Validation failures for some group", errors: {
+      some_defn: ArgumentError.new("some_defn is wrong, somehow."),
+      uri_setting: ArgumentError.new("uri_setting NOTAURI is not a URI.")
+    })
+  end
+
+  let(:flat_error_text) do
+    [
+      "Validation failures for some group:",
+      "    some_defn:",
+      "        some_defn is wrong, somehow.",
+      "    uri_setting:",
+      "        uri_setting NOTAURI is not a URI."]
+    .join("\n")
+  end
+
+  let(:nested_errors) do
+    described_class.new("Validation failures for some nesting group", errors: {
+      file_setting: ArgumentError.new("file_setting is a potato, not a file."),
+      nested: flat_errors
+    })
+  end
+
+  let(:nested_error_text) do
+    [
+      "Validation failures for some nesting group:",
+      "    file_setting:",
+      "        file_setting is a potato, not a file.",
+      "    nested:",
+      "        Validation failures for some group:",
+      "            some_defn:",
+      "                some_defn is wrong, somehow.",
+      "            uri_setting:",
+      "                uri_setting NOTAURI is not a URI."
+    ].join("\n")
+  end
+
+  describe "formatting a human readable error message" do
+    describe "no with no nested validation errors" do
+      it "generates a human readable set of validation errors." do
+        expect(flat_errors.format).to eq flat_error_text
+      end
+    end
+
+    describe "with nested validation errors" do
+      it "generates a human readable set of validation errors." do
+        expect(nested_errors.format).to eq nested_error_text
+      end
+    end
+  end
+end