r10k 3.6.0 → 3.9.2

data/spec/unit/environment/git_spec.rb

@@ -15,6 +15,22 @@ describe R10K::Environment::Git do
     )
   end
 
+  describe "initializing" do
+    subject do
+      described_class.new('name', '/dir', 'ref', {
+        :remote          => 'url',
+        :ref             => 'value',
+        :puppetfile_name => 'Puppetfile',
+        :moduledir       => 'modules',
+        :modules         => { },
+      })
+    end
+
+    it "accepts valid base class initialization arguments" do
+      expect(subject.name).to eq 'name'
+    end
+  end
+
   describe "storing attributes" do
     it "can return the environment name" do
       expect(subject.name).to eq 'myenv'
@@ -62,9 +78,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/name_spec.rb

@@ -2,6 +2,34 @@ require 'spec_helper'
 require 'r10k/environment/name'
 
 describe R10K::Environment::Name do
+  describe "strip_component" do
+    it "does not modify the given name when no strip_component is given" do
+      bn = described_class.new('myenv', source: 'source', prefix: false)
+      expect(bn.dirname).to eq 'myenv'
+    end
+
+    it "removes the first occurance of a regex match when a regex is given" do
+      bn = described_class.new('myenv', source: 'source', prefix: false, strip_component: '/env/')
+      expect(bn.dirname).to eq 'my'
+    end
+
+    it "does not modify the given name when there is no regex match" do
+      bn = described_class.new('myenv', source: 'source', prefix: false, strip_component: '/bar/')
+      expect(bn.dirname).to eq 'myenv'
+    end
+
+    it "removes the given name's prefix when it matches strip_component" do
+      bn = described_class.new('env/prod', source: 'source', prefix: false, strip_component: 'env/')
+      expect(bn.dirname).to eq 'prod'
+    end
+
+    it "raises an error when given an integer" do
+      expect {
+        described_class.new('env/prod', source: 'source', prefix: false, strip_component: 4)
+      }.to raise_error(%r{Improper.*"4"})
+    end
+  end
+
   describe "prefixing" do
     it "uses the branch name as the dirname when prefixing is off" do
       bn = described_class.new('mybranch', :source => 'source', :prefix => false)

data/spec/unit/environment/svn_spec.rb

@@ -16,6 +16,18 @@ describe R10K::Environment::SVN do
 
   let(:working_dir) { subject.working_dir }
 
