r10k 3.7.0 → 3.9.3

data/r10k.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.license  = 'Apache-2.0'
 
   s.add_dependency 'colored2',   '3.1.2'
-  s.add_dependency 'cri', ['>= 2.15.10', '< 3.0.0']
+  s.add_dependency 'cri', '2.15.10'
 
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'

data/spec/fixtures/unit/action/r10k_creds.yaml

@@ -0,0 +1,9 @@
+---
+  git:
+    private_key: '/global/config/private/key'
+    oauth_token: '/global/config/oauth/token'
+    repositories:
+      - remote: 'git@myfakegitserver.com:user/repo.git'
+        private_key: '/config/private/key'
+      - remote: 'https://myfakegitserver.com/user/repo.git'
+        oauth_token: '/config/oauth/token'

data/spec/r10k-mocks/mock_source.rb

@@ -8,6 +8,6 @@ class R10K::Source::Mock < R10K::Source::Base
     corrected_environment_names = @options[:environments].map do |env|
       R10K::Environment::Name.new(env, :prefix => @prefix, :invalid => 'correct_and_warn')
     end
-    corrected_environment_names.map { |env| R10K::Environment::Mock.new(env.name, @basedir, env.dirname) }
+    corrected_environment_names.map { |env| R10K::Environment::Mock.new(env.name, @basedir, env.dirname, { overrides: @options[:overrides] }) }
   end
 end

data/spec/shared-examples/puppetfile-action.rb

@@ -3,15 +3,15 @@ require 'spec_helper'
 shared_examples_for "a puppetfile action" do
   describe "initializing" do
     it "accepts the :root option" do
-      described_class.new({root: "/some/nonexistent/path"}, [])
+      described_class.new({root: "/some/nonexistent/path"}, [], {})
     end
 
     it "accepts the :puppetfile option" do
-      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [])
+      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [], {})
     end
 
     it "accepts the :moduledir option" do
-      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [])
+      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [], {})
     end
 
   end
@@ -20,19 +20,19 @@ end
 shared_examples_for "a puppetfile install action" do
   describe "initializing" do
     it "accepts the :root option" do
-      described_class.new({root: "/some/nonexistent/path"}, [])
+      described_class.new({root: "/some/nonexistent/path"}, [], {})
     end
 
     it "accepts the :puppetfile option" do
-      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [])
+      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [], {})
     end
 
     it "accepts the :moduledir option" do
-      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [])
+      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [], {})
     end
 
     it "accepts the :force option" do
-      described_class.new({force: true}, [])
+      described_class.new({force: true}, [], {})
     end
 
   end

data/spec/unit/action/deploy/display_spec.rb

@@ -5,27 +5,57 @@ require 'r10k/action/deploy/display'
 describe R10K::Action::Deploy::Display do
   describe "initializing" do
     it "accepts a puppetfile option" do
-      described_class.new({puppetfile: true}, [])
+      described_class.new({puppetfile: true}, [], {})
+    end
+
+    it "accepts a modules option" do
+      described_class.new({modules: true}, [], {})
     end
 
     it "accepts a detail option" do
-      described_class.new({detail: true}, [])
+      described_class.new({detail: true}, [], {})
     end
 
     it "accepts a format option" do
-      described_class.new({format: "json"}, [])
+      described_class.new({format: "json"}, [], {})
     end
 
     it "accepts a fetch option" do
-      described_class.new({fetch: true}, [])
+      described_class.new({fetch: true}, [], {})
     end
   end
 
-  subject { described_class.new({config: "/some/nonexistent/path"}, []) }
+  subject { described_class.new({config: "/some/nonexistent/path"}, [], {}) }
 
   before do
     allow(subject).to receive(:puts)
   end
 
   it_behaves_like "a deploy action that requires a config file"
