r10k 3.11.0 → 3.14.0

data/spec/unit/environment/name_spec.rb

@@ -6,21 +6,29 @@ describe R10K::Environment::Name 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'
+      expect(bn.name).to eq 'myenv'
+      expect(bn.original_name).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'
+      expect(bn.name).to eq 'my'
+      expect(bn.original_name).to eq 'myenv'
     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'
+      expect(bn.name).to eq 'myenv'
+      expect(bn.original_name).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'
+      expect(bn.name).to eq 'prod'
+      expect(bn.original_name).to eq 'env/prod'
     end
 
     it "raises an error when given an integer" do
@@ -34,21 +42,29 @@ describe R10K::Environment::Name do
     it "uses the branch name as the dirname when prefixing is off" do
       bn = described_class.new('mybranch', :source => 'source', :prefix => false)
       expect(bn.dirname).to eq 'mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "prepends the source name when prefixing is on" do
       bn = described_class.new('mybranch', :source => 'source', :prefix => true)
       expect(bn.dirname).to eq 'source_mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "prepends the prefix name when prefixing is overridden" do
       bn = described_class.new('mybranch', {:prefix => "bar", :sourcename => 'foo'})
       expect(bn.dirname).to eq 'bar_mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
 
     it "uses the branch name as the dirname when prefixing is nil" do
       bn = described_class.new('mybranch', {:prefix => nil, :sourcename => 'foo'})
       expect(bn.dirname).to eq 'mybranch'
+      expect(bn.name).to eq 'mybranch'
+      expect(bn.original_name).to eq 'mybranch'
     end
   end
 
@@ -149,6 +165,8 @@ describe R10K::Environment::Name do
         it "replaces invalid characters in #{branch} with underscores" do
           bn = described_class.new(branch.dup, {:correct => true})
           expect(bn.dirname).to eq branch.gsub(/\W/, '_')
+          expect(bn.name).to eq branch
+          expect(bn.original_name).to eq branch
         end
       end
 

data/spec/unit/environment/plain_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Plain do
+  it "initializes successfully" do
+    expect(described_class.new('envname', '/basedir', 'dirname', {})).to be_a_kind_of(described_class)
+  end
+end

data/spec/unit/environment/svn_spec.rb

@@ -78,9 +78,10 @@ describe R10K::Environment::SVN do
 
   describe "enumerating modules" do
     it "loads the Puppetfile and returns modules in that puppetfile" do
-      expect(subject.puppetfile).to receive(:load)
-      expect(subject.puppetfile).to receive(:modules).and_return [:modules]
-      expect(subject.modules).to eq([:modules])
+      loaded = { managed_directories: [], desired_contents: [], purge_exclusions: [] }
+      mod = double('A module', :name => 'dbl')
+      expect(subject.loader).to receive(:load).and_return(loaded.merge(modules: [mod]))
+      expect(subject.modules).to eq([mod])
     end
   end
 

data/spec/unit/environment/tarball_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Tarball do
+  let(:tgz_path) do
+    File.expand_path('spec/fixtures/tarball/tarball.tar.gz', PROJECT_ROOT)
+  end
+
+  let(:checksum) { '36afcfc2378b8235902d6e647fce7479da6898354d620388646c595a1155ed67' }
+  let(:base_params) { { source: tgz_path, version: checksum, modules: { } } }
+
+  subject { described_class.new('envname', '/some/imaginary/path', 'dirname', base_params) }
+
+  describe "initializing" do
+    it "accepts valid base class initialization arguments" do
+      expect(subject.name).to eq 'envname'
+    end
+  end
+
+  describe "storing attributes" do
+    it "can return the environment name" do
+      expect(subject.name).to eq 'envname'
+    end
+
+    it "can return the environment basedir" do
+      expect(subject.basedir).to eq '/some/imaginary/path'
+    end
+
+    it "can return the environment dirname" do
+      expect(subject.dirname).to eq 'dirname'
+    end
+
+    it "can return the environment path" do
+      expect(subject.path.to_s).to eq '/some/imaginary/path/dirname'
+    end
+
+    it "can return the environment source" do
+      expect(subject.tarball.source).to eq tgz_path
+    end
+
+    it "can return the environment version" do
+      expect(subject.tarball.checksum).to eq checksum
+    end
+  end
+end

