chef 12.8.1 → 12.9.38

data/spec/functional/resource/windows_service_spec.rb

@@ -1,102 +1,102 @@
-#
-# Author:: Chris Doherty (<cdoherty@chef.io>)
-# Copyright:: Copyright 2014-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 "spec_helper"
-
-describe Chef::Resource::WindowsService, :windows_only, :system_windows_service_gem_only, :appveyor_only, :broken => true do
-  # Marking as broken. This test is causing appveyor tests to exit with 116.
-
-  include_context "using Win32::Service"
-
-  let(:username) { "service_spec_user" }
-  let(:qualified_username) { "#{ENV['COMPUTERNAME']}\\#{username}" }
-  let(:password) { "1a2b3c4X!&narf" }
-
-  let(:user_resource) {
-    r = Chef::Resource::User.new(username, run_context)
-    r.username(username)
-    r.password(password)
-    r.comment("temp spec user")
-    r
-  }
-
-  let(:global_service_file_path) {
-    "#{ENV['WINDIR']}\\temp\\#{File.basename(test_service[:service_file_path])}"
-  }
-
-  let(:service_params) {
-
-    id = "#{$$}_#{rand(1000)}"
-
-    test_service.merge( {
-      run_as_user: qualified_username,
-      run_as_password: password,
-      service_name: "spec_service_#{id}",
-      service_display_name: "windows_service spec #{id}}",
-      service_description: "Test service for running the windows_service functional spec.",
-      service_file_path: global_service_file_path,
-      } )
-  }
-
-  let(:manager) {
-    Chef::Application::WindowsServiceManager.new(service_params)
-  }
-
-  let(:service_resource) {
-    r = Chef::Resource::WindowsService.new(service_params[:service_name], run_context)
-    [:run_as_user, :run_as_password].each { |prop| r.send(prop, service_params[prop]) }
-    r
-  }
-
-  before {
-    user_resource.run_action(:create)
-
-    # the service executable has to be outside the current user's home
-    # directory in order for the logon user to execute it.
-    FileUtils.copy_file(test_service[:service_file_path], global_service_file_path)
-
-    # if you don't make the file executable by the service user, you'll get
-    # the not-very-helpful "service did not respond fast enough" error.
-
-    # #mode may break in a post-Windows 8.1 release, and have to be replaced
-    # with the rights stuff in the file resource.
-    file = Chef::Resource::File.new(global_service_file_path, run_context)
-    file.mode("0777")
-
-    file.run_action(:create)
-
-    manager.run(%w{--action install})
-  }
-
-  after {
-    user_resource.run_action(:remove)
-    manager.run(%w{--action uninstall})
-    File.delete(global_service_file_path)
-  }
-
-  describe "logon as a service" do
-    it "successfully runs a service as another user" do
-      service_resource.run_action(:start)
-    end
-
-    it "grants the user the log on as service right" do
-      service_resource.run_action(:start)
-      expect(Chef::ReservedNames::Win32::Security.get_account_right(qualified_username)).to include("SeServiceLogonRight")
-    end
-  end
-end
+#
+# Author:: Chris Doherty (<cdoherty@chef.io>)
+# Copyright:: Copyright 2014-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 "spec_helper"
+
+describe Chef::Resource::WindowsService, :windows_only, :system_windows_service_gem_only, :appveyor_only, :broken => true do
+  # Marking as broken. This test is causing appveyor tests to exit with 116.
+
+  include_context "using Win32::Service"
+
+  let(:username) { "service_spec_user" }
+  let(:qualified_username) { "#{ENV['COMPUTERNAME']}\\#{username}" }
+  let(:password) { "1a2b3c4X!&narf" }
+
+  let(:user_resource) {
+    r = Chef::Resource::User.new(username, run_context)
+    r.username(username)
+    r.password(password)
+    r.comment("temp spec user")
+    r
+  }
+
+  let(:global_service_file_path) {
+    "#{ENV['WINDIR']}\\temp\\#{File.basename(test_service[:service_file_path])}"
+  }
+
+  let(:service_params) {
+
+    id = "#{$$}_#{rand(1000)}"
+
+    test_service.merge( {
+      run_as_user: qualified_username,
+      run_as_password: password,
+      service_name: "spec_service_#{id}",
+      service_display_name: "windows_service spec #{id}}",
+      service_description: "Test service for running the windows_service functional spec.",
+      service_file_path: global_service_file_path,
+      } )
+  }
+
+  let(:manager) {
+    Chef::Application::WindowsServiceManager.new(service_params)
+  }
+
+  let(:service_resource) {
+    r = Chef::Resource::WindowsService.new(service_params[:service_name], run_context)
+    [:run_as_user, :run_as_password].each { |prop| r.send(prop, service_params[prop]) }
+    r
+  }
+
+  before {
+    user_resource.run_action(:create)
+
+    # the service executable has to be outside the current user's home
+    # directory in order for the logon user to execute it.
+    FileUtils.copy_file(test_service[:service_file_path], global_service_file_path)
+
+    # if you don't make the file executable by the service user, you'll get
+    # the not-very-helpful "service did not respond fast enough" error.
+
+    # #mode may break in a post-Windows 8.1 release, and have to be replaced
+    # with the rights stuff in the file resource.
+    file = Chef::Resource::File.new(global_service_file_path, run_context)
+    file.mode("0777")
+
+    file.run_action(:create)
+
+    manager.run(%w{--action install})
+  }
+
+  after {
+    user_resource.run_action(:remove)
+    manager.run(%w{--action uninstall})
+    File.delete(global_service_file_path)
+  }
+
+  describe "logon as a service" do
+    it "successfully runs a service as another user" do
+      service_resource.run_action(:start)
+    end
+
+    it "grants the user the log on as service right" do
+      service_resource.run_action(:start)
+      expect(Chef::ReservedNames::Win32::Security.get_account_right(qualified_username)).to include("SeServiceLogonRight")
+    end
+  end
+end