+
+  describe "collecting info" do
+    subject { described_class.new({config: "/some/nonexistent/path", format: 'json', puppetfile: true, detail: true}, ['first'], {}) }
+
+    let(:mock_config) do
+      R10K::Deployment::MockConfig.new(
+        :sources => {
+          :control => {
+            :type => :mock,
+            :basedir => '/some/nonexistent/path/control',
+            :environments => %w[first second third env-that/will-be-corrected],
+            :prefix => 'PREFIX'
+          }
+        }
+      )
+    end
+
+    let(:deployment) { R10K::Deployment.new(mock_config) }
+
+    it "gathers environment info" do
+      source_info = subject.send(:source_info, deployment.sources.first, ['first'])
+      expect(source_info[:name]).to eq(:control)
+      expect(source_info[:environments].length).to eq(1)
+      expect(source_info[:environments][0][:name]).to eq('first')
+    end
+  end
 end

data/spec/unit/action/deploy/environment_spec.rb

@@ -5,37 +5,58 @@ require 'r10k/action/deploy/environment'
 
 describe R10K::Action::Deploy::Environment do
 
-  subject { described_class.new({config: "/some/nonexistent/path"}, []) }
+  subject { described_class.new({config: "/some/nonexistent/path"}, [], {}) }
 
   it_behaves_like "a deploy action that can be write locked"
   it_behaves_like "a deploy action that requires a config file"
 
   describe "initializing" do
     it "can accept a cachedir option" do
-      described_class.new({cachedir: "/some/nonexistent/cachedir"}, [])
+      described_class.new({cachedir: "/some/nonexistent/cachedir"}, [], {})
     end
 
     it "can accept a puppetfile option" do
-      described_class.new({puppetfile: true}, [])
+      described_class.new({puppetfile: true}, [], {})
+    end
+
+    it "can accept a modules option" do
+      described_class.new({modules: true}, [], {})
     end
 
     it "can accept a default_branch_override option" do
-      described_class.new({:'default-branch-override' => 'default_branch_override_name'}, [])
+      described_class.new({:'default-branch-override' => 'default_branch_override_name'}, [], {})
     end
 
     it "can accept a no-force option" do
-      described_class.new({:'no-force' => true}, [])
+      described_class.new({:'no-force' => true}, [], {})
     end
 
-    it "normalizes environment names in the arg vector"
-
     it 'can accept a generate-types option' do
-      described_class.new({ 'generate-types': true }, [])
+      described_class.new({ 'generate-types': true }, [], {})
     end
 
     it 'can accept a puppet-path option' do
-      described_class.new({ 'puppet-path': '/nonexistent' }, [])
+      described_class.new({ 'puppet-path': '/nonexistent' }, [], {})
+    end
+
+    it 'can accept a private-key option' do
+      described_class.new({ 'private-key': '/nonexistent' }, [], {})
+    end
+
+    it 'can accept a token option' do
+      described_class.new({ 'oauth-token': '/nonexistent' }, [], {})
+    end
+
+    describe "initializing errors" do
+      let (:settings) { { deploy: { purge_levels: [:environment],
+                                    purge_whitelist: ['coolfile', 'coolfile2'],
+                                    purge_allowlist: ['anothercoolfile']}}}
+
+      subject { described_class.new({config: "/some/nonexistent/path"}, [], settings)}
+      it 'errors out when both purge_whitelist and purge_allowlist are set' do
+        expect{subject}.to raise_error(R10K::Error, /Values found for both purge_whitelist and purge_allowlist./)
     end
+   end
   end
 
   describe "when called" do
@@ -52,6 +73,29 @@ describe R10K::Action::Deploy::Environment do
       )
     end
 
