chef 16.16.13 → 17.0.242

data/spec/integration/knife/config_list_spec.rb

@@ -1,220 +0,0 @@
-#
-# 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 "spec_helper"
-require "support/shared/integration/integration_helper"
-require "support/shared/context/config"
-
-describe "knife config list", :workstation do
-  include IntegrationSupport
-  include KnifeSupport
-
-  include_context "default config options"
-
-  when_the_repository("has a custom env") do
-    let(:cmd_args) { [] }
-    let(:knife_list) do
-      knife("config", "list", *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_list.stdout }
-
-    around do |ex|
-      # Store and reset the value of some env vars.
-      old_home = ENV["HOME"]
-      old_wd = Dir.pwd
-      # Clear these out because they are cached permanently.
-      ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
-      Chef::Knife::ConfigList.reset_config_loader!
-      begin
-        ex.run
-      ensure
-        ENV["HOME"] = old_home
-        Dir.chdir(old_wd)
-        ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
-      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(".")
-      allow(TTY::Screen).to receive(:width).and_return(200)
-    end
-
-    # NOTE: The funky formatting with # at the end of the line of some of the
-    # output examples are because of how the format strings are built, there is
-    # substantial trailing whitespace in most cases which many editors "helpfully" remove.
-
-    context "with no credentials file" do
-      subject { knife_list.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
-      before { file(".chef/credentials", "") }
-      subject { knife_list.stderr }
-      it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
-    end
-
-    context "with a simple default profile" do
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to eq <<~EOH.delete("#") }
-         Profile  Client    Key                  Server                                    #
-        --------------------------------------------------------------------------------#
-        *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg #
-      EOH
-    end
-
-    context "with multiple profiles" do
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-
-        [prod]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/prod"
-
-        [qa]
-        client_name = "qauser"
-        client_key = "~/src/qauser.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to eq <<~EOH.delete("#") }
-         Profile  Client    Key                  Server                                    #
-        --------------------------------------------------------------------------------#
-        *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg #
-         prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod    #
-         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg #
-      EOH
-    end
-
-    context "with a non-default active profile" do
-      let(:cmd_args) { %w{--profile prod} }
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-
-        [prod]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/prod"
-
-        [qa]
-        client_name = "qauser"
-        client_key = "~/src/qauser.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to eq <<~EOH.delete("#") }
-         Profile  Client    Key                  Server                                    #
-        --------------------------------------------------------------------------------#
-         default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg #
-        *prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod    #
-         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg #
-      EOH
-    end
-
-    context "with a bad profile as an active profile" do
-      let(:cmd_args) { %w{--profile production} }
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-
-        [prod]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/prod"
-
-        [qa]
-        client_name = "qauser"
-        client_key = "~/src/qauser.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to eq <<~EOH.delete("#") }
-         Profile  Client    Key                  Server                                    #
-        --------------------------------------------------------------------------------#
-         default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg #
-         prod     testuser  ~/.chef/testkey.pem  https://example.com/organizations/prod    #
-         qa       qauser    ~/src/qauser.pem     https://example.com/organizations/testorg #
-      EOH
-    end
-
-    context "with a minimal profile" do
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to match %r{^*default .*? https://example.com/organizations/testorg} }
-    end
-
-    context "with -i" do
-      let(:cmd_args) { %w{-i} }
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it { is_expected.to eq <<~EOH.delete("#") }
-         Profile  Client  Key  Server                                    #
-        --------------------------------------------------------------#
-        *default               https://example.com/organizations/testorg #
-      EOH
-    end
-
-    context "with --format=json" do
-      let(:cmd_args) { %w{--format=json node_name} }
-      before { file(".chef/credentials", <<~EOH) }
-        [default]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-
-        [prod]
-        client_name = "testuser"
-        client_key = "testkey.pem"
-        chef_server_url = "https://example.com/organizations/prod"
-
-        [qa]
-        client_name = "qauser"
-        client_key = "~/src/qauser.pem"
-        chef_server_url = "https://example.com/organizations/testorg"
-      EOH
-      it {
-        expect(JSON.parse(subject)).to eq [
-        { "profile" => "default", "active" => true, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/testorg" },
-        { "profile" => "prod", "active" => false, "client_name" => "testuser", "client_key" => path_to(".chef/testkey.pem"), "server_url" => "https://example.com/organizations/prod" },
-        { "profile" => "qa", "active" => false, "client_name" => "qauser", "client_key" => path_to("src/qauser.pem"), "server_url" => "https://example.com/organizations/testorg" },
-      ]
-      }
-    end
-  end
-end

data/spec/integration/knife/config_show_spec.rb

@@ -1,192 +0,0 @@
-#
-# 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 "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/knife/config_use_spec.rb

@@ -1,198 +0,0 @@
-#
-# 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 "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