knife 17.0.244 → 17.2.15

data/spec/support/shared/matchers/exit_with_code.rb

@@ -0,0 +1,32 @@
+require "rspec/expectations"
+
+# Lifted from http://stackoverflow.com/questions/1480537/how-can-i-validate-exits-and-aborts-in-rspec
+RSpec::Matchers.define :exit_with_code do |exp_code|
+  actual = nil
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual && actual == exp_code
+  end
+
+  failure_message do |block|
+    "expected block to call exit(#{exp_code}) but exit" +
+      (actual.nil? ? " not called" : "(#{actual}) was called")
+  end
+
+  failure_message_when_negated do |block|
+    "expected block not to call exit(#{exp_code})"
+  end
+
+  description do
+    "expect block to call exit(#{exp_code})"
+  end
+
+  def supports_block_expectations?
+    true
+  end
+
+end

data/spec/support/shared/matchers/match_environment_variable.rb

@@ -0,0 +1,17 @@
+
+require "rspec/expectations"
+require "spec/support/platform_helpers"
+
+RSpec::Matchers.define :match_environment_variable do |varname|
+  match do |actual|
+    expected = if windows? && ENV[varname].nil?
+                 # On Windows, if an environment variable is not set, the command
+                 # `echo %VARNAME%` outputs %VARNAME%
+                 "%#{varname}%"
+               else
+                 ENV[varname].to_s
+               end
+
+    actual == expected
+  end
+end

data/spec/support/shared/unit/knife_shared.rb

