r10k 3.11.0 → 3.12.0

data/spec/unit/module/git_spec.rb

@@ -10,15 +10,41 @@ describe R10K::Module::Git do
     allow(R10K::Git::StatefulRepository).to receive(:new).and_return(mock_repo)
   end
 
+
+  describe "statically determined version support" do
+    it 'returns a given commit' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { git: 'my/remote', commit: '123adf' })
+      expect(static_version).to eq('123adf')
+    end
+
+    it 'returns a given tag' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { git: 'my/remote', tag: 'v1.2.3' })
+      expect(static_version).to eq('v1.2.3')
+    end
+
+    it 'returns a ref if it looks like a full commit sha' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { git: 'my/remote', ref: '1234567890abcdef1234567890abcdef12345678' })
+      expect(static_version).to eq('1234567890abcdef1234567890abcdef12345678')
+    end
+
+    it 'returns nil for any non-sha-like ref' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { git: 'my/remote', ref: 'refs/heads/main' })
+      expect(static_version).to eq(nil)
+    end
+
+    it 'returns nil for branches' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { git: 'my/remote', branch: 'main' })
+      expect(static_version).to eq(nil)
+    end
+  end
+
   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',
-          }
+          { :git => 'git://git-server.site/branan/puppet-eight_hundred' }
         )
       end
 
@@ -40,9 +66,7 @@ describe R10K::Module::Git do
         described_class.new(
           'eight_hundred',
           '/moduledir',
-          {
-            :git => 'git://git-server.site/branan/puppet-eight_hundred',
-          }
+          { :git => 'git://git-server.site/branan/puppet-eight_hundred' }
         )
       end
 
@@ -97,13 +121,32 @@ describe R10K::Module::Git do
     let(:spec_path) { dirname + module_name + 'spec' }
     subject { described_class.new(title, dirname, {}) }
 
+    before(:each) do
+      allow(mock_repo).to receive(:resolve).with('master').and_return('abc123')
+    end
+
     it 'defaults to keeping the spec dir' do
       FileUtils.mkdir_p(spec_path)
-      allow(mock_repo).to receive(:resolve).with('master').and_return('abc123')
       allow(mock_repo).to receive(:sync)
       subject.sync
       expect(Dir.exist?(spec_path)).to eq true
     end
+
+    it 'returns true if repo was updated' do
+      expect(mock_repo).to receive(:sync).and_return(true)
+      expect(subject.sync).to be true
+    end
+
+    it 'returns false if repo was not updated (in-sync)' do
+      expect(mock_repo).to receive(:sync).and_return(false)
+      expect(subject.sync).to be false
+    end
+
+    it 'returns false if `should_sync?` is false' do
+      # modules do not sync if they are not requested
+      mod = described_class.new(title, dirname, { overrides: { modules: { requested_modules: ['other_mod'] } } })
+      expect(mod.sync).to be false
+    end
   end
 
   describe "determining the status" do
@@ -111,9 +154,7 @@ describe R10K::Module::Git do
       described_class.new(
         'boolean',
         '/moduledir',
-        {
-          :git => 'git://git.example.com/adrienthebo/puppet-boolean'
-        }
+        { :git => 'git://git.example.com/adrienthebo/puppet-boolean' }
       )
     end
 

data/spec/unit/module/svn_spec.rb

@@ -6,6 +6,13 @@ describe R10K::Module::SVN do
 
   include_context 'fail on execution'
 
+  describe "statically determined version support" do
+    it 'is unsupported by svn backed modules' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { svn: 'my/remote', revision: '123adf' })
+      expect(static_version).to eq(nil)
+    end
+  end
+
   describe "determining it implements a Puppetfile mod" do
     it "implements mods with the :svn hash key" do
       implements = described_class.implement?('r10k-fixture-repo', :svn => 'https://github.com/adrienthebo/r10k-fixture-repo')
@@ -128,7 +135,6 @@ describe R10K::Module::SVN do
     subject { described_class.new(title, dirname, {}) }
 
     it 'is kept by default' do
-
       FileUtils.mkdir_p(spec_path)
       expect(subject).to receive(:status).and_return(:absent)
       expect(subject).to receive(:install).and_return(nil)
@@ -150,7 +156,7 @@ describe R10K::Module::SVN do
 
       it "installs the SVN module" do
         expect(subject).to receive(:install)
-        subject.sync
+        expect(subject.sync).to be true
       end
     end
 
@@ -160,14 +166,14 @@ describe R10K::Module::SVN do
       it "reinstalls the module" do
         expect(subject).to receive(:reinstall)
 
-        subject.sync
+        expect(subject.sync).to be true
       end
 
       it "removes the existing directory" do
         expect(subject.path).to receive(:rmtree)
         allow(subject).to receive(:install)
 
