Pass IsCommandNoop diagnostic information through PutHostCommandAcknowledgement

This patch allows us to pass diagnostic information on whether a command is a noop
or not from the Agent to CodeDeploy commands service, which CodeDeploy service
team will track.

Author: jcbhl

lib/instance_agent/plugins/codedeploy/command_poller.rb

@@ -90,10 +90,9 @@ def graceful_shutdown
         end
 
         def acknowledge_and_process_command(command)
-          return unless acknowledge_command(command)
-
           begin
             spec = get_deployment_specification(command)
+            return unless acknowledge_command(command, spec)
             process_command(command, spec)
             #Commands that throw an exception will be considered to have failed
           rescue Exception => e
@@ -161,10 +160,18 @@ def next_command
         end
 
         private
-        def acknowledge_command(command)
+        def get_ack_diagnostics(command, spec)
+          is_command_noop = @plugin.is_command_noop?(command.command_name, spec)
+          return {:format => "JSON", :payload => {'IsCommandNoop' => is_command_noop}.to_json()}
+        end
+
+        private
+        def acknowledge_command(command, spec)
+          ack_diagnostics = get_ack_diagnostics(command, spec)
+
           log(:debug, "Calling PutHostCommandAcknowledgement:")
           output =  @deploy_control_client.put_host_command_acknowledgement(
-          :diagnostics => nil,
+          :diagnostics => ack_diagnostics,
           :host_command_identifier => command.host_command_identifier)
           status = output.command_status
           log(:debug, "Command Status = #{status}")

test/instance_agent/plugins/codedeploy/command_poller_test.rb

@@ -14,14 +14,18 @@ def gather_diagnostics(script_output, msg = "")
     {'error_code' => InstanceAgent::Plugins::CodeDeployPlugin::ScriptError::SUCCEEDED_CODE, 'script_name' => "", 'message' => "Succeeded: #{msg}", 'log' => script_output}.to_json
   end
 
+  def get_ack_diagnostics(is_command_noop)
+    return {:format => "JSON", :payload => {'IsCommandNoop' => is_command_noop}.to_json()}
+  end
+
   context 'The command poller' do
 
     setup do
       @host_identifier = "i-123"
       @aws_region = 'us-east-1'
       @deploy_control_endpoint = "my-deploy-control.amazon.com"
-      @deploy_control_client = mock()
-      @deploy_control_api = mock()
+      @deploy_control_client = mock('deploy-control-client')
+      @deploy_control_api = mock('deploy-control-api')
       @executor = stub(:execute_command => "test this is not returned",
                        :deployment_system => "CodeDeploy")
 
@@ -107,6 +111,7 @@ def gather_diagnostics(script_output, msg = "")
           starts_as('setup')
         @executor.stubs(:execute_command).
           when(@execute_command_state.is('setup'))
+        @executor.stubs(:is_command_noop?).returns(false)
 
         @put_host_command_complete_state = states('put_host_command_complete_state').
           starts_as('setup')
@@ -115,7 +120,7 @@ def gather_diagnostics(script_output, msg = "")
         @deployment_id  = stub(:deployment_id => "D-1234")
         InstanceAgent::Config.config[:root_dir] = File.join(Dir.tmpdir(), "CodeDeploy")
         InstanceAgent::Config.config[:ongoing_deployment_tracking] = "ongoing-deployment"
-        InstanceAgent::Plugins::CodeDeployPlugin::DeploymentSpecification.stubs(:parse).returns(@deployment_id) 
+        InstanceAgent::Plugins::CodeDeployPlugin::DeploymentSpecification.stubs(:parse).returns(@deployment_id)
         InstanceAgent::Plugins::CodeDeployPlugin::DeploymentCommandTracker.stubs(:delete_deployment_command_tracking_file).returns(true)
         InstanceAgent::Plugins::CodeDeployPlugin::DeploymentCommandTracker.stubs(:create_ongoing_deployment_tracking_file).returns(true)
       end
@@ -257,7 +262,7 @@ def gather_diagnostics(script_output, msg = "")
 
       should 'call PutHostCommandAcknowledgement with host_command_identifier returned by PollHostCommand' do
         @deploy_control_client.expects(:put_host_command_acknowledgement).
