chef 16.4.35 → 16.6.14

data/spec/functional/version_spec.rb

@@ -19,13 +19,13 @@ require "spec_helper"
 require "chef/mixin/shell_out"
 require "chef/version"
 require "ohai/version"
-require "chef/dist"
+require "chef-utils/dist"
 
 describe "Chef Versions", :executables do
   include Chef::Mixin::ShellOut
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..") }
+  let(:chef_dir) { File.join(__dir__, "..", "..") }
 
-  binaries = [ Chef::Dist::CLIENT, "chef-shell", "chef-apply", "knife", Chef::Dist::SOLOEXEC ]
+  binaries = [ ChefUtils::Dist::Infra::CLIENT, "chef-shell", "chef-apply", "knife", ChefUtils::Dist::Solo::EXEC ]
 
   binaries.each do |binary|
     it "#{binary} version should be sane" do

data/spec/integration/client/client_spec.rb

@@ -3,7 +3,7 @@ require "support/shared/integration/integration_helper"
 require "chef/mixin/shell_out"
 require "tiny_server"
 require "tmpdir"
-require "chef/dist"
+require "chef-utils/dist"
 
 describe "chef-client" do
 
@@ -34,7 +34,7 @@ describe "chef-client" do
   include IntegrationSupport
   include Chef::Mixin::ShellOut
 
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..", "bin") }
+  let(:chef_dir) { File.join(__dir__, "..", "..", "..", "bin") }
 
   # Invoke `chef-client` as `ruby PATH/TO/chef-client`. This ensures the
   # following constraints are satisfied:
@@ -45,8 +45,8 @@ describe "chef-client" do
   # machine that has omnibus chef installed. In that case we need to ensure
   # we're running `chef-client` from the source tree and not the external one.
   # cf. CHEF-4914
-  let(:chef_client) { "bundle exec #{Chef::Dist::CLIENT} --minimal-ohai" }
-  let(:chef_solo) { "bundle exec #{Chef::Dist::SOLOEXEC} --legacy-mode --minimal-ohai" }
+  let(:chef_client) { "bundle exec #{ChefUtils::Dist::Infra::CLIENT} --minimal-ohai" }
+  let(:chef_solo) { "bundle exec #{ChefUtils::Dist::Solo::EXEC} --legacy-mode --minimal-ohai" }
 
   when_the_repository "has a cookbook with a no-op recipe" do
     before { file "cookbooks/x/recipes/default.rb", "" }

data/spec/integration/client/exit_code_spec.rb

@@ -5,13 +5,14 @@ require "chef/mixin/shell_out"
 require "tiny_server"
 require "tmpdir"
 require "chef/platform"
+require "chef-utils/dist"
 
 describe "chef-client" do
 
   include IntegrationSupport
   include Chef::Mixin::ShellOut
 
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..", "bin") }
+  let(:chef_dir) { File.join(__dir__, "..", "..", "..", "bin") }
 
   # Invoke `chef-client` as `ruby PATH/TO/chef-client`. This ensures the
   # following constraints are satisfied:
@@ -22,7 +23,7 @@ describe "chef-client" do
   # machine that has omnibus chef installed. In that case we need to ensure
   # we're running `chef-client` from the source tree and not the external one.
   # cf. CHEF-4914
-  let(:chef_client) { "bundle exec #{Chef::Dist::CLIENT} --no-fork --minimal-ohai" }
+  let(:chef_client) { "bundle exec #{ChefUtils::Dist::Infra::CLIENT} --no-fork --minimal-ohai" }
 
   let(:critical_env_vars) { %w{PATH RUBYOPT BUNDLE_GEMFILE GEM_PATH}.map { |o| "#{o}=#{ENV[o]}" } .join(" ") }
 

data/spec/integration/client/ipv6_spec.rb

@@ -74,7 +74,7 @@ describe "chef-client" do
     basic_config_file
   end
 
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..", "bin") }
+  let(:chef_dir) { File.join(__dir__, "..", "..", "..", "bin") }
 
   let(:chef_client_cmd) { %Q{bundle exec chef-client --minimal-ohai -c "#{path_to("config/client.rb")}" -lwarn} }
 

data/spec/integration/knife/{config_list_profiles_spec.rb → config_list_spec.rb}

@@ -17,7 +17,7 @@ require "spec_helper"
 require "support/shared/integration/integration_helper"
 require "support/shared/context/config"
 
-describe "knife config list-profiles", :workstation do
+describe "knife config list", :workstation do
   include IntegrationSupport
   include KnifeSupport
 
@@ -25,14 +25,14 @@ describe "knife config list-profiles", :workstation do
 
   when_the_repository("has a custom env") do
     let(:cmd_args) { [] }
