r10k 3.7.0 → 3.9.3

data/spec/unit/module_spec.rb

@@ -3,27 +3,94 @@ require 'r10k/module'
 
 describe R10K::Module do
   describe 'delegating to R10K::Module::Git' do
-    it "accepts args {:git => 'git url}" do
-      obj = R10K::Module.new('foo', '/modulepath', :git => 'git url')
-      expect(obj).to be_a_kind_of(R10K::Module::Git)
+    [ {git: 'git url'},
+      {type: 'git', source: 'git url'},
+    ].each do |scenario|
+      it "accepts a name matching 'test' and args #{scenario.inspect}" do
+        obj = R10K::Module.new('test', '/modulepath', scenario)
+        expect(obj).to be_a_kind_of(R10K::Module::Git)
+        expect(obj.send(:instance_variable_get, :'@remote')).to eq('git url')
+      end
+    end
+  end
+
+  describe 'delegating to R10K::Module::Svn' do
+    [ {svn: 'svn url'},
+      {type: 'svn', source: 'svn url'},
+    ].each do |scenario|
+      it "accepts a name matching 'test' and args #{scenario.inspect}" do
+        obj = R10K::Module.new('test', '/modulepath', scenario)
+        expect(obj).to be_a_kind_of(R10K::Module::SVN)
+        expect(obj.send(:instance_variable_get, :'@url')).to eq('svn url')
+      end
     end
   end
 
   describe 'delegating to R10K::Module::Forge' do
