akerl-r10k 3.14.2.1

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

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'r10k/action/puppetfile/purge'
+
+describe R10K::Action::Puppetfile::Purge do
+  let(:default_opts) { {root: "/some/nonexistent/path"} }
+  let(:puppetfile) do
+    instance_double('R10K::ModuleLoader::Puppetfile',
+                    :load! => {
+                      :modules             => %w{mod},
+                      :managed_directories => %w{foo},
+                      :desired_contents    => %w{bar},
+                      :purge_exclusions    => %w{baz}
+                    })
+  end
+
+  def purger(opts = {}, argv = [], settings = {})
+    opts = default_opts.merge(opts)
+    return described_class.new(opts, argv, settings)
+  end
+
+  before(:each) do
+    allow(R10K::ModuleLoader::Puppetfile).to receive(:new).
+      with({basedir: "/some/nonexistent/path"}).
+      and_return(puppetfile)
+  end
+
+  it_behaves_like "a puppetfile action"
+
+  it "purges unmanaged entries in the Puppetfile moduledir" do
+    mock_cleaner = double("cleaner")
+
+    expect(R10K::Util::Cleaner).to receive(:new).
+      with(["foo"], ["bar"], ["baz"]).
+      and_return(mock_cleaner)
+
+    expect(mock_cleaner).to receive(:purge!)
+
+    purger.call
+  end
+
+  describe "using custom paths" do
+    it "can use a custom puppetfile path" do
+      expect(R10K::ModuleLoader::Puppetfile).to receive(:new).
+        with({basedir: "/some/nonexistent/path",
+              puppetfile: "/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::ModuleLoader::Puppetfile).to receive(:new).
+        with({basedir: "/some/nonexistent/path",
+              moduledir: "/some/other/path/site-modules"}).
+        and_return(puppetfile)
+
+      purger({moduledir: "/some/other/path/site-modules"}).call
+    end
+  end
+end

data/spec/unit/action/runner_spec.rb

@@ -0,0 +1,407 @@
+require 'spec_helper'
+require 'r10k/action/base'
+require 'puppet_forge/connection'
+
+require 'r10k/action/runner'
+
+describe R10K::Action::Runner do
+
+  let(:action_class) do
+    Class.new do
+      attr_reader :opts
+      attr_reader :argv
+      attr_reader :settings
+
+      def initialize(opts, argv, settings = {})
+        @opts = opts
+        @argv = argv
+        @settings = settings
+      end
+
+      def call
+        @argv.map(&:upcase)
+      end
+    end
+  end
+
+  subject(:runner) { described_class.new({:opts => :yep}, %w[args yes], action_class) }
+
+  before(:each) do
+    expect(runner.logger).not_to receive(:error)
+  end
+
+  describe "instantiating the wrapped class" do
+    it "creates an instance of the class" do
+      expect(runner.instance).to be_a_kind_of action_class
+    end
+
+    it "passes the opts and argv to the instance" do
+      expect(runner.instance.opts).to eq(:opts => :yep)
+      expect(runner.instance.argv).to eq(%w[args yes])
+    end
+
+    it "strips out options that the runner handles" do
+      runner = described_class.new({:opts => :yep, :loglevel => 'FATAL'}, %w[args yes], action_class)
+      expect(runner.instance.opts).to eq(:opts => :yep)
+    end
+  end
+
+  describe "calling" do
+    it "configures logging" do
+      expect(runner).to receive(:setup_logging)
+      runner.call
+    end
+
+    it "configures settings" do
+      expect(runner).to receive(:setup_settings)
+      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
+  end
+
+  describe "configuring settings" do
+    subject(:runner) { described_class.new(options, %w[args yes], action_class) }
+
+    let(:global_settings) { R10K::Settings.global_settings }
+
+    before(:each) do
+      expect(R10K::Settings).to receive(:global_settings).and_return(global_settings)
+      allow(File).to receive(:executable?).and_return(true)
+    end
+
+    opts = {
+      cachedir:       nil,
+      puppet_path:    :deploy,
+      generate_types: :deploy,
+    }
+
+    opts.each do |opt, conf_path|
+      context "with #{opt} config setting" do
+        let(:options) { { config: "spec/fixtures/unit/action/r10k_#{opt}.yaml" } }
+
+        context "when not overridden" do
+          it "uses the config value" do
+            override = { "#{opt}": "/config_#{opt}" }
+            overrides = if conf_path.nil?
+                          override
+                        else
+                          { "#{conf_path}": override }
+                        end
+            expect(global_settings).to receive(:evaluate).with(hash_including(overrides)).and_call_original
+            runner.call
+          end
+        end
+
+        context "when overridden" do
+          let(:options) { super().merge("#{opt.to_s.sub('_','-')}": "/overridden_#{opt}") }
+
+          it "uses the overridden value" do
+            override = { "#{opt}": "/overridden_#{opt}" }
+            overrides = if conf_path.nil?
+                          override
+                        else
+                          { "#{conf_path}": override }
+                        end
+            expect(global_settings).to receive(:evaluate).with(hash_including(overrides)).and_call_original
+            runner.call
+          end
+        end
+      end
+
+      context "with complete config" do
+        let(:options) { { config: "spec/fixtures/unit/action/r10k.yaml" } }
+        let(:config) do
+          config = {}
+          opts.each do |o, path|
+            if path.nil?
+              config[o] = "/config_#{o}"
+            else
+              config[path] ||= {}
+              config[path][o] = "/config_#{o}"
+            end
+          end
+          config
+        end
+
+        context "when not overridden" do
+          it "uses the config value" do
+            expect(global_settings).to receive(:evaluate).with(config).and_call_original
+            runner.call
+          end
+        end
+
+        context "when overridden" do
+          let(:options) {
+            super().merge("#{opt.to_s.sub('_','-')}": "/overridden_#{opt}")
+          }
+
+          it "uses the overridden value" do
+            with_overrides = config
+            if conf_path.nil?
+              with_overrides[opt] = "/overridden_#{opt}"
+            else
+              with_overrides[conf_path][opt] = "/overridden_#{opt}"
+            end
+            expect(global_settings).to receive(:evaluate).with(with_overrides).and_call_original
+            runner.call
+          end
+        end
+      end
+    end
+  end
+
+  describe "configuring logging" do
+    before(:each) do
+      R10K::Logging.outputters.clear
+    end
+
+    it "sets the log level if :loglevel is provided" do
+      runner = described_class.new({:opts => :yep, :loglevel => 'FATAL'}, %w[args yes], action_class)
+      # The settings/overrides system causes the level to be set twice
+      expect(R10K::Logging).to receive(:level=).with('FATAL').twice
+      runner.call
+    end
+
+    # The logging fixture tests require a platform with syslog
+    if !R10K::Util::Platform.windows?
+      it "sets the log level if the logging.level setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:level=).with('FATAL')
+        runner.call
+      end
+
+      it "sets the outputters if logging.outputs is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml' }, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:add_outputters).with([
+          { type: 'file', parameters: { filename: 'r10k.log' } },
+          { type: 'syslog' }
+        ])
+        runner.call
+      end
+
+      it "disables the default outputter if the logging.disable_default_stderr setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:disable_default_stderr=).with(true)
+        runner.call
+      end
+
+      it "adds additional log outputs if the logging.outputs setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        runner.call
+        expect(R10K::Logging.outputters).to_not be_empty
+      end
+
+      it "disables the default output if the logging.disable_default_stderr setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        runner.call
+        expect(runner.logger.outputters).to satisfy { |outputs| outputs.any? { |output| output.is_a?(R10K::Logging::TerminalOutputter) && output.level == Log4r::OFF } }
+      end
+    end
+
+    it "doesn't add additional log outputs if the logging.outputs setting is not provided" do
+      runner.call
+      expect(R10K::Logging.outputters).to be_empty
+    end
+
+    it "includes the default stderr outputter" do
+      runner.call
+      expect(runner.logger.outputters).to satisfy { |outputs| outputs.any? { |output| output.is_a? R10K::Logging::TerminalOutputter } }
+    end
+
+    it "does not modify the loglevel if :loglevel is not provided" do
+      expect(R10K::Logging).to_not receive(:level=)
+      runner.call
+    end
+  end
+
+  describe "configuring github app credentials" do
+    it 'errors if app id is passed without ssl key' do
+      runner = described_class.new(
+        { 'github-app-id': '/nonexistent', },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Must specify both id and SSL private key/)
+    end
+
+    it 'errors if ssl key is passed without app id' do
+      runner = described_class.new(
+        { 'github-app-key': '/nonexistent', },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Must specify both id and SSL private key/)
+    end
+
+    it 'errors if both app id and token paths are passed' do
+      runner = described_class.new(
+        { 'github-app-id': '/nonexistent', 'oauth-token': '/also/fake' },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'errors if both ssl key and token paths are passed' do
+      runner = described_class.new(
+        { 'github-app-key': '/nonexistent', 'oauth-token': '/also/fake' },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'errors if both ssl key and ssh key paths are passed' do
+      runner = described_class.new(
+        { 'github-app-key': '/nonexistent', 'private-key': '/also/fake' },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'errors if both app id and ssh key are passed' do
+      runner = described_class.new(
+        { 'github-app-id': '/nonexistent', 'private-key': '/also/fake' },
+        %w[args yes],
+        action_class
+      )
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'saves the parameters in settings hash' do
+      runner = described_class.new(
+        { 'github-app-id': '123456', 'github-app-key': '/my/ssl/key', 'github-app-ttl': '600' },
+        %w[args yes],
+        action_class
+      )
+      runner.call
+      expect(runner.instance.settings[:git][:github_app_id]).to eq('123456')
+      expect(runner.instance.settings[:git][:github_app_key]).to eq('/my/ssl/key')
+      expect(runner.instance.settings[:git][:github_app_ttl]).to eq('600')
+    end
+
+    it 'saves the parameters in settings hash without ttl and uses its default value' do
+      runner = described_class.new(
+        { 'github-app-id': '123456', 'github-app-key': '/my/ssl/key', },
+        %w[args yes],
+        action_class
+      )
+      runner.call
+      expect(runner.instance.settings[:git][:github_app_id]).to eq('123456')
+      expect(runner.instance.settings[:git][:github_app_key]).to eq('/my/ssl/key')
+      expect(runner.instance.settings[:git][:github_app_ttl]).to eq('120')
+    end
+  end
+
+  describe "configuring git credentials" do
+    it 'errors if both token and key paths are passed' do
+      runner = described_class.new({ 'oauth-token': '/nonexistent',
+                                     'private-key': '/also/fake' }, %w[args yes], action_class)
+      expect{ runner.call }.to raise_error(R10K::Error, /Cannot specify both/)
+    end
+
+    it 'saves the sshkey path in settings hash' do
+      runner = described_class.new({ 'private-key': '/my/ssh/key' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+    end
+
+    it 'overrides per-repo sshkey in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'private-key': '/my/ssh/key' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:private_key]).to eq('/my/ssh/key')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:private_key]).to eq('/my/ssh/key')
+      end
+    end
+
+    it 'saves the token path in settings hash' do
+      runner = described_class.new({ 'oauth-token': '/my/token/path' }, %w[args yes], action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token/path')
+    end
+
+    it 'overrides per-repo oauth token in settings hash' do
+      runner = described_class.new({ config: "spec/fixtures/unit/action/r10k_creds.yaml",
+                                     'oauth-token': '/my/token' },
+                                     %w[args yes],
+                                     action_class)
+      runner.call
+      expect(runner.instance.settings[:git][:oauth_token]).to eq('/my/token')
+      expect(runner.instance.settings[:git][:repositories].count).to eq(2)
+      runner.instance.settings[:git][:repositories].each do |repo_settings|
+        expect(repo_settings[:oauth_token]).to eq('/my/token')
+      end
+    end
+  end
+
+  describe "configuration authorization" do
+    context "settings auth" do
+      it "sets the configured token as the forge authorization header" do
+        options = { config: "spec/fixtures/unit/action/r10k_forge_auth.yaml" }
+        runner = described_class.new(options, %w[args yes], action_class)
+
+        expect(PuppetForge).to receive(:host=).with('http://private-forge.com')
+        expect(PuppetForge::Connection).to receive(:authorization=).with('faketoken')
+        expect(PuppetForge::Connection).to receive(:authorization).and_return('faketoken')
+        expect(R10K::Util::License).not_to receive(:load)
+        runner.setup_settings
+        runner.setup_authorization
+      end
+    end
+
+    context "license auth" do
+      context "when license is not present" do
+        before(:each) do
+          expect(R10K::Util::License).to receive(:load).and_return(nil)
+        end
+
+        it "does not set authorization header on connection class" do
+          expect(PuppetForge::Connection).not_to receive(:authorization=)
+          runner.setup_authorization
+        end
+      end
+
+      context "when license is present but invalid" do
+        before(:each) do
+          expect(R10K::Util::License).to receive(:load).and_raise(R10K::Error.new('invalid license'))
+        end
+
+        it "issues warning to logger" do
+          expect(runner.logger).to receive(:warn).with(/invalid license/)
+          runner.setup_authorization
+        end
+
+        it "does not set authorization header on connection class" do
+          expect(PuppetForge::Connection).not_to receive(:authorization=)
+          runner.setup_authorization
+        end
+      end
+
+      context "when license is present and valid" do
+        before(:each) do
+          mock_license = double('pe-license', :authorization_token => 'test token')
+          expect(R10K::Util::License).to receive(:load).and_return(mock_license)
+        end
+
+        it "sets authorization header on connection class" do
+          expect(PuppetForge::Connection).to receive(:authorization=).with('test token')
+          runner.setup_authorization
+        end
+      end
+    end
+  end
+end

data/spec/unit/action/visitor_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'r10k/action/visitor'
+require 'r10k/logging'
+
+describe R10K::Action::Visitor do
+  let(:visitor_class) do
+    Class.new do
+      include R10K::Action::Visitor
+      include R10K::Logging
+      attr_accessor :trace
+
+      def visit_error(other)
+        raise ArgumentError, "no soup for you"
+      end
+    end
+  end
+
+  subject { visitor_class.new }
+
+  it "dispatches visit invocations to the type specific method" do
+    expect(subject).to receive(:visit_sym).with(:hi)
+    subject.visit(:sym, :hi)
+  end
+
+  describe "when a visit_ method raises an error" do
+
+    [true, false].each do |trace|
+      msg = trace ? "a" : "no"
+      it "logs the error with #{msg} backtrace when trace is #{trace}" do
+        subject.trace = trace
+        expect(R10K::Errors::Formatting).to(
+          receive(:format_exception).with(instance_of(ArgumentError), trace)
+        ).and_return("errmsg")
+        expect(subject.logger).to receive(:error).with('errmsg')
+        subject.visit(:error, :hi)
+      end
+    end
+  end
+end

data/spec/unit/cli_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe 'basic cli sanity check' do
+  it 'can load the R10K::CLI namespace' do
+    expect {
+      require 'r10k/cli'
+    }.not_to raise_exception
+  end
+end

data/spec/unit/deployment/config_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe R10K::Deployment::Config do
+  let(:loader) { instance_double('R10K::Settings::Loader') }
+  let(:initializer) { instance_double('R10K::Initializers::GlobalInitializer') }
+
+  describe "applying global settings" do
+    before do
+      expect(R10K::Settings::Loader).to receive(:new).and_return(loader)
+      expect(R10K::Initializers::GlobalInitializer).to receive(:new).and_return(initializer)
+    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 "overriding settings" do
+    before do
+      expect(R10K::Settings::Loader).to receive(:new).and_return(loader)
+    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