fix fabric8io#4516: adding a blocking delete operation

CHANGELOG.md

@@ -23,6 +23,7 @@
 * Fix #4136: added support for fieldValidation as a dsl method for POST/PUT/PATCH operations
 * Fix #3896: added dsl support for server side apply
 * Fix #4582: updated [client.secrets] createOrReplace document
+* Fix #4516: added support for blocking delete operations using the withTimeout methods: op.withTimeout(1, TimeUnit.MINUTE).delete() - will wait for up to 1 minute for the resources to be fully deleted. This makes for a more concise replacement of the deletingExisting method.
 
 #### _**Note**_: Breaking changes in the API
 * Fix #4515: files located at the root of jars named model.properties, e.g. core.properties, have been removed

doc/MIGRATION-v6.md

@@ -164,8 +164,7 @@ Use:
 
 ```java
 var resource = client.resource(deployment).inNamespace(session.getNamespace());
-resource.delete();
-resource.waitUntilCondition(Objects::isNull, 30, TimeUnit.SECONDS);
+resource.withTimeout(30, TimeUnit.SECONDS).delete();
 resource.create();
 ```
 

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/dsl/DeletableWithOptions.java

@@ -19,7 +19,15 @@
 import io.fabric8.kubernetes.client.GracePeriodConfigurable;
 import io.fabric8.kubernetes.client.PropagationPolicyConfigurable;
 
+import java.util.concurrent.TimeUnit;
+
 public interface DeletableWithOptions extends GracePeriodConfigurable<PropagationPolicyConfigurable<? extends Deletable>>,