-    let(:knife_list_profiles) do
-      knife("config", "list-profiles", *cmd_args, instance_filter: lambda { |instance|
+    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_profiles.stdout }
+    subject { knife_list.stdout }
 
     around do |ex|
       # Store and reset the value of some env vars.
@@ -40,7 +40,7 @@ describe "knife config list-profiles", :workstation do
       old_wd = Dir.pwd
       # Clear these out because they are cached permanently.
       ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
-      Chef::Knife::ConfigListProfiles.reset_config_loader!
+      Chef::Knife::ConfigList.reset_config_loader!
       begin
         ex.run
       ensure
@@ -57,6 +57,7 @@ describe "knife config list-profiles", :workstation do
       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
@@ -64,13 +65,13 @@ describe "knife config list-profiles", :workstation do
     # substantial trailing whitespace in most cases which many editors "helpfully" remove.
 
     context "with no credentials file" do
-      subject { knife_list_profiles.stderr }
+      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_profiles.stderr }
+      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
 
@@ -82,9 +83,9 @@ describe "knife config list-profiles", :workstation do
         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#
+         Profile  Client    Key                  Server                                    #
+        --------------------------------------------------------------------------------#
+        *default  testuser  ~/.chef/testkey.pem  https://example.com/organizations/testorg #
       EOH
     end
 
@@ -106,11 +107,11 @@ describe "knife config list-profiles", :workstation do
         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#
+         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
 
@@ -133,11 +134,11 @@ describe "knife config list-profiles", :workstation do
         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#
+         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
 
@@ -160,11 +161,11 @@ describe "knife config list-profiles", :workstation do
         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#
+         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
 
@@ -173,7 +174,7 @@ describe "knife config list-profiles", :workstation do
         [default]
         chef_server_url = "https://example.com/organizations/testorg"
       EOH
