akerl-r10k 3.14.2.1

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

@@ -0,0 +1,207 @@
+RSpec.shared_examples "a git working repository" do
+  describe "cloning" do
+    it "creates a working copy of the repo" do
+      subject.clone(remote)
+      expect(subject.exist?).to be_truthy
+    end
+
+    describe "using the default branch" do
+      describe "and the remote HEAD is 'master'" do
+        it "checks out the default branch" do
+          subject.clone(remote)
+          expect(subject.head).to eq "157011a4eaa27f1202a9d94335ee4876b26d377e"
+        end
+      end
+
+      describe "and the remote HEAD is '0.9.x'" do
+        before do
+          File.open(File.join(remote, 'HEAD'), 'w') do |fh|
+            fh.write('ref: refs/heads/0.9.x')
+          end
+        end
+
+        after do
+          clear_remote_path
+          populate_remote_path
+        end
+
+        it "checks out the default branch" do
+          subject.clone(remote)
+          expect(subject.head).to eq "3084373e8d181cf2fea5b4ade2690ba22872bd67"
+        end
+      end
+    end
+
+    describe "using an explicit ref" do
+      it "can check out tags" do
+        subject.clone(remote, {:ref => '1.0.0'})
+        expect(subject.head).to eq "14cbb45ae3a5f764320b7e63f1a54a25a1ef6c9c"
+      end
+
+      it "can check out remote branches" do
+        subject.clone(remote, {:ref => 'origin/0.9.x'})
+        expect(subject.head).to eq "3084373e8d181cf2fea5b4ade2690ba22872bd67"
+      end
+
+      it "can check out commits" do
+        subject.clone(remote, {:ref => '14cbb45ae3a5f764320b7e63f1a54a25a1ef6c9c'})
+        expect(subject.head).to eq "14cbb45ae3a5f764320b7e63f1a54a25a1ef6c9c"
+      end
+    end
+
+    describe "with a reference repository" do
+      it "adds the reference repository to the alternates directory" do
+        subject.clone(remote, {:reference => remote})
+        alternates = subject.alternates.to_a
+        expect(alternates.size).to eq 1
+        expect(alternates[0]).to match_realpath File.join(remote, 'objects')
+      end
+    end
+
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
+
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.clone(remote)
+      end
+    end
+
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.clone(remote)
+      end
+    end
+  end
+
+  describe "updating the repo" do
+    let(:tag_090) { subject.git_dir + 'refs' + 'tags' + '0.9.0' }
+    let(:packed_refs) { subject.git_dir + 'packed-refs' }
+
+    before do
+      subject.clone(remote)
+      tag_090.delete if tag_090.exist?
+      packed_refs.delete if packed_refs.exist?
+    end
+
+    it "fetches objects from the remote" do
+      expect(subject.tags).to_not include('0.9.0')
+      subject.fetch
+      expect(subject.tags).to include('0.9.0')
+    end
+
+    context "without a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return(nil)
+      end
+
+      it 'does not change proxy ENV' do
+        expect(ENV).to_not receive(:[]=)
+        expect(ENV).to_not receive(:update)
+
+        subject.fetch
+      end
+    end
+
+    context "with a proxy" do
+      before(:each) do
+        allow(R10K::Git).to receive(:get_proxy_for_remote).with(remote).and_return('http://proxy.example.com:3128')
+      end
+
+      it "manages proxy-related ENV vars" do
+        # Sets proxy settings.
+        ['HTTPS_PROXY', 'https_proxy', 'HTTP_PROXY', 'http_proxy'].each do |var|
+          expect(ENV).to receive(:[]=).with(var, 'http://proxy.example.com:3128')
+        end
+
+        # Resets proxy settings when done.
+        expect(ENV).to receive(:update).with(hash_including('HTTPS_PROXY' => nil))
+
+        subject.fetch
+      end
+    end
+  end
+
+  describe "listing branches" do
+    before do
+      subject.clone(remote)
+    end
+
+    it "lists the local branches" do
+      expect(subject.branches).to eq(%w[master])
+    end
+  end
+
+  describe "listing the origin" do
+    it "is nil if the remote is not set" do
+      expect(subject.origin).to be_nil
+    end
+
+    it "is the remote URL when set" do
+      subject.clone(remote)
+      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/shared-examples/git-repository.rb

