r10k 1.4.2 → 1.5.1

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

@@ -0,0 +1,83 @@
+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' with a different working directory" do
+    subject do
+      described_class.new(%w[ls]).tap do |o|
+        o.cwd = fixture_root
+      end
+    end
+
+    it "returns the contents of the given working directory" do
+      result = subject.run
+      expect(result.stdout).to eq 'no-execute.sh'
+    end
+  end
+
+  describe "running 'false'" do
+    subject { described_class.new(%w[false]) }
+
+    it "sets the exit code to 1" 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

@@ -1,8 +1,11 @@
+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[lib/r10k])
+      !src.filename.match(%r[\A#{libdir}])
     end
 
     %w[Deployment Source Environment Module Git SVN Action Util].each do |group|
@@ -13,27 +16,28 @@ end
 
 require 'r10k'
 
-require 'shared-examples/git-ref'
+Dir.glob(File.expand_path('spec/shared-examples/**/*.rb', PROJECT_ROOT)).each { |file| require file }
+
+require 'shared-contexts/git-fixtures'
 require 'matchers/exit_with'
+require 'matchers/match_realpath'
 require 'r10k-mocks'
 
-PROJECT_ROOT = File.expand_path('..', File.dirname(__FILE__))
 
 require 'vcr'
 VCR.configure do |vcr|
   vcr.cassette_library_dir = File.expand_path('spec/fixtures/vcr/cassettes', PROJECT_ROOT)
+  # VCR 2.9.3 uses a Faraday constant that was deprecated in Faraday 0.9.0,
+  # and as such triggers a warning on the part of Faraday during the following
+  # hooking step. It's known and there's nothing that can be done until VCR
+  # 2.9.4 comes out.
   vcr.hook_into :faraday
   vcr.configure_rspec_metadata!
 end
 
 RSpec.configure do |config|
-  # Filter out integration tests by default
-  #
-  # To run integration tests, run `rspec --tag integration`
-  config.filter_run_excluding :integration => true
-
   config.before(:all) do
-    Log4r::Logger.global.level = 10
+    Log4r::Logger.global.level = Log4r::OFF
   end
 end
 

data/spec/unit/action/cri_runner_spec.rb

@@ -30,12 +30,6 @@ describe R10K::Action::CriRunner do
       output = {:value => :yep, :loglevel => 'DEBUG'}
       expect(cri_runner.handle_opts(input)).to eq(output)
     end
-
-    it "sets the non-argument form of :verbose to :loglevel => 'INFO'" do
-      input = {:value => :yep, :verbose => true}
-      output = {:value => :yep, :loglevel => 'INFO'}
-      expect(cri_runner.handle_opts(input)).to eq(output)
-    end
   end
 
   describe "handling arguments" do

data/spec/unit/deployment/config/loader_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'r10k/deployment/config/loader'
+
+describe R10K::Deployment::Config::Loader do
+
+  context 'populate_loadpath' do
+    it 'includes /etc/puppetlabs/r10k/r10k.yaml in the loadpath' do
+      expect(subject.loadpath).to include('/etc/puppetlabs/r10k/r10k.yaml')
+    end
+
+    it 'includes /etc/r10k.yaml in the loadpath' do
+      expect(subject.loadpath).to include('/etc/r10k.yaml')
+    end
+
+    it 'does include the current working directory in the loadpath' do
+      allow(Dir).to receive(:getwd).and_return '/some/random/path/westvletren'
+      expect(subject.loadpath).to include('/some/random/path/westvletren/r10k.yaml')
+    end
+
+    it 'does not include /some/random/path/atomium/r10k.yaml in the loadpath' do
+      expect(subject.loadpath).not_to include('/some/random/path/atomium/r10k.yaml')
+    end
+
+  end
+
+  context 'search' do
+    it 'returns the correct default location' do
+      allow(File).to receive(:file?).and_return false
+      allow(File).to receive(:file?).with('/etc/puppetlabs/r10k/r10k.yaml').and_return true
+      allow(File).to receive(:file?).with('/etc/r10k.yaml').and_return true
+      expect(subject.search).to eq '/etc/puppetlabs/r10k/r10k.yaml'
+    end
+
+    it 'issues a warning if both default locations are present' do
+      allow(File).to receive(:file?).and_return false
+      allow(File).to receive(:file?).with('/etc/puppetlabs/r10k/r10k.yaml').and_return true
+      allow(File).to receive(:file?).with('/etc/r10k.yaml').and_return true
+
+      logger_dbl = double('Logging')
+      allow(subject).to receive(:logger).and_return logger_dbl
+
+      expect(logger_dbl).to receive(:warn).with('Both /etc/puppetlabs/r10k/r10k.yaml and /etc/r10k.yaml configuration files exist.')
+      expect(logger_dbl).to receive(:warn).with('/etc/puppetlabs/r10k/r10k.yaml will be used.')
+
+      subject.search
+    end
+  end
+end

data/spec/unit/deployment/config_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe R10K::Deployment::Config do
+
+  describe "reading settings" do
+    # Try all permutations of string/symbol values as arguments to #setting and
+    # values in the config file
+    x = [:key, "key"]
+    matrix = x.product(x)
+
+    matrix.each do |(searchvalue, configvalue)|
+      it "treats #{searchvalue.inspect}:#{searchvalue.class} and #{configvalue.inspect}:#{configvalue.class} as equivalent" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return(configvalue => 'some/cache')
+        subject = described_class.new('foo/bar')
+        expect(subject.setting(searchvalue)).to eq 'some/cache'
+      end
+    end
+  end
+
+  describe "applying global settings" do
+    describe "for the cachedir" do
+      it "sets the git cache root when given" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return('cachedir' => 'some/cache')
+        expect(R10K::Git::Cache.settings).to receive(:[]=).with(:cache_root, 'some/cache')
+        described_class.new('foo/bar')
+      end
+    end
+
+    describe "for git" do
+      it "sets the git provider when given" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return('git' => {'provider' => 'rugged'})
+        expect(R10K::Git).to receive(:provider=).with(:rugged)
+        described_class.new('foo/bar')
+      end
+
+      it "sets the git ssh username when given" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return('git' => {'username' => 'grit'})
+        expect(R10K::Git.settings).to receive(:[]=).with(:username, 'grit')
+        described_class.new('foo/bar')
+      end
+
+      it "sets the git private key when given" do
+        expect(YAML).to receive(:load_file).with('foo/bar').and_return('git' => {'private_key' => '/home/user/.ssh/id_rsa'})
+        expect(R10K::Git.settings).to receive(:[]=).with(:private_key, '/home/user/.ssh/id_rsa')
+        described_class.new('foo/bar')
+      end
+    end
+  end
+end

data/spec/unit/environment/git_spec.rb

@@ -15,8 +15,6 @@ describe R10K::Environment::Git do
     )
   end
 
-  let(:working_dir) { subject.working_dir }
-
   describe "storing attributes" do
     it "can return the environment name" do
       expect(subject.name).to eq 'myenv'
@@ -40,8 +38,8 @@ describe R10K::Environment::Git do
   end
 
   describe "synchronizing the environment" do
-    it "syncs the working directory" do
-      expect(working_dir).to receive(:sync)
+    it "syncs the git repository" do
+      expect(subject.repo).to receive(:sync)
       subject.sync
     end
   end
@@ -71,41 +69,9 @@ describe R10K::Environment::Git do
   end
 
   describe "determining the status" do
-    it "is absent when the working directory is absent" do
-      expect(working_dir).to receive(:exist?).and_return false
-      expect(subject.status).to eq :absent
-    end
-
-    it "is mismatched when the working directory is not git" do
-      expect(working_dir).to receive(:exist?).and_return true
-      expect(working_dir).to receive(:git?).and_return false
-      expect(subject.status).to eq :mismatched
-    end
-
-    it "is mismatched when the working directory remote doesn't match the desired remote" do
-      expect(working_dir).to receive(:exist?).and_return true
-      expect(working_dir).to receive(:git?).and_return true
-      expect(working_dir).to receive(:remote).and_return 'git://git-server.site/my-other-repo.git'
-      expect(subject.status).to eq :mismatched
-    end
-
-    it "is is outdated when the working directory has not been synced" do
-      expect(working_dir).to receive(:exist?).and_return true
-      expect(working_dir).to receive(:git?).and_return true
-      expect(working_dir).to receive(:remote).and_return 'git://git-server.site/my-repo.git'
-      expect(subject.status).to eq :outdated
-    end
-
-    it "is is insync when the working directory has been synced" do
-      expect(working_dir).to receive(:exist?).and_return true
-      expect(working_dir).to receive(:git?).and_return true
-      expect(working_dir).to receive(:remote).and_return 'git://git-server.site/my-repo.git'
-
-      expect(working_dir).to receive(:sync)
-
-      subject.sync
-
-      expect(subject.status).to eq :insync
+    it "delegates to the repo" do
+      expect(subject.repo).to receive(:status).and_return :some_status
+      expect(subject.status).to eq :some_status
     end
   end
 end

data/spec/unit/environment/name_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'r10k/environment/name'
+
+describe R10K::Environment::Name do
+  describe "prefixing" do
+    it "uses the branch name as the dirname when prefixing is off" do
+      bn = described_class.new('mybranch', :source => 'source', :prefix => false)
+      expect(bn.dirname).to eq 'mybranch'
+    end
+
+    it "prepends the source name when prefixing is on" do
+      bn = described_class.new('mybranch', :source => 'source', :prefix => true)
+      expect(bn.dirname).to eq 'source_mybranch'
+    end
+
+    it "prepends the prefix name when prefixing is overridden" do
+      bn = described_class.new('mybranch', {:prefix => "bar", :sourcename => 'foo'})
+      expect(bn.dirname).to eq 'bar_mybranch'
+    end
+
+    it "uses the branch name as the dirname when prefixing is nil" do
+      bn = described_class.new('mybranch', {:prefix => nil, :sourcename => 'foo'})
+      expect(bn.dirname).to eq 'mybranch'
+    end
+  end
+
+  describe "determining the validate behavior with :invalid" do
+    [
+      ['correct_and_warn', {:validate => true, :correct => true}],
+      ['correct',          {:validate => false, :correct => true}],
+      ['error',            {:validate => true, :correct => false}],
+    ].each do |(setting, outcome)|
+      it "treats #{setting} as #{outcome.inspect}" do
+        bn = described_class.new('mybranch', :source => 'source', :invalid => setting)
+        expect(bn.validate?).to eq outcome[:validate]
+        expect(bn.correct?).to eq outcome[:correct]
+      end
+    end
+  end
+
+  describe "determining if a branch is a valid environment name" do
+    invalid_cases = [
+      'hyphenated-branch',
+      'dotted.branch',
+      'slashed/branch',
+      'at@branch',
+      'http://branch'
+    ]
+
+    valid_cases = [
+      'my_branchname',
+      'my_issue_346',
+    ]
+
+    describe "and validate is false" do
+      invalid_cases.each do |branch|
+        it "is valid if the branch is #{branch}" do
+          bn = described_class.new(branch, {:validate => false})
+          expect(bn).to be_valid
+        end
+      end
+
+      valid_cases.each do |branch|
+        it "is valid if the branch is #{branch}" do
+          bn = described_class.new(branch, {:validate => false})
+          expect(bn).to be_valid
+        end
+      end
+    end
+
+    describe "and validate is true" do
+      invalid_cases.each do |branch|
+        it "is invalid if the branch is #{branch}" do
+          bn = described_class.new(branch, {:validate => true})
+          expect(bn).to_not be_valid
+        end
+      end
+
+      valid_cases.each do |branch|
+        it "is valid if the branch is #{branch}" do
+          bn = described_class.new(branch, {:validate => true})
+          expect(bn).to be_valid
+        end
+      end
+
+    end
+  end
+
+  describe "correcting branch names" do
+    invalid_cases = [
+      'hyphenated-branch',
+      'dotted.branch',
+      'slashed/branch',
+      'at@branch',
+      'http://branch'
+    ]
+
+    valid_cases = [
+      'my_branchname',
+      'my_issue_346',
+    ]
+
+    describe "and correct is false" do
+      invalid_cases.each do |branch|
+        it "doesn't modify #{branch}" do
+          bn = described_class.new(branch.dup, {:correct => false})
+          expect(bn.dirname).to eq branch
+        end
+      end
+
+      valid_cases.each do |branch|
+        it "doesn't modify #{branch}" do
+          bn = described_class.new(branch.dup, {:correct => false})
+          expect(bn.dirname).to eq branch
+        end
+      end
+    end
+
+    describe "and correct is true" do
+      invalid_cases.each do |branch|
+        it "replaces invalid characters in #{branch} with underscores" do
+          bn = described_class.new(branch.dup, {:correct => true})
+          expect(bn.dirname).to eq branch.gsub(/\W/, '_')
+        end
+      end
+
+      valid_cases.each do |branch|
+        it "doesn't modify #{branch}" do
+          bn = described_class.new(branch.dup, {:correct => true})
+          expect(bn.dirname).to eq branch
+        end
+      end
+    end
+  end
+end