puppet 6.0.0 → 6.1.0

data/spec/unit/util/windows/service_spec.rb

@@ -4,6 +4,16 @@ require 'spec_helper'
 describe "Puppet::Util::Windows::Service", :if => Puppet.features.microsoft_windows? do
   require 'puppet/util/windows'
 
+  before(:each) do
+    Puppet::Util::Windows::Error.stubs(:format_error_code)
+      .with(anything)
+      .returns("fake error!")
+  end
+
+  def service_state_str(state)
+    Puppet::Util::Windows::Service::SERVICE_STATES[state].to_s
+  end
+
   # The following should emulate a successful call to the private function
   # query_status that returns the value of query_return. This should give
   # us a way to mock changes in service status.
@@ -15,6 +25,12 @@ describe "Puppet::Util::Windows::Service", :if => Puppet.features.microsoft_wind
     subject::SERVICE_STATUS_PROCESS.expects(:new).in_sequence(status_checks).returns(query_return)
   end
 
+  def expect_successful_status_queries_and_return(*query_returns)
+    query_returns.each do |query_return|
+      expect_successful_status_query_and_return(query_return)
+    end
+  end
+
   # The following should emulate a successful call to the private function
   # query_config that returns the value of query_return. This should give
   # us a way to mock changes in service configuration.
@@ -32,12 +48,11 @@ describe "Puppet::Util::Windows::Service", :if => Puppet.features.microsoft_wind
   let(:mock_service_name) { mock() }
   let(:service) { mock() }
   let(:scm) { mock() }
+  let(:timeout) { 30 }
 
   before do
     subject.stubs(:QueryServiceStatusEx).returns(1)
     subject.stubs(:QueryServiceConfigW).returns(1)
-    subject.stubs(:StartServiceW).returns(1)
-    subject.stubs(:ControlService).returns(1)
     subject.stubs(:ChangeServiceConfigW).returns(1)
     subject.stubs(:OpenSCManagerW).returns(scm)
     subject.stubs(:OpenServiceW).returns(service)
@@ -47,213 +62,444 @@ describe "Puppet::Util::Windows::Service", :if => Puppet.features.microsoft_wind
     subject::SERVICE_STATUS_PROCESS.stubs(:new)
     subject::QUERY_SERVICE_CONFIGW.stubs(:new)
     subject::SERVICE_STATUS.stubs(:new).returns({:dwCurrentState => subject::SERVICE_RUNNING})
-    Puppet::Util::Windows::Error.stubs(:new).raises(Puppet::Error.new('fake error'))
+    FFI.stubs(:errno).returns(0)
     FFI::MemoryPointer.stubs(:new).yields(pointer)
     pointer.stubs(:read_dword)
     pointer.stubs(:write_dword)
     pointer.stubs(:size)
+    subject.stubs(:sleep)
   end
 
-  describe "#start" do
-
+  describe "#exists?" do
     context "when the service control manager cannot be opened" do
       let(:scm) { FFI::Pointer::NULL_HANDLE }
       it "raises a puppet error" do
-        expect{ subject.start(mock_service_name) }.to raise_error(Puppet::Error)
+        expect{ subject.exists?(mock_service_name) }.to raise_error(Puppet::Error)
       end
     end
 
     context "when the service cannot be opened" do
       let(:service) { FFI::Pointer::NULL_HANDLE }
-      it "raises a puppet error" do
-        expect{ subject.start(mock_service_name) }.to raise_error(Puppet::Error)
+
+      it "returns false if it fails to open because the service does not exist" do
+        FFI.stubs(:errno).returns(Puppet::Util::Windows::Service::ERROR_SERVICE_DOES_NOT_EXIST)
+
+        expect(subject.exists?(mock_service_name)).to be false
       end
-    end
 
-    context "when the service can be opened and is in the stopped state" do
-      before do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
+      it "raises a puppet error if it fails to open for some other reason" do
+        expect{ subject.exists?(mock_service_name) }.to raise_error(Puppet::Error)
       end
+    end
 
