r10k 3.5.1 → 3.9.0

data/spec/unit/module_spec.rb

@@ -3,20 +3,70 @@ 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[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 #{scenario} and args nil" do
+        obj = R10K::Module.new(scenario, '/modulepath', nil)
+        expect(obj).to be_a_kind_of(R10K::Module::Forge)
+      end
+    end
+    [ '8.0.0',
+      {type: 'forge', version: '8.0.0'},
+    ].each do |scenario|
+      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, nil)
+        expect(obj.send(:instance_variable_get, :'@expected_version')).to eq('1.2.0')
       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

data/spec/unit/settings_spec.rb

@@ -129,6 +129,18 @@ describe R10K::Settings do
         expect { subject.evaluate('puppet_path' => '/nonexistent') }.to raise_error(R10K::Settings::Collection::ValidationError)
       end
     end
+
+    describe 'puppet_conf' do
+      it 'when file raises no error' do
+        allow(File).to receive(:readable?).with('/nonexistent').and_return(true)
+        expect { subject.evaluate('puppet_conf' => '/nonexistent') }.not_to raise_error
+      end
+
+      it 'when not file raises error' do
+        allow(File).to receive(:readable?).with('/nonexistent').and_return(false)
+        expect { subject.evaluate('puppet_conf' => '/nonexistent') }.to raise_error(R10K::Settings::Collection::ValidationError)
+      end
+    end
   end
 
   describe "global settings" do

data/spec/unit/source/git_spec.rb

@@ -93,9 +93,57 @@ describe R10K::Source::Git do
     let(:ignore_prefixes) { ['dev', 'test'] }
 
     it "filters branches" do
-      expect(subject.filter_branches(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
+      expect(subject.filter_branches_by_regexp(branches, ignore_prefixes)).to eq(['master', 'production', 'not_dev_test_me'])
     end
   end
+
+  describe "filtering branches with command" do
+    let(:branches) { ['master', 'development', 'production'] }
+    if R10K::Util::Platform.windows?
+      let(:filter_command) { 'powershell.exe if ($env:R10K_BRANCH.equals(\"development\")) {exit 1} else {exit 0}' }
+    else
+      let(:filter_command) { 'sh -c "[ $R10K_BRANCH != development ]"' }
+    end
+
+    it "filters branches" do
+      expect(subject.filter_branches_by_command(branches, filter_command)).to eq(['master', 'production'])
+    end
+  end
+
+  describe "generate_environments respects filter_command setting" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_BRANCH.equals(\"master\")) {exit 1} else {exit 0}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_BRANCH != master ]')
+      end
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(2)
+    end
+  end
+
+  describe "generate_environments respects filter_command setting and name" do
+    before do
+      allow(subject.cache).to receive(:branches).and_return ['master', 'development', 'production']
+      if R10K::Util::Platform.windows?
+        subject.instance_variable_set(:@filter_command, 'powershell.exe if ($env:R10K_NAME.equals(\"mysource\")) {exit 0} else {exit 1}')
+      else
+        subject.instance_variable_set(:@filter_command, '[ $R10K_NAME = mysource ]')
+      end
+    end
+
+    let(:environments) { subject.generate_environments }
+
+    it "creates an environment for each branch not filtered by filter_command" do
+      expect(subject.generate_environments.size).to eq(3)
+    end
+  end
+
 end
 
 describe R10K::Source::Git, "handling invalid branch names" do

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.5.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2021-04-23 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
@@ -204,6 +198,7 @@ files:
 - ".github/pull_request_template.md"
 - ".github/workflows/docker.yml"
 - ".github/workflows/release.yml"
+- ".github/workflows/rspec_tests.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.mkd
@@ -213,7 +208,6 @@ files:
 - LICENSE
 - README.mkd
 - Rakefile
-- azure-pipelines.yml
 - bin/r10k
 - doc/common-patterns.mkd
 - doc/dynamic-environments.mkd
@@ -235,6 +229,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
@@ -282,6 +277,7 @@ files:
 - integration/tests/command_line/negative/neg_invalid_cmd_line_arg.rb
 - integration/tests/git_source/HTTP_proxy_and_git_source.rb
 - integration/tests/git_source/git_source_git.rb
+- integration/tests/git_source/git_source_repeated_remote.rb
 - integration/tests/git_source/git_source_ssh.rb
 - integration/tests/git_source/git_source_submodule.rb
 - integration/tests/git_source/negative/neg_git_broken_remote.rb
@@ -446,6 +442,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
@@ -504,6 +501,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

data/azure-pipelines.yml

@@ -1,86 +0,0 @@
-# Don't run Azure when a branch is updated, only when a PR is updated.
-# Prevents double builds when a PR is made from the main repo and not a fork.
-trigger: none
-pr:
-  autoCancel: true
-  branches:
-    include:
-    - '*'
-
-pool:
-  # self-hosted agent on Windows 10 1903 environment
-  # includes newer Docker engine with LCOW enabled, new build of LCOW image
-  # includes Ruby 2.5, Go 1.10, Node.js 10.10
-  name: Default
-
-variables:
-  NAMESPACE: puppet
-  CONTAINER_NAME: r10k
-  CONTAINER_BUILD_PATH: .
-  LINT_IGNORES:
-  DOCKER_BUILDKIT: 1
-
-workspace:
-  clean: resources
-
-steps:
-- checkout: self  # self represents the repo where the initial Pipelines YAML file was found
-  clean: true  # whether to fetch clean each time
-
-- powershell: |
-    $gemfile = Join-Path -Path (Get-Location) -ChildPath 'docker/Gemfile'
-    $gempath = Join-Path -Path (Get-Location) -ChildPath 'docker/.bundle/gems'
-    bundle config --local gemfile $gemfile
-    bundle config --local path $gempath
-    bundle install --with test
-  displayName: Fetch Dependencies
-  timeoutInMinutes: 1
-  name: fetch_deps
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Write-HostDiagnostics
-  displayName: Diagnostic Host Information
-  timeoutInMinutes: 2
-  name: hostinfo
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Lint-Dockerfile -Name $ENV:CONTAINER_NAME -Ignore ($ENV:LINT_IGNORES -split ' ')
-  displayName: Lint $(CONTAINER_NAME) Dockerfile
-  timeoutInMinutes: 1
-  name: lint_dockerfile
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Build-Container -Name $ENV:CONTAINER_NAME -Namespace $ENV:NAMESPACE -PathOrUri $ENV:CONTAINER_BUILD_PATH
-  displayName: Build $(CONTAINER_NAME) Container
-  timeoutInMinutes: 5
-  name: build_container
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Initialize-TestEnv
-  displayName: Prepare Test Environment
-  name: test_prepare
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Invoke-ContainerTest -Name $ENV:CONTAINER_NAME -Namespace $ENV:NAMESPACE
-  displayName: Test $(CONTAINER_NAME)
-  timeoutInMinutes: 5
-  name: test_container
-
-- task: PublishTestResults@2
-  displayName: Publish $(CONTAINER_NAME) test results
-  inputs:
-    testResultsFormat: 'JUnit'
-    testResultsFiles: 'docker/TEST-*.xml'
-    testRunTitle: $(CONTAINER_NAME) Test Results
-
-- powershell: |
-    . "$(bundle show pupperware)/ci/build.ps1"
-    Clear-BuildState -Name $ENV:CONTAINER_NAME -Namespace $ENV:NAMESPACE
-  displayName: Container Cleanup
-  timeoutInMinutes: 4
-  condition: always()