r10k 3.5.0 → 3.8.0

data/spec/unit/action/puppetfile/install_spec.rb

@@ -27,6 +27,7 @@ describe R10K::Action::Puppetfile::Install do
     before do
       allow(puppetfile).to receive(:purge!)
       allow(puppetfile).to receive(:modules).and_return(modules)
+      allow(puppetfile).to receive(:modules_by_vcs_cachedir).and_return({none: modules})
     end
 
     it "syncs each module in the Puppetfile" do

data/spec/unit/action/runner_spec.rb

@@ -10,11 +10,12 @@ describe R10K::Action::Runner do
     Class.new do
       attr_reader :opts
       attr_reader :argv
+      attr_reader :settings
 
       def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv
-        @settings = {}
+        @settings = settings
       end
 
       def call
@@ -170,6 +171,52 @@ describe R10K::Action::Runner do
     end
   end
 
+  describe "configuring git credentials" do
+    it 'errors if both token and key paths are passed' do
+      runner = described_class.new({ 'oauth-token': '/nonexistent',
+                                     'private-key': '/also/fake' }, %w[args yes], action_class)
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'saves the sshkey path in settings hash' do
+      runner = described_class.new({ 'private-key': '/my/ssh/key' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+    end
+
+    it 'overrides per-repo sshkey in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'private-key': '/my/ssh/key' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:private_key]).to eq('/my/ssh/key')
+      end
+    end
+
+    it 'saves the token path in settings hash' do
+      runner = described_class.new({ 'oauth-token': '/my/token/path' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token/path')
+    end
+
+    it 'overrides per-repo oauth token in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'oauth-token': '/my/token' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:oauth_token]).to eq('/my/token')
+      end
+    end
+  end
+
   describe "configuration authorization" do
     context "when license is not present" do
       before(:each) do

data/spec/unit/environment/git_spec.rb

@@ -62,9 +62,10 @@ describe R10K::Environment::Git do
 
   describe "enumerating modules" do
     it "loads the Puppetfile and returns modules in that puppetfile" do
+      mod = double('A module', :name => 'dbl')
       expect(subject.puppetfile).to receive(:load)
-      expect(subject.puppetfile).to receive(:modules).and_return [:modules]
-      expect(subject.modules).to eq([:modules])
+      expect(subject.puppetfile).to receive(:modules).and_return [mod]
+      expect(subject.modules).to eq([mod])
     end
   end
 

data/spec/unit/environment/with_modules_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::WithModules do
+  subject do
+    described_class.new(
+      'release42',
+      '/some/nonexistent/environmentdir',
+      'prefix_release42',
+      {
+        :type             => 'bare',
+        :modules          => {
+          'puppetlabs-stdlib' => { local: true },
+          'puppetlabs-concat' => { local: true },
+          'puppetlabs-exec'   => { local: true },
+        }
+      }.merge(subject_params)
+    )
+  end
+
+  # Default no additional params
+  let(:subject_params) { {} }
+
+  describe "dealing with module conflicts" do
+    context "with no module conflicts" do
+      it "validates when there are no conflicts" do
+        mod = instance_double('R10K::Module::Base', name: 'nonconflict', origin: :puppetfile)
+        expect(subject.module_conflicts?(mod)).to eq false
+      end
+    end
+
+    context "with module conflicts and default behavior" do
+      it "does not raise an error" do
+        mod = instance_double('R10K::Module::Base', name: 'stdlib', origin: :puppetfile)
+        expect(subject.logger).to receive(:warn).with(/Puppetfile.*both define.*ignored/i)
+        expect(subject.module_conflicts?(mod)).to eq true
+      end
+    end
+
+    context "with module conflicts and 'error' behavior" do
+      let(:subject_params) {{ :module_conflicts => 'error' }}
+      it "raises an error" do
+        mod = instance_double('R10K::Module::Base', name: 'stdlib', origin: :puppetfile)
+        expect { subject.module_conflicts?(mod) }.to raise_error(R10K::Error, /Puppetfile.*both define.*/i)
+      end
+    end
+
+    context "with module conflicts and 'override' behavior" do
+      let(:subject_params) {{ :module_conflicts => 'override' }}
+      it "does not raise an error" do
+        mod = instance_double('R10K::Module::Base', name: 'stdlib', origin: :puppetfile)
+        expect(subject.logger).to receive(:debug).with(/Puppetfile.*both define.*ignored/i)
+        expect(subject.module_conflicts?(mod)).to eq true
+      end
+    end
+
+    context "with module conflicts and invalid configuration" do
+      let(:subject_params) {{ :module_conflicts => 'batman' }}
+      it "raises an error" do
+        mod = instance_double('R10K::Module::Base', name: 'stdlib', origin: :puppetfile)
+        expect { subject.module_conflicts?(mod) }.to raise_error(R10K::Error, /Unexpected value.*module_conflicts.*/i)
+      end
+    end
+  end
+
+  describe "modules method" do
+    it "returns the configured modules, and Puppetfile modules" do
+      puppetfile_mod = instance_double('R10K::Module::Base', name: 'zebra')
+      expect(subject.puppetfile).to receive(:modules).and_return [puppetfile_mod]
+      returned_modules = subject.modules
+      expect(returned_modules.map(&:name).sort).to eq(%w[concat exec stdlib zebra])
+    end
+  end
+end

data/spec/unit/forge/module_release_spec.rb

@@ -166,33 +166,37 @@ describe R10K::Forge::ModuleRelease do
   end
 
   describe "#cleanup_unpack_path" do
-    it "ignores the unpack_path if it doesn't exist" do
-      expect(unpack_path).to receive(:exist?).and_return false
-      expect(unpack_path).to_not receive(:parent)
+    it "ignores the unpack_path if the parent doesn't exist" do
+      parent = instance_double('Pathname')
+      expect(parent).to receive(:exist?).and_return false
+      expect(parent).to_not receive(:rmtree)
+      expect(unpack_path).to receive(:parent).and_return(parent)
       subject.cleanup_unpack_path
     end
 
     it "removes the containing directory of unpack_path if it exists" do
       parent = instance_double('Pathname')
       expect(parent).to receive(:rmtree)
-      expect(unpack_path).to receive(:exist?).and_return true
-      expect(unpack_path).to receive(:parent).and_return(parent)
+      expect(parent).to receive(:exist?).and_return true
+      expect(unpack_path).to receive(:parent).and_return(parent).exactly(2).times
       subject.cleanup_unpack_path
     end
   end
 
   describe "#cleanup_download_path" do
-    it "ignores the download_path if it doesn't exist" do
-      expect(download_path).to receive(:exist?).and_return false
-      expect(download_path).to_not receive(:parent)
+    it "ignores the download_path if the parent doesn't exist" do
+      parent = instance_double('Pathname')
+      expect(parent).to receive(:exist?).and_return false
+      expect(parent).to_not receive(:rmtree)
+      expect(download_path).to receive(:parent).and_return(parent)
       subject.cleanup_download_path
     end
 
     it "removes the containing directory of download_path if it exists" do
       parent = instance_double('Pathname')
       expect(parent).to receive(:rmtree)
-      expect(download_path).to receive(:exist?).and_return true
-      expect(download_path).to receive(:parent).and_return(parent)
+      expect(parent).to receive(:exist?).and_return true
+      expect(download_path).to receive(:parent).and_return(parent).exactly(2).times
       subject.cleanup_download_path
     end
   end

data/spec/unit/git/cache_spec.rb

@@ -3,6 +3,16 @@ require 'r10k/git/cache'
 
 describe R10K::Git::Cache do
 
+  describe 'the default cache_root' do
+    it 'is in the right location in linux', unless: R10K::Util::Platform.windows?  do
+      expect(described_class.defaults[:cache_root]).to match(/\.r10k\/git/)
+    end
+
+    it 'is in the right location for windows', if: R10K::Util::Platform.windows? do
+      expect(described_class.defaults[:cache_root]).to match(/[^.]r10k\/git/)
+    end
+  end
+
   let(:subclass) do
     Class.new(described_class) do
       def self.bare_repository

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby? do
+describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?  || R10K::Util::Platform.windows? do
   before(:all) do
     require 'r10k/git/rugged/credentials'
     require 'rugged/credentials'
@@ -10,7 +10,7 @@ describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?
 
   subject { described_class.new(repo) }
 
-  after(:all) { R10K::Git.settings.reset! }
+  after(:each) { R10K::Git.settings.reset! }
 
   describe "determining the username" do
     before { R10K::Git.settings[:username] = "moderns" }
@@ -39,6 +39,7 @@ describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?
 
     it "prefers a per-repository SSH private key" do
       allow(File).to receive(:readable?).with("/etc/puppetlabs/r10k/ssh/tessier-ashpool-id_rsa").and_return true
+      R10K::Git.settings[:private_key] = "/etc/puppetlabs/r10k/ssh/id_rsa"
       R10K::Git.settings[:repositories] = [{ remote: "ssh://git@tessier-ashpool.freeside/repo.git",
         private_key: "/etc/puppetlabs/r10k/ssh/tessier-ashpool-id_rsa"}]
       creds = subject.get_ssh_key_credentials("ssh://git@tessier-ashpool.freeside/repo.git", nil)
@@ -78,6 +79,72 @@ describe R10K::Git::Rugged::Credentials, :unless => R10K::Util::Platform.jruby?
     end
   end
 
+  describe "generating token credentials" do
+    it 'errors if token file does not exist' do
+      R10K::Git.settings[:oauth_token] = "/missing/token/file"
+      expect(File).to receive(:readable?).with("/missing/token/file").and_return false
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git"}]
+      expect {
+        subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      }.to raise_error(R10K::Git::GitError, /cannot load OAuth token/)
+    end
+
+    it 'errors if the token on stdin is not a valid OAuth token' do
+      allow($stdin).to receive(:read).and_return("<bad>token")
+      R10K::Git.settings[:oauth_token] = "-"
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git"}]
+      expect {
+        subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      }.to raise_error(R10K::Git::GitError, /invalid characters/)
+    end
+
+    it 'errors if the token in the file is not a valid OAuth token' do
+      token_file = Tempfile.new('token')
+      token_file.write('my bad \ntoken')
+      token_file.close
+      R10K::Git.settings[:oauth_token] = token_file.path
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git"}]
+      expect {
+        subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      }.to raise_error(R10K::Git::GitError, /invalid characters/)
+    end
+
+    it 'prefers per-repo token file' do
+      token_file = Tempfile.new('token')
+      token_file.write('my_token')
+      token_file.close
+      R10K::Git.settings[:oauth_token] = "/do/not/use"
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git",
+                                            oauth_token: token_file.path }]
+      creds = subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(creds).to be_a_kind_of(Rugged::Credentials::UserPassword)
+      expect(creds.instance_variable_get(:@password)).to eq("my_token")
+      expect(creds.instance_variable_get(:@username)).to eq("x-oauth-token")
+    end
+
+    it 'uses the token from a file as a password' do
+      token_file = Tempfile.new('token')
+      token_file.write('my_token')
+      token_file.close
+      R10K::Git.settings[:oauth_token] = token_file.path
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git"}]
+      creds = subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(creds).to be_a_kind_of(Rugged::Credentials::UserPassword)
+      expect(creds.instance_variable_get(:@password)).to eq("my_token")
+      expect(creds.instance_variable_get(:@username)).to eq("x-oauth-token")
+    end
+
+    it 'uses the token from stdin as a password' do
+      allow($stdin).to receive(:read).and_return("my_token")
+      R10K::Git.settings[:oauth_token] = '-'
+      R10K::Git.settings[:repositories] = [{remote: "https://tessier-ashpool.freeside/repo.git"}]
+      creds = subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(creds).to be_a_kind_of(Rugged::Credentials::UserPassword)
+      expect(creds.instance_variable_get(:@password)).to eq("my_token")
+      expect(creds.instance_variable_get(:@username)).to eq("x-oauth-token")
+    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")

data/spec/unit/git_spec.rb

@@ -11,7 +11,7 @@ describe R10K::Git do
       expect(described_class.default_name).to eq :shellgit
     end
 
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies with rugged available', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it 'returns rugged when the git executable is absent and the rugged library is present' do
         expect(R10K::Features).to receive(:available?).with(:shellgit).and_return false
         expect(R10K::Features).to receive(:available?).with(:rugged).and_return true
@@ -53,7 +53,7 @@ describe R10K::Git do
       }.to raise_error(R10K::Error, "Git provider 'shellgit' is not functional.")
     end
 
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies with rugged available', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it "sets the current provider if the provider exists and is functional" do
         expect(R10K::Features).to receive(:available?).with(:rugged).and_return true
         described_class.provider = :rugged
@@ -71,7 +71,7 @@ describe R10K::Git do
   end
 
   describe "retrieving the current provider" do
-    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? do
+    context 'under c-based rubies', :unless => R10K::Util::Platform.jruby? || R10K::Util::Platform.windows? do
       it "uses the default if a provider has not been set" do
         expect(described_class).to receive(:default_name).and_return :rugged
         expect(described_class.provider).to eq(R10K::Git::Rugged)

data/spec/unit/module/git_spec.rb

@@ -268,6 +268,61 @@ describe R10K::Module::Git do
             end
           end
         end
+
+        context "when using default_branch_override" do
+          before(:each) do
+            allow(mock_repo).to receive(:resolve).with(mock_env.ref).and_return(nil)
+          end
+
+          context "and the default branch override is resolvable" do
+            it "uses the override" do
+              expect(mock_repo).to receive(:resolve).with('default_override').and_return('5566aabb')
+              mod = test_module({branch: :control_branch,
+                                 default_branch: 'default',
+                                 default_branch_override: 'default_override'},
+                                 mock_env)
+              expect(mod.properties).to include(expected: 'default_override')
+            end
+          end
+
+          context "and the default branch override is not resolvable" do
+            context "and default branch is provided" do
+              it "falls back to the default" do
+                expect(mock_repo).to receive(:resolve).with('default_override').and_return(nil)
+                expect(mock_repo).to receive(:resolve).with('default').and_return('5566aabb')
+                mod = test_module({branch: :control_branch,
+                                   default_branch: 'default',
+                                   default_branch_override: 'default_override'},
+                                   mock_env)
+                expect(mod.properties).to include(expected: 'default')
+              end
+            end
+
+            context "and default branch is not provided" do
+              it "raises the appropriate error" do
+                expect(mock_repo).to receive(:resolve).with('default_override').and_return(nil)
+                mod = test_module({branch: :control_branch,
+                                   default_branch_override: 'default_override'},
+                                   mock_env)
+
+                expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*or resolve the default branch override.*no default provided/i)
+              end
+            end
+
+            context "and default branch is not resolvable" do
+              it "raises the appropriate error" do
+                expect(mock_repo).to receive(:resolve).with('default_override').and_return(nil)
+                expect(mock_repo).to receive(:resolve).with('default').and_return(nil)
+                mod = test_module({branch: :control_branch,
+                                   default_branch: 'default',
+                                   default_branch_override: 'default_override'},
+                                   mock_env)
+
+                expect { mod.properties }.to raise_error(ArgumentError, /unable to manage.*or resolve the default branch override.*or resolve default/i)
+              end
+            end
+          end
+        end
       end
     end
   end

