r10k 3.5.2

data/spec/unit/settings/container_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+require 'r10k/settings'
+
+describe R10K::Settings::Container do
+
+  describe 'validating keys' do
+    it 'can add new valid keys' do
+      subject.add_valid_key(:v)
+      subject[:v]
+    end
+
+    it 'can check if a key is valid' do
+      subject.add_valid_key(:v)
+      expect(subject.valid_key?(:v)).to be_truthy
+    end
+
+    it 'can list all valid keys' do
+      subject.add_valid_key(:v)
+      subject.add_valid_key(:w)
+
+      expect(subject.valid_keys).to include :v
+      expect(subject.valid_keys).to include :w
+    end
+  end
+
+  describe 'specifying settings' do
+    it 'fails if a setting application uses an invalid key' do
+      expect { subject[:invalid] = 'fail' }.to raise_error R10K::Settings::Container::InvalidKey
+    end
+
+    it 'can look up values that it sets' do
+      subject.add_valid_key :v
+      subject[:v] = 'set'
+      expect(subject[:v]).to eq 'set'
+    end
+  end
+
+  describe 'looking up settings' do
+    before do
+      subject.add_valid_key :v
+    end
+
+    it 'fails if a setting lookup uses an invalid key' do
+      expect { subject[:invalid] }.to raise_error R10K::Settings::Container::InvalidKey
+    end
+
+    it 'returns nil if a key is valid but no setting is present' do
+      expect(subject[:v]).to be_nil
+    end
+
+    describe 'with a parent container' do
+      let(:parent) { described_class.new.tap { |p| p.add_valid_key :v } }
+      subject { described_class.new(parent) }
+
+      it 'uses its setting over a parent value' do
+        subject[:v] = 'child'
+        parent[:v] = 'parent'
+        expect(subject[:v]).to eq 'child'
+      end
+
+      it 'duplicates and stores the parent object to avoid modifying the parent object' do
+        parent[:v] = {}
+        subject[:v][:hello] = "world"
+        expect(subject[:v]).to eq({hello: "world"})
+        expect(parent[:v]).to eq({})
+      end
+
+      it 'falls back to the parent value if it does not have a value' do
+        parent[:v] = 'parent'
+        expect(subject[:v]).to eq 'parent'
+      end
+    end
+  end
+
+  describe "resetting" do
+    before do
+      subject.add_valid_key :v
+    end
+
+    it "unsets all settings" do
+      subject[:v] = "hi"
+      subject.reset!
+      expect(subject[:v]).to be_nil
+    end
+
+    it "doesn't remove valid values" do
+      subject.reset!
+      expect(subject.valid_key?(:v)).to be_truthy
+    end
+  end
+end

data/spec/unit/settings/definition_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'r10k/settings/definition'
+require 'r10k/settings/collection'
+require 'r10k/settings/list'
+
+describe R10K::Settings::Definition do
+  subject { described_class.new(:setting) }
+
+  it_behaves_like "a setting with ancestors"
+
+  describe "#evaluate" do
+    it "assigns a value, validates it, and resolves a final value" do
+      expect(subject).to receive(:assign).with("myvalue")
+      expect(subject).to receive(:validate)
+      expect(subject).to receive(:resolve)
+      subject.evaluate("myvalue")
+    end
+  end
+
+  describe "#assign" do
+    it 'stores the provided value' do
+      subject.assign("I'm the value")
+      expect(subject.value).to eq "I'm the value"
+    end
+
+    it "normalizes the stored value when a normalize hook is set" do
+      subject = described_class.new(:setting, :normalize => lambda { |input| input.to_sym })
+      subject.assign("symbolizeme")
+      expect(subject.value).to eq :symbolizeme
+    end
+  end
+
+  describe "#validate" do
+    it "does nothing if a value has not been assigned" do
+      subject = described_class.new(:setting, :validate => lambda { |_| raise "Shouldn't be called" })
+      subject.validate
+    end
+
+    it "does nothing if a validate hook has not been assigned" do
+      subject.assign("I'm the value")
+      subject.validate
+    end
+
+    it "raises up errors raised from the validate hook" do
+      subject = described_class.new(:satellite, :validate => lambda { |input| raise ArgumentError, "Invalid value #{input}: that's no moon!" })
+      subject.assign("Alderaan")
+      expect {
+        subject.validate
+      }.to raise_error(ArgumentError, "Invalid value Alderaan: that's no moon!")
+    end
+
+    it "returns if the validate hook did not raise an error" do
+      subject = described_class.new(:setting, :validate => lambda { |_| "That's a moon" })
+      subject.assign("Mun")
+      subject.validate
+    end
+  end
+
+  describe "#resolve" do
+    it "returns the value when the value has been given" do
+      subject.assign("Mun")
+      expect(subject.resolve).to eq "Mun"
+    end
+
+    it "resolves the default when the default is a proc" do
+      subject = described_class.new(:setting, :default => lambda { "Minmus" })
+      expect(subject.resolve).to eq "Minmus"
+    end
+
+    it "returns the default when the default is not a proc" do
+      subject = described_class.new(:setting, :default => "Ike")
+      expect(subject.resolve).to eq "Ike"
+    end
+
+    it "returns nil when there is no value nor default" do
+      expect(subject.resolve).to be_nil
+    end
+  end
+end

