r10k 2.6.9 → 3.0.0

data/r10k.gemspec

@@ -18,30 +18,26 @@ Gem::Specification.new do |s|
     dynamic environments.
   DESCRIPTION
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0.0'
 
   s.license  = 'Apache-2.0'
 
   s.add_dependency 'colored',   '1.2'
-  s.add_dependency 'cri',       '~> 2.6.1'
+  s.add_dependency 'cri',       '~> 2.8'
 
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'
 
-  s.add_dependency 'puppet_forge', '~> 2.3.0'
+  s.add_dependency 'puppet_forge', '~> 2.2.8'
 
   s.add_dependency 'gettext-setup', '~>0.24'
-  # These two pins narrow what is allowed by gettext-setup,
-  # to preserver compatability with Ruby 2.4
-  s.add_dependency 'fast_gettext', '~> 1.1.0'
-  s.add_dependency 'gettext', ['>= 3.0.2', '< 3.3.0']
 
   s.add_development_dependency 'rspec', '~> 3.1'
 
   s.add_development_dependency 'rake'
 
   s.add_development_dependency 'yard', '~> 0.9.11'
-  s.add_development_dependency 'minitar', '~> 0.9.0'
+  s.add_development_dependency 'minitar', '~> 0.6.1'
 
   s.files        = %x[git ls-files].split($/)
   s.require_path = 'lib'

data/r10k.yaml.example

@@ -37,6 +37,12 @@ sources:
     # for more information about the Puppet 'environmentpath' setting.
     #basedir: '/etc/puppetlabs/puppet/environments'
 
+    # The Puppetfile filename in the repo, defaults to 'Puppetfile'. This
+    # setting can be used, to allow custom Puppetfile names to allow hybrid
+    # use of librarian-puppet (transitive dependency resolution) and r10k
+    # (code management on the server).
+    #puppetfile_name: 'Puppetfile.r10k'
+
   # One or more sources can be specified; each source is simple another entry
   # in the sources map.
   #qa:

data/spec/fixtures/unit/puppetfile/duplicate-module-error/Puppetfile

@@ -0,0 +1,10 @@
+forge "http://forge.puppetlabs.com"
+
+mod "puppetlabs/stdlib", '4.11.0'
+mod "puppetlabs/stdlib", '4.12.0'
+mod "puppetlabs/concat", '2.1.0'
+mod "otheruser/concat", '2.1.0'
+
+mod 'apache',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :branch => 'docs_experiment'

data/spec/fixtures/unit/puppetfile/name-error/Puppetfile

@@ -0,0 +1 @@
+mod 'branan/eight_hundred', undefined_lookup_function('eight_hundred')

data/spec/shared-examples/git/working_repository.rb

@@ -158,4 +158,50 @@ RSpec.shared_examples "a git working repository" do
       expect(subject.origin).to eq remote
     end
   end
+
+  describe "checking out ref" do
+    before(:each) do
+      subject.clone(remote)
+      File.open(File.join(subject.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
+    end
+
+    context "with force = true" do
+      it "should revert changes in managed files" do
+        subject.checkout(subject.head, {:force => true})
+        expect(File.read(File.join(subject.path, 'README.markdown')).include?('local modifications!')).to eq false
+      end
+    end
+
+    context "with force = false" do
+      it "should not revert changes in managed files" do
+        subject.checkout(subject.head, {:force => false})
+        expect(File.read(File.join(subject.path, 'README.markdown')).include?('local modifications!')).to eq true
+      end
+    end
+  end
+
+  describe "checking if worktree is dirty" do
+    before do
+      subject.clone(remote)
+    end
+
+    context "with no local changes" do
+      it "reports worktree as not dirty" do
+        expect(subject.dirty?).to be false
+      end
+    end
+
+    context "with local changes" do
+      before(:each) do
+        File.open(File.join(subject.path, 'README.markdown'), 'a') { |f| f.write('local modifications!') }
+      end
+
+      it "logs and reports worktree as dirty" do
+        expect(subject.logger).to receive(:debug).with(/found local modifications in.*README\.markdown/i)
+        expect(subject.logger).to receive(:debug1)
+
+        expect(subject.dirty?).to be true
+      end
+    end
+  end
 end

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

@@ -19,10 +19,6 @@ describe R10K::Action::Deploy::Environment do
       described_class.new({puppetfile: true}, [])
     end
 
-    it "can accept a default_branch_override option" do
-      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}, [])
     end