data/spec/unit/puppetfile_spec.rb

@@ -127,6 +127,17 @@ describe R10K::Puppetfile do
 
       expect { subject.add_module('puppet/test_module', module_opts) }.to raise_error(R10K::Error, /cannot manage content.*is not within/i).and not_change { subject.modules }
     end
+
+    it "should disable and not add modules that conflict with the environment" do
+      env = instance_double('R10K::Environment::Base')
+      mod = instance_double('R10K::Module::Base', name: 'conflict', origin: :puppetfile)
+      allow(mod).to receive(:origin=).and_return(nil)
+      allow(subject).to receive(:environment).and_return(env)
+      allow(env).to receive(:'module_conflicts?').with(mod).and_return(true)
+
+      allow(R10K::Module).to receive(:new).with('test', anything, anything, anything).and_return(mod)
+      expect { subject.add_module('test', {}) }.not_to change { subject.modules }
+    end
   end
 
   describe "#purge_exclusions" do
@@ -154,6 +165,26 @@ describe R10K::Puppetfile do
     end
   end
 
+  describe '#managed_directories' do
+    it 'returns an array of paths that can be purged' do
+      allow(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, '1.2.3', anything).and_call_original
+
+      subject.add_module('puppet/test_module', '1.2.3')
+      expect(subject.managed_directories).to match_array(["/some/nonexistent/basedir/modules"])
+    end
+
+    context 'with a module with install_path == \'\'' do
+      it 'basedir isn\'t in the list of paths to purge' do
+        module_opts = { install_path: '', git: 'git@example.com:puppet/test_module.git' }
+
+        allow(R10K::Module).to receive(:new).with('puppet/test_module', subject.basedir, module_opts, anything).and_call_original
+
+        subject.add_module('puppet/test_module', module_opts)
+        expect(subject.managed_directories).to be_empty
+      end
+    end
+  end
+
   describe "evaluating a Puppetfile" do
     def expect_wrapped_error(orig, pf_path, wrapped_error)
       expect(orig).to be_a_kind_of(R10K::Error)
