chef 12.10.24 → 12.11.18

data/spec/unit/application/exit_code_spec.rb

@@ -0,0 +1,231 @@
+#
+# Author:: Steven Murawski (<smurawski@chef.io>)
+# Copyright:: Copyright 2016, 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 "chef"
+require "spec_helper"
+
+require "chef/application/exit_code"
+
+describe Chef::Application::ExitCode do
+
+  let(:exit_codes) { Chef::Application::ExitCode }
+
+  let(:valid_rfc_exit_codes) { Chef::Application::ExitCode::VALID_RFC_062_EXIT_CODES.values }
+
+  context "Validates the return codes from RFC 062" do
+
+    before do
+      allow(Chef::Config).to receive(:[]).with(:exit_status).and_return(:enabled)
+    end
+
+    it "validates a SUCCESS return code of 0" do
+      expect(valid_rfc_exit_codes.include?(0)).to eq(true)
+    end
+
+    it "validates a GENERIC_FAILURE return code of 1" do
+      expect(valid_rfc_exit_codes.include?(1)).to eq(true)
+    end
+
+    it "validates a SIGINT_RECEIVED return code of 2" do
+      expect(valid_rfc_exit_codes.include?(2)).to eq(true)
+    end
+
+    it "validates a SIGTERM_RECEIVED return code of 3" do
+      expect(valid_rfc_exit_codes.include?(3)).to eq(true)
+    end
+
+    it "validates a AUDIT_MODE_FAILURE return code of 42" do
+      expect(valid_rfc_exit_codes.include?(42)).to eq(true)
+    end
+
+    it "validates a REBOOT_SCHEDULED return code of 35" do
+      expect(valid_rfc_exit_codes.include?(35)).to eq(true)
+    end
+
+    it "validates a REBOOT_NEEDED return code of 37" do
+      expect(valid_rfc_exit_codes.include?(37)).to eq(true)
+    end
+
+    it "validates a REBOOT_FAILED return code of 41" do
+      expect(valid_rfc_exit_codes.include?(41)).to eq(true)
+    end
+  end
+
+  context "when Chef::Config :exit_status is not configured" do
+    before do
+      allow(Chef::Config).to receive(:[]).with(:exit_status).and_return(nil)
+      allow(Chef::Config).to receive(:[]).with(:treat_deprecation_warnings_as_errors).and_return(false)
+    end
+
+    it "writes a deprecation warning" do
+      warn = "Chef RFC 062 (https://github.com/chef/chef-rfc/master/rfc062-exit-status.md) defines the" \
+      " exit codes that should be used with Chef.  Chef::Application::ExitCode defines valid exit codes"  \
+      " In a future release, non-standard exit codes will be redefined as" \
+      " GENERIC_FAILURE unless `exit_status` is set to `:disabled` in your client.rb."
+      expect(Chef).to receive(:log_deprecation).with(warn)
+      expect(exit_codes.normalize_exit_code(151)).to eq(151)
+    end
+
+    it "does not modify non-RFC exit codes" do
+      expect(exit_codes.normalize_exit_code(151)).to eq(151)
+    end
+
+    it "returns DEPRECATED_FAILURE when no exit code is specified" do
+      expect(exit_codes.normalize_exit_code()).to eq(-1)
+    end
+
+    it "returns SIGINT_RECEIVED when a SIGINT is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigInt.new("BOOM"))).to eq(2)
+    end
+
+    it "returns SIGTERM_RECEIVED when a SIGTERM is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigTerm.new("BOOM"))).to eq(3)
+    end
+
+    it "returns SIGINT_RECEIVED when a deprecated exit code error is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::DeprecatedExitCode.new("BOOM"))).to eq(2)
+    end
+
+    it "returns GENERIC_FAILURE when an exception is specified" do
+      expect(exit_codes.normalize_exit_code(Exception.new("BOOM"))).to eq(1)
+    end
+
+  end
+
+  context "when Chef::Config :exit_status is configured to not validate exit codes" do
+    before do
+      allow(Chef::Config).to receive(:[]).with(:exit_status).and_return(:disabled)
+      allow(Chef::Config).to receive(:[]).with(:treat_deprecation_warnings_as_errors).and_return(false)
+    end
+
+    it "does not write a deprecation warning" do
+      warn = "Chef RFC 062 (https://github.com/chef/chef-rfc/master/rfc062-exit-status.md) defines the" \
+      " exit codes that should be used with Chef.  Chef::Application::ExitCode defines valid exit codes"  \
+      " In a future release, non-standard exit codes will be redefined as" \
+      " GENERIC_FAILURE unless `exit_status` is set to `:disabled` in your client.rb."
+      expect(Chef).not_to receive(:log_deprecation).with(warn)
+      expect(exit_codes.normalize_exit_code(151)).to eq(151)
+    end
+
+    it "does not modify non-RFC exit codes" do
+      expect(exit_codes.normalize_exit_code(151)).to eq(151)
+    end
+
+    it "returns DEPRECATED_FAILURE when no exit code is specified" do
+      expect(exit_codes.normalize_exit_code()).to eq(-1)
+    end
+
+    it "returns GENERIC_FAILURE when an exception is specified" do
+      expect(exit_codes.normalize_exit_code(Exception.new("BOOM"))).to eq(1)
+    end
+
+    it "returns SUCCESS when a reboot is pending" do
+      allow(Chef::DSL::RebootPending).to receive(:reboot_pending?).and_return(true)
+      expect(exit_codes.normalize_exit_code(0)).to eq(0)
+    end
+
+    it "returns SIGINT_RECEIVED when a SIGINT is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigInt.new("BOOM"))).to eq(2)
+    end
+
+    it "returns SIGTERM_RECEIVED when a SIGTERM is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigTerm.new("BOOM"))).to eq(3)
+    end
+
+    it "returns SIGINT_RECEIVED when a deprecated exit code error is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::DeprecatedExitCode.new("BOOM"))).to eq(2)
+    end
+  end
+
+  context "when Chef::Config :exit_status is configured to validate exit codes" do
+    before do
+      allow(Chef::Config).to receive(:[]).with(:exit_status).and_return(:enabled)
+      allow(Chef::Config).to receive(:[]).with(:treat_deprecation_warnings_as_errors).and_return(false)
+    end
+
+    it "does write a deprecation warning" do
+      warn = "Chef RFC 062 (https://github.com/chef/chef-rfc/master/rfc062-exit-status.md) defines the" \
+      " exit codes that should be used with Chef.  Chef::Application::ExitCode defines valid exit codes"  \
+      " In a future release, non-standard exit codes will be redefined as" \
+      " GENERIC_FAILURE unless `exit_status` is set to `:disabled` in your client.rb."
+      expect(Chef).to receive(:log_deprecation).with(warn)
+      expect(exit_codes.normalize_exit_code(151)).to eq(1)
+    end
+
+    it "returns a GENERIC_FAILURE for non-RFC exit codes" do
+      expect(exit_codes.normalize_exit_code(151)).to eq(1)
+    end
+
+    it "returns GENERIC_FAILURE when no exit code is specified" do
+      expect(exit_codes.normalize_exit_code()).to eq(1)
+    end
+
+    it "returns SIGINT_RECEIVED when a SIGINT is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigInt.new("BOOM"))).to eq(2)
+    end
+
+    it "returns SIGTERM_RECEIVED when a SIGTERM is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::SigTerm.new("BOOM"))).to eq(3)
+    end
+
+    it "returns GENERIC_FAILURE when a deprecated exit code error is received" do
+      expect(exit_codes.normalize_exit_code(Chef::Exceptions::DeprecatedExitCode.new("BOOM"))).to eq(1)
+    end
+
+    it "returns GENERIC_FAILURE when an exception is specified" do
+      expect(exit_codes.normalize_exit_code(Exception.new("BOOM"))).to eq(1)
+    end
+
+    it "returns AUDIT_MODE_FAILURE when there is an audit error" do
+      audit_error = Chef::Exceptions::AuditError.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(audit_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(42)
+    end
+
+    it "returns REBOOT_SCHEDULED when there is an reboot requested" do
+      reboot_error = Chef::Exceptions::Reboot.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(reboot_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(35)
+    end
+
+    it "returns REBOOT_FAILED when the reboot command fails" do
+      reboot_error = Chef::Exceptions::RebootFailed.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(reboot_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(41)
+    end
+
+    it "returns REBOOT_NEEDED when a reboot is pending" do
+      reboot_error = Chef::Exceptions::RebootPending.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(reboot_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(37)
+    end
+
+    it "returns SIGINT_RECEIVED when a SIGINT is received." do
+      sigint_error = Chef::Exceptions::SigInt.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(sigint_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(2)
+    end
+
+    it "returns SIGTERM_RECEIVED when a SIGTERM is received." do
+      sigterm_error = Chef::Exceptions::SigTerm.new("BOOM")
+      runtime_error = Chef::Exceptions::RunFailedWrappingError.new(sigterm_error)
+      expect(exit_codes.normalize_exit_code(runtime_error)).to eq(3)
+    end
+  end
+
+end

data/spec/unit/application/solo_spec.rb

@@ -30,141 +30,196 @@ describe Chef::Application::Solo do
 
     Chef::Config[:json_attribs] = false
     Chef::Config[:solo] = true
+    Chef::Config[:solo_legacy_mode] = true
 
     # protect the unit tests against accidental --delete-entire-chef-repo from firing
     # for real during tests.  DO NOT delete this line.
     expect(FileUtils).not_to receive(:rm_rf)
   end
 
-  describe "configuring the application" do
-    it "should call set_specific_recipes" do
-      expect(app).to receive(:set_specific_recipes)
-      app.reconfigure
-    end
-
-    it "should set solo mode to true" do
-      app.reconfigure
-      expect(Chef::Config[:solo]).to be_truthy
-    end
+  context "in legacy mode" do
+    describe "configuring the application" do
+      it "should call set_specific_recipes" do
+        expect(app).to receive(:set_specific_recipes)
+        app.reconfigure
+      end
 
-    it "should set audit-mode to :disabled" do
-      app.reconfigure
-      expect(Chef::Config[:audit_mode]).to be :disabled
-    end
+      it "should set solo mode to true" do
+        app.reconfigure
+        expect(Chef::Config[:solo]).to be_truthy
+      end
 
-    describe "when configured to not fork the client process" do
-      before do
-        Chef::Config[:client_fork] = false
-        Chef::Config[:daemonize] = false
-        Chef::Config[:interval] = nil
-        Chef::Config[:splay] = nil
+      it "should set audit-mode to :disabled" do
+        app.reconfigure
+        expect(Chef::Config[:audit_mode]).to be :disabled
       end
 
-      context "when interval is given" do
+      describe "when configured to not fork the client process" do
         before do
-          Chef::Config[:interval] = 600
+          Chef::Config[:client_fork] = false
+          Chef::Config[:daemonize] = false
+          Chef::Config[:interval] = nil
+          Chef::Config[:splay] = nil
         end
 
-        it "should terminate with message" do
-          expect(Chef::Application).to receive(:fatal!).with(
-"Unforked chef-client interval runs are disabled in Chef 12.
+        context "when interval is given" do
+          before do
+            Chef::Config[:interval] = 600
+          end
+
+          it "should terminate with message" do
+            expect(Chef::Application).to receive(:fatal!).with(
+              "Unforked chef-client interval runs are disabled in Chef 12.
 Configuration settings:
   interval  = 600 seconds
 Enable chef-client interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options."
-          )
+            )
+            app.reconfigure
+          end
+        end
+      end
+
+      describe "when in daemonized mode and no interval has been set" do
+        before do
+          Chef::Config[:daemonize] = true
+        end
+
+        it "should set the interval to 1800" do
+          Chef::Config[:interval] = nil
           app.reconfigure
+          expect(Chef::Config[:interval]).to eq(1800)
         end
       end
-    end
 
-    describe "when in daemonized mode and no interval has been set" do
-      before do
-        Chef::Config[:daemonize] = true
+      describe "when the json_attribs configuration option is specified" do
+        let(:json_attribs) { { "a" => "b" } }
+        let(:config_fetcher) { double(Chef::ConfigFetcher, :fetch_json => json_attribs) }
+        let(:json_source) { "https://foo.com/foo.json" }
+
+        before do
+          Chef::Config[:json_attribs] = json_source
+          expect(Chef::ConfigFetcher).to receive(:new).with(json_source).
+            and_return(config_fetcher)
+        end
+
+        it "reads the JSON attributes from the specified source" do
+          app.reconfigure
+          expect(app.chef_client_json).to eq(json_attribs)
+        end
       end
 
-      it "should set the interval to 1800" do
-        Chef::Config[:interval] = nil
+      it "downloads a tarball when the recipe_url configuration option is specified" do
+        Chef::Config[:cookbook_path] = "#{Dir.tmpdir}/chef-solo/cookbooks"
+        Chef::Config[:recipe_url] = "http://junglist.gen.nz/recipes.tgz"
+
+        expect(FileUtils).to receive(:mkdir_p).with("#{Dir.tmpdir}/chef-solo").and_return(true)
+
+        tarfile = StringIO.new("remote_tarball_content")
+        target_file = StringIO.new
+
+        expect(app).to receive(:open).with("http://junglist.gen.nz/recipes.tgz").and_yield(tarfile)
+        expect(File).to receive(:open).with("#{Dir.tmpdir}/chef-solo/recipes.tgz", "wb").and_yield(target_file)
+
+        shellout = instance_double("Mixlib::ShellOut", run_command: nil, error!: nil, stdout: "")
+
+        expect(app).to receive(:shell_out!).with("tar zxvf #{Dir.tmpdir}/chef-solo/recipes.tgz -C #{Dir.tmpdir}/chef-solo").and_return(shellout)
         app.reconfigure
-        expect(Chef::Config[:interval]).to eq(1800)
+        expect(target_file.string).to eq("remote_tarball_content")
       end
-    end
 
-    describe "when the json_attribs configuration option is specified" do
-      let(:json_attribs) { { "a" => "b" } }
-      let(:config_fetcher) { double(Chef::ConfigFetcher, :fetch_json => json_attribs) }
-      let(:json_source) { "https://foo.com/foo.json" }
+      it "fetches the recipe_url first when both json_attribs and recipe_url are specified" do
+        json_attribs = { "a" => "b" }
+        config_fetcher = instance_double("Chef::ConfigFetcher", :fetch_json => json_attribs)
 
-      before do
-        Chef::Config[:json_attribs] = json_source
-        expect(Chef::ConfigFetcher).to receive(:new).with(json_source).
-          and_return(config_fetcher)
-      end
+        Chef::Config[:json_attribs] = "https://foo.com/foo.json"
+        Chef::Config[:recipe_url] = "http://icanhas.cheezburger.com/lolcats"
+        Chef::Config[:cookbook_path] = "#{Dir.tmpdir}/chef-solo/cookbooks"
+        expect(FileUtils).to receive(:mkdir_p).with("#{Dir.tmpdir}/chef-solo").and_return(true)
 
-      it "reads the JSON attributes from the specified source" do
+        allow(Chef::Mixin::Command).to receive(:run_command).and_return(true)
+
+        shellout = instance_double("Mixlib::ShellOut", run_command: nil, error!: nil, stdout: "")
+
+        expect(app).to receive(:shell_out!).with("tar zxvf #{Dir.tmpdir}/chef-solo/recipes.tgz -C #{Dir.tmpdir}/chef-solo").and_return(shellout)
+        expect(app).to receive(:fetch_recipe_tarball).ordered
+        expect(Chef::ConfigFetcher).to receive(:new).ordered.and_return(config_fetcher)
         app.reconfigure
-        expect(app.chef_client_json).to eq(json_attribs)
       end
     end
 
-    it "downloads a tarball when the recipe_url configuration option is specified" do
-      Chef::Config[:cookbook_path] = "#{Dir.tmpdir}/chef-solo/cookbooks"
-      Chef::Config[:recipe_url] = "http://junglist.gen.nz/recipes.tgz"
-
-      expect(FileUtils).to receive(:mkdir_p).with("#{Dir.tmpdir}/chef-solo").and_return(true)
+    describe "after the application has been configured" do
+      before do
+        Chef::Config[:solo] = true
+        Chef::Config[:solo_legacy_mode] = true
+
+        allow(Chef::Daemon).to receive(:change_privilege)
+        chef_client = double("Chef::Client")
+        allow(Chef::Client).to receive(:new).and_return(chef_client)
+        # this is all stuff the reconfigure method needs
+        allow(app).to receive(:configure_opt_parser).and_return(true)
+        allow(app).to receive(:configure_chef).and_return(true)
+        allow(app).to receive(:configure_logging).and_return(true)
+      end
 
-      tarfile = StringIO.new("remote_tarball_content")
-      target_file = StringIO.new
+      it "should change privileges" do
+        expect(Chef::Daemon).to receive(:change_privilege).and_return(true)
+        app.setup_application
+      end
+    end
 
-      expect(app).to receive(:open).with("http://junglist.gen.nz/recipes.tgz").and_yield(tarfile)
-      expect(File).to receive(:open).with("#{Dir.tmpdir}/chef-solo/recipes.tgz", "wb").and_yield(target_file)
+    it_behaves_like "an application that loads a dot d" do
+      let(:dot_d_config_name) { :solo_d_dir }
+    end
+  end
 
-      shellout = instance_double("Mixlib::ShellOut", run_command: nil, error!: nil, stdout: "")
+  context "in local mode" do
+    before do
+      Chef::Config[:solo_legacy_mode] = false
+    end
 
-      expect(app).to receive(:shell_out!).with("tar zxvf #{Dir.tmpdir}/chef-solo/recipes.tgz -C #{Dir.tmpdir}/chef-solo").and_return(shellout)
+    it "sets solo mode to true" do
       app.reconfigure
-      expect(target_file.string).to eq("remote_tarball_content")
+      expect(Chef::Config[:solo]).to be_truthy
     end
 
-    it "fetches the recipe_url first when both json_attribs and recipe_url are specified" do
-      json_attribs = { "a" => "b" }
-      config_fetcher = instance_double("Chef::ConfigFetcher", :fetch_json => json_attribs)
+    it "sets local mode to true" do
+      app.reconfigure
+      expect(Chef::Config[:local_mode]).to be_truthy
+    end
 
-      Chef::Config[:json_attribs] = "https://foo.com/foo.json"
-      Chef::Config[:recipe_url] = "http://icanhas.cheezburger.com/lolcats"
-      Chef::Config[:cookbook_path] = "#{Dir.tmpdir}/chef-solo/cookbooks"
-      expect(FileUtils).to receive(:mkdir_p).with("#{Dir.tmpdir}/chef-solo").and_return(true)
+    context "argv gets tidied up" do
+      before do
+        @original_argv = ARGV.dup
+        ARGV.clear
+        Chef::Config[:treat_deprecation_warnings_as_errors] = false
+      end
 
-      allow(Chef::Mixin::Command).to receive(:run_command).and_return(true)
+      after do
+        ARGV.replace(@original_argv)
+      end
 
-      shellout = instance_double("Mixlib::ShellOut", run_command: nil, error!: nil, stdout: "")
+      it "deletes --ez" do
+        ARGV << "--ez"
+        app.reconfigure
+        expect(ARGV.include?("--ez")).to be_falsey
+      end
 
-      expect(app).to receive(:shell_out!).with("tar zxvf #{Dir.tmpdir}/chef-solo/recipes.tgz -C #{Dir.tmpdir}/chef-solo").and_return(shellout)
-      expect(app).to receive(:fetch_recipe_tarball).ordered
-      expect(Chef::ConfigFetcher).to receive(:new).ordered.and_return(config_fetcher)
-      app.reconfigure
+      it "replaces -r with --recipe-url" do
+        ARGV.push("-r", "http://junglist.gen.nz/recipes.tgz")
+        app.reconfigure
+        expect(ARGV.include?("-r")).to be_falsey
+        expect(ARGV.include?("--recipe-url")).to be_truthy
+      end
     end
-  end
-
-  describe "after the application has been configured" do
-    before do
-      Chef::Config[:solo] = true
 
-      allow(Chef::Daemon).to receive(:change_privilege)
-      chef_client = double("Chef::Client")
-      allow(Chef::Client).to receive(:new).and_return(chef_client)
-      # this is all stuff the reconfigure method needs
-      allow(app).to receive(:configure_opt_parser).and_return(true)
+    it "runs chef-client in local mode" do
+      allow(app).to receive(:setup_application).and_return(true)
+      allow(app).to receive(:run_application).and_return(true)
       allow(app).to receive(:configure_chef).and_return(true)
       allow(app).to receive(:configure_logging).and_return(true)
+      expect(Chef::Application::Client).to receive_message_chain(:new, :run)
+      app.run
     end
 
-    it "should change privileges" do
-      expect(Chef::Daemon).to receive(:change_privilege).and_return(true)
-      app.setup_application
-    end
-  end
-
-  it_behaves_like "an application that loads a dot d" do
-    let(:dot_d_config_name) { :solo_d_dir }
   end
 end