@@ -127,63 +123,4 @@ describe R10K::Action::Deploy::Environment do
       end
     end
   end
-
-  describe "write_environment_info!" do
-
-    class Fake_Environment
-      attr_accessor :path
-      attr_accessor :puppetfile
-      attr_accessor :info
-
-      def initialize(path, info)
-        @path = path
-        @info = info
-        @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_puppetfile) { instance_double("R10K::Puppetfile", :modules => [mock_git_module_1, mock_git_module_2, mock_forge_module_1]) }
-
-    before(:all) do
-      @tmp_path = "./tmp-r10k-test-dir/"
-      Dir.mkdir(@tmp_path) unless File.exists?(@tmp_path)
-    end
-
-    after(:all) do
-      File.delete("#{@tmp_path}/.r10k-deploy.json")
-      Dir.delete(@tmp_path)
-    end
-
-    it "writes the .r10k-deploy file correctly" 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"})
-      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(3)
-      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]['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
-  end
 end

data/spec/unit/action/puppetfile/check_spec.rb

@@ -2,25 +2,40 @@ require 'spec_helper'
 require 'r10k/action/puppetfile/check'
 
 describe R10K::Action::Puppetfile::Check do
+  let(:default_opts) { {root: "/some/nonexistent/path"} }
+  let(:puppetfile) { instance_double('R10K::Puppetfile', :load! => true) }
 
-  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
-
-  let(:puppetfile) { instance_double('R10K::Puppetfile') }
+  def checker(opts = {}, argv = [], settings = {})
+    opts = default_opts.merge(opts)
+    return described_class.new(opts, argv, settings)
+  end
 
-  before { allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile) }
+  before(:each) do
+    allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile)
+  end
 
   it_behaves_like "a puppetfile action"
 
   it "prints 'Syntax OK' when the Puppetfile syntax could be validated" do
-    expect(puppetfile).to receive(:load!)
     expect($stderr).to receive(:puts).with("Syntax OK")
-    subject.call
+
+    checker.call
   end
 
   it "prints an error message when validating the Puppetfile syntax raised an error" do
-    expect(puppetfile).to receive(:load!).and_raise(R10K::Error.new("Boom!"))
-    expect(R10K::Errors::Formatting).to receive(:format_exception).with(instance_of(R10K::Error), anything).and_return("Formatted error message")
+    allow(puppetfile).to receive(:load!).and_raise(R10K::Error.new("Boom!"))
+    allow(R10K::Errors::Formatting).to receive(:format_exception).with(instance_of(R10K::Error), anything).and_return("Formatted error message")
+
     expect($stderr).to receive(:puts).with("Formatted error message")
-    subject.call
+
+    checker.call
+  end
+
+  it "respects --puppetfile option" do
+    allow($stderr).to receive(:puts)
+
+    expect(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, "/custom/puppetfile/path").and_return(puppetfile)
+
+    checker({puppetfile: "/custom/puppetfile/path"}).call
   end
 end

data/spec/unit/action/puppetfile/cri_runner_spec.rb

@@ -31,32 +31,14 @@ describe R10K::Action::Puppetfile::CriRunner do
     end
 
     describe "for the moduledir" do
-      before do
-        allow(cri_runner).to receive(:env).and_return({'PUPPETFILE_DIR' => '/some/nonexistent/modules'})
-      end
-
-      it "sets the option from the environment when the cli option is not given" do
-        opts = {}
-        expect(cri_runner.handle_opts(opts)).to include(:moduledir => '/some/nonexistent/modules')
-      end
-
-      it "doesn't set the option from the environment when the cli option is given" do
+      it "sets the option from the cli option if given" do
         opts = {:moduledir => '/some/other/nonexistent/modules'}
         expect(cri_runner.handle_opts(opts)).to include(:moduledir => '/some/other/nonexistent/modules')
       end
     end
 
     describe "for the puppetfile path" do