data/spec/unit/environment/with_modules_spec.rb

@@ -8,7 +8,7 @@ describe R10K::Environment::WithModules do
       '/some/nonexistent/environmentdir',
       'prefix_release42',
       {
-        :type             => 'bare',
+        :type             => 'plain',
         :modules          => {
           'puppetlabs-stdlib' => { local: true },
           'puppetlabs-concat' => { local: true },
@@ -65,8 +65,9 @@ describe R10K::Environment::WithModules do
 
   describe "modules method" do
     it "returns the configured modules, and Puppetfile modules" do
+      loaded = { managed_directories: [], desired_contents: [], purge_exclusions: [] }
       puppetfile_mod = instance_double('R10K::Module::Base', name: 'zebra')
-      expect(subject.puppetfile).to receive(:modules).and_return [puppetfile_mod]
+      expect(subject.loader).to receive(:load).and_return(loaded.merge(modules: [puppetfile_mod]))
       returned_modules = subject.modules
       expect(returned_modules.map(&:name).sort).to eq(%w[concat exec stdlib zebra])
     end

data/spec/unit/git/cache_spec.rb

@@ -21,7 +21,8 @@ describe R10K::Git::Cache do
     end
   end
 
-  subject { subclass.new('git://some/git/remote') }
+  let(:remote) { 'git://some/git/remote' }
+  subject { subclass.new(remote) }
 
   describe "updating the cache" do
     it "only updates the cache once" do
@@ -62,18 +63,4 @@ describe R10K::Git::Cache do
       subject.cached?
     end
   end
-
-  describe "dirname sanitization" do
-    it 'sanitizes cache directory name' do
-      expect(subject.sanitized_dirname).to eq('git---some-git-remote')
-    end
-
-    context 'with username and password' do
-      subject { subclass.new('https://"user:pa$$w0rd:@some/git/remote') }
-
-      it 'sanitizes cache directory name' do
-        expect(subject.sanitized_dirname).to eq('https---some-git-remote')
-      end
-    end
-  end
 end

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

@@ -26,4 +26,23 @@ describe R10K::Git::Rugged::Cache, :unless => R10K::Util::Platform.jruby? do
       expect(described_class.settings[:cache_root]).to eq '/some/path'
     end
   end
+
+  describe "remote url updates" do
+    before do
+      allow(subject.repo).to receive(:exist?).and_return true
+      allow(subject.repo).to receive(:fetch)
+      allow(subject.repo).to receive(:remotes).and_return({ 'origin' => 'git://some/git/remote' })
+    end
+
+    it "does not update the URLs if they match" do
+      expect(subject.repo).to_not receive(:update_remote)
+      subject.sync!
+    end
+
+    it "updates the remote URL if they do not match" do
+      allow(subject.repo).to receive(:remotes).and_return({ 'origin' => 'foo'})
+      expect(subject.repo).to receive(:update_remote)
+      subject.sync!
+    end
+  end
 end

data/spec/unit/module/base_spec.rb

@@ -4,26 +4,26 @@ 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', [])
+      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', [])
+      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', [])
+      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', [])
+        described_class.new('branan!eight_hundred', '/moduledir', {})
       }.to raise_error(ArgumentError, "Module name (branan!eight_hundred) must match either 'modulename' or 'owner/modulename'")
     end
   end
@@ -76,13 +76,13 @@ describe R10K::Module::Base do
 
   describe "path variables" do
     it "uses the module name as the name" do
-      m = described_class.new('eight_hundred', '/moduledir', [])
+      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', [])
+      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
@@ -90,7 +90,7 @@ describe R10K::Module::Base do
 
   describe "with alternate variable names" do
     subject do
-      described_class.new('branan/eight_hundred', '/moduledir', [])
+      described_class.new('branan/eight_hundred', '/moduledir', {})
     end
 
     it "aliases full_name to title" do
@@ -107,7 +107,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

@@ -9,6 +9,28 @@ describe R10K::Module::Forge do
   let(:fixture_modulepath) { File.expand_path('spec/fixtures/module/forge', PROJECT_ROOT) }
   let(:empty_modulepath) { File.expand_path('spec/fixtures/empty', PROJECT_ROOT) }
 
+  describe "statically determined version support" do
+    it 'returns explicitly released forge versions' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { version: '8.0.0' })
+      expect(static_version).to eq('8.0.0')
+    end
+
+    it 'returns explicit pre-released forge versions' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { version: '8.0.0-pre1' })
+      expect(static_version).to eq('8.0.0-pre1')
+    end
+
+    it 'retuns nil for latest versions' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { version: :latest })
+      expect(static_version).to eq(nil)
+    end
+
+    it 'retuns nil for undefined versions' do
+      static_version = described_class.statically_defined_version('branan/eight_hundred', { version: nil })
+      expect(static_version).to eq(nil)
+    end
+  end
+
   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', { version: '8.0.0' })