@@ -244,7 +275,8 @@ describe R10K::Puppetfile do
       default_branch_override = 'default_branch_override_name'
       expect { subject.load!(default_branch_override) }.not_to raise_error
       git_module = subject.modules[0]
-      expect(git_module.default_ref).to eq default_branch_override
+      expect(git_module.default_override_ref).to eq default_branch_override
+      expect(git_module.default_ref).to eq "here_lies_the_default_branch"
     end
   end
 
@@ -263,12 +295,12 @@ describe R10K::Puppetfile do
         block.call
       end
 
-      mod1 = spy('module')
+      mod1 = instance_double('R10K::Module::Base', :cachedir => :none)
+      mod2 = instance_double('R10K::Module::Base', :cachedir => :none)
       expect(mod1).to receive(:accept).with(visitor)
-      mod2 = spy('module')
       expect(mod2).to receive(:accept).with(visitor)
-
       expect(subject).to receive(:modules).and_return([mod1, mod2])
+
       subject.accept(visitor)
     end
 
@@ -284,11 +316,10 @@ describe R10K::Puppetfile do
         block.call
       end
 
-      mod1 = spy('module')
+      mod1 = instance_double('R10K::Module::Base', :cachedir => :none)
+      mod2 = instance_double('R10K::Module::Base', :cachedir => :none)
       expect(mod1).to receive(:accept).with(visitor)
-      mod2 = spy('module')
       expect(mod2).to receive(:accept).with(visitor)
-
       expect(subject).to receive(:modules).and_return([mod1, mod2])
 
       expect(Thread).to receive(:new).exactly(pool_size).and_call_original
@@ -296,5 +327,28 @@ describe R10K::Puppetfile do
 
       subject.accept(visitor)
     end
+
+    it "Creates queues of modules grouped by cachedir" do
+      visitor = spy('visitor')
+      expect(visitor).to receive(:visit) do |type, other, &block|
+        expect(type).to eq :puppetfile
+        expect(other).to eq subject
+        block.call
+      end
+
+      m1 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/A')
+      m2 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/B')
+      m3 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/C')
+      m4 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/C')
+      m5 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/D')
+      m6 = instance_double('R10K::Module::Base', :cachedir => '/dev/null/D')
+
+      expect(subject).to receive(:modules).and_return([m1, m2, m3, m4, m5, m6])
+
+      queue = subject.modules_queue(visitor)
+      expect(queue.length).to be 4
+      queue_array = 4.times.map { queue.pop }
+      expect(queue_array).to match_array([[m1], [m2], [m3, m4], [m5, m6]])
+    end
   end
 end