-    [
-      ['bar/quux', nil],
-      ['bar-quux', nil],
-      ['bar/quux', '8.0.0'],
+    [ 'bar/quux',
+      'bar-quux',
+    ].each do |scenario|
+      it "accepts a name matching #{scenario} and version nil" do
+        obj = R10K::Module.new(scenario, '/modulepath', { version: nil })
+        expect(obj).to be_a_kind_of(R10K::Module::Forge)
+      end
+    end
+    [ {version: '8.0.0'},
+      {type: 'forge', version: '8.0.0'},
     ].each do |scenario|
-      it "accepts a name matching #{scenario[0]} and args #{scenario[1].inspect}" do
-        expect(R10K::Module.new(scenario[0], '/modulepath', scenario[1])).to be_a_kind_of(R10K::Module::Forge)
+      it "accepts a name matching bar-quux and args #{scenario.inspect}" do
+        obj = R10K::Module.new('bar-quux', '/modulepath', scenario)
+        expect(obj).to be_a_kind_of(R10K::Module::Forge)
+        expect(obj.send(:instance_variable_get, :'@expected_version')).to eq('8.0.0')
+      end
+    end
+
+    describe 'when the module is ostensibly on disk' do
+      before do
+        owner = 'theowner'
+        module_name = 'themodulename'
+        @title = "#{owner}-#{module_name}"
+        metadata = <<~METADATA
+          {
+            "name": "#{@title}",
+            "version": "1.2.0"
+          }
+        METADATA
+        @dirname = Dir.mktmpdir
+        module_path = File.join(@dirname, module_name)
+        FileUtils.mkdir(module_path)
+        File.open("#{module_path}/metadata.json", 'w') do |file|
+           file.write(metadata)
+        end
+      end
+
+      it 'sets the expected version to what is found in the metadata' do
+        obj = R10K::Module.new(@title, @dirname, {version: nil})
+        expect(obj.send(:instance_variable_get, :'@expected_version')).to eq('1.2.0')
       end
     end
   end
 
   it "raises an error if delegation fails" do
     expect {
-      R10K::Module.new('bar!quux', '/modulepath', ["NOPE NOPE NOPE NOPE!"])
+      R10K::Module.new('bar!quux', '/modulepath', {version: ["NOPE NOPE NOPE NOPE!"]})
     }.to raise_error RuntimeError, /doesn't have an implementation/
   end
+
+  describe 'when a user passes a `default_branch_override`' do
+    [ ['name', {git: 'git url'}],
+      ['name', {type: 'git', source: 'git url'}],
+      ['name', {svn: 'svn url'}],
+      ['name', {type: 'svn', source: 'svn url'}],
+      ['namespace-name', {version: '8.0.0'}],
+      ['namespace-name', {type: 'forge', version: '8.0.0'}]
+    ].each do |(name, options)|
+      it 'can handle the default_branch_override option' do
+        expect {
+          obj = R10K::Module.new(name, '/modulepath', options.merge({default_branch_override: 'foo'}))
+          expect(obj).to be_a_kind_of(R10K::Module::Base)
+        }.not_to raise_error
+      end
+    end
+  end
 end

data/spec/unit/puppetfile_spec.rb

@@ -6,9 +6,7 @@ describe R10K::Puppetfile do
   subject do
     described_class.new(
       '/some/nonexistent/basedir',
-      nil,
-      nil,
-      'Puppetfile.r10k'
+      {puppetfile_name: 'Puppetfile.r10k'}
     )
   end
 
@@ -23,9 +21,25 @@ end
 describe R10K::Puppetfile do
 
   subject do
-    described_class.new(
-      '/some/nonexistent/basedir'
-    )
+    described_class.new( '/some/nonexistent/basedir', {})
+  end
+
+  describe "backwards compatibility with older calling conventions" do
+    it "honors all arguments correctly" do
+      puppetfile = described_class.new('/some/nonexistant/basedir', '/some/nonexistant/basedir/site-modules', nil, 'Pupupupetfile', true)
+      expect(puppetfile.force).to eq(true)
+      expect(puppetfile.moduledir).to eq('/some/nonexistant/basedir/site-modules')
+      expect(puppetfile.puppetfile_path).to eq('/some/nonexistant/basedir/Pupupupetfile')
+      expect(puppetfile.overrides).to eq({})
+    end
+
+    it "handles defaults correctly" do
+      puppetfile = described_class.new('/some/nonexistant/basedir', nil, nil, nil)
+      expect(puppetfile.force).to eq(false)
+      expect(puppetfile.moduledir).to eq('/some/nonexistant/basedir/modules')
+      expect(puppetfile.puppetfile_path).to eq('/some/nonexistant/basedir/Puppetfile')
+      expect(puppetfile.overrides).to eq({})
+    end
   end
 
   describe "the default moduledir" do
@@ -54,15 +68,15 @@ describe R10K::Puppetfile do
   end
 
   describe "adding modules" do
-    it "should accept Forge modules with a string arg" do
-      allow(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, '1.2.3', anything).and_call_original
+    it "should transform Forge modules with a string arg to have a version key" do
+      allow(R10K::Module).to receive(:new).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
-      allow(R10K::Module).to receive(:new).with('puppet/test_module', subject.moduledir, '< 1.2.0', anything).and_call_original
+      allow(R10K::Module).to receive(:new).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')
@@ -128,23 +142,15 @@ 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 "groups modules by vcs cache location" do
-      module_opts = { install_path: File.join(subject.basedir, 'vendor') }
-      opts1 = module_opts.merge(git: 'git@example.com:puppet/test_module.git')
-      opts2 = module_opts.merge(git: 'git@example.com:puppet/test_module_c.git')
-      sanitized_name1 = "git@example.com-puppet-test_module.git"
-      sanitized_name2 = "git@example.com-puppet-test_module_c.git"
-
-      subject.add_module('puppet/test_module_a', opts1)
-      subject.add_module('puppet/test_module_b', opts1)
-      subject.add_module('puppet/test_module_c', opts2)
-      subject.add_module('puppet/test_module_d', '1.2.3')
+    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)
 
-      mods_by_cachedir = subject.modules_by_vcs_cachedir
-
-      expect(mods_by_cachedir[:none].length).to be 1
-      expect(mods_by_cachedir[sanitized_name1].length).to be 2
-      expect(mods_by_cachedir[sanitized_name2].length).to be 1
+      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
 
@@ -175,7 +181,7 @@ describe R10K::Puppetfile do
 
   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
+      allow(R10K::Module).to receive(:new).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')
       expect(subject.managed_directories).to match_array(["/some/nonexistent/basedir/modules"])
@@ -203,7 +209,7 @@ describe R10K::Puppetfile do
     it "wraps and re-raises syntax errors" do
       path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'invalid-syntax')
       pf_path = File.join(path, 'Puppetfile')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect {
         subject.load!
       }.to raise_error do |e|
@@ -214,7 +220,7 @@ describe R10K::Puppetfile do
     it "wraps and re-raises load errors" do
       path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'load-error')
       pf_path = File.join(path, 'Puppetfile')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect {
         subject.load!
       }.to raise_error do |e|
@@ -225,7 +231,7 @@ describe R10K::Puppetfile do
     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)
+      subject = described_class.new(path, {})
       expect {
         subject.load!
       }.to raise_error do |e|
