feat(stackdriver): Allow scope/region/... to be used in templates. (#214

)
spinnaker · Jan 23, 2018 · f73186f · f73186f
1 parent 7815442
commit f73186f
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 2 deletions.
diff --git a/...iver/src/main/java/com/netflix/kayenta/stackdriver/metrics/StackdriverMetricsService.java b/...iver/src/main/java/com/netflix/kayenta/stackdriver/metrics/StackdriverMetricsService.java
@@ -53,6 +53,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
@@ -289,9 +290,33 @@ String expandCustomFilter(CanaryConfig canaryConfig,
       Template template = new Template(customFilterTemplate, new StringReader(templateStr), configuration);
 
       try {
-        log.debug("Expanded: extendedScopeParams={}", stackdriverCanaryScope.getExtendedScopeParams());
+        log.debug("extendedScopeParams={}", stackdriverCanaryScope.getExtendedScopeParams());
 
-        customFilter = FreeMarkerTemplateUtils.processTemplateIntoString(template, stackdriverCanaryScope.getExtendedScopeParams());
+        Map<String, String> templateBindings = new LinkedHashMap<>();
+
+        if (!StringUtils.isEmpty(stackdriverCanaryScope.getProject())) {
+          templateBindings.put("project", stackdriverCanaryScope.getProject());
+        }
+
+        if (!StringUtils.isEmpty(stackdriverCanaryScope.getResourceType())) {
+          templateBindings.put("resourceType", stackdriverCanaryScope.getResourceType());
+        }
+
+        if (!StringUtils.isEmpty(stackdriverCanaryScope.getScope())) {
+          templateBindings.put("scope", stackdriverCanaryScope.getScope());
+        }
+
+        if (!StringUtils.isEmpty(stackdriverCanaryScope.getRegion())) {
+          templateBindings.put("region", stackdriverCanaryScope.getRegion());
+        }
+
+        if (!CollectionUtils.isEmpty(stackdriverCanaryScope.getExtendedScopeParams())) {
+          templateBindings.putAll(stackdriverCanaryScope.getExtendedScopeParams());
+        }
+
+        log.debug("templateBindings={}", templateBindings);
+
+        customFilter = FreeMarkerTemplateUtils.processTemplateIntoString(template, templateBindings);
       } catch (TemplateException e) {
         throw new IllegalArgumentException("Problem evaluating custom filter template:", e);
       }

diff --git a/.../test/groovy/com/netflix/kayenta/stackdriver/metrics/StackdriverMetricsServiceSpec.groovy b/.../test/groovy/com/netflix/kayenta/stackdriver/metrics/StackdriverMetricsServiceSpec.groovy
@@ -99,4 +99,21 @@ class StackdriverMetricsServiceSpec extends Specification {
     ["my-template": 'A test: key1=${key1} key2=${key2}.'] | "my-template"        | [key3: "value-3",
                                                                                     key4: "value-4"]
   }
+
+  @Unroll
+  void "Can use predefined variables in custom filter template"() {
+    given:
+    CanaryConfig canaryConfig = CanaryConfig.builder().templates(templates).build()
+    StackdriverCanaryMetricSetQueryConfig stackdriverCanaryMetricSetQueryConfig =
+      StackdriverCanaryMetricSetQueryConfig.builder().customFilterTemplate(customFilterTemplate).build()
+    StackdriverCanaryScope stackdriverCanaryScope = new StackdriverCanaryScope(scope: scope, extendedScopeParams: scopeParams)
+
+    expect:
+    stackdriverMetricsService.expandCustomFilter(canaryConfig, stackdriverCanaryMetricSetQueryConfig, stackdriverCanaryScope) == expectedExpandedTemplate
+
+    where:
+    templates                                                     | customFilterTemplate | scope            | scopeParams       || expectedExpandedTemplate
+    ["my-template": 'A test: myGroupName=${scope} key1=${key1}.'] | "my-template"        | "myapp-dev-v001" | [key1: "value-1"] || "A test: myGroupName=myapp-dev-v001 key1=value-1."
+    ["my-template": 'A test: myGroupName=${scope} key1=${key1}.'] | "my-template"        | "myapp-dev-v002" | [key1: "value-1"] || "A test: myGroupName=myapp-dev-v002 key1=value-1."
+  }
 }