-        subject.sync
+        expect(subject.sync).to be true
       end
     end
 
@@ -177,7 +183,7 @@ describe R10K::Module::SVN do
       it "upgrades the repository" do
         expect(subject).to receive(:update)
 
-        subject.sync
+        expect(subject.sync).to be true
       end
     end
 
@@ -189,8 +195,14 @@ describe R10K::Module::SVN do
         expect(subject).to receive(:reinstall).never
         expect(subject).to receive(:update).never
 
-        subject.sync
+        expect(subject.sync).to be false
       end
     end
+
+    it 'and `should_sync?` is false' do
+      # modules do not sync if they are not requested
+      mod = described_class.new('my_mod', '/path/to/mod', { overrides: { modules: { requested_modules: ['other_mod'] } } })
+      expect(mod.sync).to be false
+    end
   end
 end

data/spec/unit/module_loader/puppetfile_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'r10k/module_loader/puppetfile'
+require 'tmpdir'
 
 describe R10K::ModuleLoader::Puppetfile do
   describe 'initial parameters' do
@@ -7,7 +8,6 @@ describe R10K::ModuleLoader::Puppetfile do
       let(:options) do
         {
           basedir: '/test/basedir/env',
-          forge: 'localforge.internal.corp',
           overrides: { modules: { deploy_modules: true } },
           environment: R10K::Environment::Git.new('env',
                                                   '/test/basedir/',
@@ -47,10 +47,6 @@ describe R10K::ModuleLoader::Puppetfile do
         end
       end
 
-      it 'the forge' do
-        expect(subject.instance_variable_get(:@forge)).to eq('localforge.internal.corp')
-      end
-
       it 'the overrides' do
         expect(subject.instance_variable_get(:@overrides)).to eq({ modules: { deploy_modules: true }})
       end
@@ -71,10 +67,6 @@ describe R10K::ModuleLoader::Puppetfile do
         expect(subject.instance_variable_get(:@puppetfile_path)).to eq('/test/basedir/Puppetfile')
       end
 
-      it 'uses the public forge' do
-        expect(subject.instance_variable_get(:@forge)).to eq('forgeapi.puppetlabs.com')
-      end
-
       it 'creates an empty overrides' do
         expect(subject.instance_variable_get(:@overrides)).to eq({})
       end
@@ -91,14 +83,14 @@ describe R10K::ModuleLoader::Puppetfile do
     subject { R10K::ModuleLoader::Puppetfile.new(basedir: basedir) }
 
     it 'should transform Forge modules with a string arg to have a version key' do
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, hash_including(version: '1.2.3'), anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', subject.moduledir, hash_including(version: '1.2.3'), anything).and_call_original
 
       expect { subject.add_module('puppet/test_module', '1.2.3') }.to change { subject.modules }
       expect(subject.modules.collect(&:name)).to include('test_module')
     end
 
     it 'should not accept Forge modules with a version comparison' do
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, hash_including(version: '< 1.2.0'), anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', subject.moduledir, hash_including(version: '< 1.2.0'), anything).and_call_original
 
       expect {
         subject.add_module('puppet/test_module', '< 1.2.0')
@@ -122,7 +114,7 @@ describe R10K::ModuleLoader::Puppetfile do
     it 'should accept non-Forge modules with a hash arg' do
       module_opts = { git: 'git@example.com:puppet/test_module.git' }
 
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, module_opts, anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', subject.moduledir, module_opts, anything).and_call_original
 
       expect { subject.add_module('puppet/test_module', module_opts) }.to change { subject.modules }
       expect(subject.modules.collect(&:name)).to include('test_module')
@@ -134,7 +126,7 @@ describe R10K::ModuleLoader::Puppetfile do
         git: 'git@example.com:puppet/test_module.git',
       }
 
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', File.join(basedir, 'vendor'), module_opts, anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', File.join(basedir, 'vendor'), module_opts, anything).and_call_original
 
       expect { subject.add_module('puppet/test_module', module_opts) }.to change { subject.modules }
       expect(subject.modules.collect(&:name)).to include('test_module')
@@ -148,7 +140,7 @@ describe R10K::ModuleLoader::Puppetfile do
         git: 'git@example.com:puppet/test_module.git',
       }
 
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', install_path, module_opts, anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', install_path, module_opts, anything).and_call_original
 
       expect { subject.add_module('puppet/test_module', module_opts) }.to change { subject.modules }
       expect(subject.modules.collect(&:name)).to include('test_module')
@@ -179,7 +171,7 @@ describe R10K::ModuleLoader::Puppetfile do
       allow(env).to receive(:'module_conflicts?').with(mod).and_return(true)
       allow(mod).to receive(:spec_deletable=)
 
