r10k 2.0.3 → 2.1.0

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

@@ -0,0 +1,17 @@
+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

data/spec/unit/action/cri_runner_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'r10k/action/base'
 require 'r10k/action/cri_runner'
 
 describe R10K::Action::CriRunner do
@@ -8,9 +9,10 @@ describe R10K::Action::CriRunner do
       attr_reader :opts
       attr_reader :argv
 
-      def initialize(opts, argv)
+      def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv
+        @settings = {}
       end
 
       def call

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,31 @@
+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 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"
+end

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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+require 'r10k/deployment'
+require 'r10k/action/deploy/environment'
+
+describe R10K::Action::Deploy::Environment do
+
+  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"}, [])
+    end
+
+    it "can accept a puppetfile option" do
+      described_class.new({puppetfile: true}, [])
+    end
+
+    it "normalizes environment names in the arg vector"
+  end
+
+  describe "when called" do
+    describe "with an environment that doesn't exist" do
+      let(:config) do
+        R10K::Deployment::MockConfig.new(
+          :sources => {
+            :control => {
+              :type => :mock,
+              :basedir => '/some/nonexistent/path/control',
+              :environments => %w[first second third],
+            }
+          }
+        )
+      end
+
+      let(:deployment) do
+        R10K::Deployment.new(config)
+      end
+
+      before do
+        expect(R10K::Deployment).to receive(:new).and_return(deployment)
+      end
+
+      subject { described_class.new({config: "/some/nonexistent/path", purge: false}, %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.")
+        logger = subject.logger
+        expect(subject.call).to eq false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+require 'r10k/action/deploy/module'
+
+describe R10K::Action::Deploy::Module do
+
+  subject { described_class.new({config: "/some/nonexistent/path"}, []) }
+
+  it_behaves_like "a deploy action that requires a config file"
+  it_behaves_like "a deploy action that can be write locked"
+
+  describe "initializing" do
+    it "accepts an environment option" do
+      described_class.new({environment: "production"}, [])
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'r10k/action/puppetfile/check'
+
+describe R10K::Action::Puppetfile::Check do
+
+  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
+
+  let(:puppetfile) { instance_double('R10K::Puppetfile') }
+
+  before { allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile) }
+
+  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
+  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")
+    expect($stderr).to receive(:puts).with("Formatted error message")
+    subject.call
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'r10k/action/puppetfile/install'
+
+describe R10K::Action::Puppetfile::Install do
+
+  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
+
+  let(:puppetfile) { R10K::Puppetfile.new('/some/nonexistent/path', nil, nil) }
+
+  before do
+    allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile)
+  end
+
+  it_behaves_like "a puppetfile action"
+
+  describe "installing modules" do
+    let(:modules) do
+      Array.new(4, R10K::Module::Base.new('author/modname', "/some/nonexistent/path/modname", nil))
+    end
+
+    before do
+      allow(puppetfile).to receive(:purge!)
+      allow(puppetfile).to receive(:modules).and_return(modules)
+    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
+    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
+    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
+    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").and_return(puppetfile)
+      subject.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).and_return(puppetfile)
+      subject.call
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'r10k/action/puppetfile/purge'
+
+describe R10K::Action::Puppetfile::Purge do
+
+  subject { described_class.new({root: "/some/nonexistent/path"}, []) }
+
+  let(:puppetfile) { instance_double('R10K::Puppetfile') }
+
+  before { allow(R10K::Puppetfile).to receive(:new).with("/some/nonexistent/path", nil, nil).and_return(puppetfile) }
+
+  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
+  end
+end

data/spec/unit/action/runner_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
-require 'r10k/action/runner'
+require 'r10k/action/base'
+require 'puppet_forge/connection'
 
+require 'r10k/action/runner'
 
 describe R10K::Action::Runner do
 
@@ -9,9 +11,10 @@ describe R10K::Action::Runner do
       attr_reader :opts
       attr_reader :argv
 
-      def initialize(opts, argv)
+      def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv
+        @settings = {}
       end
 
       def call
@@ -49,6 +52,11 @@ describe R10K::Action::Runner do
       runner.call
     end
 
+    it "configures forge authorization" do
+      expect(runner).to receive(:setup_authorization)
+      runner.call
+    end
+
     it "returns the result of the wrapped class #call method" do
       expect(runner.call).to eq %w[ARGS YES]
     end
@@ -67,13 +75,6 @@ describe R10K::Action::Runner do
     end
   end
 
-  describe "configuring settings" do
-    it "configures authorization" do
-      expect(runner).to receive(:setup_authorization)
-      runner.setup_settings
-    end
-  end
-
   describe "configuration authorization" do
     context "when license is not present" do
       before(:each) do

data/spec/unit/deployment/config_spec.rb

@@ -1,57 +1,33 @@
 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
+  let(:loader) { instance_double('R10K::Settings::Loader') }
+  let(:initializer) { instance_double('R10K::Initializers::GlobalInitializer') }
 
   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
+    before do
+      expect(R10K::Settings::Loader).to receive(:new).and_return(loader)
+      expect(R10K::Initializers::GlobalInitializer).to receive(:new).and_return(initializer)
     end
 
-    describe "for the forge" do
-      it "sets the proxy when given" do
-        expect(YAML).to receive(:load_file).with('foo/bar').and_return('forge' => {'proxy' => 'https://proxy.url'})
-        expect(R10K::Forge::ModuleRelease.settings).to receive(:[]=).with(:proxy, 'https://proxy.url')
-        described_class.new('foo/bar')
-      end
+    it 'runs application initialization' do
+      config = instance_double('Hash')
+      allow(loader).to receive(:read).and_return({})
+      expect(initializer).to receive(:call)
+      described_class.new('some/path')
     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
+  describe "overriding settings" do
+    before do
+      expect(R10K::Settings::Loader).to receive(:new).and_return(loader)
+    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
+    it 'allows settings from config to be overridden' do
+      allow(loader).to receive(:read).and_return({:cachedir => 'fromfile'})
+      expect(R10K::Initializers::GlobalInitializer).to receive(:new).with(hash_including(:cachedir => 'fromoverride')).and_return(initializer)
+      expect(initializer).to receive(:call)
+      described_class.new('some/path', {:cachedir => 'fromoverride'})
     end
   end
 end

data/spec/unit/deployment_spec.rb

@@ -155,7 +155,7 @@ describe R10K::Deployment, "checking the 'sources' key" do
       it "raises an error when enumerating sources" do
         expect {
           deployment.sources
-        }.to raise_error(R10K::Error, "'sources' key in /some/nonexistent/config_file missing or empty.")
+        }.to raise_error(R10K::Error, "Unable to load sources; the supplied configuration does not define the 'sources' key")
       end
     end
   end

data/spec/unit/environment/git_spec.rb

@@ -74,4 +74,24 @@ describe R10K::Environment::Git do
       expect(subject.status).to eq :some_status
     end
   end
+
+  describe "environment signature" do
+    it "returns the git sha of HEAD" do
+      expect(subject.repo).to receive(:head).and_return 'f00b00'
+      expect(subject.signature).to eq 'f00b00'
+    end
+  end
+
+  describe "info hash" do
+    let(:info_hash) { subject.info }
+
+    before(:each) do
+      allow(subject.repo).to receive(:head).and_return 'f00b00'
+    end
+
+    it "includes name and signature" do
+      expect(info_hash.keys).to include :name, :signature
+      expect(info_hash).not_to have_value(nil)
+    end
+  end
 end