+    describe "with puppetfile or modules flag" do
+      let(:deployment) { R10K::Deployment.new(mock_config) }
+      let(:puppetfile) { instance_double("R10K::Puppetfile", modules: []).as_null_object }
+
+      before do
+        expect(R10K::Deployment).to receive(:new).and_return(deployment)
+        expect(R10K::Puppetfile).to receive(:new).and_return(puppetfile).at_least(:once)
+      end
+
+      it "syncs the puppetfile when given the puppetfile flag" do
+        expect(puppetfile).to receive(:sync)
+        action = described_class.new({config: "/some/nonexistent/path", puppetfile: true}, [], {})
+        action.call
+      end
+
+      it "syncs the puppetfile when given the modules flag" do
+        expect(puppetfile).to receive(:sync)
+        action = described_class.new({config: "/some/nonexistent/path", modules: true}, [], {})
+        action.call
+      end
+
+    end
+
     describe "with an environment that doesn't exist" do
       let(:deployment) do
         R10K::Deployment.new(mock_config)
@@ -61,7 +105,7 @@ describe R10K::Action::Deploy::Environment do
         expect(R10K::Deployment).to receive(:new).and_return(deployment)
       end
 
-      subject { described_class.new({config: "/some/nonexistent/path"}, %w[not_an_environment]) }
+      subject { described_class.new({config: "/some/nonexistent/path"}, %w[not_an_environment], {}) }
 
       it "logs that the environments can't be deployed and returns false" do
         expect(subject.logger).to receive(:error).with("Environment(s) 'not_an_environment' cannot be found in any source and will not be deployed.")
@@ -71,10 +115,10 @@ describe R10K::Action::Deploy::Environment do
     end
 
     describe "with no-force" do
-      subject { described_class.new({ config: "/some/nonexistent/path", puppetfile: true, :'no-force' => true}, %w[first]) }
+      subject { described_class.new({ config: "/some/nonexistent/path", modules: true, :'no-force' => true}, %w[first], {}) }
 
       it "tries to preserve local modifications" do
-        expect(subject.force).to equal(false)
+        expect(subject.settings[:overrides][:modules][:force]).to equal(false)
       end
     end
 
@@ -162,26 +206,73 @@ describe R10K::Action::Deploy::Environment do
       end
     end
 
+    describe "Purging white/allowlist" do
+
+      let(:settings) { { deploy: { purge_levels: [:environment], purge_allowlist: ['coolfile', 'coolfile2'] } } }
+      let(:overrides) { { environments: {}, modules: {}, purging: { purge_levels: [:environment], purge_allowlist: ['coolfile', 'coolfile2'] } } }
+      let(:deployment) do
+        R10K::Deployment.new(mock_config.merge(overrides))
+      end
+      before do
+        expect(R10K::Deployment).to receive(:new).and_return(deployment)
+      end
+
+      subject { described_class.new({ config: "/some/nonexistent/path", modules: true }, %w[PREFIX_first], settings) }
+
+      it "reads in the purge_allowlist setting and purges accordingly" do
+        expect(subject.logger).to receive(:debug).with(/purging unmanaged content for environment/i)
+        expect(subject.settings[:overrides][:purging][:purge_allowlist]).to eq(['coolfile', 'coolfile2'])
+        subject.call
+      end
+
+      describe "purge_whitelist" do
+        let (:settings) { { deploy: { purge_levels: [:environment], purge_whitelist: ['coolfile', 'coolfile2'] } } }
+
+        it "reads in the purge_whitelist setting and still sets it to purge_allowlist and purges accordingly" do
+          expect(subject.logger).to receive(:debug).with(/purging unmanaged content for environment/i)
+          expect(subject.settings[:overrides][:purging][:purge_allowlist]).to eq(['coolfile', 'coolfile2'])
+          subject.call
+        end
+      end
+    end
+
     describe "purge_levels" do
       let(:settings) { { deploy: { purge_levels: purge_levels } } }
+      let(:overrides) do
+        {
+          environments: {
+            requested_environments: ['PREFIX_first']
+          },
+          modules: {
+            deploy_modules: true
+          },
+          purging: {
+            purge_levels: purge_levels
+          }
+        }
+      end
 
       let(:deployment) do
-        R10K::Deployment.new(mock_config.merge(settings))
+        R10K::Deployment.new(mock_config.merge({ overrides: overrides }))
       end
 
       before do
         expect(R10K::Deployment).to receive(:new).and_return(deployment)
       end
 