@@ -236,7 +242,7 @@ describe R10K::Puppetfile do
     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')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect {
         subject.load!
       }.to raise_error(R10K::Error, /Puppetfiles cannot contain duplicate module names/i)
@@ -245,7 +251,7 @@ describe R10K::Puppetfile do
     it "wraps and re-raises name errors" do
       path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'name-error')
       pf_path = File.join(path, 'Puppetfile')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect {
         subject.load!
       }.to raise_error do |e|
@@ -256,21 +262,21 @@ describe R10K::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')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect { subject.load! }.not_to raise_error
     end
 
     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')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect { subject.load! }.not_to raise_error
     end
 
     it "creates a git module and applies the default branch sepcified in the Puppetfile" do
       path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'default-branch-override')
       pf_path = File.join(path, 'Puppetfile')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       expect { subject.load! }.not_to raise_error
       git_module = subject.modules[0]
       expect(git_module.default_ref).to eq 'here_lies_the_default_branch'
@@ -279,11 +285,12 @@ describe R10K::Puppetfile do
     it "creates a git module and applies the provided default_branch_override" do
       path = File.join(PROJECT_ROOT, 'spec', 'fixtures', 'unit', 'puppetfile', 'default-branch-override')
       pf_path = File.join(path, 'Puppetfile')
-      subject = described_class.new(path)
+      subject = described_class.new(path, {})
       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
 
@@ -294,7 +301,7 @@ describe R10K::Puppetfile do
       subject.accept(visitor)
     end
 
-    it "passes the visitor to each module if the visitor yields" do
+    it "synchronizes each module if the visitor yields" do
       visitor = spy('visitor')
       expect(visitor).to receive(:visit) do |type, other, &block|
         expect(type).to eq :puppetfile
@@ -302,12 +309,12 @@ describe R10K::Puppetfile do
         block.call
       end
 
-      mod1 = spy('module')
-      expect(mod1).to receive(:accept).with(visitor)
-      mod2 = spy('module')
-      expect(mod2).to receive(:accept).with(visitor)
+      mod1 = instance_double('R10K::Module::Base', :cachedir => :none)
+      mod2 = instance_double('R10K::Module::Base', :cachedir => :none)
+      expect(mod1).to receive(:sync)
+      expect(mod2).to receive(:sync)
+      expect(subject).to receive(:modules).and_return([mod1, mod2])
 
-      expect(subject).to receive(:modules_by_vcs_cachedir).and_return({none: [mod1, mod2]})
       subject.accept(visitor)
     end
 
@@ -323,12 +330,11 @@ describe R10K::Puppetfile do
         block.call
       end
 
-      mod1 = spy('module')
-      expect(mod1).to receive(:accept).with(visitor)
-      mod2 = spy('module')
-      expect(mod2).to receive(:accept).with(visitor)
-
-      expect(subject).to receive(:modules_by_vcs_cachedir).and_return({none: [mod1, mod2]})
+      mod1 = instance_double('R10K::Module::Base', :cachedir => :none)
+      mod2 = instance_double('R10K::Module::Base', :cachedir => :none)
+      expect(mod1).to receive(:sync)
+      expect(mod2).to receive(:sync)
+      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
@@ -344,22 +350,19 @@ describe R10K::Puppetfile do
         block.call
       end
 
-      mod1 = spy('module1')
-      mod2 = spy('module2')
-      mod3 = spy('module3')
-      mod4 = spy('module4')
-      mod5 = spy('module5')
-      mod6 = spy('module6')
+      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_by_vcs_cachedir)
-        .and_return({:none => [mod1, mod2],
-                     "foo-cachedir" => [mod3, mod4],
-                     "bar-cachedir" => [mod5, mod6]})
+      modules = [m1, m2, m3, m4, m5, m6]
 
-      queue = subject.modules_queue(visitor)
+      queue = R10K::ContentSynchronizer.modules_visit_queue(modules, visitor, subject)
       expect(queue.length).to be 4
       queue_array = 4.times.map { queue.pop }
-      expect(queue_array).to match_array([[mod1], [mod2], [mod3, mod4], [mod5, mod6]])
+      expect(queue_array).to match_array([[m1], [m2], [m3, m4], [m5, m6]])
     end
   end
 end

data/spec/unit/util/purgeable_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'r10k/util/purgeable'
+require 'r10k/util/cleaner'
 
 RSpec.describe R10K::Util::Purgeable do
   let(:managed_directories) do
@@ -21,14 +22,7 @@ RSpec.describe R10K::Util::Purgeable do
     ]
   end
 