@@ -0,0 +1,38 @@
+shared_examples_for "a git repository" do
+
+  it "does not exist if the repo is not present" do
+    expect(subject.exist?).to be_falsey
+  end
+
+  describe "listing tags" do
+    before do
+      subject.clone(remote)
+    end
+
+    it "lists all tags in alphabetical order" do
+      expect(subject.tags).to eq(%w[0.9.0 0.9.0-rc1 1.0.0 1.0.1])
+    end
+  end
+
+  describe "resolving refs" do
+    before do
+      subject.clone(remote)
+    end
+
+    it "can resolve branches" do
+      expect(subject.resolve('master')).to eq '157011a4eaa27f1202a9d94335ee4876b26d377e'
+    end
+
+    it "can resolve tags" do
+      expect(subject.resolve('1.0.0')).to eq '14cbb45ae3a5f764320b7e63f1a54a25a1ef6c9c'
+    end
+
+    it "can resolve commits" do
+      expect(subject.resolve('3084373e8d181cf2fea5b4ade2690ba22872bd67')).to eq '3084373e8d181cf2fea5b4ade2690ba22872bd67'
+    end
+
+    it "returns nil when the object cannot be resolved" do
+      expect(subject.resolve('1.2.3')).to be_nil
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+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"}, [], {})
+    end
+
+    it "accepts the :puppetfile option" do
+      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [], {})
+    end
+
+    it "accepts the :moduledir option" do
+      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [], {})
+    end
+
+  end
+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"}, [], {})
+    end
+
+    it "accepts the :puppetfile option" do
+      described_class.new({puppetfile: "/some/nonexistent/path/Puppetfile"}, [], {})
+    end
+
+    it "accepts the :moduledir option" do
+      described_class.new({moduledir: "/some/nonexistent/path/modules"}, [], {})
+    end
+
+    it "accepts the :force option" do
+      described_class.new({force: true}, [], {})
+    end
+
+  end
+end

data/spec/shared-examples/settings/ancestry.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+require 'r10k/settings/collection'
+require 'r10k/settings/list'
+
+shared_examples_for "a setting with ancestors" do
+  describe '#parent=' do
+    it "allows assignment to a collection" do
+      parent = R10K::Settings::Collection.new(:parent, [])
+
+      subject.parent = parent
+
+      expect(subject.parent).to eq parent
+    end
+
+    it "allows assignment to a list" do
+      parent = R10K::Settings::List.new(:parent, [])
+
+      subject.parent = parent
+
+      expect(subject.parent).to eq parent
+    end
+
+    it "rejects assignment when argument is not a settings collection or list" do
+      parent = Hash.new
+
+      expect { subject.parent = parent }.to raise_error do |error|
+        expect(error.message).to match /may only belong to a settings collection or list/i
+      end
+    end
+
+    it "rejects re-assignment" do
+      parent = R10K::Settings::Collection.new(:parent, [])
+      step_parent = R10K::Settings::Collection.new(:step_parent, [])
+
+      subject.parent = parent
+
+      expect { subject.parent = step_parent }.to raise_error do |error|
+        expect(error.message).to match /cannot be reassigned.*new parent/i
+      end
+    end
+  end
+end
+

data/spec/shared-examples/subprocess-runner.rb