-    PropagationPolicyConfigurable<GracePeriodConfigurable<? extends Deletable>> {
+    PropagationPolicyConfigurable<GracePeriodConfigurable<? extends Deletable>>, Timeoutable {
+
+  @Override
+  DeletableWithOptions withTimeout(long timeout, TimeUnit unit);
+
+  @Override
+  DeletableWithOptions withTimeoutInMillis(long timeoutInMillis);
 
 }

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/dsl/TimeoutImageEditReplacePatchable.java

@@ -16,7 +16,14 @@
 
 package io.fabric8.kubernetes.client.dsl;
 
+import java.util.concurrent.TimeUnit;
+
 public interface TimeoutImageEditReplacePatchable<T> extends
-  Timeoutable<ImageEditReplacePatchable<T>>,
-  ImageEditReplacePatchable<T> {
+    Timeoutable, ImageEditReplacePatchable<T> {
+
+  @Override
+  ImageEditReplacePatchable<T> withTimeout(long timeout, TimeUnit unit);
+
+  @Override
+  ImageEditReplacePatchable<T> withTimeoutInMillis(long timeoutInMillis);
 }

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/dsl/Timeoutable.java

@@ -18,10 +18,21 @@
 
 import java.util.concurrent.TimeUnit;
 
-public interface Timeoutable<T> {
+public interface Timeoutable {
 
-  T withTimeout(long timeout, TimeUnit unit);
+  /**
+   * Wait for the given operation timeout. For list contexts it applies to each delete operation.
+   *
+   * @param timeout 0 indicates no wait
+   * @param unit
+   */
+  Object withTimeout(long timeout, TimeUnit unit);
 
+  /**
+   * Wait for the given operation timeout in milliseconds. For list contexts it applies to each delete operation.
+   *
+   * @param timeoutInMillis 0 indicates no wait
+   */
+  Object withTimeoutInMillis(long timeoutInMillis);
 
-  T withTimeoutInMillis(long timeoutInMillis);
 }

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/extension/ExtensibleResource.java

@@ -20,9 +20,11 @@
 import io.fabric8.kubernetes.client.Client;
 import io.fabric8.kubernetes.client.dsl.Nameable;
 import io.fabric8.kubernetes.client.dsl.Resource;
+import io.fabric8.kubernetes.client.dsl.WritableOperation;
 
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 
 /**
@@ -84,4 +86,12 @@ public interface ExtensibleResource<T> extends Resource<T> {
   @Override
   ExtensibleResource<T> forceConflicts();
 
+  @Override
+  ExtensibleResource<T> withTimeout(long timeout, TimeUnit unit);
+
+  @Override
+  default WritableOperation<T> withTimeoutInMillis(long timeoutInMillis) {
+    return withTimeout(timeoutInMillis, TimeUnit.MILLISECONDS);
+  }
+
 }

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/extension/ExtensibleResourceAdapter.java

@@ -21,6 +21,7 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 
 /**
@@ -116,4 +117,14 @@ public ExtensibleResource<T> forceConflicts() {
     return newInstance().init(resource.forceConflicts(), client);
   }
 
+  @Override
+  public ExtensibleResource<T> withTimeout(long timeout, TimeUnit unit) {
+    return newInstance().init(resource.withTimeout(timeout, unit), client);
+  }
+
+  @Override
+  public ExtensibleResource<T> withTimeoutInMillis(long timeoutInMillis) {
+    return withTimeout(timeoutInMillis, TimeUnit.MILLISECONDS);
+  }
+
 }

kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/extension/ResourceAdapter.java

@@ -26,6 +26,7 @@
 import io.fabric8.kubernetes.client.Watch;
 import io.fabric8.kubernetes.client.Watcher;
 import io.fabric8.kubernetes.client.dsl.Deletable;
+import io.fabric8.kubernetes.client.dsl.DeletableWithOptions;
 import io.fabric8.kubernetes.client.dsl.Gettable;
 import io.fabric8.kubernetes.client.dsl.Informable;
 import io.fabric8.kubernetes.client.dsl.NonDeletingOperation;
@@ -324,4 +325,14 @@ public T serverSideApply() {
     return resource.serverSideApply();
   }
 
+  @Override
+  public DeletableWithOptions withTimeout(long timeout, TimeUnit unit) {
+    return resource.withTimeout(timeout, unit);
+  }
+
+  @Override
+  public DeletableWithOptions withTimeoutInMillis(long timeoutInMillis) {
+    return withTimeout(timeoutInMillis, TimeUnit.MILLISECONDS);
+  }
+
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/internal/BaseOperation.java

@@ -451,6 +451,17 @@ static void toStatusDetails(KubernetesResource obj, List<StatusDetails> details)
 
   @Override
   public List<StatusDetails> delete() {
+    List<StatusDetails> deleted = deleteAll();
+    if (this.context.getTimeout() > 0) {
+      Set<String> uids = deleted.stream().map(StatusDetails::getUid).collect(Collectors.toSet());
+      CompletableFuture<List<T>> delete = this
+          .informOnCondition(l -> l.stream().map(i -> i.getMetadata().getUid()).noneMatch(uid -> uids.contains(uid)));
+      Utils.waitUntilReadyOrFail(delete, this.context.getTimeout(), this.context.getTimeoutUnit());
+    }
+    return deleted;
+  }
+
+  protected List<StatusDetails> deleteAll() {
     if (Utils.isNotNullOrEmpty(name) || Utils.isNotNullOrEmpty(namespace) || !isResourceNamespaced()) {
       try {
         URL resourceURLForWriteOperation = getResourceURLForWriteOperation(getResourceUrl());
@@ -1103,4 +1114,9 @@ public T serverSideApply() {
     return this.patch(PatchContext.of(PatchType.SERVER_SIDE_APPLY));
   }
 
+  @Override
+  public ExtensibleResource<T> withTimeout(long timeout, TimeUnit unit) {
+    return newInstance(context.withTimeout(timeout, unit));
+  }
+
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/internal/NamespaceVisitFromServerGetWatchDeleteRecreateWaitApplicableListImpl.java

@@ -27,6 +27,7 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientException;
 import io.fabric8.kubernetes.client.KubernetesClientTimeoutException;
+import io.fabric8.kubernetes.client.dsl.DeletableWithOptions;
 import io.fabric8.kubernetes.client.dsl.Gettable;
 import io.fabric8.kubernetes.client.dsl.ListVisitFromServerGetDeleteRecreateWaitApplicable;
 import io.fabric8.kubernetes.client.dsl.ListVisitFromServerWritable;
@@ -314,4 +315,14 @@ public List<HasMetadata> replaceStatus() {
     return performOperation(Resource::replaceStatus);
   }
 
+  @Override
+  public DeletableWithOptions withTimeout(long timeout, TimeUnit unit) {
+    return newInstance(context.withTimeout(timeout, unit));
+  }
+
+  @Override
+  public DeletableWithOptions withTimeoutInMillis(long timeoutInMillis) {
+    return this.withTimeout(timeoutInMillis, TimeUnit.MILLISECONDS);
+  }
+
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/internal/OperationContext.java

@@ -33,6 +33,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
 import java.util.function.BiFunction;
 import java.util.stream.Collectors;
 
@@ -68,6 +69,9 @@ public class OperationContext {
 
   protected Client client;
 
+  private long timeout;
+  private TimeUnit timeoutUnit = TimeUnit.MILLISECONDS;
+
   public OperationContext() {
   }
 
@@ -76,7 +80,7 @@ public OperationContext(OperationContext other) {
         other.item, other.labels, other.labelsNot, other.labelsIn, other.labelsNotIn, other.fields,
         other.fieldsNot, other.resourceVersion, other.reloadingFromServer, other.gracePeriodSeconds, other.propagationPolicy,
         other.dryRun, other.selectorAsString, other.defaultNamespace, other.fieldValidation, other.fieldManager,
-        other.forceConflicts);
+        other.forceConflicts, other.timeout, other.timeoutUnit);
   }
 
   public OperationContext(Client client, String plural, String namespace, String name,
@@ -85,7 +89,7 @@ public OperationContext(Client client, String plural, String namespace, String n
       Map<String, String> fields, Map<String, String[]> fieldsNot, String resourceVersion, boolean reloadingFromServer,
       long gracePeriodSeconds, DeletionPropagation propagationPolicy,
       boolean dryRun, String selectorAsString, boolean defaultNamespace, FieldValidateable.Validation fieldValidation,
-      String fieldManager, Boolean forceConflicts) {
+      String fieldManager, Boolean forceConflicts, long timeout, TimeUnit timeoutUnit) {
     this.client = client;
     this.item = item;
     this.plural = plural;
@@ -108,6 +112,8 @@ public OperationContext(Client client, String plural, String namespace, String n
     this.fieldValidation = fieldValidation;
     this.fieldManager = fieldManager;
     this.forceConflicts = forceConflicts;
+    this.timeout = timeout;
+    this.timeoutUnit = timeoutUnit;
   }
 
   private void setFieldsNot(Map<String, String[]> fieldsNot) {
@@ -243,6 +249,14 @@ public boolean getDryRun() {
     return dryRun;
   }
 
+  public long getTimeout() {
+    return timeout;
+  }
+
+  public TimeUnit getTimeoutUnit() {
+    return timeoutUnit;
+  }
+
   public String getLabelQueryParam() {
     if (Utils.isNotNullOrEmpty(selectorAsString)) {
       return selectorAsString;
@@ -485,7 +499,8 @@ public <C extends Client> C clientInWriteContext(Class<C> clazz) {
     // operationcontext
     OperationContext newContext = HasMetadataOperationsImpl.defaultContext(client).withDryRun(getDryRun())
         .withGracePeriodSeconds(getGracePeriodSeconds()).withPropagationPolicy(getPropagationPolicy())
-        .withReloadingFromServer(isReloadingFromServer()).withFieldValidation(this.fieldValidation);
+        .withReloadingFromServer(isReloadingFromServer()).withFieldValidation(this.fieldValidation)
+        .withTimeout(this.timeout, this.timeoutUnit);
 
     // check before setting to prevent flipping the default flag
     if (!Objects.equals(getNamespace(), newContext.getNamespace())
@@ -527,4 +542,11 @@ public OperationContext withForceConflicts() {
     return context;
   }
 
+  public OperationContext withTimeout(long timeout, TimeUnit timeUnit) {
+    final OperationContext context = new OperationContext(this);
+    context.timeout = timeout;
+    context.timeoutUnit = timeUnit == null ? TimeUnit.MILLISECONDS : timeUnit;
+    return context;
+  }
+
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/internal/PodOperationContext.java

@@ -67,6 +67,8 @@ public StreamContext() {
   private String dir;
   private boolean terminateOnError;
 
+  private boolean rolling;
+
   public PodOperationContext withContainerId(String containerId) {
     return this.toBuilder().containerId(containerId).build();
   }