-      before do
-        allow(cri_runner).to receive(:env).and_return({'PUPPETFILE' => '/some/nonexistent/Puppetfile'})
-      end
-
-      it "sets the option from the environment when the cli option is not given" do
-        opts = {}
-        expect(cri_runner.handle_opts(opts)).to include(:puppetfile => '/some/nonexistent/Puppetfile')
-      end
-
-      it "doesn't set the option from the environment when the cli option is given" do
+      it "sets the option from the cli option if given" do
         opts = {:puppetfile => '/some/other/nonexistent/modules'}
         expect(cri_runner.handle_opts(opts)).to include(:puppetfile => '/some/other/nonexistent/modules')
       end

data/spec/unit/action/puppetfile/install_spec.rb

@@ -2,11 +2,14 @@ require 'spec_helper'
 require 'r10k/action/puppetfile/install'
 
 describe R10K::Action::Puppetfile::Install do
-
-  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
-
+  let(:default_opts) { {root: "/some/nonexistent/path"} }
   let(:puppetfile) { R10K::Puppetfile.new('/some/nonexistent/path', nil, nil) }
 
+  def installer(opts = {}, argv = [], settings = {})
+    opts = default_opts.merge(opts)
+    return described_class.new(opts, argv, settings)
+  end
+
   before(:each) do
     allow(puppetfile).to receive(:load!).and_return(nil)
     allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil, nil, nil).and_return(puppetfile)
@@ -25,45 +28,42 @@ describe R10K::Action::Puppetfile::Install do
     end
 
     it "syncs each module in the Puppetfile" do
-      expect(puppetfile).to receive(:load!)
       modules.each { |m| expect(m).to receive(:sync) }
-      expect(subject.call).to eq true
+
+      expect(installer.call).to eq true
     end
 
     it "returns false if a module failed to install" do
-      expect(puppetfile).to receive(:load!)
-
       modules[0..2].each { |m| expect(m).to receive(:sync) }
       expect(modules[3]).to receive(:sync).and_raise
-      expect(subject.call).to eq false
+
+      expect(installer.call).to eq false
     end
   end
 
   describe "purging" do
     before do
-      allow(puppetfile).to receive(:load!)
       allow(puppetfile).to receive(:modules).and_return([])
     end
 
     it "purges the moduledir after installation" do
       expect(puppetfile).to receive(:purge!)
-      subject.call
+
+      installer.call
     end
   end
 
   describe "using custom paths" do
-    let(:puppetfile) { instance_double("R10K::Puppetfile", load!: nil, accept: nil, purge!: nil) }
-
     it "can use a custom puppetfile path" do
-      subject = described_class.new({root: "/some/nonexistent/path", puppetfile: "/some/other/path/Puppetfile"}, [])
       expect(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, "/some/other/path/Puppetfile", nil, nil).and_return(puppetfile)
-      subject.call
+
+      installer({puppetfile: "/some/other/path/Puppetfile"}).call
     end
 
     it "can use a custom moduledir path" do
-      subject = described_class.new({root: "/some/nonexistent/path", moduledir: "/some/other/path/site-modules"}, [])
       expect(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", "/some/other/path/site-modules", nil, nil, nil).and_return(puppetfile)
-      subject.call
+
+      installer({moduledir: "/some/other/path/site-modules"}).call
     end
   end
 

data/spec/unit/action/puppetfile/purge_spec.rb

@@ -2,18 +2,41 @@ require 'spec_helper'
 require 'r10k/action/puppetfile/purge'
 
 describe R10K::Action::Puppetfile::Purge do
+  let(:default_opts) { {root: "/some/nonexistent/path"} }
+  let(:puppetfile) { instance_double('R10K::Puppetfile', :load! => nil) }
 
-  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
-
-  let(:puppetfile) { instance_double('R10K::Puppetfile') }
+  def purger(opts = {}, argv = [], settings = {})
+    opts = default_opts.merge(opts)
+    return described_class.new(opts, argv, settings)
+  end
 
-  before { allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile) }
+  before(:each) do
+    allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile)
+  end
 
   it_behaves_like "a puppetfile action"
 
   it "purges unmanaged entries in the Puppetfile moduledir" do