data/spec/unit/settings/enum_definition_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'r10k/settings/enum_definition'
+
+describe R10K::Settings::EnumDefinition do
+
+  subject { described_class.new(:enum, :enum => %w[one two three]) }
+
+  describe '#validate' do
+    it "doesn't raise an error when given an expected value" do
+      subject.assign('two')
+      subject.validate
+    end
+    it "raises an error when given a value outside the enum" do
+      subject.assign('dos')
+      expect {
+        subject.validate
+      }.to raise_error(ArgumentError, "Setting enum should be one of #{%w[one two three].inspect}, not 'dos'")
+    end
+  end
+end

data/spec/unit/settings/inheritance_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'r10k/settings/collection'
+require 'r10k/settings/definition'
+
+RSpec.describe 'R10K::Settings inheritance' do
+  subject do
+    R10K::Settings::Collection.new(:parent_settings, [
+      R10K::Settings::Definition.new(:banana, {
+        :default => 'cavendish',
+      }),
+
+      R10K::Settings::Collection.new(:child_settings, [
+        R10K::Settings::Definition.new(:banana, {
+          :default => :inherit,
+        }),
+      ]),
+    ])
+  end
+
+  describe "child settings" do
+    let(:setting) { subject[:child_settings][:banana] }
+
+    context "when child value is not set" do
+      it "should resolve to default value from parent" do
+        expect(setting.value).to be_nil
+        expect(setting.resolve).to eq 'cavendish'
+      end
+    end
+
+    context "when child value is set" do
+      before(:each) { setting.assign('gros michel') }
+
+      it "should resolve to child value" do
+        expect(setting.resolve).to eq 'gros michel'
+      end
+    end
+  end
+end

data/spec/unit/settings/list_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'r10k/settings/list'
+require 'r10k/settings/collection'
+require 'r10k/settings/definition'
+require 'r10k/settings/uri_definition'
+
+describe R10K::Settings::List do
+  let(:item_proc) do
+    lambda { R10K::Settings::URIDefinition.new(nil, { :desc => "A URI in a list" }) }
+  end
+
+  subject do
+    described_class.new(:test_list, item_proc, { :desc => "A test setting list" })
+  end
+
+  it_behaves_like "a setting with ancestors"
+
+  describe '#assign' do
+    it "calls item_proc for each item assigned" do
+      expect(R10K::Settings::URIDefinition).to receive(:new).and_call_original.exactly(3).times
+
+      subject.assign([ "uri_1", "uri_2", "uri_3"])
+    end
+
+    it "claims ownership of newly added items" do
+      subject.assign([ "uri_1", "uri_2", "uri_3"])
+
+      item_parents = subject.instance_variable_get(:@items).collect { |i| i.parent }
+      expect(item_parents).to all(eq subject)
+    end
+
+    it "assigns value to each item" do
+      new_values = [ "uri_1", "uri_2", "uri_3"]
+      subject.assign(new_values)
+
+      item_values = subject.instance_variable_get(:@items).collect { |i| i.value }
+      expect(item_values).to eq new_values
+    end
+
+    it "silently ignores attempts to assign nil" do
+      subject.assign(nil)
+    end
+  end
+
+  describe '#validate' do
+    it "raises an error containing a list of every item with validation errors" do
+      subject.assign([ "uri 1", "uri 2", "http://www.example.com"])
+
+      expect { subject.validate }.to raise_error do |error|
+        expect(error).to be_a_kind_of(R10K::Settings::List::ValidationError)
+        errors = error.errors.collect { |key, val| val }
+        expect(errors.size).to eq 2
+        expect(errors).to all(be_a_kind_of(ArgumentError))
+        expect(errors.collect { |e| e.message }).to all(match /requires a URL.*could not be parsed/i)
+      end
+    end
+
+    it "it does not raise an error if no errors were found" do
+      subject.assign([ "http://www.example.com" ])
+      expect(subject.validate).to be_nil
+    end
+  end
+
+  describe '#resolve' do
+    it "returns a frozen list of all items" do
+      subject.assign([ "uri_1", "uri_2" ])
+
+      rv = subject.resolve
+
+      expect(rv).to be_frozen
+      expect(rv).to eq([ "uri_1", "uri_2" ])
+    end
+  end
+end
+
+describe R10K::Settings::List::ValidationError do
+  subject do
+    described_class.new("Sample List Validation Errors", errors: {
+      2 => ArgumentError.new("Sample List Item Error"),
+    })
+  end
+
+  it "generates a human readable error message for the invalid item" do
+    message = subject.format
+
+    expect(message).to match /sample list validation errors.*item 2.*sample list item error/im
+  end
+end

