chore(standalone-canary-analysis): tweak control offset field name to…

… make units clear, add unit test
spinnaker · Dec 21, 2020 · b559be3 · b559be3
1 parent e7fc9cb
commit b559be3
Show file tree

Hide file tree

Showing 5 changed files with 123 additions and 5 deletions.
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/.../netflix/kayenta/standalonecanaryanalysis/domain/CanaryAnalysisExecutionRequestScope.java b/.../netflix/kayenta/standalonecanaryanalysis/domain/CanaryAnalysisExecutionRequestScope.java
@@ -58,11 +58,11 @@ public class CanaryAnalysisExecutionRequestScope {
 
   @ApiModelProperty(
       value =
-          "The time offset (in minutes) to apply to the control scope. If none is provided, the control is "
+          "The time offset in minutes to be subtracted from the control start and end time. If none is provided, the control is "
               + "evaluated at the same time as the experiment.",
       example = "10")
   @Builder.Default
-  Long controlOffset = 0L;
+  Long controlOffsetInMinutes = 0L;
 
   @ApiModelProperty(
       value =

diff --git a/...com/netflix/kayenta/standalonecanaryanalysis/orca/stage/SetupAndExecuteCanariesStage.java b/...com/netflix/kayenta/standalonecanaryanalysis/orca/stage/SetupAndExecuteCanariesStage.java
@@ -226,8 +226,10 @@ protected Map<String, CanaryScopePair> buildRequestScopes(
                   new CanaryScope(
                       scope.getControlScope(),
                       scope.getControlLocation(),
-                      scopeTimeConfig.start.minus(Duration.ofMinutes(scope.getControlOffset())),
-                      scopeTimeConfig.end.minus(Duration.ofMinutes(scope.getControlOffset())),
+                      scopeTimeConfig.start.minus(
+                          Duration.ofMinutes(scope.getControlOffsetInMinutes())),
+                      scopeTimeConfig.end.minus(
+                          Duration.ofMinutes(scope.getControlOffsetInMinutes())),
                       config.getStep().getSeconds(),
                       scope.getExtendedScopeParams());
 

diff --git a/...netflix/kayenta/standalonecanaryanalysis/orca/stage/SetupAndExecuteCanariesStageTest.java b/...netflix/kayenta/standalonecanaryanalysis/orca/stage/SetupAndExecuteCanariesStageTest.java
@@ -206,4 +206,27 @@ public void test_that_calculateLifetime_uses_supplied_start_and_end_time_if_prov
     assertEquals(Instant.parse(startIso), actual.getStart());
     assertEquals(Instant.parse(startIso).plus(3L, ChronoUnit.MINUTES), actual.getEnd());
   }
+
+  @Test
+  public void
+      test_that_buildRequestScopes_has_expected_start_and_end_when_control_offset_is_supplied() {
+    int interval = 1;
+    String startIso = "2018-12-17T20:56:39.689Z";
+    Duration lifetimeDuration = Duration.ofMinutes(3L);
+    CanaryAnalysisExecutionRequest request =
+        CanaryAnalysisExecutionRequest.builder()
+            .scopes(
+                ImmutableList.of(
+                    CanaryAnalysisExecutionRequestScope.builder()
+                        .controlOffsetInMinutes(5L)
+                        .startTimeIso(startIso)
+                        .build()))
+            .build();
+
+    var requestScopes = stage.buildRequestScopes(request, interval, lifetimeDuration);
+    var defaultScope = requestScopes.get("default");
+    var expectedControlStartIso = "2018-12-17T20:51:39.689Z";
+    assertEquals(Instant.parse(startIso), defaultScope.getExperimentScope().getStart());
+    assertEquals(Instant.parse(expectedControlStartIso), defaultScope.getControlScope().getStart());
+  }
 }