SCMOD-8730: Support expiry policies

README.md

@@ -4,7 +4,7 @@ Manifest of the components which make up the Job Service:
 * [job-service](job-service)
 * [job-service-acceptance-tests](job-service-acceptance-tests)
 * [job-service-caller](job-service-caller)
-* [job-service-client](job-service-client)
+* [job-service-internal-client](job-service-internal-client)
 * [job-service-container](job-service-container)
 * [job-service-contract](job-service-contract)
 * [job-service-db](job-service-db)

job-service-acceptance-tests/src/test/java/com/hpe/caf/jobservice/acceptance/JobServiceEndToEndIT.java

@@ -26,8 +26,11 @@
 import com.hpe.caf.services.job.client.ApiClient;
 import com.hpe.caf.services.job.client.ApiException;
 import com.hpe.caf.services.job.client.api.JobsApi;
+import com.hpe.caf.services.job.client.model.Action;
+import com.hpe.caf.services.job.client.model.ExpirationPolicy;
 import com.hpe.caf.services.job.client.model.Job;
 import com.hpe.caf.services.job.client.model.NewJob;
+import com.hpe.caf.services.job.client.model.Policy;
 import com.hpe.caf.services.job.client.model.WorkerAction;
 import com.hpe.caf.worker.batch.BatchWorkerConstants;
 import com.hpe.caf.worker.batch.BatchWorkerTask;
@@ -1268,6 +1271,12 @@ private NewJob constructNewJob(String jobId, final boolean useTaskDataObject) th
         String jobName = "Job_" + jobId;
         NewJob newJob = new NewJob();
         newJob.setName(jobName);
+        final Policy policyActive = new Policy();
+        policyActive.setAction(Action.delete);
+        policyActive.setExpiryTime(new Date());
+        final ExpirationPolicy expirationPolicy = new ExpirationPolicy();
+        expirationPolicy.setActive(policyActive);
+        newJob.setExpirationPolicy(expirationPolicy);
         newJob.setDescription(jobName + " description");
         newJob.setExternalData(jobName + " external data");
         newJob.setTask(batchWorkerAction);

job-service-contract/src/main/resources/com/hpe/caf/services/job/swagger.yaml

@@ -298,6 +298,8 @@ definitions:
       description:
         type: string
         description: The description of the job
+      expirationPolicy:
+        $ref: "#/definitions/expirationPolicy"
       externalData:
         # TODO: Should we make this more structured than just string
         #       Name/Value Pairs perhaps
@@ -323,7 +325,7 @@ definitions:
       delay:
         type: integer
         format: int32
-        default: 0		
+        default: 0
         description: The time in seconds after the prerequisite job identifiers have completed before this job is eligible for running.
       labels:
         type: object
@@ -335,6 +337,41 @@ definitions:
         example:
           "tag:4": "4"
           owner: "bob"
+  expirationPolicy:
+    type: object
+    properties:
+      "Active":
+        $ref: "#/definitions/policy"
+      "Completed":
+        $ref: "#/definitions/policy"
+      "Failed":
+        $ref: "#/definitions/policy"
+      "Cancelled":
+        $ref: "#/definitions/policy"
+      "Waiting":
+        $ref: "#/definitions/policy"
+      "Paused":
+        $ref: "#/definitions/policy"
+      "Default":
+        $ref: "#/definitions/policy"
+    description: The expiration policy to be applied on the job
+  policy:
+    type: object
+    properties:
+      expiryTime:
+        type: string
+        format: date-time
+        default: 2222-04-12T23:20:50.52Z
+      action:
+        $ref: "#/definitions/action"
+    description: The expiration details to be applied on the job
+  action:
+    type: string
+    enum:
+      - expire
+      - delete
+    default: expire
+    description: The action to apply on expired jobs
   worker-action:
     type: object
     required:
@@ -372,6 +409,8 @@ definitions:
       description:
         type: string
         description: The description of the job
+      expirationPolicy:
+        $ref: "#/definitions/expirationPolicy"
       externalData:
         type: string
         description: |