@@ -0,0 +1,89 @@
+shared_examples_for "a subprocess runner" do |fixture_root|
+
+  describe "running 'echo test'" do
+    subject { described_class.new(%w[echo test]) }
+
+    it "sets the exit code to 0" do
+      result = subject.run
+      expect(result.exit_code).to eq 0
+    end
+
+    it "returns the contents of stdout" do
+      result = subject.run
+      expect(result.stdout).to eq 'test'
+    end
+
+    it "indicates the command succeeded" do
+      result = subject.run
+      expect(result).to be_success
+      expect(result).to_not be_failed
+    end
+  end
+
+  describe "running a command with a large amount of output" do
+    subject do
+      described_class.new(['ruby', '-e', 'blob = "buffalo!" * (2 << 16); puts blob'])
+    end
+
+    it "does not hang" do
+      Timeout.timeout(5) do
+        subject.run
+      end
+    end
+  end
+
+  describe "running 'ls' or 'dir' with a different working directory" do
+    subject do
+      if R10K::Util::Platform.windows?
+        described_class.new(%w[cmd /c dir]).tap do |o|
+          o.cwd = fixture_root
+        end
+      else
+        described_class.new(%w[ls]).tap do |o|
+          o.cwd = fixture_root
+        end
+      end
+    end
+
+    it "returns the contents of the given working directory" do
+      result = subject.run
+      expect(result.stdout).to match('no-execute.sh')
+    end
+  end
+
+  describe "running 'false'" do
+    subject { described_class.new(%w[false]) }
+
+    it "sets the exit code to 1", unless: R10K::Util::Platform.windows? do
+      result = subject.run
+      expect(result.exit_code).to eq 1
+    end
+
+    it "indicates the command failed" do
+      result = subject.run
+      expect(result).to_not be_success
+      expect(result).to be_failed
+    end
+  end
+
+  describe "running '/this/command/will/not/exist'" do
+    subject { described_class.new(%w[/this/command/will/not/exist]) }
+
+    it "indicates the command failed" do
+      result = subject.run
+      expect(result).to_not be_success
+      expect(result).to be_failed
+    end
+  end
+
+  describe "running a non-executable file", :unless => R10K::Util::Platform.windows? do
+    let(:fixture_file) { File.join(fixture_root, 'no-execute.sh') }
+    subject { described_class.new([fixture_file]) }
+
+    it "indicates the command failed" do
+      result = subject.run
+      expect(result).to_not be_success
+      expect(result).to be_failed
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+PROJECT_ROOT = File.expand_path('..', File.dirname(__FILE__))
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    libdir = File.join(PROJECT_ROOT, 'lib')
+    add_filter do |src|
+      !src.filename.match(%r[\A#{libdir}])
+    end
+
+    %w[Deployment Source Environment Module Git SVN Action Util].each do |group|
+      add_group group, "lib/r10k/#{group.downcase}"
+    end
+  end
+end
+
+require 'r10k'
+
+Dir.glob(File.expand_path('spec/shared-examples/**/*.rb', PROJECT_ROOT)).each { |file| require file }
+
+require 'shared-contexts/git-fixtures'
+require 'shared-contexts/tarball'
+require 'matchers/exit_with'
+require 'matchers/match_realpath'
+require 'r10k-mocks'
+
+# Add a negated version of the change matcher.
+RSpec::Matchers.define_negated_matcher :not_change, :change
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Log4r::Logger.global.level = Log4r::OFF
+  end
+end
+
+shared_context 'fail on execution' do
+  before do
+    allow_any_instance_of(described_class).to receive(:execute).and_raise "Tests should never invoke system calls"
+    allow_any_instance_of(R10K::Util::Subprocess).to receive(:execute).and_raise "Tests should never invoke system calls"
+  end
+end

data/spec/unit/action/cri_runner_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'r10k/action/base'
+require 'r10k/action/cri_runner'
+
+describe R10K::Action::CriRunner do
+
+  let(:action_class) do
+    Class.new do
+      attr_reader :opts
+      attr_reader :argv
+
+      def initialize(opts, argv, settings = {})
+        @opts = opts
+        @argv = argv
+        @settings = {}
+      end
+
+      def call
+        @opts[:runok]
+      end
+    end
+  end
+
+  subject(:cri_runner) { described_class.wrap(action_class)  }
+
+  let(:opts) { {:value => :yep} }
+  let(:argv) { %w[value yes] }
+
+  describe "handling options" do
+    it "adapts the :verbose flag to :loglevel" do
+      input = {:value => :yep, :verbose => 'DEBUG'}
+      output = {:value => :yep, :loglevel => 'DEBUG'}
+      expect(cri_runner.handle_opts(input)).to eq(output)
+    end
+  end
+
+  describe "handling arguments" do
+    it "sets the arguments as-is" do
+      expect(cri_runner.handle_argv(%w[one two])).to eq(%w[one two])
+    end
+  end
+
+  describe "proxying invocations to .new" do
+    it "returns itself" do
+      expect(cri_runner.new(opts, argv, :cri_cmd)).to eql cri_runner
+    end
+
+    it "handles options" do
+      expect(cri_runner).to receive(:handle_opts)
+      cri_runner.new({:value => :yep, :verbose => 'DEBUG'}, argv, :cri_cmd)
+    end
+
+    it "handles arguments" do
+      expect(cri_runner).to receive(:handle_argv)
+      cri_runner.new({:value => :yep, :verbose => 'DEBUG'}, argv, :cri_cmd)
+    end
+  end
+
+  describe "calling" do
+    it "exits with a return value of 0 if the action returned true" do
+      expect {
+        cri_runner.new({:runok => true}, []).call
+      }.to exit_with(0)
+    end
+
+    it "exits with a return value of 1 if the action returned false" do
+      expect {
+        cri_runner.new({:runok => false}, []).call
+      }.to exit_with(1)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+require 'r10k/logging'
+require 'r10k/action/deploy/deploy_helpers'
+
+describe R10K::Action::Deploy::DeployHelpers do
+  subject do
+    Object.new.tap do |o|
+      o.extend(R10K::Logging)
+      o.extend(described_class)
+    end
+  end
+
+  describe "checking for a config file" do
+    it "logs a warning and exits when no config file was set" do
+      logger = subject.logger
+
+      expect(logger).to receive(:fatal).with("No configuration file given, no config file found in current directory, and no global config present")
+
+      expect {
+        subject.expect_config!
+      }.to exit_with(8)
+    end
+  end
+
+  describe "checking the write lock setting" do
+    it "logs a warning and exits when the write lock is set" do
+      logger = subject.logger
+
+      expect(logger).to receive(:fatal).with("Making changes to deployed environments has been administratively disabled.")
+      expect(logger).to receive(:fatal).with("Reason: r10k is sleepy and wants to take a nap")
+
+      expect {
+        subject.check_write_lock!(deploy: {write_lock: "r10k is sleepy and wants to take a nap"})
+      }.to exit_with(16)
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+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}, [], {})
+    end
+
+    it "accepts a modules option" do
+      described_class.new({modules: true}, [], {})
+    end
+
+    it "accepts a detail option" do
+      described_class.new({detail: true}, [], {})
+    end
+
+    it "accepts a format option" do
+      described_class.new({format: "json"}, [], {})
+    end
+
+    it "accepts a fetch option" do
+      described_class.new({fetch: true}, [], {})
+    end
+  end
+
+  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