knife 17.0.246 → 17.1.35

data/spec/integration/config_show_spec.rb

@@ -0,0 +1,192 @@
+#
+# Copyright 2018, Noah Kantrowitz
+#
+# 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 "support/shared/integration/integration_helper"
+require "support/shared/context/config"
+
+describe "knife config show", :workstation do
+  include IntegrationSupport
+  include KnifeSupport
+
+  include_context "default config options"
+
+  let(:cmd_args) { [] }
+
+  when_the_repository("has a custom env") do
+    subject do
+      cmd = knife("config", "show", *cmd_args, instance_filter: lambda { |instance|
+        # Clear the stub set up in KnifeSupport.
+        allow(File).to receive(:file?).and_call_original
+        # Lies, damn lies, and config files. We need to allow normal config loading
+        # behavior to be able to test stuff.
+        instance.config.delete(:config_file)
+        $__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
+      })
+      cmd.stdout
+    end
+
+    around do |ex|
+      # Store and reset the value of some env vars.
+      old_chef_home = ENV["CHEF_HOME"]
+      old_knife_home = ENV["KNIFE_HOME"]
+      old_home = ENV["HOME"]
+      old_wd = Dir.pwd
+      ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
+      # Clear these out because they are cached permanently.
+      ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
+      Chef::Knife::ConfigShow.reset_config_loader!
+      begin
+        ex.run
+      ensure
+        ENV["CHEF_HOME"] = old_chef_home
+        ENV["KNIFE_HOME"] = old_knife_home
+        ENV["HOME"] = old_home
+        Dir.chdir(old_wd)
+        ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+        ChefConfig::PathHelper.per_tool_home_environment = nil
+      end
+    end
+
+    before do
+      # Always run from the temp folder. This can't be in the `around` block above
+      # because it has to run after the before set in the "with a chef repo" shared context.
+      directory("repo")
+      Dir.chdir(path_to("repo"))
+      ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+      ENV["HOME"] = path_to(".")
+    end
+
+    context "with a global knife.rb" do
+      before { file(".chef/knife.rb", "node_name 'one'\n") }
+
+      it { is_expected.to match(%r{^Loading from configuration file .*/#{File.basename(path_to("."))}/.chef/knife.rb$}) }
+      it { is_expected.to match(/^node_name:\s+one$/) }
+    end
+
+    context "with a repo knife.rb" do
+      before { file("repo/.chef/knife.rb", "node_name 'two'\n") }
+
+      it { is_expected.to match(%r{^Loading from configuration file .*/#{File.basename(path_to("."))}/repo/.chef/knife.rb$}) }
+      it { is_expected.to match(/^node_name:\s+two$/) }
+    end
+
+    context "with both knife.rb" do
+      before do
+        file(".chef/knife.rb", "node_name 'one'\n")
+        file("repo/.chef/knife.rb", "node_name 'two'\n")
+      end
+
+      it { is_expected.to match(%r{^Loading from configuration file .*/#{File.basename(path_to("."))}/repo/.chef/knife.rb$}) }
+      it { is_expected.to match(/^node_name:\s+two$/) }
+    end
+
+    context "with a credentials file" do
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { is_expected.to match(%r{^Loading from credentials file .*/#{File.basename(path_to("."))}/.chef/credentials$}) }
+      it { is_expected.to match(/^node_name:\s+three$/) }
+    end
+
+    context "with a credentials file and knife.rb" do
+      before do
+        file(".chef/knife.rb", "node_name 'one'\n")
+        file(".chef/credentials", "[default]\nclient_name = \"three\"\n")
+      end
+
+      it { is_expected.to match(%r{^Loading from configuration file .*/#{File.basename(path_to("."))}/.chef/knife.rb$}) }
+      it { is_expected.to match(%r{^Loading from credentials file .*/#{File.basename(path_to("."))}/.chef/credentials$}) }
+      it { is_expected.to match(/^node_name:\s+one$/) }
+    end
+
+    context "with a config dot d files" do
+      before { file(".chef/config.d/abc.rb", "node_name 'one'\n") }
+
+      it { is_expected.to match(%r{^Loading from .d/ configuration file .*/#{File.basename(path_to("."))}/.chef/config.d/abc.rb$}) }
+      it { is_expected.to match(/^node_name:\s+one$/) }
+    end
+
+    context "with a credentials file and CHEF_HOME" do
+      before do
+        file(".chef/credentials", "[default]\nclient_name = \"three\"\n")
+        file("foo/.chef/credentials", "[default]\nclient_name = \"four\"\n")
+        ENV["CHEF_HOME"] = path_to("foo")
+      end
+
+      it { is_expected.to match(%r{^Loading from credentials file .*/#{File.basename(path_to("."))}/foo/.chef/credentials$}) }
+      it { is_expected.to match(/^node_name:\s+four$/) }
+    end
+
+    context "with a credentials file and KNIFE_HOME" do
+      before do
+        file(".chef/credentials", "[default]\nclient_name = \"three\"\n")
+        file("bar/.chef/credentials", "[default]\nclient_name = \"four\"\n")
+        ENV["KNIFE_HOME"] = path_to("bar")
+      end
+
+      it { is_expected.to match(%r{^Loading from credentials file .*/#{File.basename(path_to("."))}/bar/.chef/credentials$}) }
+      it { is_expected.to match(/^node_name:\s+four$/) }
+    end
+
+    context "with single argument" do
+      let(:cmd_args) { %w{node_name} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { is_expected.to match(/^node_name:\s+three\Z/) }
+    end
+
+    context "with two arguments" do
+      let(:cmd_args) { %w{node_name client_key} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\nclient_key = \"three.pem\"") }
+
+      it { is_expected.to match(%r{^client_key:\s+\S*/.chef/three.pem\nnode_name:\s+three\Z}) }
+    end
+
+    context "with a dotted argument" do
+      let(:cmd_args) { %w{knife.ssh_user} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n[default.knife]\nssh_user = \"foo\"\n") }
+
+      it { is_expected.to match(/^knife.ssh_user:\s+foo\Z/) }
+    end
+
+    context "with regex argument" do
+      let(:cmd_args) { %w{/name/} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { is_expected.to match(/^node_name:\s+three\Z/) }
+    end
+
+    context "with --all" do
+      let(:cmd_args) { %w{-a /key_contents/} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { is_expected.to match(/^client_key_contents:\s+\nvalidation_key_contents:\s+\Z/) }
+    end
+
+    context "with --raw" do
+      let(:cmd_args) { %w{-r node_name} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { is_expected.to eq("three\n") }
+    end
+
+    context "with --format=json" do
+      let(:cmd_args) { %w{--format=json node_name} }
+      before { file(".chef/credentials", "[default]\nclient_name = \"three\"\n") }
+
+      it { expect(JSON.parse(subject)).to eq({ "node_name" => "three" }) }
+    end
+  end
+end

data/spec/integration/config_use_spec.rb

@@ -0,0 +1,198 @@
+#
+# Copyright 2018, Noah Kantrowitz
+#
+# 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 "support/shared/integration/integration_helper"
+require "support/shared/context/config"
+
+describe "knife config use", :workstation do
+  include IntegrationSupport
+  include KnifeSupport
+
+  include_context "default config options"
+
+  let(:cmd_args) { [] }
+
+  when_the_repository("has a custom env") do
+    let(:knife_use) do
+      knife("config", "use", *cmd_args, instance_filter: lambda { |instance|
+        # Fake the failsafe check because this command doesn't actually process knife.rb.
+        $__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
+        allow(File).to receive(:file?).and_call_original
+      })
+    end
+
+    subject { knife_use.stdout }
+
+    around do |ex|
+      # Store and reset the value of some env vars.
+      old_chef_home = ENV["CHEF_HOME"]
+      old_knife_home = ENV["KNIFE_HOME"]
+      old_home = ENV["HOME"]
+      old_wd = Dir.pwd
+      ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
+      # Clear these out because they are cached permanently.
+      ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
+      Chef::Knife::ConfigUse.reset_config_loader!
+      begin
+        ex.run
+      ensure
+        ENV["CHEF_HOME"] = old_chef_home
+        ENV["KNIFE_HOME"] = old_knife_home
+        ENV["HOME"] = old_home
+        Dir.chdir(old_wd)
+        ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+        ChefConfig::PathHelper.per_tool_home_environment = nil
+      end
+    end
+
+    before do
+      # Always run from the temp folder. This can't be in the `around` block above
+      # because it has to run after the before set in the "with a chef repo" shared context.
+      directory("repo")
+      Dir.chdir(path_to("repo"))
+      ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
+      ENV["HOME"] = path_to(".")
+    end
+
+    context "with no argument" do
+      context "with no configuration" do
+        it { is_expected.to eq "default\n" }
+      end
+
+      context "with --profile" do
+        let(:cmd_args) { %w{--profile production} }
+        it { is_expected.to eq "production\n" }
+      end
+
+      context "with an environment variable" do
+        around do |ex|
+          old_chef_profile = ENV["CHEF_PROFILE"]
+          begin
+            ENV["CHEF_PROFILE"] = "staging"
+            ex.run
+          ensure
+            ENV["CHEF_PROFILE"] = old_chef_profile
+          end
+        end
+
+        it { is_expected.to eq "staging\n" }
+      end
+
+      context "with a context file" do
+        before { file(".chef/context", "development\n") }
+        it { is_expected.to eq "development\n" }
+      end
+
+      context "with a context file under $CHEF_HOME" do
+        before do
+          file("chefhome/.chef/context", "other\n")
+          ENV["CHEF_HOME"] = path_to("chefhome")
+        end
+
+        it { is_expected.to eq "other\n" }
+      end
+
+      context "with a context file under $KNIFE_HOME" do
+        before do
+          file("knifehome/.chef/context", "other\n")
+          ENV["KNIFE_HOME"] = path_to("knifehome")
+        end
+
+        it { is_expected.to eq "other\n" }
+      end
+    end
+
+    context "with an argument" do
+      let(:cmd_args) { %w{production} }
+      before { file(".chef/credentials", <<~EOH) }
+        [production]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      it do
+        is_expected.to eq "Set default profile to production\n"
+        expect(File.read(path_to(".chef/context"))).to eq "production\n"
+      end
+    end
+
+    context "with no credentials file" do
+      let(:cmd_args) { %w{production} }
+      subject { knife_use.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
+    end
+
+    context "with an empty credentials file" do
+      let(:cmd_args) { %w{production} }
+      before { file(".chef/credentials", "") }
+      subject { knife_use.stderr }
+      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
+    end
+
+    context "with an wrong argument" do
+      let(:cmd_args) { %w{staging} }
+      before { file(".chef/credentials", <<~EOH) }
+        [production]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+      EOH
+      subject { knife_use }
+      it { expect { subject }.to raise_error ChefConfig::ConfigurationError, "Profile staging doesn't exist. Please add it to #{path_to(".chef/credentials")} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles." }
+    end
+
+    context "with $CHEF_HOME" do
+      let(:cmd_args) { %w{staging} }
+      before do
+        ENV["CHEF_HOME"] = path_to("chefhome"); file("chefhome/tmp", "")
+        file("chefhome/.chef/credentials", <<~EOH
+        [staging]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+        EOH
+        )
+      end
+
+      it do
+        is_expected.to eq "Set default profile to staging\n"
+        expect(File.read(path_to("chefhome/.chef/context"))).to eq "staging\n"
+        expect(File.exist?(path_to(".chef/context"))).to be_falsey
+      end
+    end
+
+    context "with $KNIFE_HOME" do
+      let(:cmd_args) { %w{development} }
+
+      before do
+        ENV["KNIFE_HOME"] = path_to("knifehome"); file("knifehome/tmp", "")
+        file("knifehome/.chef/credentials", <<~EOH
+        [development]
+        client_name = "testuser"
+        client_key = "testkey.pem"
+        chef_server_url = "https://example.com/organizations/testorg"
+        EOH
+        )
+      end
+
+      it do
+        is_expected.to eq "Set default profile to development\n"
+        expect(File.read(path_to("knifehome/.chef/context"))).to eq "development\n"
+        expect(File.exist?(path_to(".chef/context"))).to be_falsey
+      end
+    end
+  end
+end

data/spec/integration/cookbook_api_ipv6_spec.rb

@@ -0,0 +1,113 @@
+#
+# 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 "knife_spec_helper"
+require "support/shared/integration/integration_helper"
+require "chef/mixin/shell_out"
+
+describe "Knife cookbook API integration with IPv6", :workstation, :not_supported_on_gce do
+  include IntegrationSupport
+  include Chef::Mixin::ShellOut
+
+  when_the_chef_server "is bound to IPv6" do
+    let(:chef_zero_opts) { { host: "::1" } }
+
+    let(:client_key) do
+      <<~END_VALIDATION_PEM
+        -----BEGIN RSA PRIVATE KEY-----
+        MIIEogIBAAKCAQEApubutqtYYQ5UiA9QhWP7UvSmsfHsAoPKEVVPdVW/e8Svwpyf
+        0Xef6OFWVmBE+W442ZjLOe2y6p2nSnaq4y7dg99NFz6X+16mcKiCbj0RCiGqCvCk
+        NftHhTgO9/RFvCbmKZ1RKNob1YzLrFpxBHaSh9po+DGWhApcd+I+op+ZzvDgXhNn
+        0nauZu3rZmApI/r7EEAOjFedAXs7VPNXhhtZAiLSAVIrwU3ZajtSzgXOxbNzgj5O
+        AAAMmThK+71qPdffAdO4J198H6/MY04qgtFo7vumzCq0UCaGZfmeI1UNE4+xQWwP
+        HJ3pDAP61C6Ebx2snI2kAd9QMx9Y78nIedRHPwIDAQABAoIBAHssRtPM1GacWsom
+        8zfeN6ZbI4KDlbetZz0vhnqDk9NVrpijWlcOP5dwZXVNitnB/HaqCqFvyPDY9JNB
+        zI/pEFW4QH59FVDP42mVEt0keCTP/1wfiDDGh1vLqVBYl/ZphscDcNgDTzNkuxMx
+        k+LFVxKnn3w7rGc59lALSkpeGvbbIDjp3LUMlUeCF8CIFyYZh9ZvXe4OCxYdyjxb
+        i8tnMLKvJ4Psbh5jMapsu3rHQkfPdqzztQUz8vs0NYwP5vWge46FUyk+WNm/IhbJ
+        G3YM22nwUS8Eu2bmTtADSJolATbCSkOwQ1D+Fybz/4obfYeGaCdOqB05ttubhenV
+        ShsAb7ECgYEA20ecRVxw2S7qA7sqJ4NuYOg9TpfGooptYNA1IP971eB6SaGAelEL
+        awYkGNuu2URmm5ElZpwJFFTDLGA7t2zB2xI1FeySPPIVPvJGSiZoFQOVlIg9WQzK
+        7jTtFQ/tOMrF+bigEUJh5bP1/7HzqSpuOsPjEUb2aoCTp+tpiRGL7TUCgYEAwtns
+        g3ysrSEcTzpSv7fQRJRk1lkBhatgNd0oc+ikzf74DaVLhBg1jvSThDhiDCdB59mr
+        Jh41cnR1XqE8jmdQbCDRiFrI1Pq6TPaDZFcovDVE1gue9x86v3FOH2ukPG4d2/Xy
+        HevXjThtpMMsWFi0JYXuzXuV5HOvLZiP8sN3lSMCgYANpdxdGM7RRbE9ADY0dWK2
+        V14ReTLcxP7fyrWz0xLzEeCqmomzkz3BsIUoouu0DCTSw+rvAwExqcDoDylIVlWO
+        fAifz7SeZHbcDxo+3TsXK7zwnLYsx7YNs2+aIv6hzUUbMNmNmXMcZ+IEwx+mRMTN
+        lYmZdrA5mr0V83oDFPt/jQKBgC74RVE03pMlZiObFZNtheDiPKSG9Bz6wMh7NWMr
+        c37MtZLkg52mEFMTlfPLe6ceV37CM8WOhqe+dwSGrYhOU06dYqUR7VOZ1Qr0aZvo
+        fsNPu/Y0+u7rMkgv0fs1AXQnvz7kvKaF0YITVirfeXMafuKEtJoH7owRbur42cpV
+        YCAtAoGAP1rHOc+w0RUcBK3sY7aErrih0OPh9U5bvJsrw1C0FIZhCEoDVA+fNIQL
+        syHLXYFNy0OxMtH/bBAXBGNHd9gf5uOnqh0pYcbe/uRAxumC7Rl0cL509eURiA2T
+        +vFmf54y9YdnLXaqv+FhJT6B6V7WX7IpU9BMqJY1cJYXHuHG2KA=
+        -----END RSA PRIVATE KEY-----
+      END_VALIDATION_PEM
+    end
+
+    let(:cache_path) do
+      Dir.mktmpdir
+    end
+
+    let(:chef_dir) { File.join(__dir__, "..", "..", "..", "knife", "bin") }
+    let(:knife) { "ruby '#{chef_dir}/knife'" }
+
+    let(:knife_config_flag) { "-c '#{path_to("config/knife.rb")}'" }
+
+    # Some Solaris test platforms are too old for IPv6. These tests should not
+    # otherwise be platform dependent, so exclude solaris
+    context "and the chef_server_url contains an IPv6 literal", :not_supported_on_solaris do
+
+      # This provides helper functions we need such as #path_to()
+      when_the_repository "has the cookbook to be uploaded" do
+
+        let(:knife_rb_content) do
+          <<~END_CLIENT_RB
+            chef_server_url "http://[::1]:8900"
+            syntax_check_cache_path '#{cache_path}'
+            client_key '#{path_to("config/knifeuser.pem")}'
+            node_name 'whoisthisis'
+            cookbook_path '#{CHEF_SPEC_DATA}/cookbooks'
+          END_CLIENT_RB
+        end
+
+        before do
+          file "config/knife.rb", knife_rb_content
+          file "config/knifeuser.pem", client_key
+        end
+
+        it "successfully uploads a cookbook" do
+          shell_out!("#{knife} cookbook upload apache2 #{knife_config_flag}", cwd: chef_dir)
+          versions_list_json = Chef::HTTP::Simple.new("http://[::1]:8900").get("/cookbooks/apache2", "accept" => "application/json")
+          versions_list = Chef::JSONCompat.from_json(versions_list_json)
+          expect(versions_list["apache2"]["versions"]).not_to be_empty
+        end
+
+        context "and the cookbook has been uploaded to the server" do
+          before do
+            shell_out!("#{knife} cookbook upload apache2 #{knife_config_flag}", cwd: chef_dir)
+          end
+
+          it "downloads the cookbook" do
+            shell_out!("#{knife} cookbook download apache2 #{knife_config_flag} -d #{cache_path}", cwd: chef_dir)
+            expect(Dir["#{cache_path}/*"].map { |entry| File.basename(entry) }).to include("apache2-0.0.1")
+          end
+        end
+
+      end
+    end
+  end
+end