control-service: user-initiated deployment notifications (#2757)

# Why Currently, the new deployment mechanism sends notifications every time, lacking the ability to send them only when the user initiates the deployment. # What We modified the method to send notifications exclusively when deployments are initiated by the User, by incorporating a check for DeploymentStatus.NONE which represents user-initiated deployments. # Testing done: Unit tests. Signed-off-by: Miroslav Ivanov [email protected] --------- Signed-off-by: Miroslav Ivanov [email protected] Co-authored-by: github-actions <>
vmware · Oct 9, 2023 · 0823610 · 0823610
1 parent 0305fa3
commit 0823610
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 15 deletions.
diff --git a/..._control_service/src/main/java/com/vmware/taurus/service/deploy/DataJobsSynchronizer.java b/..._control_service/src/main/java/com/vmware/taurus/service/deploy/DataJobsSynchronizer.java
@@ -91,15 +91,11 @@ void synchronizeDataJob(
       ActualDataJobDeployment actualDataJobDeployment,
       boolean isDeploymentPresentInKubernetes) {
     if (desiredDataJobDeployment != null) {
-      boolean sendNotification =
-          true; // TODO [miroslavi] sends notification only when the deployment is initiated by the
-      // user.
       deploymentService.updateDeployment(
           dataJob,
           desiredDataJobDeployment,
           actualDataJobDeployment,
-          isDeploymentPresentInKubernetes,
-          sendNotification);
+          isDeploymentPresentInKubernetes);
     }
   }
 