-      it "Starts the service once the service reports SERVICE_RUNNING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.start(mock_service_name)
+    context "when the service can be opened" do
+      it "returns true" do
+        expect(subject.exists?(mock_service_name)).to be true
       end
+    end
+  end
+
+  # This shared example contains the unit tests for the wait_on_pending_state
+  # helper as used by service actions like #start and #stop. Before including
+  # this shared example, be sure to mock out any intermediate calls prior to
+  # the pending transition, and make sure that the post-condition _after_ those
+  # intermediate calls leaves the service in the pending state. Before including
+  # this example in your tests, be sure to define the following variables in a `let`
+  # context:
+  #     * action -- The service action
+  shared_examples "a service action waiting on a pending transition" do |pending_state|
+    pending_state_str = Puppet::Util::Windows::Service::SERVICE_STATES[pending_state].to_s
+
+    final_state = Puppet::Util::Windows::Service::FINAL_STATES[pending_state]
+    final_state_str = Puppet::Util::Windows::Service::SERVICE_STATES[final_state].to_s
+
+    it "raises a Puppet::Error if the service query fails" do
+      subject.expects(:QueryServiceStatusEx).in_sequence(status_checks).returns(FFI::WIN32_FALSE)
+
+      expect { subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
+    end
+
+    it "raises a Puppet::Error if the service unexpectedly transitions to a state other than #{pending_state_str} or #{final_state_str}" do
+      invalid_state = (subject::SERVICE_STATES.keys - [pending_state, final_state]).first
+
+      expect_successful_status_query_and_return(dwCurrentState: invalid_state)
+
+      expect { subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
+    end
+
+    it "waits for at least 1 second if the wait_hint/10 is < 1 second" do
+      expect_successful_status_queries_and_return(
+        { :dwCurrentState => pending_state, :dwWaitHint => 0, :dwCheckPoint => 1 },
+        { :dwCurrentState => final_state }
+      )
+
+      subject.expects(:sleep).with(1)
+
+      subject.send(action, mock_service_name, timeout: timeout)
+    end
+
+    it "waits for at most 10 seconds if wait_hint/10 is > 10 seconds" do
+      expect_successful_status_queries_and_return(
+        { :dwCurrentState => pending_state, :dwWaitHint => 1000000, :dwCheckPoint => 1 },
+        { :dwCurrentState => final_state }
+      )
 
-      it "Raises an error if after calling StartServiceW the service is not in RUNNING or START_PENDING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_PAUSED})
-        expect{ subject.start(mock_service_name) }.to raise_error(Puppet::Error)
+      subject.expects(:sleep).with(10)
+
+      subject.send(action, mock_service_name, timeout: timeout)
+    end
+
+    it "does not raise an error if the service makes any progress while transitioning to #{final_state_str}" do
+      expect_successful_status_queries_and_return(
+        # The three "pending_state" statuses simulate the scenario where the service
+        # makes some progress during the transition right when Puppet's about to
+        # time out.
+        { :dwCurrentState => pending_state, :dwWaitHint => 100000, :dwCheckPoint => 1 },
+        { :dwCurrentState => pending_state, :dwWaitHint => 100000, :dwCheckPoint => 1 },
+        { :dwCurrentState => pending_state, :dwWaitHint => 100000, :dwCheckPoint => 2 },
+
+        { :dwCurrentState => final_state }
+      )
+
+      expect { subject.send(action, mock_service_name, timeout: timeout) }.to_not raise_error
+    end
+
+    it "raises a Puppet::Error if it times out while waiting for the transition to #{final_state_str}" do
+      31.times do
+        expect_successful_status_query_and_return(
+          dwCurrentState: pending_state,
+          dwWaitHint: 10000,
+          dwCheckPoint: 1
+        )
       end
 
-      it "raises a puppet error if StartServiceW returns false" do
-        subject.expects(:StartServiceW).returns(FFI::WIN32_FALSE)
-        expect{ subject.start(mock_service_name) }.to raise_error(Puppet::Error)
+      expect { subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
+    end
+  end
+
+  # This shared example contains the unit tests for the transition_service_state
+  # helper, which is the helper that all of our service actions like #start, #stop
+  # delegate to. Including these tests under a shared example lets us include them in each of
+  # those service action's unit tests. Before including this example in your tests, be
+  # sure to define the following variables in a `let` context:
+  #     * initial_state         -- The initial state of the service prior to performing the state
+  #                                transition
+  #
+  #     * mock_state_transition -- A lambda that mocks the state transition. This should mock
+  #                                any code in the block that's passed to the
+  #                                transition_service_state helper
+  #
+  # See the unit tests for the #start method to see how this shared example's
+  # included.
+  #
+  shared_examples "a service action that transitions the service state" do |action, valid_initial_states, pending_state, final_state|
+    valid_initial_states_str = valid_initial_states.map do |state|
+      Puppet::Util::Windows::Service::SERVICE_STATES[state]
+    end.join(', ')
+    pending_state_str = Puppet::Util::Windows::Service::SERVICE_STATES[pending_state].to_s
+    final_state_str = Puppet::Util::Windows::Service::SERVICE_STATES[final_state].to_s
+
+    it "noops if the service is already in the #{final_state} state" do
+      expect_successful_status_query_and_return(dwCurrentState: final_state)
+
+      expect { subject.send(action, mock_service_name, timeout: timeout) }.to_not raise_error
+    end
+
+    # invalid_initial_states will be empty for the #stop action
+    invalid_initial_states = Puppet::Util::Windows::Service::SERVICE_STATES.keys - valid_initial_states - [final_state]
+    unless invalid_initial_states.empty?
+      it "raises a Puppet::Error if the service's initial state is not one of #{valid_initial_states_str}" do
+        invalid_initial_state = invalid_initial_states.first
+        expect_successful_status_query_and_return(dwCurrentState: invalid_initial_state)
+
+        expect{ subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
 
-    context "when the service hasn't stopped yet:" do
-      it "waits, then queries again until SERVICE_STOPPED" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(3).twice
-        subject.start(mock_service_name)
+    context "when there's a pending transition to the #{final_state} state" do
+      before(:each) do
+        expect_successful_status_query_and_return(dwCurrentState: pending_state)
       end
 
-      it "waits for at least 1 second if wait hint/10 is < 1 second" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(1)
-        subject.start(mock_service_name)
+      include_examples "a service action waiting on a pending transition", pending_state do
+        let(:action) { action }
       end
+    end
+
+    # If the service action accepts an unsafe pending state as one of the service's
+    # initial states, then we need to test that the action waits for the service to
+    # transition from that unsafe pending state before doing anything else.
+    unsafe_pending_states = valid_initial_states & Puppet::Util::Windows::Service::UNSAFE_PENDING_STATES
+    unless unsafe_pending_states.empty?
+      unsafe_pending_state = unsafe_pending_states.first
+      unsafe_pending_state_str = Puppet::Util::Windows::Service::SERVICE_STATES[unsafe_pending_state]
+
+      context "waiting for a service with #{unsafe_pending_state_str} as its initial state" do
+        before(:each) do
+          # This mocks the status query to return the 'final_state' by default. Otherwise,
+          # we will fail the tests in the latter parts of the code where we wait for the
+          # service to finish transitioning to the 'final_state'.
+          subject::SERVICE_STATUS_PROCESS.stubs(:new).returns(dwCurrentState: final_state)
+
+          # Set our service's initial state
+          expect_successful_status_query_and_return(dwCurrentState: unsafe_pending_state)
+
+          mock_state_transition.call
+        end
 
-      it "waits for at most 10 seconds if wait hint/10 is > 10 seconds" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 1000000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(10)
-        subject.start(mock_service_name)
+        include_examples "a service action waiting on a pending transition", unsafe_pending_state do
+          let(:action) { action }
+        end
       end
+    end
 
-      it "raises a puppet error if the service query fails" do
-        subject.expects(:QueryServiceStatusEx).in_sequence(status_checks).returns(1)
+    # reads e.g. "waiting for the service to transition to the SERVICE_RUNNING state after executing the 'start' action"
+    #
+    # NOTE: This is really unit testing the wait_on_state_transition helper
+    context "waiting for the service to transition to the #{final_state_str} state after executing the '#{action}' action" do
+      before(:each) do
+        # Set our service's initial state prior to performing the state transition
+        expect_successful_status_query_and_return(dwCurrentState: initial_state)
+
+        mock_state_transition.call
+      end
+
+      it "raises a Puppet::Error if the service query fails" do
         subject.expects(:QueryServiceStatusEx).in_sequence(status_checks).returns(FFI::WIN32_FALSE)
-        expect{subject.start(mock_service_name)}.to raise_error(Puppet::Error)
+
+        expect { subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
 
-      it "raises a puppet error if the services configured dwWaitHint is 0, 30 seconds have passed and dwCheckPoint hasn't increased" do
-        # the number of times here is a little strange: there are 31 and 32 status queries sleeps because:
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 0}).times(31)
-        subject.expects(:sleep).times(30).with(1)
-        expect{subject.start(mock_service_name)}.to raise_error(Puppet::Error)
+      it "waits, then queries again until it transitions to #{final_state_str}" do
+        expect_successful_status_queries_and_return(
+          { :dwCurrentState => initial_state },
+          { :dwCurrentState => initial_state },
+          { :dwCurrentState => final_state }
+        )
+
+        subject.expects(:sleep).with(1).twice
+
+        subject.send(action, mock_service_name, timeout: timeout)
       end
 
-      it "raises a puppet error if the services configured dwWaitHint has passed and dwCheckPoint hasn't increased" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 40000, :dwCheckPoint => 0}).times(11)
-        subject.expects(:sleep).times(10).with(4)
-        expect{subject.start(mock_service_name)}.to raise_error(Puppet::Error)
+      context "when it transitions to the #{pending_state_str} state" do
+        before(:each) do
+          expect_successful_status_query_and_return(dwCurrentState: pending_state)
+        end
+
+        include_examples "a service action waiting on a pending transition", pending_state do
+          let(:action) { action }
+        end
       end
 
-      it "Does not raise an error if the service makes progress" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 0})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 2})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 30})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 0, :dwCheckPoint => 98})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).times(5).with(1)
-        expect{subject.start(mock_service_name)}.to_not raise_error
+      it "raises a Puppet::Error if it times out while waiting for the transition to #{final_state_str}" do
+        31.times do
+          expect_successful_status_query_and_return(dwCurrentState: initial_state)
+        end
+
+        expect { subject.send(action, mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
+  end
 
-    context "when the service ends up in START_PENDING:" do
-      it "waits, then queries again until SERVICE_RUNNING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(3).twice
-        subject.start(mock_service_name)
+  describe "#start" do
+    # rspec will still try to load the tests even though
+    # the :if => Puppet.features.microsoft_windows? filter
+    # is passed-in to the top-level describe block on
+    # non-Windows platforms; it just won't run them. However
+    # on these platforms, the loading will fail because this
+    # test uses a shared example that references variables
+    # from the Windows::Service module when building the unit
+    # tests, which is only available on Windows platforms.
+    # Thus, we add the next here to ensure that rspec does not
+    # attempt to load our test code. This is OK for us to do
+    # because we do not want to run these tests on non-Windows
+    # platforms.
+    next unless Puppet.features.microsoft_windows?
+
+    context "when the service control manager cannot be opened" do
+      let(:scm) { FFI::Pointer::NULL_HANDLE }
+      it "raises a puppet error" do
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
+    end
 
-      it "waits for at least 1 second if wait hint/10 is < 1 second" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(1)
-        subject.start(mock_service_name)
+    context "when the service cannot be opened" do
+      let(:service) { FFI::Pointer::NULL_HANDLE }
+      it "raises a puppet error" do
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
+    end
 
-      it "waits for at most 10 seconds if wait hint/10 is > 10 seconds" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 1000000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).with(10)
-        subject.start(mock_service_name)
+    context "when the service can be opened" do
+      # Can't use rspec's subject here because that
+      # can only be referenced inside an 'it' block.
+      service = Puppet::Util::Windows::Service
+      valid_initial_states = [
+        service::SERVICE_STOP_PENDING,
+        service::SERVICE_STOPPED,
+        service::SERVICE_START_PENDING
+      ]
+      final_state = service::SERVICE_RUNNING
+
+      include_examples "a service action that transitions the service state", :start, valid_initial_states, service::SERVICE_START_PENDING, final_state do
+        let(:initial_state) { subject::SERVICE_STOPPED }
+        let(:mock_state_transition) do
+          lambda do
+            subject.stubs(:StartServiceW).returns(1)
+          end
+        end
       end
 
-      it "raises a puppet error if the service's configured dwWaitHint has passed and dwCheckPoint hasn't increased" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 40000, :dwCheckPoint => 0}).times(11)
-        subject.expects(:sleep).times(10).with(4)
-        expect{subject.start(mock_service_name)}.to raise_error(Puppet::Error)
+      it "raises a Puppet::Error if StartServiceW returns false" do
+        expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_STOPPED)
+
+        subject.expects(:StartServiceW).returns(FFI::WIN32_FALSE)
+
+        expect { subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
 
-      it "Does not raise an error if the service makes progress" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 0})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 2})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 30})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 0, :dwCheckPoint => 98})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        subject.expects(:sleep).times(5).with(1)
-        expect{subject.start(mock_service_name)}.to_not raise_error
+      it "starts the service" do
+        expect_successful_status_queries_and_return(
+          { dwCurrentState: subject::SERVICE_STOPPED },
+          { dwCurrentState: subject::SERVICE_RUNNING }
+        )
+
+        subject.expects(:StartServiceW).returns(1)
+
+        subject.start(mock_service_name, timeout: timeout)
       end
     end
   end
 
   describe "#stop" do