@@ -190,25 +212,31 @@ describe R10K::Module::Forge do
       expect(subject).to receive(:install).never
       expect(subject).to receive(:upgrade).never
       expect(subject).to receive(:reinstall).never
-      subject.sync
+      expect(subject.sync).to be false
     end
 
     it 'reinstalls the module when it is mismatched' do
       allow(subject).to receive(:status).and_return :mismatched
       expect(subject).to receive(:reinstall)
-      subject.sync
+      expect(subject.sync).to be true
     end
 
     it 'upgrades the module when it is outdated' do
       allow(subject).to receive(:status).and_return :outdated
       expect(subject).to receive(:upgrade)
-      subject.sync
+      expect(subject.sync).to be true
     end
 
     it 'installs the module when it is absent' do
       allow(subject).to receive(:status).and_return :absent
       expect(subject).to receive(:install)
-      subject.sync
+      expect(subject.sync).to be true
+    end
+
+    it 'returns false if `should_sync?` is false' do
+      # modules do not sync if they are not requested
+      mod = described_class.new('my_org/my_mod', '/path/to/mod', { overrides: { modules: { requested_modules: ['other_mod'] } } })
+      expect(mod.sync).to be false
     end
   end
 

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/tarball_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'r10k/module'
+require 'fileutils'
+
+describe R10K::Module::Tarball do
+  include_context 'Tarball'
+
+  let(:base_params) { { type: 'tarball', source: fixture_tarball, version: fixture_checksum } }
+
+  subject do
+    described_class.new(
+      'fixture-tarball',
+      moduledir,
+      base_params,
+    )
+  end
+
+  describe "setting the owner and name" do
+    describe "with a title of 'fixture-tarball'" do
+      it "sets the owner to 'fixture'" do
+        expect(subject.owner).to eq 'fixture'
+      end
+
+      it "sets the name to 'tarball'" do
+        expect(subject.name).to eq 'tarball'
+      end
+
+      it "sets the path to the given moduledir + modname" do
+        expect(subject.path.to_s).to eq(File.join(moduledir, 'tarball'))
+      end
+    end
+  end
+
+  describe "properties" do
+    it "sets the module type to :tarball" do
+      expect(subject.properties).to include(type: :tarball)
+    end
+
+    it "sets the version" do
+      expect(subject.properties).to include(expected: fixture_checksum)
+    end
+  end
+
+  describe 'syncing the module' do
+    it 'defaults to keeping the spec dir' do
+      subject.sync
+      expect(Dir.exist?(File.join(moduledir, 'tarball', 'spec'))).to be(true)
+    end
+  end
+
+  describe "determining the status" do
+    it "delegates to R10K::Tarball" do
+      expect(subject).to receive(:tarball).twice.and_return instance_double('R10K::Tarball', cache_valid?: true, insync?: true)
+      expect(subject).to receive(:path).twice.and_return instance_double('Pathname', exist?: true)
+
+      expect(subject.status).to eq(:insync)
+    end
+  end
+
+  describe "option parsing" do
+    describe "version" do
+      context "when no version is given" do
+        subject { described_class.new('fixture-tarball', moduledir, base_params.reject { |k| k.eql?(:version) }) }
+        it "does not require a version" do
+          expect(subject).to be_kind_of(described_class)
+        end
+      end
+    end
+  end
+end