data/spec/functional/rest_spec.rb

@@ -1,95 +1,95 @@
-#
-# Author:: Lamont Granquist (<lamont@chef.io>)
-# Copyright:: Copyright 2014-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 "spec_helper"
-require "tiny_server"
-require "support/shared/functional/http"
-
-describe Chef::REST do
-  include ChefHTTPShared
-
-  let(:http_client) { described_class.new(source) }
-  let(:http_client_disable_gzip) { described_class.new(source, Chef::Config[:node_name], Chef::Config[:client_key], { :disable_gzip => true } ) }
-
-  shared_examples_for "downloads requests correctly" do
-    it "successfully downloads a streaming request" do
-      tempfile = http_client.streaming_request(source, {})
-      tempfile.close
-      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
-    end
-
-    it "successfully downloads a GET request" do
-      tempfile = http_client.get(source, {})
-      tempfile.close
-      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
-    end
-  end
-
-  shared_examples_for "validates content length and throws an exception" do
-    it "fails validation on a streaming download" do
-      expect { http_client.streaming_request(source, {}) }.to raise_error(Chef::Exceptions::ContentLengthMismatch)
-    end
-
-    it "fails validation on a GET request" do
-      expect { http_client.get(source, {}) }.to raise_error(Chef::Exceptions::ContentLengthMismatch)
-    end
-  end
-
-  shared_examples_for "an endpoint that 403s" do
-    it "fails with a Net::HTTPServerException on a streaming download" do
-      expect { http_client.streaming_request(source, {}) }.to raise_error(Net::HTTPServerException)
-    end
-
-    it "fails with a Net::HTTPServerException on a GET request" do
-      expect { http_client.get(source, {}) }.to raise_error(Net::HTTPServerException)
-    end
-  end
-
-  # see CHEF-5100
-  shared_examples_for "a 403 after a successful request when reusing the request object" do
-    it "fails with a Net::HTTPServerException on a streaming download" do
-      tempfile = http_client.streaming_request(source, {})
-      tempfile.close
-      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
-      expect { http_client.streaming_request(source2, {}) }.to raise_error(Net::HTTPServerException)
-    end
-
-    it "fails with a Net::HTTPServerException on a GET request" do
-      tempfile = http_client.get(source, {})
-      tempfile.close
-      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
-      expect { http_client.get(source2, {}) }.to raise_error(Net::HTTPServerException)
-    end
-  end
-
-  before do
-    Chef::Config[:node_name]  = "webmonkey.example.com"
-    Chef::Config[:client_key] = CHEF_SPEC_DATA + "/ssl/private_key.pem"
-    Chef::Config[:treat_deprecation_warnings_as_errors] = false
-  end
-
-  before(:all) do
-    start_tiny_server
-  end
-
-  after(:all) do
-    stop_tiny_server
-  end
-
-  it_behaves_like "downloading all the things"
-end
+#
+# Author:: Lamont Granquist (<lamont@chef.io>)
+# Copyright:: Copyright 2014-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 "spec_helper"
+require "tiny_server"
+require "support/shared/functional/http"
+
+describe Chef::REST do
+  include ChefHTTPShared
+
+  let(:http_client) { described_class.new(source) }
+  let(:http_client_disable_gzip) { described_class.new(source, Chef::Config[:node_name], Chef::Config[:client_key], { :disable_gzip => true } ) }
+
+  shared_examples_for "downloads requests correctly" do
+    it "successfully downloads a streaming request" do
+      tempfile = http_client.streaming_request(source, {})
+      tempfile.close
+      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
+    end
+
+    it "successfully downloads a GET request" do
+      tempfile = http_client.get(source, {})
+      tempfile.close
+      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
+    end
+  end
+
+  shared_examples_for "validates content length and throws an exception" do
+    it "fails validation on a streaming download" do
+      expect { http_client.streaming_request(source, {}) }.to raise_error(Chef::Exceptions::ContentLengthMismatch)
+    end
+
+    it "fails validation on a GET request" do
+      expect { http_client.get(source, {}) }.to raise_error(Chef::Exceptions::ContentLengthMismatch)
+    end
+  end
+
+  shared_examples_for "an endpoint that 403s" do
+    it "fails with a Net::HTTPServerException on a streaming download" do
+      expect { http_client.streaming_request(source, {}) }.to raise_error(Net::HTTPServerException)
+    end
+
+    it "fails with a Net::HTTPServerException on a GET request" do
+      expect { http_client.get(source, {}) }.to raise_error(Net::HTTPServerException)
+    end
+  end
+
+  # see CHEF-5100
+  shared_examples_for "a 403 after a successful request when reusing the request object" do
+    it "fails with a Net::HTTPServerException on a streaming download" do
+      tempfile = http_client.streaming_request(source, {})
+      tempfile.close
+      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
+      expect { http_client.streaming_request(source2, {}) }.to raise_error(Net::HTTPServerException)
+    end
+
+    it "fails with a Net::HTTPServerException on a GET request" do
+      tempfile = http_client.get(source, {})
+      tempfile.close
+      expect(Digest::MD5.hexdigest(binread(tempfile.path))).to eq(Digest::MD5.hexdigest(expected_content))
+      expect { http_client.get(source2, {}) }.to raise_error(Net::HTTPServerException)
+    end
+  end
+
+  before do
+    Chef::Config[:node_name]  = "webmonkey.example.com"
+    Chef::Config[:client_key] = CHEF_SPEC_DATA + "/ssl/private_key.pem"
+    Chef::Config[:treat_deprecation_warnings_as_errors] = false
+  end
+
+  before(:all) do
+    start_tiny_server
+  end
+
+  after(:all) do
+    stop_tiny_server
+  end
+
+  it_behaves_like "downloading all the things"
+end