data/spec/unit/settings/loader_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'r10k/settings/loader'
+
+describe R10K::Settings::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
+
+    it 'issues a warning if the old location is used' do
+      allow(File).to receive(:file?).and_return false
+      allow(File).to receive(:file?).with('/etc/puppetlabs/r10k/r10k.yaml').and_return false
+      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("The r10k configuration file at /etc/r10k.yaml is deprecated.")
+      expect(logger_dbl).to receive(:warn).with('Please move your r10k configuration to /etc/puppetlabs/r10k/r10k.yaml.')
+
+      subject.search
+    end
+
+    describe 'using an override value' do
+      it 'uses the override when set and ignores files in the load path' do
+        expect(File).to_not receive(:file?)
+        expect(subject.search('/some/override/r10k.yaml')).to eq '/some/override/r10k.yaml'
+      end
+
+      it 'ignores a nil override value' 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(nil)).to eq('/etc/puppetlabs/r10k/r10k.yaml')
+      end
+    end
+  end
+
+  context '#read' do
+    it "raises an error if no config file could be found" do
+      expect(subject).to receive(:search).and_return nil
+      expect {
+        subject.read
+      }.to raise_error(R10K::Settings::Loader::ConfigError, "No configuration file given, no config file found in current directory, and no global config present")
+    end
+
+    it "raises an error if the YAML file load raises an error" do
+      expect(subject).to receive(:search).and_return '/some/path/r10k.yaml'
+      expect(YAML).to receive(:load_file).and_raise(Errno::ENOENT, "/no/such/file")
+      expect {
+        subject.read
+      }.to raise_error(R10K::Settings::Loader::ConfigError, "Couldn't load config file: No such file or directory - /no/such/file")
+    end
+
+    it "recursively replaces string keys with symbol keys in the parsed structure" do
+      expect(subject).to receive(:search).and_return '/some/path/r10k.yaml'
+      expect(YAML).to receive(:load_file).and_return({
+        'cachedir' => '/var/cache/r10k',
+        'git' => {
+          'provider' => 'rugged',
+        }
+      })
+
+      expect(subject.read).to eq({
+        :cachedir => '/var/cache/r10k',
+        :git => {
+          :provider => 'rugged',
+        }
+      })
+    end
+  end
+end

data/spec/unit/settings/uri_definition_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'r10k/settings/uri_definition'
+
+describe R10K::Settings::URIDefinition do
+
+  subject { described_class.new(:uri) }
+
+  it "passes validation if a value has not been set" do
+    expect(subject.validate).to be_nil
+  end
+
+  it "passes validation when given a valid url" do
+    subject.assign("http://definitely.a/url")
+    expect(subject.validate).to be_nil
+  end
+
+  it "raises an error when given an invalid URL" do
+    subject.assign("That's no URI!")
+    expect {
+      subject.validate
+    }.to raise_error(ArgumentError, "Setting uri requires a URL but 'That's no URI!' could not be parsed as a URL")
+  end
+end