-      expect(R10K::Module).to receive(:new).with('conflict', anything, anything, anything).and_return(mod)
+      expect(R10K::Module).to receive(:from_metadata).with('conflict', anything, anything, anything).and_return(mod)
       expect { loader.add_module('conflict', {}) }.not_to change { loader.modules }
     end
   end
@@ -214,9 +206,9 @@ describe R10K::ModuleLoader::Puppetfile do
     end
 
     it 'returns an array of paths that #purge! will operate within' do
-      expect(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, hash_including(version: '1.2.3'), anything).and_call_original
+      expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', subject.moduledir, hash_including(version: '1.2.3'), anything).and_call_original
       subject.add_module('puppet/test_module', '1.2.3')
-      subject.load
+      subject.load!
 
       expect(subject.modules.length).to be 1
       expect(subject.managed_directories).to match_array([subject.moduledir])
@@ -226,9 +218,9 @@ describe R10K::ModuleLoader::Puppetfile 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' }
 
-        expect(R10K::Module).to receive(:new).with('puppet/test_module', basedir, module_opts, anything).and_call_original
+        expect(R10K::Module).to receive(:from_metadata).with('puppet/test_module', basedir, module_opts, anything).and_call_original
         subject.add_module('puppet/test_module', module_opts)
-        subject.load
+        subject.load!
 
         expect(subject.modules.length).to be 1
         expect(subject.managed_directories).to be_empty
@@ -249,7 +241,7 @@ describe R10K::ModuleLoader::Puppetfile do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'invalid-syntax')
       pf_path = File.join(@path, 'Puppetfile')
       expect {
-        subject.load
+        subject.load!
       }.to raise_error do |e|
         expect_wrapped_error(e, pf_path, SyntaxError)
       end
@@ -259,7 +251,7 @@ describe R10K::ModuleLoader::Puppetfile do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'load-error')
       pf_path = File.join(@path, 'Puppetfile')
       expect {
-        subject.load
+        subject.load!
       }.to raise_error do |e|
         expect_wrapped_error(e, pf_path, LoadError)
       end
@@ -269,17 +261,38 @@ describe R10K::ModuleLoader::Puppetfile do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'argument-error')
       pf_path = File.join(@path, 'Puppetfile')
       expect {
-        subject.load
+        subject.load!
       }.to raise_error do |e|
         expect_wrapped_error(e, pf_path, ArgumentError)
       end
     end
 
+    describe 'forge declaration' do
+      before(:each) do
+        PuppetForge.host = ""
+      end
+
+      it 'is respected if `allow_puppetfile_override` is true' do
+        @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'forge-override')
+        puppetfile = R10K::ModuleLoader::Puppetfile.new(basedir: @path, overrides: { forge: { allow_puppetfile_override: true } })
+        puppetfile.load!
+        expect(PuppetForge.host).to eq("my.custom.forge.com/")
+      end
+
+      it 'is ignored if `allow_puppetfile_override` is false' do
+        @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'forge-override')
+        puppetfile = R10K::ModuleLoader::Puppetfile.new(basedir: @path, overrides: { forge: { allow_puppetfile_override: false } })
+        expect(PuppetForge).not_to receive(:host=).with("my.custom.forge.com")
+        puppetfile.load!
+        expect(PuppetForge.host).to eq("/")
+      end
+    end
+
     it 'rejects Puppetfiles with duplicate module names' do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'duplicate-module-error')
       pf_path = File.join(@path, 'Puppetfile')
       expect {
-        subject.load
+        subject.load!
       }.to raise_error(R10K::Error, /Puppetfiles cannot contain duplicate module names/i)
     end
 
@@ -287,7 +300,7 @@ describe R10K::ModuleLoader::Puppetfile do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'name-error')
       pf_path = File.join(@path, 'Puppetfile')
       expect {
-        subject.load
+        subject.load!
       }.to raise_error do |e|
         expect_wrapped_error(e, pf_path, NameError)
       end
@@ -296,21 +309,21 @@ describe R10K::ModuleLoader::Puppetfile do
     it 'accepts a forge module with a version' do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'valid-forge-with-version')
       pf_path = File.join(@path, 'Puppetfile')
-      expect { subject.load }.not_to raise_error
+      expect { subject.load! }.not_to raise_error
     end
 
     describe 'setting a custom moduledir' do
       it 'allows setting an absolute moduledir' do
         @path = '/fake/basedir'
         allow(subject).to receive(:puppetfile_content).and_return('moduledir "/fake/moduledir"')
-        subject.load
+        subject.load!
         expect(subject.instance_variable_get(:@moduledir)).to eq('/fake/moduledir')
       end
 
       it 'roots relative moduledirs in the basedir' do
         @path = '/fake/basedir'
         allow(subject).to receive(:puppetfile_content).and_return('moduledir "my/moduledir"')