data/spec/functional/run_lock_spec.rb

@@ -1,466 +1,466 @@
-#
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2012-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 File.expand_path("../../spec_helper", __FILE__)
-require "chef/client"
-
-describe Chef::RunLock do
-
-  # This behavior works on windows, but the tests use fork :(
-  describe "when locking the chef-client run", :unix_only => true do
-
-    ##
-    # Lockfile location and helpers
-
-    let(:random_temp_root) do
-      Kernel.srand(Time.now.to_i + Process.pid)
-      "#{Dir.tmpdir}/#{Kernel.rand(Time.now.to_i + Process.pid)}"
-    end
-
-    let(:lockfile) { "#{random_temp_root}/this/long/path/does/not/exist/chef-client-running.pid" }
-
-    # make sure to start with a clean slate.
-    before(:each) { log_event("rm -rf before"); FileUtils.rm_r(random_temp_root) if File.exist?(random_temp_root) }
-    after(:each) { log_event("rm -rf after"); FileUtils.rm_r(random_temp_root) if File.exist?(random_temp_root) }
-
-    def log_event(message, time = Time.now.strftime("%H:%M:%S.%L"))
-      events << [ message, time ]
-    end
-
-    def events
-      @events ||= []
-    end
-
-    WAIT_ON_LOCK_TIME = 1.0
-    def wait_on_lock
-      Timeout.timeout(WAIT_ON_LOCK_TIME) do
-        until File.exist?(lockfile)
-          sleep 0.1
-        end
-      end
-    rescue Timeout::Error
-      raise "Lockfile never created, abandoning test"
-    end
-
-    CLIENT_PROCESS_TIMEOUT = 10
-    BREATHING_ROOM = 1
-
-    # ClientProcess is defined below
-    let!(:p1) { ClientProcess.new(self, "p1") }
-    let!(:p2) { ClientProcess.new(self, "p2") }
-    after(:each) do |example|
-      begin
-        p1.stop
-        p2.stop
-      rescue
-        example.exception = $!
-        raise
-      ensure
-        if example.exception
-          print_events
-        end
-      end
-    end
-
-    def print_events
-      # Consume any remaining events that went on the channel and print them all
-      p1.last_event
-      p2.last_event
-      events.each_with_index.sort_by { |(message, time), index| [ time, index ] }.each do |(message, time), index|
-        print "#{time} #{message}\n"
-      end
-    end
-
-    context "when the lockfile does not already exist" do
-      context "when a client creates the lockfile but has not yet acquired the lock" do
-        before { p1.run_to("created lock") }
-        shared_context "second client gets the lock" do
-          it "the lockfile is created" do
-            log_event("lockfile exists? #{File.exist?(lockfile)}")
-            expect(File.exist?(lockfile)).to be_truthy
-          end
-
-          it "the lockfile is not locked" do
-            run_lock = Chef::RunLock.new(lockfile)
-            begin
-              expect(run_lock.test).to be_truthy
-            ensure
-              run_lock.release
-            end
-          end
-
-          it "the lockfile is empty" do
-            expect(IO.read(lockfile)).to eq("")
-          end
-
-          context "and a second client gets the lock" do
-            before { p2.run_to("acquired lock") }
-            it "the first client does not get the lock until the second finishes" do
-              p1.run_to("acquired lock") do
-                p2.run_to_completion
-              end
-            end
-            it "and the first client tries to get the lock and the second is killed, the first client gets the lock immediately" do
-              p1.run_to("acquired lock") do
-                sleep BREATHING_ROOM
-                expect(p1.last_event).to match(/after (started|created lock)/)
-                p2.stop
-              end
-              p1.run_to_completion
-            end
-          end
-        end
-
-        context "and the second client has done nothing" do
-          include_context "second client gets the lock"
-        end
-
-        context "and the second client has created the lockfile but not yet acquired the lock" do
-          before { p2.run_to("created lock") }
-          include_context "second client gets the lock"
-        end
-      end
-
-      context "when a client acquires the lock but has not yet saved the pid" do
-        before { p1.run_to("acquired lock") }
-
-        it "the lockfile is created" do
-          log_event("lockfile exists? #{File.exist?(lockfile)}")
-          expect(File.exist?(lockfile)).to be_truthy
-        end
-
-        it "the lockfile is locked" do
-          run_lock = Chef::RunLock.new(lockfile)
-          begin
-            expect(run_lock.test).to be_falsey
-          ensure
-            run_lock.release
-          end
-        end
-
-        it "sets FD_CLOEXEC on the lockfile", :supports_cloexec => true do
-          run_lock = File.open(lockfile)
-          expect(run_lock.fcntl(Fcntl::F_GETFD, 0) & Fcntl::FD_CLOEXEC).to eq(Fcntl::FD_CLOEXEC)
-        end
-
-        it "the lockfile is empty" do
-          expect(IO.read(lockfile)).to eq("")
-        end
-
-        it "and a second client tries to acquire the lock, it doesn't get the lock until *after* the first client exits" do
-          # Start p2 and tell it to move forward in the background
-          p2.run_to("acquired lock") do
-            # While p2 is trying to acquire, wait a bit and then let p1 complete
-            sleep(BREATHING_ROOM)
-            expect(p2.last_event).to match(/after (started|created lock)/)
-            p1.run_to_completion
-          end
-
-          p2.run_to_completion
-        end
-
-        it "and a second client tries to get the lock and the first is killed, the second client gets the lock immediately" do
-          p2.run_to("acquired lock") do
-            sleep BREATHING_ROOM
-            expect(p2.last_event).to match(/after (started|created lock)/)
-            p1.stop
-          end
-          p2.run_to_completion
-        end
-      end
-
-      context "when a client acquires the lock and saves the pid" do
-        before { p1.run_to("saved pid") }
-
-        it "the lockfile is created" do
-          expect(File.exist?(lockfile)).to be_truthy
-        end
-
-        it "the lockfile is locked" do
-          run_lock = Chef::RunLock.new(lockfile)
-          begin
-            expect(run_lock.test).to be_falsey
-          ensure
-            run_lock.release
-          end
-        end
-
-        it "sets FD_CLOEXEC on the lockfile", :supports_cloexec => true do
-          run_lock = File.open(lockfile)
-          expect(run_lock.fcntl(Fcntl::F_GETFD, 0) & Fcntl::FD_CLOEXEC).to eq(Fcntl::FD_CLOEXEC)
-        end
-
-        it "the PID is in the lockfile" do
-          expect(IO.read(lockfile)).to eq p1.pid.to_s
-        end
-
-        it "and a second client tries to acquire the lock, it doesn't get the lock until *after* the first client exits" do
-          # Start p2 and tell it to move forward in the background
-          p2.run_to("acquired lock") do
-            # While p2 is trying to acquire, wait a bit and then let p1 complete
-            sleep(BREATHING_ROOM)
-            expect(p2.last_event).to match(/after (started|created lock)/)
-            p1.run_to_completion
-          end
-
-          p2.run_to_completion
-        end
-
-        it "when a second client tries to get the lock and the first is killed, the second client gets the lock immediately" do
-          p2.run_to("acquired lock") do
-            sleep BREATHING_ROOM
-            expect(p2.last_event).to match(/after (started|created lock)/)
-            p1.stop
-          end
-          p2.run_to_completion
-        end
-      end
-
-      context "when a client acquires a lock and exits normally" do
-        before { p1.run_to_completion }
-
-        it "the lockfile remains" do
-          expect(File.exist?(lockfile)).to be_truthy
-        end
-
-        it "the lockfile is not locked" do
-          run_lock = Chef::RunLock.new(lockfile)
-          begin
-            expect(run_lock.test).to be_truthy
-          ensure
-            run_lock.release
-          end
-        end
-
-        it "the PID is in the lockfile" do
-          expect(IO.read(lockfile)).to eq p1.pid.to_s
-        end
-
-        it "and a second client tries to acquire the lock, it gets the lock immediately" do
-          p2.run_to_completion
-        end
-      end
-    end
-
-    it "test returns true and acquires the lock" do
-      run_lock = Chef::RunLock.new(lockfile)
-      p1 = fork do
-        expect(run_lock.test).to eq(true)
-        run_lock.save_pid
-        sleep 2
-        exit! 1
-      end
-
-      wait_on_lock
-
-      p2 = fork do
-        expect(run_lock.test).to eq(false)
-        exit! 0
-      end
-
-      Process.waitpid2(p2)
-      Process.waitpid2(p1)
-    end
-
-    it "test returns without waiting when the lock is acquired" do
-      run_lock = Chef::RunLock.new(lockfile)
-      p1 = fork do
-        run_lock.acquire
-        run_lock.save_pid
-        sleep 2
-        exit! 1
-      end
-
-      wait_on_lock
-
-      expect(run_lock.test).to eq(false)
-      Process.waitpid2(p1)
-    end
-
-  end
-
-  #
-  # Runs a process in the background that will:
-  #
-  # 1. start up (`started` event)
-  # 2. acquire the runlock file (`acquired lock` event)
-  # 3. save the pid to the lockfile (`saved pid` event)
-  # 4. exit
-  #
-  # You control exactly how far the client process goes with the `run_to`
-  # method: it will stop at any given spot so you can test for race conditions.
-  #
-  # It uses a pair of pipes to communicate with the process. The tests will
-  # send an event name over to the process, which gives the process permission
-  # to run until it reaches that event (at which point it waits for another event
-  # name). The process sends the name of each event it reaches back to the tests.
-  #
-  class ClientProcess
-    def initialize(example, name)
-      @example = example
-      @name = name
-      @read_from_process, @write_to_tests = IO.pipe
-      @read_from_tests, @write_to_process = IO.pipe
-    end
-
-    attr_reader :example
-    attr_reader :name
-    attr_reader :pid
-
-    def last_event
-      loop do
-        line = readline_nonblock(read_from_process)
-        break if line.nil?
-        event, time = line.split("@")
-        example.log_event("#{name}.last_event got #{event}")
-        example.log_event("[#{name}] #{event}", time.strip)
-        @last_event = event
-      end
-      @last_event
-    end
-
-    def run_to(to_event, &background_block)
-      example.log_event("#{name}.run_to(#{to_event.inspect})")
-
-      # Start the process if it's not started
-      start if !pid
-
-      # Tell the process what to stop at (also means it can go)
-      write_to_process.print "#{to_event}\n"
-
-      # Run the background block
-      yield if background_block
-
-      # Wait until it gets there
-      Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
-        until @last_event == "after #{to_event}"
-          got_event, time = read_from_process.gets.split("@")
-          example.log_event("#{name}.last_event got #{got_event}")
-          example.log_event("[#{name}] #{got_event}", time.strip)
-          @last_event = got_event
-        end
-      end
-
-      example.log_event("#{name}.run_to(#{to_event.inspect}) finished")
-    end
-
-    def run_to_completion
-      example.log_event("#{name}.run_to_completion")
-      # Start the process if it's not started
-      start if !pid
-
-      # Tell the process to stop at nothing (no blocking)
-      @write_to_process.print "nothing\n"
-
-      # Wait for the process to exit
-      wait_for_exit
-      example.log_event("#{name}.run_to_completion finished")
-    end
-
-    def wait_for_exit
-      example.log_event("#{name}.wait_for_exit (pid #{pid})")
-      Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
-        Process.wait(pid) if pid
-      end
-      example.log_event("#{name}.wait_for_exit finished (pid #{pid})")
-    end
-
-    def stop
-      if pid
-        example.log_event("#{name}.stop (pid #{pid})")
-        begin
-          # Send it the kill signal over and over until it dies
-          Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
-            Process.kill(:KILL, pid)
-            until Process.waitpid2(pid, Process::WNOHANG)
-              sleep(0.05)
-            end
-          end
-          example.log_event("#{name}.stop finished (stopped pid #{pid})")
-        # Process not found is perfectly fine when we're trying to kill a process :)
-        rescue Errno::ESRCH
-          example.log_event("#{name}.stop finished (pid #{pid} wasn't running)")
-        end
-      end
-    end
-
-    def fire_event(event)
-      # Let the caller know what event we've reached
-      write_to_tests.print("after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
-
-      # Block until the client tells us where to stop
-      if !@run_to_event || event == @run_to_event
-        write_to_tests.print("waiting for instructions after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
-        @run_to_event = read_from_tests.gets.strip
-        write_to_tests.print("told to run to #{@run_to_event} after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
-      elsif @run_to_event
-        write_to_tests.print("continuing until #{@run_to_event} after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
-      end
-    end
-
-    private
-
-    attr_reader :read_from_process
-    attr_reader :write_to_tests
-    attr_reader :read_from_tests
-    attr_reader :write_to_process
-
-    class TestRunLock < Chef::RunLock
-      attr_accessor :client_process
-      def create_lock
-        super
-        client_process.fire_event("created lock")
-      end
-    end
-
-    def start
-      example.log_event("#{name}.start")
-      @pid = fork do
-        begin
-          Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
-            run_lock = TestRunLock.new(example.lockfile)
-            run_lock.client_process = self
-            fire_event("started")
-            run_lock.acquire
-            fire_event("acquired lock")
-            run_lock.save_pid
-            fire_event("saved pid")
-            exit!(0)
-          end
-        rescue
-          fire_event($!.message.lines.join(" // "))
-          raise
-        end
-      end
-      example.log_event("#{name}.start forked (pid #{pid})")
-    end
-
-    def readline_nonblock(fd)
-      buffer = ""
-      buffer << fd.read_nonblock(1) while buffer[-1] != "\n"
-
-      buffer
-    #rescue IO::EAGAINUnreadable
-    rescue IO::WaitReadable
-      unless buffer == ""
-        sleep 0.1
-        retry
-      end
-      nil
-    end
-  end
-end
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2012-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 File.expand_path("../../spec_helper", __FILE__)
+require "chef/client"
+
+describe Chef::RunLock do
+
+  # This behavior works on windows, but the tests use fork :(
+  describe "when locking the chef-client run", :unix_only => true do
+
+    ##
+    # Lockfile location and helpers
+
+    let(:random_temp_root) do
+      Kernel.srand(Time.now.to_i + Process.pid)
+      "#{Dir.tmpdir}/#{Kernel.rand(Time.now.to_i + Process.pid)}"
+    end
+
+    let(:lockfile) { "#{random_temp_root}/this/long/path/does/not/exist/chef-client-running.pid" }
+
+    # make sure to start with a clean slate.
+    before(:each) { log_event("rm -rf before"); FileUtils.rm_r(random_temp_root) if File.exist?(random_temp_root) }
+    after(:each) { log_event("rm -rf after"); FileUtils.rm_r(random_temp_root) if File.exist?(random_temp_root) }
+
+    def log_event(message, time = Time.now.strftime("%H:%M:%S.%L"))
+      events << [ message, time ]
+    end
+
+    def events
+      @events ||= []
+    end
+
+    WAIT_ON_LOCK_TIME = 1.0
+    def wait_on_lock
+      Timeout.timeout(WAIT_ON_LOCK_TIME) do
+        until File.exist?(lockfile)
+          sleep 0.1
+        end
+      end
+    rescue Timeout::Error
+      raise "Lockfile never created, abandoning test"
+    end
+
+    CLIENT_PROCESS_TIMEOUT = 10
+    BREATHING_ROOM = 1
+
+    # ClientProcess is defined below
+    let!(:p1) { ClientProcess.new(self, "p1") }
+    let!(:p2) { ClientProcess.new(self, "p2") }
+    after(:each) do |example|
+      begin
+        p1.stop
+        p2.stop
+      rescue
+        example.exception = $!
+        raise
+      ensure
+        if example.exception
+          print_events
+        end
+      end
+    end
+
+    def print_events
+      # Consume any remaining events that went on the channel and print them all
+      p1.last_event
+      p2.last_event
+      events.each_with_index.sort_by { |(message, time), index| [ time, index ] }.each do |(message, time), index|
+        print "#{time} #{message}\n"
+      end
+    end
+
+    context "when the lockfile does not already exist" do
+      context "when a client creates the lockfile but has not yet acquired the lock" do
+        before { p1.run_to("created lock") }
+        shared_context "second client gets the lock" do
+          it "the lockfile is created" do
+            log_event("lockfile exists? #{File.exist?(lockfile)}")
+            expect(File.exist?(lockfile)).to be_truthy
+          end
+
+          it "the lockfile is not locked" do
+            run_lock = Chef::RunLock.new(lockfile)
+            begin
+              expect(run_lock.test).to be_truthy
+            ensure
+              run_lock.release
+            end
+          end
+
+          it "the lockfile is empty" do
+            expect(IO.read(lockfile)).to eq("")
+          end
+
+          context "and a second client gets the lock" do
+            before { p2.run_to("acquired lock") }
+            it "the first client does not get the lock until the second finishes" do
+              p1.run_to("acquired lock") do
+                p2.run_to_completion
+              end
+            end
+            it "and the first client tries to get the lock and the second is killed, the first client gets the lock immediately" do
+              p1.run_to("acquired lock") do
+                sleep BREATHING_ROOM
+                expect(p1.last_event).to match(/after (started|created lock)/)
+                p2.stop
+              end
+              p1.run_to_completion
+            end
+          end
+        end
+
+        context "and the second client has done nothing" do
+          include_context "second client gets the lock"
+        end
+
+        context "and the second client has created the lockfile but not yet acquired the lock" do
+          before { p2.run_to("created lock") }
+          include_context "second client gets the lock"
+        end
+      end
+
+      context "when a client acquires the lock but has not yet saved the pid" do
+        before { p1.run_to("acquired lock") }
+
+        it "the lockfile is created" do
+          log_event("lockfile exists? #{File.exist?(lockfile)}")
+          expect(File.exist?(lockfile)).to be_truthy
+        end
+
+        it "the lockfile is locked" do
+          run_lock = Chef::RunLock.new(lockfile)
+          begin
+            expect(run_lock.test).to be_falsey
+          ensure
+            run_lock.release
+          end
+        end
+
+        it "sets FD_CLOEXEC on the lockfile", :supports_cloexec => true do
+          run_lock = File.open(lockfile)
+          expect(run_lock.fcntl(Fcntl::F_GETFD, 0) & Fcntl::FD_CLOEXEC).to eq(Fcntl::FD_CLOEXEC)
+        end
+
+        it "the lockfile is empty" do
+          expect(IO.read(lockfile)).to eq("")
+        end
+
+        it "and a second client tries to acquire the lock, it doesn't get the lock until *after* the first client exits" do
+          # Start p2 and tell it to move forward in the background
+          p2.run_to("acquired lock") do
+            # While p2 is trying to acquire, wait a bit and then let p1 complete
+            sleep(BREATHING_ROOM)
+            expect(p2.last_event).to match(/after (started|created lock)/)
+            p1.run_to_completion
+          end
+
+          p2.run_to_completion
+        end
+
+        it "and a second client tries to get the lock and the first is killed, the second client gets the lock immediately" do
+          p2.run_to("acquired lock") do
+            sleep BREATHING_ROOM
+            expect(p2.last_event).to match(/after (started|created lock)/)
+            p1.stop
+          end
+          p2.run_to_completion
+        end
+      end
+
+      context "when a client acquires the lock and saves the pid" do
+        before { p1.run_to("saved pid") }
+
+        it "the lockfile is created" do
+          expect(File.exist?(lockfile)).to be_truthy
+        end
+
+        it "the lockfile is locked" do
+          run_lock = Chef::RunLock.new(lockfile)
+          begin
+            expect(run_lock.test).to be_falsey
+          ensure
+            run_lock.release
+          end
+        end
+
+        it "sets FD_CLOEXEC on the lockfile", :supports_cloexec => true do
+          run_lock = File.open(lockfile)
+          expect(run_lock.fcntl(Fcntl::F_GETFD, 0) & Fcntl::FD_CLOEXEC).to eq(Fcntl::FD_CLOEXEC)
+        end
+
+        it "the PID is in the lockfile" do
+          expect(IO.read(lockfile)).to eq p1.pid.to_s
+        end
+
+        it "and a second client tries to acquire the lock, it doesn't get the lock until *after* the first client exits" do
+          # Start p2 and tell it to move forward in the background
+          p2.run_to("acquired lock") do
+            # While p2 is trying to acquire, wait a bit and then let p1 complete
+            sleep(BREATHING_ROOM)
+            expect(p2.last_event).to match(/after (started|created lock)/)
+            p1.run_to_completion
+          end
+
+          p2.run_to_completion
+        end
+
+        it "when a second client tries to get the lock and the first is killed, the second client gets the lock immediately" do
+          p2.run_to("acquired lock") do
+            sleep BREATHING_ROOM
+            expect(p2.last_event).to match(/after (started|created lock)/)
+            p1.stop
+          end
+          p2.run_to_completion
+        end
+      end
+
+      context "when a client acquires a lock and exits normally" do
+        before { p1.run_to_completion }
+
+        it "the lockfile remains" do
+          expect(File.exist?(lockfile)).to be_truthy
+        end
+
+        it "the lockfile is not locked" do
+          run_lock = Chef::RunLock.new(lockfile)
+          begin
+            expect(run_lock.test).to be_truthy
+          ensure
+            run_lock.release
+          end
+        end
+
+        it "the PID is in the lockfile" do
+          expect(IO.read(lockfile)).to eq p1.pid.to_s
+        end
+
+        it "and a second client tries to acquire the lock, it gets the lock immediately" do
+          p2.run_to_completion
+        end
+      end
+    end
+
+    it "test returns true and acquires the lock" do
+      run_lock = Chef::RunLock.new(lockfile)
+      p1 = fork do
+        expect(run_lock.test).to eq(true)
+        run_lock.save_pid
+        sleep 2
+        exit! 1
+      end
+
+      wait_on_lock
+
+      p2 = fork do
+        expect(run_lock.test).to eq(false)
+        exit! 0
+      end
+
+      Process.waitpid2(p2)
+      Process.waitpid2(p1)
+    end
+
+    it "test returns without waiting when the lock is acquired" do
+      run_lock = Chef::RunLock.new(lockfile)
+      p1 = fork do
+        run_lock.acquire
+        run_lock.save_pid
+        sleep 2
+        exit! 1
+      end
+
+      wait_on_lock
+
+      expect(run_lock.test).to eq(false)
+      Process.waitpid2(p1)
+    end
+
+  end
+
+  #
+  # Runs a process in the background that will:
+  #
+  # 1. start up (`started` event)
+  # 2. acquire the runlock file (`acquired lock` event)
+  # 3. save the pid to the lockfile (`saved pid` event)
+  # 4. exit
+  #
+  # You control exactly how far the client process goes with the `run_to`
+  # method: it will stop at any given spot so you can test for race conditions.
+  #
+  # It uses a pair of pipes to communicate with the process. The tests will
+  # send an event name over to the process, which gives the process permission
+  # to run until it reaches that event (at which point it waits for another event
+  # name). The process sends the name of each event it reaches back to the tests.
+  #
+  class ClientProcess
+    def initialize(example, name)
+      @example = example
+      @name = name
+      @read_from_process, @write_to_tests = IO.pipe
+      @read_from_tests, @write_to_process = IO.pipe
+    end
+
+    attr_reader :example
+    attr_reader :name
+    attr_reader :pid
+
+    def last_event
+      loop do
+        line = readline_nonblock(read_from_process)
+        break if line.nil?
+        event, time = line.split("@")
+        example.log_event("#{name}.last_event got #{event}")
+        example.log_event("[#{name}] #{event}", time.strip)
+        @last_event = event
+      end
+      @last_event
+    end
+
+    def run_to(to_event, &background_block)
+      example.log_event("#{name}.run_to(#{to_event.inspect})")
+
+      # Start the process if it's not started
+      start if !pid
+
+      # Tell the process what to stop at (also means it can go)
+      write_to_process.print "#{to_event}\n"
+
+      # Run the background block
+      yield if background_block
+
+      # Wait until it gets there
+      Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
+        until @last_event == "after #{to_event}"
+          got_event, time = read_from_process.gets.split("@")
+          example.log_event("#{name}.last_event got #{got_event}")
+          example.log_event("[#{name}] #{got_event}", time.strip)
+          @last_event = got_event
+        end
+      end
+
+      example.log_event("#{name}.run_to(#{to_event.inspect}) finished")
+    end
+
+    def run_to_completion
+      example.log_event("#{name}.run_to_completion")
+      # Start the process if it's not started
+      start if !pid
+
+      # Tell the process to stop at nothing (no blocking)
+      @write_to_process.print "nothing\n"
+
+      # Wait for the process to exit
+      wait_for_exit
+      example.log_event("#{name}.run_to_completion finished")
+    end
+
+    def wait_for_exit
+      example.log_event("#{name}.wait_for_exit (pid #{pid})")
+      Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
+        Process.wait(pid) if pid
+      end
+      example.log_event("#{name}.wait_for_exit finished (pid #{pid})")
+    end
+
+    def stop
+      if pid
+        example.log_event("#{name}.stop (pid #{pid})")
+        begin
+          # Send it the kill signal over and over until it dies
+          Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
+            Process.kill(:KILL, pid)
+            until Process.waitpid2(pid, Process::WNOHANG)
+              sleep(0.05)
+            end
+          end
+          example.log_event("#{name}.stop finished (stopped pid #{pid})")
+        # Process not found is perfectly fine when we're trying to kill a process :)
+        rescue Errno::ESRCH
+          example.log_event("#{name}.stop finished (pid #{pid} wasn't running)")
+        end
+      end
+    end
+
+    def fire_event(event)
+      # Let the caller know what event we've reached
+      write_to_tests.print("after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
+
+      # Block until the client tells us where to stop
+      if !@run_to_event || event == @run_to_event
+        write_to_tests.print("waiting for instructions after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
+        @run_to_event = read_from_tests.gets.strip
+        write_to_tests.print("told to run to #{@run_to_event} after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
+      elsif @run_to_event
+        write_to_tests.print("continuing until #{@run_to_event} after #{event}@#{Time.now.strftime("%H:%M:%S.%L")}\n")
+      end
+    end
+
+    private
+
+    attr_reader :read_from_process
+    attr_reader :write_to_tests
+    attr_reader :read_from_tests
+    attr_reader :write_to_process
+
+    class TestRunLock < Chef::RunLock
+      attr_accessor :client_process
+      def create_lock
+        super
+        client_process.fire_event("created lock")
+      end
+    end
+
+    def start
+      example.log_event("#{name}.start")
+      @pid = fork do
+        begin
+          Timeout.timeout(CLIENT_PROCESS_TIMEOUT) do
+            run_lock = TestRunLock.new(example.lockfile)
+            run_lock.client_process = self
+            fire_event("started")
+            run_lock.acquire
+            fire_event("acquired lock")
+            run_lock.save_pid
+            fire_event("saved pid")
+            exit!(0)
+          end
+        rescue
+          fire_event($!.message.lines.join(" // "))
+          raise
+        end
+      end
+      example.log_event("#{name}.start forked (pid #{pid})")
+    end
+
+    def readline_nonblock(fd)
+      buffer = ""
+      buffer << fd.read_nonblock(1) while buffer[-1] != "\n"
+
+      buffer
+    #rescue IO::EAGAINUnreadable
+    rescue IO::WaitReadable
+      unless buffer == ""
+        sleep 0.1
+        retry
+      end
+      nil
+    end
+  end
+end