-  let(:test_class) do
-    Struct.new(:managed_directories, :desired_contents) do
-      include R10K::Util::Purgeable
-      include R10K::Logging
-    end
-  end
-
-  subject { test_class.new(managed_directories, desired_contents) }
+  subject { R10K::Util::Cleaner.new(managed_directories, desired_contents) }
 
   context 'without recurse option' do
     let(:recurse) { false }

data/spec/unit/util/setopts_spec.rb

@@ -10,7 +10,10 @@ describe R10K::Util::Setopts do
 
       def initialize(opts = {})
         setopts(opts, {
-          :valid => :self, :alsovalid => :self, :truthyvalid => true,
+          :valid => :self,
+          :duplicate => :valid,
+          :alsovalid => :self,
+          :truthyvalid => true,
           :validalias => :valid,
           :ignoreme => nil
         })
@@ -53,7 +56,28 @@ describe R10K::Util::Setopts do
     }.to raise_error(ArgumentError, /cannot handle option 'notvalid'/)
   end
 
+  it "warns when given an unhandled option and raise_on_unhandled=false" do
+    test = Class.new { include R10K::Util::Setopts }.new
+    allow(test).to receive(:logger).and_return(spy)
+
+    test.send(:setopts, {valid: :value, invalid: :value},
+                        {valid: :self},
+                        raise_on_unhandled: false)
+
+    expect(test.logger).to have_received(:warn).with(%r{cannot handle option 'invalid'})
+  end
+
   it "ignores values that are marked as unhandled" do
     klass.new(:ignoreme => "IGNORE ME!")
   end
+
+  it "warns when given conflicting options" do
+    test = Class.new { include R10K::Util::Setopts }.new
+    allow(test).to receive(:logger).and_return(spy)
+
+    test.send(:setopts, {valid: :one, duplicate: :two},
+                        {valid: :arg, duplicate: :arg})
+
+    expect(test.logger).to have_received(:warn).with(%r{valid.*duplicate.*conflict.*not both})
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.9.3
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -28,22 +28,16 @@ dependencies:
   name: cri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.15.10
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.15.10
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +199,7 @@ files:
 - ".github/workflows/docker.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/rspec_tests.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.mkd
@@ -214,7 +209,6 @@ files:
 - LICENSE
 - README.mkd
 - Rakefile
-- azure-pipelines.yml
 - bin/r10k
 - doc/common-patterns.mkd
 - doc/dynamic-environments.mkd
@@ -236,6 +230,7 @@ files:
 - docker/Gemfile
 - docker/Makefile
 - docker/README.md
+- docker/docker-compose.yml
 - docker/r10k/Dockerfile
 - docker/r10k/adduser.sh
 - docker/r10k/docker-entrypoint.d/10-analytics.sh
@@ -352,6 +347,7 @@ files:
 - lib/r10k/cli/help.rb
 - lib/r10k/cli/puppetfile.rb
 - lib/r10k/cli/version.rb
+- lib/r10k/content_synchronizer.rb
 - lib/r10k/deployment.rb
 - lib/r10k/deployment/config.rb
 - lib/r10k/environment.rb
@@ -421,6 +417,7 @@ files:
 - lib/r10k/svn/working_dir.rb
 - lib/r10k/util/attempt.rb
 - lib/r10k/util/basedir.rb
+- lib/r10k/util/cleaner.rb
 - lib/r10k/util/commands.rb
 - lib/r10k/util/exec_env.rb
 - lib/r10k/util/license.rb
@@ -448,6 +445,7 @@ files:
 - spec/fixtures/module/forge/eight_hundred/metadata.json
 - spec/fixtures/unit/action/r10k.yaml
 - spec/fixtures/unit/action/r10k_cachedir.yaml
+- spec/fixtures/unit/action/r10k_creds.yaml
 - spec/fixtures/unit/action/r10k_generate_types.yaml
 - spec/fixtures/unit/action/r10k_puppet_path.yaml
 - spec/fixtures/unit/puppetfile/argument-error/Puppetfile
@@ -506,6 +504,7 @@ files:
 - spec/unit/environment/git_spec.rb
 - spec/unit/environment/name_spec.rb
 - spec/unit/environment/svn_spec.rb
+- spec/unit/environment/with_modules_spec.rb
 - spec/unit/errors/formatting_spec.rb
 - spec/unit/feature_spec.rb
 - spec/unit/forge/module_release_spec.rb
@@ -577,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Puppet environment and module deployment