job-service/src/main/java/com/hpe/caf/services/job/api/generated/model/Action.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2016-2021 Micro Focus or one of its affiliates.
+ *
+ * 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.
+ */
+package com.hpe.caf.services.job.api.generated.model;
+
+/**
+ * The action to apply on expired jobs
+ **/
+public enum Action {
+    expire, delete
+}

job-service/src/main/java/com/hpe/caf/services/job/api/generated/model/ExpirationPolicy.java

@@ -0,0 +1,140 @@
+/*
+ * Copyright 2016-2021 Micro Focus or one of its affiliates.
+ *
+ * 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.
+ */
+package com.hpe.caf.services.job.api.generated.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.util.Objects;
+
+@ApiModel(
+        description = "The expiration policy to be applied on the job"
+)
+public class ExpirationPolicy {
+    private Policy active = null;
+    private Policy completed = null;
+    private Policy failed = null;
+    private Policy cancelled = null;
+    private Policy waiting = null;
+    private Policy paused = null;
+    private Policy _default = null;
+
+    public ExpirationPolicy() {
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Active")
+    public Policy getActive() {
+        return this.active;
+    }
+
+    public void setActive(Policy active) {
+        this.active = active;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Completed")
+    public Policy getCompleted() {
+        return this.completed;
+    }
+
+    public void setCompleted(Policy completed) {
+        this.completed = completed;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Failed")
+    public Policy getFailed() {
+        return this.failed;
+    }
+
+    public void setFailed(Policy failed) {
+        this.failed = failed;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Cancelled")
+    public Policy getCancelled() {
+        return this.cancelled;
+    }
+
+    public void setCancelled(Policy cancelled) {
+        this.cancelled = cancelled;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Waiting")
+    public Policy getWaiting() {
+        return this.waiting;
+    }
+
+    public void setWaiting(Policy waiting) {
+        this.waiting = waiting;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Paused")
+    public Policy getPaused() {
+        return this.paused;
+    }
+
+    public void setPaused(Policy paused) {
+        this.paused = paused;
+    }
+
+    @ApiModelProperty("")
+    @JsonProperty("Default")
+    public Policy getDefault() {
+        return this._default;
+    }
+
+    public void setDefault(Policy _default) {
+        this._default = _default;
+    }
+
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        } else if (o != null && this.getClass() == o.getClass()) {
+            ExpirationPolicy expirationPolicy = (ExpirationPolicy)o;
+            return Objects.equals(this.active, expirationPolicy.active) && Objects.equals(this.completed, expirationPolicy.completed) && Objects.equals(this.failed, expirationPolicy.failed) && Objects.equals(this.cancelled, expirationPolicy.cancelled) && Objects.equals(this.waiting, expirationPolicy.waiting) && Objects.equals(this.paused, expirationPolicy.paused) && Objects.equals(this._default, expirationPolicy._default);
+        } else {
+            return false;
+        }
+    }
+
+    public int hashCode() {
+        return Objects.hash(new Object[]{this.active, this.completed, this.failed, this.cancelled, this.waiting, this.paused, this._default});
+    }
+
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("class ExpirationPolicy {\n");
+        sb.append("    active: ").append(this.toIndentedString(this.active)).append("\n");
+        sb.append("    completed: ").append(this.toIndentedString(this.completed)).append("\n");
+        sb.append("    failed: ").append(this.toIndentedString(this.failed)).append("\n");
+        sb.append("    cancelled: ").append(this.toIndentedString(this.cancelled)).append("\n");
+        sb.append("    waiting: ").append(this.toIndentedString(this.waiting)).append("\n");
+        sb.append("    paused: ").append(this.toIndentedString(this.paused)).append("\n");
+        sb.append("    _default: ").append(this.toIndentedString(this._default)).append("\n");
+        sb.append("}");
+        return sb.toString();
+    }
+
+    private String toIndentedString(Object o) {
+        return o == null ? "null" : o.toString().replace("\n", "\n    ");
+    }
+}

job-service/src/main/java/com/hpe/caf/services/job/api/generated/model/Job.java

@@ -35,6 +35,7 @@ public class Job   {
     private String id = null;
     private String name = null;
     private String description = null;
+    private ExpirationPolicy expirationPolicy = null;
     /**
      * @deprecated 21/01/2020 - Replaced by labels functionality.
      */
@@ -126,6 +127,15 @@ public void setDescription(String description) {
         this.description = description;
     }
 
+    @ApiModelProperty("")
+    @JsonProperty("expirationPolicy")
+    public ExpirationPolicy getExpirationPolicy() {
+        return this.expirationPolicy;
+    }
+
+    public void setExpirationPolicy(ExpirationPolicy expirationPolicy) {
+        this.expirationPolicy = expirationPolicy;
+    }
 
     /**
      * External data can be associated with the job for use by other components
@@ -260,6 +270,7 @@ public boolean equals(Object o) {
         return Objects.equals(id, job.id) &&
                 Objects.equals(name, job.name) &&
                 Objects.equals(description, job.description) &&
+                Objects.equals(this.expirationPolicy, job.expirationPolicy) &&
                 Objects.equals(externalData, job.externalData) &&
                 Objects.equals(createTime, job.createTime) &&
                 Objects.equals(this.lastUpdateTime, job.lastUpdateTime) &&
@@ -270,7 +281,8 @@ public boolean equals(Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(id, name, description, externalData, createTime, lastUpdateTime, status, percentageComplete, failures);
+        return Objects.hash(id, name, description, this.expirationPolicy, externalData, createTime, lastUpdateTime, status,
+                percentageComplete, failures);
     }
 
     @Override
@@ -281,6 +293,7 @@ public String toString() {
         sb.append("    id: ").append(toIndentedString(id)).append("\n");
         sb.append("    name: ").append(toIndentedString(name)).append("\n");
         sb.append("    description: ").append(toIndentedString(description)).append("\n");
+        sb.append("    expirationPolicy: ").append(this.toIndentedString(this.expirationPolicy)).append("\n");
         sb.append("    externalData: ").append(toIndentedString(externalData)).append("\n");
         sb.append("    createTime: ").append(toIndentedString(createTime)).append("\n");
         sb.append("    lastUpdateTime: ").append(toIndentedString(lastUpdateTime)).append("\n");

job-service/src/main/java/com/hpe/caf/services/job/api/generated/model/NewJob.java

@@ -35,6 +35,7 @@ public class NewJob   {
 
     private String name = null;
     private String description = null;
+    private ExpirationPolicy expirationPolicy = null;
     /**
      * @deprecated 21/01/2020 - Replaced by labels functionality.
      */
@@ -84,6 +85,19 @@ public void setDescription(String description) {
         this.description = description;
     }
 
+    /**
+     **/
+
+    @ApiModelProperty(value = "")
+    @JsonProperty("expirationPolicy")
+    public ExpirationPolicy getExpirationPolicy() {
+        return expirationPolicy;
+    }
+    public void setExpirationPolicy(ExpirationPolicy expirationPolicy) {
+        this.expirationPolicy = expirationPolicy;
+    }
+
+
 
     /**
      * External data can be associated with the job for use by other components
@@ -221,6 +235,7 @@ public boolean equals(Object o) {
         NewJob newJob = (NewJob) o;
         return Objects.equals(name, newJob.name) &&
                 Objects.equals(description, newJob.description) &&
+                Objects.equals(expirationPolicy, newJob.expirationPolicy) &&
                 Objects.equals(externalData, newJob.externalData) &&
                 Objects.equals(task, newJob.task) &&
                 Objects.equals(prerequisiteJobIds, newJob.prerequisiteJobIds) &&
@@ -229,7 +244,7 @@ public boolean equals(Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(name, description, externalData, task, prerequisiteJobIds, delay);
+        return Objects.hash(name, description, expirationPolicy, externalData, task, prerequisiteJobIds, delay);
     }
 
     @Override
@@ -239,6 +254,7 @@ public String toString() {
 
         sb.append("    name: ").append(toIndentedString(name)).append("\n");
         sb.append("    description: ").append(toIndentedString(description)).append("\n");
+        sb.append("    expirationPolicy: ").append(toIndentedString(expirationPolicy)).append("\n");
         sb.append("    externalData: ").append(toIndentedString(externalData)).append("\n");
         sb.append("    task: ").append(toIndentedString(task)).append("\n");
         sb.append("    prerequisiteJobIds: ").append(toIndentedString(prerequisiteJobIds)).append("\n");