diff --git a/...s_control_service/src/main/java/com/vmware/taurus/service/deploy/DeploymentServiceV2.java b/...s_control_service/src/main/java/com/vmware/taurus/service/deploy/DeploymentServiceV2.java
@@ -57,15 +57,13 @@ public class DeploymentServiceV2 {
    * @param actualJobDeployment the actual data job deployment has been deployed.
    * @param isJobDeploymentPresentInKubernetes if it is true the data job deployment is present in
    *     Kubernetes.
-   * @param sendNotification if it is true the method will send a notification to the end user.
    */
   @Measurable(includeArg = 0, argName = "data_job")
   public void updateDeployment(
       DataJob dataJob,
       DesiredDataJobDeployment desiredJobDeployment,
       ActualDataJobDeployment actualJobDeployment,
-      boolean isJobDeploymentPresentInKubernetes,
-      Boolean sendNotification) {
+      boolean isJobDeploymentPresentInKubernetes) {
     if (desiredJobDeployment == null) {
       log.warn(
           "Skipping the data job [job_name={}] deployment due to the missing deployment data",
@@ -83,6 +81,9 @@ public void updateDeployment(
       return;
     }
 
+    // Sends notification only when the deployment is initiated by the user.
+    boolean sendNotification = Boolean.TRUE.equals(desiredJobDeployment.getUserInitiated());
+
     try {
       log.info("Starting deployment of job {}", desiredJobDeployment.getDataJobName());
       deploymentProgress.started(dataJob.getJobConfig(), desiredJobDeployment);

diff --git a/...ntrol_service/src/main/java/com/vmware/taurus/service/model/DesiredDataJobDeployment.java b/...ntrol_service/src/main/java/com/vmware/taurus/service/model/DesiredDataJobDeployment.java
@@ -10,6 +10,7 @@
 import lombok.Setter;
 import lombok.ToString;
 
+import javax.persistence.Column;
 import javax.persistence.Entity;
 
 @Getter
@@ -20,4 +21,7 @@
 public class DesiredDataJobDeployment extends BaseDataJobDeployment {
 
   private DeploymentStatus status;
+
+  @Column(name = "is_user_initiated")
+  private Boolean userInitiated;
 }
diff --git a/...control_service/src/main/java/com/vmware/taurus/service/monitoring/DeploymentMonitor.java b/...control_service/src/main/java/com/vmware/taurus/service/monitoring/DeploymentMonitor.java
@@ -107,8 +107,9 @@ private boolean saveDataJobStatus(
         actualJobDeploymentRepository.save(actualDataJobDeployment);
       }
 
-      desiredJobDeploymentRepository.updateDesiredDataJobDeploymentStatusByDataJobName(
-          dataJobName, deploymentStatus);
+      desiredJobDeploymentRepository
+          .updateDesiredDataJobDeploymentStatusAndUserInitiatedByDataJobName(
+              dataJobName, deploymentStatus, false);
       return true;
     }
     log.debug("Data job: {} was deleted or hasn't been created", dataJobName);

diff --git a/...ce/src/main/java/com/vmware/taurus/service/repository/DesiredJobDeploymentRepository.java b/...ce/src/main/java/com/vmware/taurus/service/repository/DesiredJobDeploymentRepository.java
@@ -41,9 +41,10 @@ int updateDesiredDataJobDeploymentEnabledByDataJobName(
   @Transactional
   @Modifying(clearAutomatically = true)
   @Query(
-      "update DesiredDataJobDeployment d set d.status = :status where d.dataJobName ="
-          + " :dataJobName")
-  int updateDesiredDataJobDeploymentStatusByDataJobName(
+      "update DesiredDataJobDeployment d set d.status = :status, d.userInitiated = :userInitiated"
+          + " where d.dataJobName = :dataJobName")
+  int updateDesiredDataJobDeploymentStatusAndUserInitiatedByDataJobName(
       @Param(value = "dataJobName") String dataJobName,
-      @Param(value = "status") DeploymentStatus status);
+      @Param(value = "status") DeploymentStatus status,
+      @Param(value = "userInitiated") Boolean userInitiatedDeployment);
 }
diff --git a/...on/V20231005163000__add_column_is_user_initiated_to_desired_data_job_deployment_table.sql b/...on/V20231005163000__add_column_is_user_initiated_to_desired_data_job_deployment_table.sql
@@ -0,0 +1,2 @@
+alter table if exists desired_data_job_deployment
+    add column if not exists is_user_initiated boolean;
diff --git a/...rol_service/src/test/java/com/vmware/taurus/service/deploy/DeploymentServiceV2TestIT.java b/...rol_service/src/test/java/com/vmware/taurus/service/deploy/DeploymentServiceV2TestIT.java
@@ -49,19 +49,48 @@ public void updateDeployment_withDesiredDeploymentStatusNone_shouldStartDeployme
     updateDeployment(DeploymentStatus.NONE, 1);
   }
 
+  @Test
+  public void
+      updateDeployment_withDesiredDeploymentUserInitiatedDeploymentTrue_shouldSendNotification()
+          throws IOException, InterruptedException, ApiException {
+    updateDeployment(DeploymentStatus.NONE, 1, true);
+
+    Mockito.verify(jobImageBuilder, Mockito.times(1))
+        .buildImage(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.eq(true));
+  }
+
+  @Test
+  public void
+      updateDeployment_withDesiredDeploymentUserInitiatedDeploymentFalse_shouldNotSendNotification()
+          throws IOException, InterruptedException, ApiException {
+    updateDeployment(DeploymentStatus.NONE, 1, false);
+
+    Mockito.verify(jobImageBuilder, Mockito.times(1))
+        .buildImage(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.eq(false));
+  }
+
   private void updateDeployment(
       DeploymentStatus deploymentStatus, int deploymentProgressStartedInvocations)
       throws IOException, InterruptedException, ApiException {
+    updateDeployment(deploymentStatus, deploymentProgressStartedInvocations, true);
+  }
+
+  private void updateDeployment(
+      DeploymentStatus deploymentStatus,
+      int deploymentProgressStartedInvocations,
+      boolean sendNotification)
+      throws IOException, InterruptedException, ApiException {
     DesiredDataJobDeployment desiredDataJobDeployment = new DesiredDataJobDeployment();
     desiredDataJobDeployment.setStatus(deploymentStatus);
+    desiredDataJobDeployment.setUserInitiated(sendNotification);
     DataJob dataJob = new DataJob();
     dataJob.setJobConfig(new JobConfig());
     Mockito.when(
             jobImageBuilder.buildImage(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any()))
         .thenReturn(false);
 
     deploymentService.updateDeployment(
-        dataJob, desiredDataJobDeployment, new ActualDataJobDeployment(), true, true);
+        dataJob, desiredDataJobDeployment, new ActualDataJobDeployment(), true);
 
     Mockito.verify(deploymentProgress, Mockito.times(deploymentProgressStartedInvocations))
         .started(dataJob.getJobConfig(), desiredDataJobDeployment);
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		alter table if exists desired_data_job_deployment
		add column if not exists is_user_initiated boolean;