@@ -0,0 +1,39 @@
+#
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+shared_examples_for "mandatory field missing" do
+  context "when field is nil" do
+    before do
+      knife.name_args = name_args
+    end
+
+    it "exits 1" do
+      expect { knife.run }.to raise_error(SystemExit)
+    end
+
+    it "prints the usage" do
+      expect(knife).to receive(:show_usage)
+      expect { knife.run }.to raise_error(SystemExit)
+    end
+
+    it "prints a relevant error message" do
+      expect { knife.run }.to raise_error(SystemExit)
+      expect(stderr.string).to match(/You must specify a #{fieldname}/)
+    end
+  end
+end

data/spec/support/shared/unit/mock_shellout.rb

@@ -0,0 +1,49 @@
+#
+# Author:: John Keiser <jkeiser@chef.io>
+# Copyright:: Copyright 2015-2016, John Keiser.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#
+# Mocks shellout results. Examples:
+#   mock_shellout_command("systemctl --all", exitstatus: 1)
+#
+class MockShellout
+  module RSpec
+    def mock_shellout_command(command, **result)
+      allow(::Mixlib::ShellOut).to receive(:new).with(command, anything).and_return MockShellout.new(**result)
+    end
+  end
+
+  def initialize(**properties)
+    @properties = {
+      stdout: "",
+      stderr: "",
+      exitstatus: 0,
+    }.merge(properties)
+  end
+
+  def method_missing(name, *args)
+    @properties[name.to_sym]
+  end
+
+  def error?
+    exitstatus != 0
+  end
+
+  def error!
+    raise Mixlib::ShellOut::ShellCommandFailed, "Expected process to exit with 0, but received #{exitstatus}" if error?
+  end
+end

data/spec/tiny_server.rb

@@ -0,0 +1,190 @@
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "webrick"
+require "webrick/https"
+require "rack"
+require "singleton"
+require "open-uri"
+require "chef/config"
+
+module TinyServer
+
+  class Manager
+
+    # 5 == debug, 3 == warning
+    LOGGER = WEBrick::Log.new(STDOUT, 3)
+    DEFAULT_OPTIONS = {
+      Port: 9000,
+      Host: "localhost",
+      Logger: LOGGER,
+      # SSLEnable: options[:ssl],
+      # SSLCertName: [ [ 'CN', WEBrick::Utils::getservername ] ],
+      AccessLog: [], # Remove this option to enable the access log when debugging.
+    }.freeze
+
+    def initialize(**options)
+      @options = DEFAULT_OPTIONS.merge(options)
+      @creator = caller.first
+    end
+
+    attr_reader :options
+    attr_reader :creator
+    attr_reader :server
+
+    def start(timeout = 5)
+      raise "Server already started!" if server
+
+      # Create the server (but don't start yet)
+      start_queue = Queue.new
+      @server = create_server(StartCallback: proc { start_queue << true })
+
+      @server_thread = Thread.new do
+        # Ensure any exceptions will cause the main rspec thread to fail too
+        Thread.current.abort_on_exception = true
+        server.start
+      end
+
+      # Wait for the StartCallback to tell us we've started
+      Timeout.timeout(timeout) do
+        start_queue.pop
+      end
+    end
+
+    def stop(timeout = 5)
+      if server
+        server.shutdown
+        @server = nil
+      end
+
+      if server_thread
+        begin
+          # Wait for a normal shutdown
+          server_thread.join(timeout)
+        rescue
+          # If it wouldn't shut down normally, kill it.
+          server_thread.kill
+          server_thread.join(timeout)
+        end
+        @server_thread = nil
+      end
+    end
+
+    private
+
+    attr_reader :server_thread
+
+    def create_server(**extra_options)
+      server = WEBrick::HTTPServer.new(**options, **extra_options)
+      server.mount("/", Rack::Handler::WEBrick, API.instance)
+      server
+    end
+  end
+
+  class API
+    include Singleton
+
+    GET     = "GET".freeze
+    PUT     = "PUT".freeze
+    POST    = "POST".freeze
+    DELETE  = "DELETE".freeze
+
+    attr_reader :routes
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @routes = { GET => [], PUT => [], POST => [], DELETE => [] }
+    end
+
+    def get(path, response_code, data = nil, headers = nil, &block)
+      @routes[GET] << Route.new(path, Response.new(response_code, data, headers, &block))
+    end
+
+    def put(path, response_code, data = nil, headers = nil, &block)
+      @routes[PUT] << Route.new(path, Response.new(response_code, data, headers, &block))
+    end
+
+    def post(path, response_code, data = nil, headers = nil, &block)
+      @routes[POST] << Route.new(path, Response.new(response_code, data, headers, &block))
+    end
+
+    def delete(path, response_code, data = nil, headers = nil, &block)
+      @routes[DELETE] << Route.new(path, Response.new(response_code, data, headers, &block))
+    end
+
+    def call(env)
+      if response = response_for_request(env)
+        response.call
+      else
+        debug_info = { message: "no data matches the request for #{env["REQUEST_URI"]}",
+                       available_routes: @routes, request: env }
+        # Uncomment me for glorious debugging
+        # pp :not_found => debug_info
+        [404, { "Content-Type" => "application/json" }, [ Chef::JSONCompat.to_json(debug_info) ]]
+      end
+    end
+
+    def response_for_request(env)
+      if route = @routes[env["REQUEST_METHOD"]].find { |route| route.matches_request?(env["REQUEST_URI"]) }
+        route.response
+      end
+    end
+  end
+
+  class Route
+    attr_reader :response
+
+    def initialize(path_spec, response)
+      @path_spec, @response = path_spec, response
+    end
+
+    def matches_request?(uri)
+      uri = URI.parse(uri).request_uri
+      @path_spec === uri
+    end
+
+    def to_s
+      "#{@path_spec} => (#{@response})"
+    end
+
+  end
+
+  class Response
+    HEADERS = { "Content-Type" => "application/json" }.freeze
+
+    def initialize(response_code = 200, data = nil, headers = nil, &block)
+      @response_code, @data = response_code, data
+      @response_headers = headers ? HEADERS.merge(headers) : HEADERS
+      @block = block_given? ? block : nil
+    end
+
+    def call
+      data = @data || @block.call
+      [@response_code, @response_headers, Array(data)]
+    end
+
+    def to_s
+      "#{@response_code} => #{(@data || @block)}"
+    end
+
+  end
+
+end

data/spec/unit/application/knife_spec.rb

@@ -0,0 +1,241 @@
+#
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "knife_spec_helper"
+require "#{CHEF_SPEC_DATA}/knife_subcommand/test_yourself"
+
+describe Chef::Application::Knife do
+  include SpecHelpers::Knife
+
+  before(:all) do
+    class NoopKnifeCommand < Chef::Knife
+      option :opt_with_default,
+        short: "-D VALUE",
+        long: "-optwithdefault VALUE",
+        default: "default-value"
+
+      def run; end
+    end
+  end
+
+  after(:each) do
+    # reset some really nasty global state
+    NoopKnifeCommand.reset_config_loader!
+  end
+
+  before(:each) do
+    # Prevent code from getting loaded on every test invocation.
+    allow(Chef::Knife).to receive(:load_commands)
+
+    @knife = Chef::Application::Knife.new
+    allow(@knife).to receive(:puts)
+    allow(@knife).to receive(:trap)
+    allow(Chef::Knife).to receive(:list_commands)
+  end
+
+  it "should exit 1 and print the options if no arguments are given at all" do
+    with_argv([]) do
+      expect { @knife.run }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+    end
+  end
+
+  it "should exit 2 if run without a sub command" do
+    with_argv("--user", "adam") do
+      expect(Chef::Log).to receive(:error).with(/you need to pass a sub\-command/i)
+      expect { @knife.run }.to raise_error(SystemExit) { |e| expect(e.status).to eq(2) }
+    end
+  end
+
+  it "should run a sub command with the applications command line option prototype" do
+    with_argv(*%w{noop knife command with some args}) do
+      knife = double(Chef::Knife)
+      expect(Chef::Knife).to receive(:run).with(ARGV, @knife.options).and_return(knife)
+      expect(@knife).to receive(:exit).with(0)
+      @knife.run
+    end
+  end
+
+  it "should set the colored output to true by default on windows and true on all other platforms as well" do
+    with_argv(*%w{noop knife command}) do
+      expect(@knife).to receive(:exit).with(0)
+      @knife.run
+    end
+    expect(Chef::Config[:color]).to be_truthy
+  end
+
+  context "validate --format option" do
+    it "should set the default format summary" do
+      with_argv(*%w{noop knife command}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+        expect(@knife.default_config[:format]).to eq("summary")
+      end
+    end
+
+    it "should raise the error for invalid value" do
+      with_argv(*%w{noop knife command -F abc}) do
+        expect(STDOUT).to receive(:puts).at_least(2).times
+        expect { @knife.run }.to raise_error(SystemExit) { |e| expect(e.status).to eq(2) }
+      end
+    end
+  end
+
+  context "when given fips flags" do
+    context "when Chef::Config[:fips]=false" do
+      before do
+        # This is required because the chef-fips pipeline does
+        # has a default value of true for fips
+        Chef::Config[:fips] = false
+      end
+
+      it "does not initialize fips mode when no flags are passed" do
+        with_argv(*%w{noop knife command}) do
+          expect(@knife).to receive(:exit).with(0)
+          expect(Chef::Config).not_to receive(:enable_fips_mode)
+          @knife.run
+          expect(Chef::Config[:fips]).to eq(false)
+        end
+      end
+
+      it "overwrites the Chef::Config value when passed --fips" do
+        with_argv(*%w{noop knife command --fips}) do
+          expect(@knife).to receive(:exit).with(0)
+          expect(Chef::Config).to receive(:enable_fips_mode)
+          @knife.run
+          expect(Chef::Config[:fips]).to eq(true)
+        end
+      end
+    end
+
+    context "when Chef::Config[:fips]=true" do
+      before do
+        Chef::Config[:fips] = true
+      end
+
+      it "initializes fips mode when passed --fips" do
+        with_argv(*%w{noop knife command --fips}) do
+          expect(@knife).to receive(:exit).with(0)
+          expect(Chef::Config).to receive(:enable_fips_mode)
+          @knife.run
+          expect(Chef::Config[:fips]).to eq(true)
+        end
+      end
+
+      it "overwrites the Chef::Config value when passed --no-fips" do
+        with_argv(*%w{noop knife command --no-fips}) do
+          expect(@knife).to receive(:exit).with(0)
+          expect(Chef::Config).not_to receive(:enable_fips_mode)
+          @knife.run
+          expect(Chef::Config[:fips]).to eq(false)
+        end
+      end
+    end
+  end
+
+  describe "when given a path to the client key" do
+    it "expands a relative path relative to the CWD" do
+      relative_path = ".chef/client.pem"
+      allow(Dir).to receive(:pwd).and_return(CHEF_SPEC_DATA)
+      with_argv(*%W{noop knife command -k #{relative_path}}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:client_key]).to eq(File.join(CHEF_SPEC_DATA, relative_path))
+    end
+
+    it "expands a ~/home/path to the correct full path" do
+      home_path = "~/.chef/client.pem"
+      with_argv(*%W{noop knife command -k #{home_path}}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:client_key]).to eq(File.join(ENV["HOME"], ".chef/client.pem").gsub((File::ALT_SEPARATOR || "\\"), File::SEPARATOR))
+    end
+
+    it "does not expand a full path" do
+      full_path = if windows?
+                    "C:/chef/client.pem"
+                  else
+                    "/etc/chef/client.pem"
+                  end
+      with_argv(*%W{noop knife command -k #{full_path}}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:client_key]).to eq(full_path)
+    end
+  end
+
+  describe "with environment configuration" do
+    before do
+      Chef::Config[:environment] = nil
+    end
+
+    it "should default to no environment" do
+      with_argv(*%w{noop knife command}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:environment]).to eq(nil)
+    end
+
+    it "should load the environment from the config file" do
+      config_file = File.join(CHEF_SPEC_DATA, "environment-config.rb")
+      with_argv(*%W{noop knife command -c #{config_file}}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:environment]).to eq("production")
+    end
+
+    it "should load the environment from the CLI options" do
+      with_argv(*%w{noop knife command -E development}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:environment]).to eq("development")
+    end
+
+    it "should override the config file environment with the CLI environment" do
+      config_file = File.join(CHEF_SPEC_DATA, "environment-config.rb")
+      with_argv(*%W{noop knife command -c #{config_file} -E override}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:environment]).to eq("override")
+    end
+
+    it "should override the config file environment with the CLI environment regardless of order" do
+      config_file = File.join(CHEF_SPEC_DATA, "environment-config.rb")
+      with_argv(*%W{noop knife command -E override -c #{config_file}}) do
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+      expect(Chef::Config[:environment]).to eq("override")
+    end
+
+    it "should run a sub command with the applications command line option prototype" do
+      with_argv(*%w{noop knife command with some args}) do
+        knife = double(Chef::Knife)
+        expect(Chef::Knife).to receive(:run).with(ARGV, @knife.options).and_return(knife)
+        expect(@knife).to receive(:exit).with(0)
+        @knife.run
+      end
+    end
+  end
+
+end