-      it { is_expected.to match %r{^*default .*? https://example.com/organizations/testorg$} }
+      it { is_expected.to match %r{^*default .*? https://example.com/organizations/testorg} }
     end
 
     context "with -i" do
@@ -183,9 +184,9 @@ describe "knife config list-profiles", :workstation do
         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#
+         Profile  Client  Key  Server                                    #
+        --------------------------------------------------------------#
+        *default               https://example.com/organizations/testorg #
       EOH
     end
 

data/spec/integration/knife/{config_get_spec.rb → config_show_spec.rb}

@@ -17,7 +17,7 @@ require "spec_helper"
 require "support/shared/integration/integration_helper"
 require "support/shared/context/config"
 
-describe "knife config get", :workstation do
+describe "knife config show", :workstation do
   include IntegrationSupport
   include KnifeSupport
 
@@ -27,7 +27,7 @@ describe "knife config get", :workstation do
 
   when_the_repository("has a custom env") do
     subject do
-      cmd = knife("config", "get", *cmd_args, instance_filter: lambda { |instance|
+      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
@@ -47,7 +47,7 @@ describe "knife config get", :workstation do
       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::ConfigGet.reset_config_loader!
+      Chef::Knife::ConfigShow.reset_config_loader!
       begin
         ex.run
       ensure

data/spec/integration/knife/{config_use_profile_spec.rb → config_use_spec.rb}

@@ -17,7 +17,7 @@ require "spec_helper"
 require "support/shared/integration/integration_helper"
 require "support/shared/context/config"
 
-describe "knife config use-profile", :workstation do
+describe "knife config use", :workstation do
   include IntegrationSupport
   include KnifeSupport
 
@@ -26,15 +26,15 @@ describe "knife config use-profile", :workstation do
   let(:cmd_args) { [] }
 
   when_the_repository("has a custom env") do
-    let(:knife_use_profile) do
-      knife("config", "use-profile", *cmd_args, instance_filter: lambda { |instance|
+    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_profile.stdout }
+    subject { knife_use.stdout }
 
     around do |ex|
       # Store and reset the value of some env vars.
@@ -45,7 +45,7 @@ describe "knife config use-profile", :workstation do
       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::ConfigUseProfile.reset_config_loader!
+      Chef::Knife::ConfigUse.reset_config_loader!
       begin
         ex.run
       ensure
@@ -68,8 +68,51 @@ describe "knife config use-profile", :workstation do
     end
 
     context "with no argument" do
-      subject { knife_use_profile.stderr }
-      it { is_expected.to eq "FATAL: You must specify a profile\n" }
+      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
@@ -88,14 +131,14 @@ describe "knife config use-profile", :workstation do
 
     context "with no credentials file" do
       let(:cmd_args) { %w{production} }
-      subject { knife_use_profile.stderr }
+      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_profile.stderr }
+      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
 
@@ -107,7 +150,7 @@ describe "knife config use-profile", :workstation do
         client_key = "testkey.pem"
         chef_server_url = "https://example.com/organizations/testorg"
       EOH
-      subject { knife_use_profile }
+      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
 

data/spec/integration/knife/cookbook_api_ipv6_spec.rb

@@ -62,7 +62,7 @@ describe "Knife cookbook API integration with IPv6", :workstation, :not_supporte
       Dir.mktmpdir
     end
 
-    let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..", "bin") }
+    let(:chef_dir) { File.join(__dir__, "..", "..", "..", "bin") }
     let(:knife) { "ruby '#{chef_dir}/knife'" }
 
     let(:knife_config_flag) { "-c '#{path_to("config/knife.rb")}'" }

data/spec/integration/ohai/ohai_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+require "chef/mixin/shell_out"
+require "benchmark" unless defined?(Benchmark)
+
+describe "ohai" do
+  include Chef::Mixin::ShellOut
+
+  let(:ohai) { "bundle exec ohai" }
+
+  describe "testing ohai performance" do
+    # The purpose of this test is to generally find misconfigured DNS on
+    # CI testers.  If this fails, it is probably because the forward+reverse
+    # DNS lookup that node[:hostname] needs is timing out and failing.
+    #
+    # If it is failing spuriously, it may mean DNS is failing spuriously, the
+    # best solution will be to make sure that `hostname -f`-like behavior hits
+    # /etc/hosts and not DNS.
+    #
+    # If it still fails supriously, it is possible that the server has high
+    # CPU load (e.g. due to background processes) which are contending with the
+    # running tests (disable the screensaver on servers, stop playing Fortnite
+    # while you're running tests, etc).
+    #
+    # If this just fails due to I/O being very slow and ruby being very slow to
+    # startup then that still indicates that the tester configuration needs
+    # fixing.  The fact that this will fail on a windows box on a virt that doesn't
+    # use an SSD is because we have a higher bar for the tests to run successfully
+    # and that configuration is broken, so this test is red for a reason.
+    #
+    # This will probably fail on raspberry pi's or something like that as well.  That
+    # is not a bug.  We will never accept a raspberry pi as a CI tester for our
+    # software.  Feel free to manually delete and thereby skip this file in your
+    # own testing harness, but that is not our concern, we are testing behavior
+    # that is critical to our infrastructure and must run in our tests.
+    #
+    # XXX: unfortunately this is so slow on our windows testers (~9 seconds on one
+    # tester) that we can't enable it for windows unless we get some better perf there.
+    #
+    it "the hostname plugin must return in under 4 seconds (see comments in code)" do
+      # unfortunately this doesn't look stable enough to enable
+      skip "we need to do more performance work on windows and s390x testers before this can be enabled"
+      delta = Benchmark.realtime do
+        shell_out!("#{ohai} hostname")
+      end
+      expect(delta).to be < 4
+    end
+
+    # The purpose of this is to give some indication of if shell_out is slow or
+    # if the hostname plugin itself is slow.  If this test is also failing that we
+    # almost certainly have some kind of issue with DNS timeouts, etc.  If this
+    # test succeeds and the other one fails, then it can be some kind of shelling-out
+    # issue or poor performance due to I/O on starting up ruby to run ohai, etc.
+    #
+    it "the hostname plugin must return in under 2 seconds when called from pure ruby" do
+      delta = Benchmark.realtime do
+        Ohai::System.new.all_plugins(["hostname"])
+      end
+      expect(delta).to be < 2
+    end
+  end
+end

data/spec/integration/recipes/remote_directory.rb

@@ -5,7 +5,7 @@ describe Chef::Resource::RemoteDirectory do
   include Chef::Mixin::ShellOut
 
   # Until Cheffish::RSpec has cookbook support, we have to run the whole client
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..", "bin") }
+  let(:chef_dir) { File.join(__dir__, "..", "..", "..", "bin") }
 
   # Invoke `chef-client` as `ruby PATH/TO/chef-client`. This ensures the
   # following constraints are satisfied:

data/spec/integration/solo/solo_spec.rb

@@ -5,20 +5,20 @@ require "chef/run_lock"
 require "chef/config"
 require "timeout"
 require "fileutils"
+require "chef-utils"
 require "chef/win32/security" if ChefUtils.windows?
-require "chef/dist"
 
-describe Chef::Dist::SOLOEXEC do
+describe ChefUtils::Dist::Solo::EXEC do
   include IntegrationSupport
   include Chef::Mixin::ShellOut
 
-  let(:chef_dir) { File.join(File.dirname(__FILE__), "..", "..", "..") }
+  let(:chef_dir) { File.join(__dir__, "..", "..", "..") }
 
   let(:cookbook_x_100_metadata_rb) { cb_metadata("x", "1.0.0") }
 
   let(:cookbook_ancient_100_metadata_rb) { cb_metadata("ancient", "1.0.0") }
 
-  let(:chef_solo) { "bundle exec #{Chef::Dist::SOLOEXEC} --legacy-mode --minimal-ohai" }
+  let(:chef_solo) { "bundle exec #{ChefUtils::Dist::Solo::EXEC} --legacy-mode --minimal-ohai" }
 
   when_the_repository "creates nodes" do
     let(:nodes_dir) { File.join(@repository_dir, "nodes") }
@@ -183,7 +183,7 @@ describe Chef::Dist::SOLOEXEC do
       # run_lock gets stuck we can discover it.
       expect do
         Timeout.timeout(120) do
-          chef_dir = File.join(File.dirname(__FILE__), "..", "..", "..")
+          chef_dir = File.join(__dir__, "..", "..", "..")
 
           threads = []