Updated to latest AWS CodePipeline model

Using the latest AWS CodePipeline SDK and model. Updated the internal job worker
classes to reflect the latest model changes.

Author: schmittthomas

README.md

@@ -35,9 +35,9 @@ The job worker comes with two pre-defined configuration classes: `CustomActionJo
 
 You can configure the following settings:
 ```java
-// Configure action type the job worker polls for
-public ActionType getActionType() {
-    return new ActionType(
+// Configure action type id the job worker polls for
+public ActionTypeId getActionTypeId() {
+    return new ActionTypeId(
         "Deploy",          // Action Type Category: Source, Build, Test, Deploy, Invoke
         "Custom",          // Action Type Owner: Custom or ThirdParty
         "MyCustomAction",  // Action Type Provider: Name of your action type

lib/aws_sdk/AWSCodePipelineJavaClient-1.0.jar

@@ -13,7 +13,7 @@
 package com.amazonaws.codepipeline.jobworker.configuration;
 
 import com.amazonaws.codepipeline.jobworker.JobService;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.plugin.customaction.CustomActionJobService;
 
 /**
@@ -25,13 +25,13 @@ public class CustomActionJobWorkerConfiguration extends DefaultJobWorkerConfigur
      * Action type this job worker is polling and processing jobs for.
      * @return action type identifier
      */
-    public ActionType getActionType() {
-        return new ActionType("Deploy", "Custom", "MyCustomAction", "1");
+    public ActionTypeId getActionTypeId() {
+        return new ActionTypeId("Deploy", "Custom", "MyCustomAction", "1");
     }
 
     /**
      * @return job service implementation fpr the custom action API.
      */
     @Override
-    public JobService jobService() { return new CustomActionJobService(codePipelineClient(), getActionType()); }
+    public JobService jobService() { return new CustomActionJobService(codePipelineClient(), getActionTypeId()); }
 }

src/com/amazonaws/codepipeline/jobworker/configuration/CustomActionJobWorkerConfiguration.java

@@ -13,7 +13,7 @@
 package com.amazonaws.codepipeline.jobworker.configuration;
 
 import com.amazonaws.codepipeline.jobworker.JobService;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.plugin.thirdparty.ClientTokenProvider;
 import com.amazonaws.codepipeline.jobworker.plugin.thirdparty.DefaultClientTokenProvider;
 import com.amazonaws.codepipeline.jobworker.plugin.thirdparty.ThirdPartyJobService;
@@ -31,15 +31,15 @@ public class ThirdPartyJobWorkerConfiguration extends DefaultJobWorkerConfigurat
      * Action type this job worker is polling and processing jobs for.
      * @return action type identifier
      */
-    public ActionType getActionType() {
-        return new ActionType("Deploy", "ThirdParty", "ThirdPartyDeployProvider", "1");
+    public ActionTypeId getActionTypeId() {
+        return new ActionTypeId("Deploy", "ThirdParty", "ThirdPartyDeployProvider", "1");
     }
 
     /**
      * @return job service implementation for the third party API.
      */
     @Override
-    public JobService jobService() { return new ThirdPartyJobService(codePipelineClient(), getActionType(), clientTokenProvider()); }
+    public JobService jobService() { return new ThirdPartyJobService(codePipelineClient(), getActionTypeId(), clientTokenProvider()); }
 
     /**
      * @return the poll interval in milliseconds

src/com/amazonaws/codepipeline/jobworker/configuration/ThirdPartyJobWorkerConfiguration.java

@@ -17,20 +17,20 @@
 /**
  * Action type uniquely identifies a specific action which can be used in pipelines.
  */
-public class ActionType {
+public class ActionTypeId {
     private final String category;
     private final String owner;
     private final String provider;
     private final String version;
 
     /**
-     * Initializes the action type
+     * Initializes the action type id.
      * @param category action category (Source, Build, Test, Deploy, etc...)
      * @param owner action owner (AWS, ThirdParty or CustomAction)
      * @param provider action provider (CodeDeploy, ElasticBeanstalk, OpsWorks, etc...)
      * @param version action version
      */
-    public ActionType(final String category, final String owner, final String provider, final String version) {
+    public ActionTypeId(final String category, final String owner, final String provider, final String version) {
         Validator.notNull(category);
         Validator.notNull(owner);
         Validator.notNull(provider);

src/com/amazonaws/codepipeline/jobworker/model/ActionType.java renamed to src/com/amazonaws/codepipeline/jobworker/model/ActionTypeId.java

@@ -20,6 +20,7 @@
 public class FailureDetails {
     private final FailureType type;
     private final String message;
+    private final String externalExecutionId;
 
     /**
      * Initializes the failure details to report the reason for the job failure.
@@ -29,6 +30,7 @@ public FailureDetails(final FailureType type) {
         Validator.notNull(type);
         this.type = type;
         this.message = null;
+        this.externalExecutionId = null;
     }
 
     /**
@@ -40,6 +42,20 @@ public FailureDetails(final FailureType type, final String message) {
         Validator.notNull(type);
         this.type = type;
         this.message = message;
+        this.externalExecutionId = null;
+    }
+
+    /**
+     * Initializes the failure details to report the reason for the job failure.
+     * @param type failure type / failure class
+     * @param message message indicating why the job failed
+     * @param externalExecutionId the id of the external execution.
+     */
+    public FailureDetails(final FailureType type, final String message, final String externalExecutionId) {
+        Validator.notNull(type);
+        this.type = type;
+        this.message = message;
+        this.externalExecutionId = externalExecutionId;
     }
 
     /**
@@ -55,4 +71,11 @@ public FailureType getType() {
     public String getMessage() {
         return message;
     }
+
+    /**
+     * @return the id of the external execution.
+     */
+    public String getExternalExecutionId() {
+        return externalExecutionId;
+    }
 }

src/com/amazonaws/codepipeline/jobworker/model/FailureDetails.java

@@ -17,7 +17,7 @@
 import java.util.stream.Collectors;
 
 import com.amazonaws.codepipeline.jobworker.model.AWSSessionCredentials;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.model.Artifact;
 import com.amazonaws.codepipeline.jobworker.model.CurrentRevision;
 import com.amazonaws.codepipeline.jobworker.model.ExecutionDetails;
@@ -161,15 +161,15 @@ public final static com.amazonaws.services.codepipeline.model.FailureDetails con
 
     /**
      * Converts the third party action type structure into the internal job worker structure.
-     * @param actionType action type identifier
+     * @param actionTypeId action type identifier
      * @return action type identifier (internal model)
      */
-    public final static com.amazonaws.services.codepipeline.model.ActionType convert(final ActionType actionType) {
-        final com.amazonaws.services.codepipeline.model.ActionType result = new com.amazonaws.services.codepipeline.model.ActionType();
-        result.setCategory(actionType.getCategory());
-        result.setOwner(actionType.getOwner());
-        result.setProvider(actionType.getProvider());
-        result.setVersion(actionType.getVersion());
+    public final static com.amazonaws.services.codepipeline.model.ActionTypeId convert(final ActionTypeId actionTypeId) {
+        final com.amazonaws.services.codepipeline.model.ActionTypeId result = new com.amazonaws.services.codepipeline.model.ActionTypeId();
+        result.setCategory(actionTypeId.getCategory());
+        result.setOwner(actionTypeId.getOwner());
+        result.setProvider(actionTypeId.getProvider());
+        result.setVersion(actionTypeId.getVersion());
         return result;
     }
 }

src/com/amazonaws/codepipeline/jobworker/plugin/JobConverter.java

@@ -19,7 +19,7 @@
 
 import com.amazonaws.codepipeline.jobworker.JobService;
 import com.amazonaws.codepipeline.jobworker.Validator;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.model.CurrentRevision;
 import com.amazonaws.codepipeline.jobworker.model.ExecutionDetails;
 import com.amazonaws.codepipeline.jobworker.model.FailureDetails;
@@ -42,19 +42,19 @@ public class CustomActionJobService implements JobService {
     private static final Logger LOGGER = Logger.getLogger(CustomActionJobService.class);
 
     private final AmazonCodePipelineClient codePipelineClient;
-    private final ActionType actionType;
+    private final ActionTypeId actionTypeId;
 
     /**
      * Initializes the custom action job service wrapper.
      * @param codePipelineClient service client for the AWS CodePipeline api.
-     * @param actionType action type to poll for.
+     * @param actionTypeId action type id to poll for.
      */
-    public CustomActionJobService(final AmazonCodePipelineClient codePipelineClient, final ActionType actionType) {
+    public CustomActionJobService(final AmazonCodePipelineClient codePipelineClient, final ActionTypeId actionTypeId) {
         Validator.notNull(codePipelineClient);
-        Validator.notNull(actionType);
+        Validator.notNull(actionTypeId);
 
         this.codePipelineClient = codePipelineClient;
-        this.actionType = actionType;
+        this.actionTypeId = actionTypeId;
     }
 
     /**
@@ -64,11 +64,11 @@ public CustomActionJobService(final AmazonCodePipelineClient codePipelineClient,
      */
     @Override
     public List<WorkItem> pollForJobs(final int maxBatchSize) {
-        LOGGER.info(String.format("PollForJobs for action type %s", actionType));
+        LOGGER.info(String.format("PollForJobs for action type id %s", actionTypeId));
         final List<WorkItem> result = new ArrayList<>();
 
         final PollForJobsRequest pollForJobsRequest = new PollForJobsRequest();
-        pollForJobsRequest.setActionType(getActionType());
+        pollForJobsRequest.setActionTypeId(getActionTypeId());
         pollForJobsRequest.setMaxBatchSize(maxBatchSize);
 
         final PollForJobsResult pollForJobsResult = codePipelineClient.pollForJobs(pollForJobsRequest);
@@ -134,7 +134,7 @@ public void putJobFailure(final String jobId, final String clientId, final Failu
         codePipelineClient.putJobFailureResult(request);
     }
 
-    private com.amazonaws.services.codepipeline.model.ActionType getActionType() {
-        return JobConverter.convert(actionType);
+    private com.amazonaws.services.codepipeline.model.ActionTypeId getActionTypeId() {
+        return JobConverter.convert(actionTypeId);
     }
 }

src/com/amazonaws/codepipeline/jobworker/plugin/customaction/CustomActionJobService.java

@@ -18,7 +18,7 @@
 import org.apache.log4j.Logger;
 
 import com.amazonaws.codepipeline.jobworker.Validator;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.JobService;
 import com.amazonaws.codepipeline.jobworker.model.CurrentRevision;
 import com.amazonaws.codepipeline.jobworker.model.ExecutionDetails;
@@ -45,23 +45,23 @@ public class ThirdPartyJobService implements JobService {
     private static final Logger LOGGER = Logger.getLogger(ThirdPartyJobService.class);
 
     private final AmazonCodePipelineClient codePipelineClient;
-    private final ActionType actionType;
+    private final ActionTypeId actionTypeId;
     private final ClientTokenProvider clientTokenProvider;
 
     /**
      * Initializes the third party job service wrapper.
      * @param codePipelineClient service client for the AWS CodePipeline api.
-     * @param actionType action type to poll for.
+     * @param actionTypeId action type to poll for.
      * @param clientTokenProvider client token provider to look up client token by client id
      *                            in order to get the job details.
      */
-    public ThirdPartyJobService(final AmazonCodePipelineClient codePipelineClient, final ActionType actionType, final ClientTokenProvider clientTokenProvider) {
+    public ThirdPartyJobService(final AmazonCodePipelineClient codePipelineClient, final ActionTypeId actionTypeId, final ClientTokenProvider clientTokenProvider) {
         Validator.notNull(codePipelineClient);
-        Validator.notNull(actionType);
+        Validator.notNull(actionTypeId);
         Validator.notNull(clientTokenProvider);
 
         this.codePipelineClient = codePipelineClient;
-        this.actionType = actionType;
+        this.actionTypeId = actionTypeId;
         this.clientTokenProvider = clientTokenProvider;
     }
 
@@ -72,11 +72,11 @@ public ThirdPartyJobService(final AmazonCodePipelineClient codePipelineClient, f
      */
     @Override
     public List<WorkItem> pollForJobs(final int maxBatchSize) {
-        LOGGER.info(String.format("PollForThirdPartyJobs for action type '%s'", actionType));
+        LOGGER.info(String.format("PollForThirdPartyJobs for action type id '%s'", actionTypeId));
         final List<WorkItem> result = new ArrayList<>();
 
         final PollForThirdPartyJobsRequest pollForJobsRequest = new PollForThirdPartyJobsRequest();
-        pollForJobsRequest.setActionType(getActionType());
+        pollForJobsRequest.setActionTypeId(getActionTypeId());
         pollForJobsRequest.setMaxBatchSize(maxBatchSize);
 
         final PollForThirdPartyJobsResult pollForJobsResult = codePipelineClient.pollForThirdPartyJobs(pollForJobsRequest);
@@ -155,7 +155,7 @@ private ThirdPartyJobDetails getJobDetails(final String jobId, final String clie
         return getJobDetailsResult.getJobDetails();
     }
 
-    private com.amazonaws.services.codepipeline.model.ActionType getActionType() {
-        return JobConverter.convert(actionType);
+    private com.amazonaws.services.codepipeline.model.ActionTypeId getActionTypeId() {
+        return JobConverter.convert(actionTypeId);
     }
 }

src/com/amazonaws/codepipeline/jobworker/plugin/thirdparty/ThirdPartyJobService.java

@@ -30,7 +30,7 @@
 import org.mockito.MockitoAnnotations;
 
 import com.amazonaws.codepipeline.jobworker.JobService;
-import com.amazonaws.codepipeline.jobworker.model.ActionType;
+import com.amazonaws.codepipeline.jobworker.model.ActionTypeId;
 import com.amazonaws.codepipeline.jobworker.model.CurrentRevision;
 import com.amazonaws.codepipeline.jobworker.model.ExecutionDetails;
 import com.amazonaws.codepipeline.jobworker.model.FailureDetails;
@@ -49,7 +49,7 @@
 public class CustomActionJobServiceTest {
 
     private JobService jobService;
-    private final ActionType actionType = new ActionType("Build", "Custom", "MyCustomAction", "1.0");
+    private final ActionTypeId actionTypeId = new ActionTypeId("Build", "Custom", "MyCustomAction", "1.0");
 
     @Mock
     private AmazonCodePipelineClient codePipelineClient;
@@ -66,16 +66,16 @@ public class CustomActionJobServiceTest {
     @Before
     public void setUp() {
         MockitoAnnotations.initMocks(this);
-        jobService = new CustomActionJobService(codePipelineClient, actionType);
+        jobService = new CustomActionJobService(codePipelineClient, actionTypeId);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void shouldThrowWhenCodePipelineClientIsNull() {
-        new CustomActionJobService(null, actionType);
+        new CustomActionJobService(null, actionTypeId);
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void shouldThrowWhenActionTypeIsNull() {
+    public void shouldThrowWhenActionTypeIdIsNull() {
         new CustomActionJobService(codePipelineClient, null);
     }