-          with(:diagnostics => nil,
+          with(:diagnostics => get_ack_diagnostics(false),
                :host_command_identifier => @command.host_command_identifier).
           returns(@poll_host_command_acknowledgement_output)
 
@@ -266,13 +271,10 @@ def gather_diagnostics(script_output, msg = "")
 
       should 'return when Succeeded command status is given by PutHostCommandAcknowledgement' do
         @deploy_control_client.expects(:put_host_command_acknowledgement).
-          with(:diagnostics => nil,
+          with(:diagnostics => get_ack_diagnostics(false),
                :host_command_identifier => @command.host_command_identifier).
           returns(stub(:command_status => "Succeeded"))
 
-        @get_deployment_specification_state.become('never')
-        @deploy_control_client.expects(:get_deployment_specification).never.
-          when(@get_deployment_specification_state.is('never'))
         @put_host_command_complete_state.become('never')
         @deploy_control_client.expects(:put_host_command_complete).never.
           when(@put_host_command_complete_state.is('never'))
@@ -281,39 +283,50 @@ def gather_diagnostics(script_output, msg = "")
       end
 
       context 'when Failed command status is given by PutHostCommandAcknowledgement' do
-        setup do
-          @deploy_control_client.expects(:put_host_command_acknowledgement).
-            with(:diagnostics => nil,
-                :host_command_identifier => @command.host_command_identifier).
-            returns(stub(:command_status => "Failed"))
+        context 'when the command is not a noop' do
+          setup do
+            @deploy_control_client.expects(:put_host_command_acknowledgement).
+              with(:diagnostics => get_ack_diagnostics(false),
+                  :host_command_identifier => @command.host_command_identifier).
+              returns(stub(:command_status => "Failed"))
+
+            @executor.expects(:is_command_noop?).
+              with(@command.command_name, @deployment_specification.generic_envelope).returns(false)
+          end
 
-          @deploy_control_client.expects(:get_deployment_specification).
-            with(:deployment_execution_id => @command.deployment_execution_id,
-               :host_identifier => @host_identifier).
-            returns(@get_deploy_specification_output)
-        end
+          should 'do nothing' do
+            @put_host_command_complete_state.become('never')
+            @deploy_control_client.expects(:put_host_command_complete).never.
+              when(@put_host_command_complete_state.is('never'))
 
-        should "return when the command is not a noop" do
-          @executor.expects(:is_command_noop?).
-            with(@command.command_name, @deployment_specification.generic_envelope).returns(false)
+            @poller.acknowledge_and_process_command(@command)
+          end
+        end
 
-          @put_host_command_complete_state.become('never')
-          @deploy_control_client.expects(:put_host_command_complete).never.
-            when(@put_host_command_complete_state.is('never'))
+        context 'when the command is a noop' do
+          setup do
+            @deploy_control_client.expects(:put_host_command_acknowledgement).
+              with(:diagnostics => get_ack_diagnostics(true),
+                  :host_command_identifier => @command.host_command_identifier).
+              returns(stub(:command_status => "Failed"))
 
-          @poller.acknowledge_and_process_command(@command)
-        end
+            @deploy_control_client.expects(:get_deployment_specification).
+              with(:deployment_execution_id => @command.deployment_execution_id,
+                  :host_identifier => @host_identifier).
+              returns(@get_deploy_specification_output)
 
-        should "PutHostCommandComplete when the command is a noop" do
-          @executor.expects(:is_command_noop?).
-            with(@command.command_name, @deployment_specification.generic_envelope).returns(true)
+            @executor.expects(:is_command_noop?).
+              with(@command.command_name, @deployment_specification.generic_envelope).returns(true).twice
+          end
 
-          @deploy_control_client.expects(:put_host_command_complete).
-            with(:command_status => "Succeeded",
-                :diagnostics => {:format => "JSON", :payload => gather_diagnostics("", "CompletedNoopCommand")},
-                :host_command_identifier => @command.host_command_identifier)
+          should 'call PutHostCommandComplete with Succeeded' do
+            @deploy_control_client.expects(:put_host_command_complete).
+              with(:command_status => "Succeeded",
+                  :diagnostics => {:format => "JSON", :payload => gather_diagnostics("", "CompletedNoopCommand")},
+                  :host_command_identifier => @command.host_command_identifier)
 
-          @poller.acknowledge_and_process_command(@command)
+            @poller.acknowledge_and_process_command(@command)
+          end
         end
       end