-        subject.load
+        subject.load!
         expect(subject.instance_variable_get(:@moduledir)).to eq(File.join(@path, 'my/moduledir'))
       end
     end
@@ -318,13 +331,13 @@ describe R10K::ModuleLoader::Puppetfile do
     it 'accepts a forge module without a version' do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'valid-forge-without-version')
       pf_path = File.join(@path, 'Puppetfile')
-      expect { subject.load }.not_to raise_error
+      expect { subject.load! }.not_to raise_error
     end
 
     it 'creates a git module and applies the default branch specified in the Puppetfile' do
       @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'default-branch-override')
       pf_path = File.join(@path, 'Puppetfile')
-      expect { subject.load }.not_to raise_error
+      expect { subject.load! }.not_to raise_error
       git_module = subject.modules[0]
       expect(git_module.default_ref).to eq 'here_lies_the_default_branch'
     end
@@ -334,10 +347,57 @@ describe R10K::ModuleLoader::Puppetfile do
       pf_path = File.join(@path, 'Puppetfile')
       default_branch_override = 'default_branch_override_name'
       subject.default_branch_override = default_branch_override
-      expect { subject.load }.not_to raise_error
+      expect { subject.load! }.not_to raise_error
       git_module = subject.modules[0]
       expect(git_module.default_override_ref).to eq default_branch_override
       expect(git_module.default_ref).to eq 'here_lies_the_default_branch'
     end
+
+    describe 'using module metadata' do
+      it 'properly loads module metadata' do
+        @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'various-modules')
+        metadata = subject.load_metadata[:modules].map { |mod| [ mod.name, mod.version ] }.to_h
+        expect(metadata['apt']).to eq('2.1.1')
+        expect(metadata['stdlib']).to eq(nil)
+        expect(metadata['concat']).to eq(nil)
+        expect(metadata['rpm']).to eq('2.1.1-pre1')
+        expect(metadata['foo']).to eq(nil)
+        expect(metadata['bar']).to eq('v1.2.3')
+        expect(metadata['baz']).to eq('123abc456')
+        expect(metadata['fizz']).to eq('1234567890abcdef1234567890abcdef12345678')
+        expect(metadata['buzz']).to eq(nil)
+      end
+
+      it 'does not load module implementations for static versioned' do
+        @path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'various-modules')
+        subject.load_metadata
+        modules = subject.load[:modules].map { |mod| [ mod.name, mod ] }.to_h
+        expect(modules['apt']).to be_a_kind_of(R10K::Module::Definition)
+        expect(modules['stdlib']).to be_a_kind_of(R10K::Module::Forge)
+        expect(modules['concat']).to be_a_kind_of(R10K::Module::Forge)
+        expect(modules['rpm']).to be_a_kind_of(R10K::Module::Definition)
+        expect(modules['foo']).to be_a_kind_of(R10K::Module::Git)
+        expect(modules['bar']).to be_a_kind_of(R10K::Module::Definition)
+        expect(modules['baz']).to be_a_kind_of(R10K::Module::Definition)
+        expect(modules['fizz']).to be_a_kind_of(R10K::Module::Definition)
+        expect(modules['buzz']).to be_a_kind_of(R10K::Module::Git)
+      end
+
+      it 'loads module implementations whose static versions are different' do
+        fixture_path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'various-modules')
+        @path = Dir.mktmpdir
+        unsynced_pf_path = File.join(fixture_path, 'Puppetfile')
+        FileUtils.cp(unsynced_pf_path, @path)
+
+        subject.load_metadata
+
+        synced_pf_path = File.join(fixture_path, 'Puppetfile.new')
+        FileUtils.cp(synced_pf_path, File.join(@path, 'Puppetfile'))
+
+        modules = subject.load[:modules].map { |mod| [ mod.name, mod ] }.to_h
+
+        expect(modules['apt']).to be_a_kind_of(R10K::Module::Forge)
+      end
+    end
   end
 end

data/spec/unit/puppetfile_spec.rb

@@ -114,7 +114,7 @@ describe R10K::Puppetfile do
         path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'valid-forge-with-version')
         subject = described_class.new(path, {})
 
-        expect(subject.loader).to receive(:load).and_call_original.once
+        expect(subject.loader).to receive(:load!).and_call_original.once
 
         loaded_content1 = subject.load
         expect(subject.loaded?).to be true
@@ -273,7 +273,7 @@ describe R10K::Puppetfile do
       expect(subject).to receive(:modules).and_return([mod1, mod2])
 
       expect(Thread).to receive(:new).exactly(pool_size).and_call_original
-      expect(Queue).to receive(:new).and_call_original
+      expect(Queue).to receive(:new).and_call_original.twice
 
       subject.accept(visitor)
     end