-      subject { described_class.new({ config: "/some/nonexistent/path", puppetfile: true }, %w[PREFIX_first], settings) }
+      subject { described_class.new({ config: "/some/nonexistent/path", modules: true }, %w[PREFIX_first], settings) }
 
       describe "deployment purge level" do
         let(:purge_levels) { [:deployment] }
 
         it "only logs about purging deployment" do
+          expect(subject).to receive(:visit_environment).and_wrap_original do |original, env, &block|
+            expect(env.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
+            original.call(env)
+          end.at_least(:once)
+
           expect(subject.logger).to receive(:debug).with(/purging unmanaged environments for deployment/i)
           expect(subject.logger).to_not receive(:debug).with(/purging unmanaged content for environment/i)
-          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
 
           subject.call
         end
@@ -191,15 +282,23 @@ describe R10K::Action::Deploy::Environment do
         let(:purge_levels) { [:environment] }
 
         it "only logs about purging environment" do
+          expect(subject).to receive(:visit_environment).and_wrap_original do |original, env, &block|
+            expect(env.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
+            original.call(env)
+          end.at_least(:once)
           expect(subject.logger).to receive(:debug).with(/purging unmanaged content for environment/i)
           expect(subject.logger).to_not receive(:debug).with(/purging unmanaged environments for deployment/i)
-          expect(subject.logger).to_not receive(:debug).with(/purging unmanaged puppetfile content/i)
 
           subject.call
         end
 
         it "logs that environment was not purged if deploy failed" do
-          expect(subject).to receive(:visit_puppetfile) { subject.instance_variable_set(:@visit_ok, false) }
+          expect(subject).to receive(:visit_environment).and_wrap_original do |original, env, &block|
+            if env.name =~ /first/
+              expect(env).to receive(:deploy) { subject.instance_variable_set(:@visit_ok, false) }
+            end
+            original.call(env)
+          end.at_least(:once)
 
           expect(subject.logger).to receive(:debug).with(/not purging unmanaged content for environment/i)
 
@@ -211,7 +310,13 @@ describe R10K::Action::Deploy::Environment do
         let(:purge_levels) { [:puppetfile] }
 
         it "only logs about purging puppetfile" do
-          expect(subject.logger).to receive(:debug).with(/purging unmanaged puppetfile content/i)
+          expect(subject).to receive(:visit_environment).and_wrap_original do |original, env, &block|
+            if env.name =~ /first/
+              expect(env.logger).to receive(:debug).with(/purging unmanaged puppetfile content/i)
+            end
+            original.call(env)
+          end.at_least(:once)
+
           expect(subject.logger).to_not receive(:debug).with(/purging unmanaged environments for deployment/i)
           expect(subject.logger).to_not receive(:debug).with(/purging unmanaged content for environment/i)
 
@@ -219,6 +324,7 @@ describe R10K::Action::Deploy::Environment do
         end
       end
     end
+
     describe "generate-types" do
       let(:deployment) do
         R10K::Deployment.new(
@@ -248,19 +354,22 @@ describe R10K::Action::Deploy::Environment do
           described_class.new(
             {
               config: '/some/nonexistent/path',
-              puppetfile: true,
+              modules: true,
               'generate-types': true
             },
-            %w[first second]
+            %w[first second],
+            {}
           )
         end
 
         it 'generate_types is true' do
-          expect(subject.instance_variable_get(:@generate_types)).to eq(true)
+          expect(subject.settings[:overrides][:environments][:generate_types]).to eq(true)
         end
 
         it 'only calls puppet generate types on specified environment' do
-          subject.instance_variable_set(:@argv, %w[first])
+          settings = subject.instance_variable_get(:@settings)
+          settings[:overrides][:environments][:requested_environments] = %w{first}
+          subject.instance_variable_set(:@settings, settings)
           expect(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
             if environment.dirname == 'first'
               expect(environment).to receive(:generate_types!)
@@ -273,8 +382,8 @@ describe R10K::Action::Deploy::Environment do
         end
 
         it 'does not call puppet generate types on puppetfile failure' do
-          allow(subject).to receive(:visit_puppetfile) { subject.instance_variable_set(:@visit_ok, false) }
           expect(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
+            allow(environment).to receive(:deploy) { subject.instance_variable_set(:@visit_ok, false) }
             expect(environment).not_to receive(:generate_types!)
             original.call(environment, &block)
           end.twice
@@ -282,10 +391,11 @@ describe R10K::Action::Deploy::Environment do
         end
 
         it 'calls puppet generate types on previous puppetfile failure' do
-          allow(subject).to receive(:visit_puppetfile) do |puppetfile|
-            subject.instance_variable_set(:@visit_ok, false) if puppetfile.environment.dirname == 'first'
-          end
           expect(subject).to receive(:visit_environment).and_wrap_original do |original, environment, &block|
+            allow(environment).to receive(:deploy) do
+              subject.instance_variable_set(:@visit_ok, false) if environment.dirname == 'first'
+            end
+
             if environment.dirname == 'second'
               expect(environment).to receive(:generate_types!)
             else
@@ -302,15 +412,16 @@ describe R10K::Action::Deploy::Environment do
           described_class.new(
             {
               config: '/some/nonexistent/path',
-              puppetfile: true,
+              modules: true,
               'generate-types': false
             },
-            %w[first]
+            %w[first],
+            {}
           )
         end
 
         it 'generate_types is false' do
-          expect(subject.instance_variable_get(:@generate_types)).to eq(false)
+          expect(subject.settings[:overrides][:environments][:generate_types]).to eq(false)
         end
 
         it 'does not call puppet generate types' do
@@ -325,7 +436,7 @@ describe R10K::Action::Deploy::Environment do
 
     describe 'with puppet-path' do
 
-      subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-path': '/nonexistent' }, []) }
+      subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-path': '/nonexistent' }, [], {}) }
 
       it 'sets puppet_path' do
         expect(subject.instance_variable_get(:@puppet_path)).to eq('/nonexistent')
@@ -334,12 +445,30 @@ describe R10K::Action::Deploy::Environment do
 
     describe 'with puppet-conf' do
 
-      subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-conf': '/nonexistent' }, []) }
+      subject { described_class.new({ config: '/some/nonexistent/path', 'puppet-conf': '/nonexistent' }, [], {}) }
 
       it 'sets puppet_conf' do
         expect(subject.instance_variable_get(:@puppet_conf)).to eq('/nonexistent')
       end
     end
+
+    describe 'with private-key' do
+
+      subject { described_class.new({ config: '/some/nonexistent/path', 'private-key': '/nonexistent' }, [], {}) }
+
+      it 'sets private_key' do
+        expect(subject.instance_variable_get(:@private_key)).to eq('/nonexistent')
+      end
+    end
+
+    describe 'with oauth-token' do
+
+      subject { described_class.new({ config: '/some/nonexistent/path', 'oauth-token': '/nonexistent' }, [], {}) }
+
+      it 'sets oauth_token' do
+        expect(subject.instance_variable_get(:@oauth_token)).to eq('/nonexistent')
+      end
+    end
   end
 
   describe "write_environment_info!" do
@@ -352,15 +481,31 @@ describe R10K::Action::Deploy::Environment do
       def initialize(path, info)
         @path = path
         @info = info
-        @puppetfile = R10K::Puppetfile.new
+        @puppetfile = R10K::Puppetfile.new("", {})
       end
     end
 
     let(:mock_stateful_repo_1) { instance_double("R10K::Git::StatefulRepository", :head => "123456") }
     let(:mock_stateful_repo_2) { instance_double("R10K::Git::StatefulRepository", :head => "654321") }
-    let(:mock_git_module_1) { instance_double("R10K::Module::Git", :name => "my_cool_module", :version => "1.0", :repo => mock_stateful_repo_1) }
-    let(:mock_git_module_2) { instance_double("R10K::Module::Git", :name => "my_lame_module", :version => "0.0.1", :repo => mock_stateful_repo_2) }
-    let(:mock_forge_module_1) { double(:name => "their_shiny_module", :version => "2.0.0") }
+    let(:mock_git_module_1) do
+      instance_double("R10K::Module::Git",
+                      :name       => "my_cool_module",
+                      :properties => {
+                        :type     => :git,
+                        :expected => "1.0",
+                        :actual   => mock_stateful_repo_1.head
+                      })
+    end
+    let(:mock_git_module_2) do
+      instance_double("R10K::Module::Git",
+                      :name       => "my_uncool_module",
+                      :properties => {
+                        :type     => :git,
+                        :expected => "0.0.1",
+                        :actual   => mock_stateful_repo_2.head
+                      })
+    end
+    let(:mock_forge_module_1) { double(:name => "their_shiny_module", :properties => { :expected => "2.0.0" }) }
     let(:mock_puppetfile) { instance_double("R10K::Puppetfile", :modules => [mock_git_module_1, mock_git_module_2, mock_forge_module_1]) }
 
     before(:all) do
@@ -373,9 +518,8 @@ describe R10K::Action::Deploy::Environment do
       Dir.delete(@tmp_path)
     end
 
-    it "writes the .r10k-deploy file correctly" do
+    it "writes the .r10k-deploy file correctly if all goes well" do
       allow(R10K::Puppetfile).to receive(:new).and_return(mock_puppetfile)
-      allow(mock_forge_module_1).to receive(:repo).and_raise(NoMethodError)
 
       fake_env = Fake_Environment.new(@tmp_path, {:name => "my_cool_environment", :signature => "pablo picasso"})
       allow(fake_env).to receive(:modules).and_return(mock_puppetfile.modules)
@@ -392,13 +536,30 @@ describe R10K::Action::Deploy::Environment do
       expect(r10k_deploy['module_deploys'][0]['name']).to eq("my_cool_module")
       expect(r10k_deploy['module_deploys'][0]['version']).to eq("1.0")
       expect(r10k_deploy['module_deploys'][0]['sha']).to eq("123456")
-      expect(r10k_deploy['module_deploys'][1]['name']).to eq("my_lame_module")
+      expect(r10k_deploy['module_deploys'][1]['name']).to eq("my_uncool_module")
       expect(r10k_deploy['module_deploys'][1]['version']).to eq("0.0.1")
       expect(r10k_deploy['module_deploys'][1]['sha']).to eq("654321")
       expect(r10k_deploy['module_deploys'][2]['name']).to eq("their_shiny_module")
       expect(r10k_deploy['module_deploys'][2]['version']).to eq("2.0.0")
       expect(r10k_deploy['module_deploys'][2]['sha']).to eq(nil)
+    end
+
+    it "writes the .r10k-deploy file correctly if there's a failure" do
+      allow(R10K::Puppetfile).to receive(:new).and_return(mock_puppetfile)
+
+      fake_env = Fake_Environment.new(@tmp_path, {:name => "my_cool_environment", :signature => "pablo picasso"})
+      allow(fake_env).to receive(:modules).and_return(mock_puppetfile.modules)
+      allow(mock_forge_module_1).to receive(:properties).and_raise(StandardError)
+      subject.send(:write_environment_info!, fake_env, "2019-01-01 23:23:22 +0000", true)
+
+      file_contents = File.read("#{@tmp_path}/.r10k-deploy.json")
+      r10k_deploy = JSON.parse(file_contents)
 
+      expect(r10k_deploy['name']).to eq("my_cool_environment")
+      expect(r10k_deploy['signature']).to eq("pablo picasso")
+      expect(r10k_deploy['started_at']).to eq("2019-01-01 23:23:22 +0000")
+      expect(r10k_deploy['deploy_success']).to eq(true)
+      expect(r10k_deploy['module_deploys'].length).to eq(0)
     end
   end
 end