Update Supported Deployment Information

This commit adds support for additional deployment status values and reasons, while
retaining older options for backwards compatibility. It also adds filtering for the
value and reason.

[resolves #1039]

Signed-off-by: Paul Harris <[email protected]>

Author: twoseat

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/deployments/Deployment.java

@@ -93,5 +93,4 @@ public abstract class Deployment extends Resource {
     @Nullable
     public abstract Status getStatus();
 
-
 }

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/deployments/DeploymentStatusReason.java

@@ -20,7 +20,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
- * The state of a {@link Deployment}
+ * The status reason of a {@link Deployment}
  */
 public enum DeploymentStatusReason {
 
@@ -29,6 +29,11 @@ public enum DeploymentStatusReason {
      */
     CANCELED("CANCELED"),
 
+    /**
+     * The canceling status reason
+     */
+    CANCELING("CANCELING"),
+
     /**
      * The degenerate status reason
      */
@@ -39,6 +44,11 @@ public enum DeploymentStatusReason {
      */
     DEPLOYED("DEPLOYED"),
 
+    /**
+     * The deploying status reason
+     */
+    DEPLOYING("DEPLOYING"),
+
     /**
      * The superseded status reason
      */
@@ -55,10 +65,14 @@ public static DeploymentStatusReason from(String s) {
         switch (s.toLowerCase()) {
             case "canceled":
                 return CANCELED;
+            case "canceling":
+                return CANCELING;
             case "degenerate":
                 return DEGENERATE;
             case "deployed":
                 return DEPLOYED;
+            case "deploying":
+                return DEPLOYING;
             case "superseded":
                 return SUPERSEDED;
             default:

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/deployments/DeploymentStatusValue.java

@@ -20,20 +20,25 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
- * The state of a {@link Deployment}
+ * The status value of a {@link Deployment}
  */
 public enum DeploymentStatusValue {
 
     /**
-     * The deploying status value
+     * The active status value
      */
-    DEPLOYING("DEPLOYING"),
+    ACTIVE("ACTIVE"),
 
     /**
      * The canceling status value
      */
     CANCELING("CANCELING"),
 
+    /**
+     * The deploying status value
+     */
+    DEPLOYING("DEPLOYING"),
+
     /**
      * The finalized status value
      */
@@ -48,6 +53,8 @@ public enum DeploymentStatusValue {
     @JsonCreator
     public static DeploymentStatusValue from(String s) {
         switch (s.toLowerCase()) {
+            case "active":
+                return ACTIVE;
             case "deploying":
                 return DEPLOYING;
             case "canceling":

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/deployments/_ListDeploymentsRequest.java

@@ -41,4 +41,16 @@ abstract class _ListDeploymentsRequest extends PaginatedRequest {
     @FilterParameter("states")
     abstract List<DeploymentState> getStates();
 
+    /**
+     * List of status reasons to filter by
+     */
+    @FilterParameter("status_reasons")
+    abstract List<DeploymentStatusReason> getStatusReasons();
+
+    /**
+     * List of status values to filter by
+     */
+    @FilterParameter("status_values")
+    abstract List<DeploymentStatusValue> getStatusValues();
+
 }

integration-test/src/test/java/org/cloudfoundry/client/v3/DeploymentsTest.java

@@ -28,6 +28,7 @@
 import org.cloudfoundry.client.v3.deployments.DeploymentRelationships;
 import org.cloudfoundry.client.v3.deployments.DeploymentResource;
 import org.cloudfoundry.client.v3.deployments.DeploymentState;
+import org.cloudfoundry.client.v3.deployments.DeploymentStatusValue;
 import org.cloudfoundry.client.v3.deployments.GetDeploymentRequest;
 import org.cloudfoundry.client.v3.deployments.ListDeploymentsRequest;
 import org.cloudfoundry.operations.CloudFoundryOperations;
@@ -207,6 +208,29 @@ public void listFilterByState() throws Exception {
             .verify(Duration.ofMinutes(5));
     }
 
+    @Test
+    public void listFilterByStatusValues() throws Exception {
+        String name = this.nameFactory.getApplicationName();
+        Path path = new ClassPathResource("test-application.zip").getFile().toPath();
+
+        createApplicationId(this.cloudFoundryOperations, name, path)
+            .flatMap(applicationId -> Mono.zip(
+                Mono.just(applicationId),
+                getDropletId(this.cloudFoundryClient, applicationId)
+            ))
+            .flatMap(function((applicationId, dropletId) -> createDeploymentId(this.cloudFoundryClient, applicationId, dropletId)))
+            .flatMapMany(deploymentId -> PaginationUtils.requestClientV3Resources(page -> this.cloudFoundryClient.deploymentsV3()
+                .list(ListDeploymentsRequest.builder()
+                    .statusValue(DeploymentStatusValue.DEPLOYING)
+                    .page(page)
+                    .build()))
+                .filter(resource -> deploymentId.equals(resource.getId())))
+            .as(StepVerifier::create)
+            .expectNextCount(1)
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
     private static Mono<String> createApplicationId(CloudFoundryOperations cloudFoundryOperations, String name, Path path) {
         return requestCreateApplication(cloudFoundryOperations, name, path)
             .then(getApplicationId(cloudFoundryOperations, name));