+    next unless Puppet.features.microsoft_windows?
+
     context "when the service control manager cannot be opened" do
       let(:scm) { FFI::Pointer::NULL_HANDLE }
       it "raises a puppet error" do
-        expect{ subject.stop(mock_service_name) }.to raise_error(Puppet::Error)
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
 
     context "when the service cannot be opened" do
       let(:service) { FFI::Pointer::NULL_HANDLE }
       it "raises a puppet error" do
-        expect{ subject.stop(mock_service_name) }.to raise_error(Puppet::Error)
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
 
-    context "when the service can be opened and is in the running state:" do
-      before do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
+    context "when the service can be opened" do
+      service = Puppet::Util::Windows::Service
+      valid_initial_states = service::SERVICE_STATES.keys - [service::SERVICE_STOPPED]
+      final_state = service::SERVICE_STOPPED
+
+      include_examples "a service action that transitions the service state", :stop, valid_initial_states, service::SERVICE_STOP_PENDING, final_state do
+        let(:initial_state) { subject::SERVICE_RUNNING }
+        let(:mock_state_transition) do
+          lambda do
+            subject.stubs(:ControlService).returns(1)
+          end
+        end
       end
 
-      it "Sends the SERVICE_CONTROL_STOP to the service once the service reports SERVICE_RUNNING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        subject.stop(mock_service_name)
+      it "raises a Puppet::Error if ControlService returns false" do
+        expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_RUNNING)
+
+        subject.stubs(:ControlService).returns(FFI::WIN32_FALSE)
+
+        expect { subject.stop(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
 
-      it "Raises an error if after calling ControlService the service is not in STOPPED or STOP_PENDING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_PAUSED})
-        expect{ subject.stop(mock_service_name) }.to raise_error(Puppet::Error)
+      it "stops the service" do
+        expect_successful_status_queries_and_return(
+          { dwCurrentState: subject::SERVICE_RUNNING },
+          { dwCurrentState: subject::SERVICE_STOPPED }
+        )
+
+        subject.expects(:ControlService).returns(1)
+
+        subject.stop(mock_service_name, timeout: timeout)
       end
+    end
+  end
+
+  describe "#resume" do
+    next unless Puppet.features.microsoft_windows?
 
-      it "raises a puppet error if ControlService returns false" do
-        subject.expects(:ControlService).returns(FFI::WIN32_FALSE)
-        expect{ subject.stop(mock_service_name) }.to raise_error(Puppet::Error)
+    context "when the service control manager cannot be opened" do
+      let(:scm) { FFI::Pointer::NULL_HANDLE }
+      it "raises a puppet error" do
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
 
-    # No need to retest much of the wait functionality here, since
-    # both stop and start use the wait_for_pending_transition helper
-    # which is tested in the start unit tests.
-    context "when the service hasn't started yet:" do
-      it "waits, then queries again until SERVICE_STOPPED" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_START_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        subject.expects(:sleep).with(3).twice
-        subject.stop(mock_service_name)
+    context "when the service cannot be opened" do
+      let(:service) { FFI::Pointer::NULL_HANDLE }
+      it "raises a puppet error" do
+        expect{ subject.start(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
       end
     end
 
-    context "when the service ends up in STOP_PENDING:" do
-      it "waits, then queries again until SERVICE_RUNNING" do
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_RUNNING})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 1})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOP_PENDING, :dwWaitHint => 30000, :dwCheckPoint => 50})
-        expect_successful_status_query_and_return({:dwCurrentState => subject::SERVICE_STOPPED})
-        subject.expects(:sleep).with(3).twice
-        subject.stop(mock_service_name)
+    context "when the service can be opened" do
+      service = Puppet::Util::Windows::Service
+      valid_initial_states = [
+        service::SERVICE_PAUSE_PENDING,
+        service::SERVICE_PAUSED,
+        service::SERVICE_CONTINUE_PENDING
+      ]
+      final_state = service::SERVICE_RUNNING
+
+      include_examples "a service action that transitions the service state", :resume, valid_initial_states, service::SERVICE_CONTINUE_PENDING, final_state do
+        let(:initial_state) { service::SERVICE_PAUSED }
+        let(:mock_state_transition) do
+          lambda do
+            # We need to mock the status query because in the block for #resume, we
+            # wait for the service to enter the SERVICE_PAUSED state prior to
+            # performing the transition (in case it is in SERVICE_PAUSE_PENDING).
+            expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_PAUSED)
+
+            subject.stubs(:ControlService).returns(1)
+          end
+        end
+      end
+
+      context "waiting for the SERVICE_PAUSE_PENDING => SERVICE_PAUSED transition to finish before resuming it" do
+        before(:each) do
+          # This mocks the status query to return the SERVICE_RUNNING state by default.
+          # Otherwise, we will fail the tests in the latter parts of the code where we
+          # wait for the service to finish transitioning to the 'SERVICE_RUNNING' state.
+          subject::SERVICE_STATUS_PROCESS.stubs(:new).returns(dwCurrentState: subject::SERVICE_RUNNING)
+
+          expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_PAUSE_PENDING)
+
+          subject.stubs(:ControlService).returns(1)
+        end
+
+        include_examples "a service action waiting on a pending transition", service::SERVICE_PAUSE_PENDING do
+          let(:action) { :resume }
+        end
+      end
+
+      it "raises a Puppet::Error if ControlService returns false" do
+        expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_PAUSED)
+        expect_successful_status_query_and_return(dwCurrentState: subject::SERVICE_PAUSED)
+
+        subject.stubs(:ControlService).returns(FFI::WIN32_FALSE)
+
+        expect { subject.resume(mock_service_name, timeout: timeout) }.to raise_error(Puppet::Error)
+      end
+
+      it "resumes the service" do
+        expect_successful_status_queries_and_return(
+          { dwCurrentState: subject::SERVICE_PAUSED },
+          { dwCurrentState: subject::SERVICE_PAUSED },
+          { dwCurrentState: subject::SERVICE_RUNNING }
+        )
+
+        subject.expects(:ControlService).returns(1)
+
+        subject.resume(mock_service_name, timeout: timeout)
       end
     end
   end