+  describe "initializing" do
+    subject do
+      described_class.new('name', '/dir', 'ref', {
+        :puppetfile_name => 'Puppetfile',
+      })
+    end
+
+    it "accepts valid base class initialization arguments" do
+      expect(subject.name).to eq 'name'
+    end
+  end
+
   describe "storing attributes" do
     it "can return the environment name" do
       expect(subject.name).to eq 'myenv'

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/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,82 @@ 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
+
+    it 'only reads the token in once' do
+      expect($stdin).to receive(:read).and_return("my_token").once
+      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.instance_variable_get(:@password)).to eq("my_token")
+      creds = subject.get_plaintext_credentials("https://tessier-ashpool.freeside/repo.git", nil)
+      expect(creds.instance_variable_get(:@password)).to eq("my_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/forge_spec.rb

@@ -11,20 +11,26 @@ describe R10K::Module::Forge do
 
   describe "implementing the Puppetfile spec" do
     it "should implement 'branan/eight_hundred', '8.0.0'" do
-      expect(described_class).to be_implement('branan/eight_hundred', '8.0.0')
+      expect(described_class).to be_implement('branan/eight_hundred', { version: '8.0.0' })
     end
 
     it "should implement 'branan-eight_hundred', '8.0.0'" do
-      expect(described_class).to be_implement('branan-eight_hundred', '8.0.0')
+      expect(described_class).to be_implement('branan-eight_hundred', { version: '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')
+      expect(described_class).to_not be_implement('branan!eight_hundred', { version: '8.0.0' })
+    end
+  end
+
+  describe "implementing the standard options interface" do
+    it "should implement {type: forge}" do
+      expect(described_class).to be_implement('branan-eight_hundred', {type: 'forge', version: '8.0.0', source: 'not implemented'})
     end
   end
 
   describe "setting attributes" do
-    subject { described_class.new('branan/eight_hundred', '/moduledir', '8.0.0') }
+    subject { described_class.new('branan/eight_hundred', '/moduledir', { version: '8.0.0' }) }
 
     it "sets the name" do
       expect(subject.name).to eq 'eight_hundred'
@@ -44,7 +50,7 @@ describe R10K::Module::Forge do
   end
 
   describe "properties" do
-    subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
+    subject { described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' }) }
 
     it "sets the module type to :forge" do
       expect(subject.properties).to include(:type => :forge)
@@ -61,7 +67,7 @@ describe R10K::Module::Forge do
   end
 
   context "when a module is deprecated" do
-    subject { described_class.new('puppetlabs/corosync', fixture_modulepath, :latest) }
+    subject { described_class.new('puppetlabs/corosync', fixture_modulepath, { version: :latest }) }
 
     it "warns on sync if module is not already insync" do
       allow(subject).to receive(:status).and_return(:absent)
@@ -71,6 +77,7 @@ describe R10K::Module::Forge do
       logger_dbl = double(Log4r::Logger)
       allow_any_instance_of(described_class).to receive(:logger).and_return(logger_dbl)
 
+      allow(logger_dbl).to receive(:info).with(/Deploying module to.*/)
       expect(logger_dbl).to receive(:warn).with(/puppet forge module.*puppetlabs-corosync.*has been deprecated/i)
 
       subject.sync
@@ -82,6 +89,7 @@ describe R10K::Module::Forge do
       logger_dbl = double(Log4r::Logger)
       allow_any_instance_of(described_class).to receive(:logger).and_return(logger_dbl)
 
+      allow(logger_dbl).to receive(:info).with(/Deploying module to.*/)
       expect(logger_dbl).to_not receive(:warn).with(/puppet forge module.*puppetlabs-corosync.*has been deprecated/i)
 
       subject.sync
@@ -90,12 +98,12 @@ describe R10K::Module::Forge do
 
   describe '#expected_version' do
     it "returns an explicitly given expected version" do
-      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' })
       expect(subject.expected_version).to eq '8.0.0'
     end
 
     it "uses the latest version from the forge when the version is :latest" do
-      subject = described_class.new('branan/eight_hundred', fixture_modulepath, :latest)
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: :latest })
       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
@@ -103,7 +111,7 @@ describe R10K::Module::Forge do
 
   describe "determining the status" do
 
-    subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
+    subject { described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' }) }
 
     it "is :absent if the module directory is absent" do
       allow(subject).to receive(:exist?).and_return false
@@ -148,7 +156,7 @@ describe R10K::Module::Forge do
   end
 
   describe "#sync" do
-    subject { described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0') }
+    subject { described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' }) }
 
     it 'does nothing when the module is in sync' do
       allow(subject).to receive(:status).and_return :insync
@@ -180,7 +188,7 @@ describe R10K::Module::Forge do
 
   describe '#install' do
     it 'installs the module from the forge' do
-      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: '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(release).to receive(:install).with(subject.path)
@@ -190,7 +198,7 @@ describe R10K::Module::Forge do
 
   describe '#uninstall' do
     it 'removes the module path' do
-      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' })
       expect(FileUtils).to receive(:rm_rf).with(subject.path.to_s)
       subject.uninstall
     end
@@ -198,7 +206,7 @@ describe R10K::Module::Forge do
 
   describe '#reinstall' do
     it 'uninstalls and then installs the module' do
-      subject = described_class.new('branan/eight_hundred', fixture_modulepath, '8.0.0')
+      subject = described_class.new('branan/eight_hundred', fixture_modulepath, { version: '8.0.0' })
       expect(subject).to receive(:uninstall)
       expect(subject).to receive(:install)
       subject.reinstall

data/spec/unit/module/git_spec.rb

@@ -123,7 +123,7 @@ describe R10K::Module::Git do
       let(:opts) { { unrecognized: true } }
 
       it "raises an error" do
-        expect { test_module(opts) }.to raise_error(ArgumentError, /unhandled options.*unrecognized/i)
+        expect { test_module(opts) }.to raise_error(ArgumentError, /cannot handle option 'unrecognized'/)
       end
     end
 
@@ -210,6 +210,14 @@ describe R10K::Module::Git do
             expect(mod.desired_ref).to eq(:control_branch)
           end
 
+          it "warns control branch may be unresolvable" do
+            logger = double("logger")
+            allow_any_instance_of(described_class).to receive(:logger).and_return(logger)
+            expect(logger).to receive(:warn).with(/Cannot track control repo branch.*boolean.*/)
+
+            test_module(branch: :control_branch)
+          end
+
           context "when default ref is provided and resolvable" do
             it "uses default ref" do
               expect(mock_repo).to receive(:resolve).with('default').and_return('abc123')
@@ -268,6 +276,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