-    allow(puppetfile).to receive(:load!)
     expect(puppetfile).to receive(:purge!)
-    subject.call
+
+    purger.call
+  end
+
+  describe "using custom paths" do
+    before(:each) do
+      allow(puppetfile).to receive(:purge!)
+    end
+
+    it "can use a custom puppetfile path" do
+      expect(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, "/some/other/path/Puppetfile").and_return(puppetfile)
+
+      purger({puppetfile: "/some/other/path/Puppetfile"}).call
+    end
+
+    it "can use a custom moduledir path" do
+      expect(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", "/some/other/path/site-modules", nil).and_return(puppetfile)
+
+      purger({moduledir: "/some/other/path/site-modules"}).call
+    end
   end
 end

data/spec/unit/forge/module_release_spec.rb

@@ -132,13 +132,15 @@ describe R10K::Forge::ModuleRelease do
   describe "#cleanup_unpack_path" do
     it "ignores the unpack_path if it doesn't exist" do
       expect(unpack_path).to receive(:exist?).and_return false
-      expect(unpack_path).to_not receive(:rmtree)
+      expect(unpack_path).to_not receive(:parent)
       subject.cleanup_unpack_path
     end
 
-    it "removes the unpack_path if it exists" do
+    it "removes the containing directory of unpack_path if it exists" do
+      parent = instance_double('Pathname')
+      expect(parent).to receive(:rmtree)
       expect(unpack_path).to receive(:exist?).and_return true
-      expect(unpack_path).to receive(:rmtree)
+      expect(unpack_path).to receive(:parent).and_return(parent)
       subject.cleanup_unpack_path
     end
   end
@@ -146,13 +148,15 @@ describe R10K::Forge::ModuleRelease do
   describe "#cleanup_download_path" do
     it "ignores the download_path if it doesn't exist" do
       expect(download_path).to receive(:exist?).and_return false
-      expect(download_path).to_not receive(:delete)
+      expect(download_path).to_not receive(:parent)
       subject.cleanup_download_path
     end
 
-    it "removes the download_path if it exists" do
+    it "removes the containing directory of download_path if it exists" do
+      parent = instance_double('Pathname')
+      expect(parent).to receive(:rmtree)
       expect(download_path).to receive(:exist?).and_return true
-      expect(download_path).to receive(:delete)
+      expect(download_path).to receive(:parent).and_return(parent)
       subject.cleanup_download_path
     end
   end

data/spec/unit/git/stateful_repository_spec.rb

@@ -21,23 +21,20 @@ describe R10K::Git::StatefulRepository do
 
     it "is true if the ref is unresolvable" do
       expect(cache).to receive(:exist?).and_return true
-      expect(cache).to receive(:resolve).with('0.9.x')
+      expect(cache).to receive(:ref_type).with('0.9.x').and_return(:unknown)
       expect(subject.sync_cache?(ref)).to eq true
     end
 
     it "is true if the ref is not a tag or commit" do
       expect(cache).to receive(:exist?).and_return true
-      expect(cache).to receive(:resolve).with('0.9.x').and_return('93456ec7dc0f6fd3ac193b4df64f6544615dfbc9')
       expect(cache).to receive(:ref_type).with('0.9.x').and_return(:branch)
       expect(subject.sync_cache?(ref)).to eq true
     end
 
     it "is false otherwise" do
       expect(cache).to receive(:exist?).and_return true
-      expect(cache).to receive(:resolve).with('0.9.x').and_return('93456ec7dc0f6fd3ac193b4df64f6544615dfbc9')
       expect(cache).to receive(:ref_type).with('0.9.x').and_return(:tag)
       expect(subject.sync_cache?(ref)).to eq false
     end
-
   end
 end