Add icecap qtags as a field in sundeck

Author: scgkiran

go/cmd/declarations/declarations.go

@@ -75,6 +75,10 @@ func (c *{{.ClassName}}) Merge(other *{{.ClassName}}) {
 		c.values[k] = v
 	}
 }
+
+func (c *{{.ClassName}}) Values() map[string]any {
+	return c.values
+}
 `
 
 // Template for generating methods

go/pkg/qtag/declarations/icecap.yaml

@@ -0,0 +1,14 @@
+name: icecap
+site: "https://sundeck.io"
+identifier:
+  fields:
+    app: icecap
+fields:
+  - name: app
+    type: APPLICATION
+  - name: target_size
+    type: DIMENSION
+  - name: used
+    type: DIMENSION
+  - name: no_route_reason
+    type: TRACE

go/pkg/qtag/declarations/sundeck.yaml

@@ -60,9 +60,5 @@ fields:
     type: DIMENSION
   - name: auto_routing_uniform_random_warehouse_choice
     type: DIMENSION
-  - name: icecap_target_size
+  - name: icecap
     type: DIMENSION
-  - name: icecap_used
-    type: DIMENSION
-  - name: icecap_no_route_reason
-    type: TRACE

go/pkg/qtag/generated.go

@@ -38,6 +38,10 @@ func (c *Dbt) Merge(other *Dbt) {
 	}
 }
 
+func (c *Dbt) Values() map[string]any {
+	return c.values
+}
+
 func (c *Dbt) AddApp(value any) {
 	c.values["app"] = value
 }
@@ -176,6 +180,10 @@ func (c *Hex) Merge(other *Hex) {
 	}
 }
 
+func (c *Hex) Values() map[string]any {
+	return c.values
+}
+
 func (c *Hex) AddCategories(value any) {
 	c.values["categories"] = value
 }
@@ -204,6 +212,60 @@ func (c *Hex) AddUser_email(value any) {
 	c.values["user_email"] = value
 }
 
+type Icecap struct {
+	Builder
+	name       string
+	identifier map[string]any
+	values     map[string]any
+}
+
+func NewIcecap() *Icecap {
+	x := Icecap{}
+	x.init()
+	return &x
+}
+
+func (c *Icecap) init() {
+	c.name = "icecap"
+	c.identifier = make(map[string]any)
+	json.Unmarshal([]byte("{\"fields\":{\"app\":\"icecap\"}}"), &c.identifier)
+	c.values = make(map[string]any)
+}
+
+func (c *Icecap) Format() (string, error) {
+	return format(c.name, c.identifier, c.values)
+}
+
+func (c *Icecap) UnknownValue(name string, value any) {
+	c.values[name] = value
+}
+
+func (c *Icecap) Merge(other *Icecap) {
+	for k, v := range other.values {
+		c.values[k] = v
+	}
+}
+
+func (c *Icecap) Values() map[string]any {
+	return c.values
+}
+
+func (c *Icecap) AddApp(value any) {
+	c.values["app"] = value
+}
+
+func (c *Icecap) AddTarget_size(value any) {
+	c.values["target_size"] = value
+}
+
+func (c *Icecap) AddUsed(value any) {
+	c.values["used"] = value
+}
+
+func (c *Icecap) AddNo_route_reason(value any) {
+	c.values["no_route_reason"] = value
+}
+
 type Metabase struct {
 	Builder
 	name       string
@@ -238,6 +300,10 @@ func (c *Metabase) Merge(other *Metabase) {
 	}
 }
 
+func (c *Metabase) Values() map[string]any {
+	return c.values
+}
+
 func (c *Metabase) AddClient(value any) {
 	c.values["client"] = value
 }
@@ -312,6 +378,10 @@ func (c *Mode) Merge(other *Mode) {
 	}
 }
 
+func (c *Mode) Values() map[string]any {
+	return c.values
+}
+
 func (c *Mode) AddUser(value any) {
 	c.values["user"] = value
 }
@@ -362,6 +432,10 @@ func (c *Sigma) Merge(other *Sigma) {
 	}
 }
 
+func (c *Sigma) Values() map[string]any {
+	return c.values
+}
+
 func (c *Sigma) AddKind(value any) {
 	c.values["kind"] = value
 }
@@ -412,6 +486,10 @@ func (c *Sundeck) Merge(other *Sundeck) {
 	}
 }
 
+func (c *Sundeck) Values() map[string]any {
+	return c.values
+}
+
 func (c *Sundeck) AddApp(value any) {
 	c.values["app"] = value
 }
@@ -524,16 +602,8 @@ func (c *Sundeck) AddAuto_routing_uniform_random_warehouse_choice(value any) {
 	c.values["auto_routing_uniform_random_warehouse_choice"] = value
 }
 
-func (c *Sundeck) AddIcecap_target_size(value any) {
-	c.values["icecap_target_size"] = value
-}
-
-func (c *Sundeck) AddIcecap_used(value any) {
-	c.values["icecap_used"] = value
-}
-
-func (c *Sundeck) AddIcecap_no_route_reason(value any) {
-	c.values["icecap_no_route_reason"] = value
+func (c *Sundeck) AddIcecap(value any) {
+	c.values["icecap"] = value
 }
 
 type Walrusiq struct {
@@ -570,6 +640,10 @@ func (c *Walrusiq) Merge(other *Walrusiq) {
 	}
 }
 
+func (c *Walrusiq) Values() map[string]any {
+	return c.values
+}
+
 func (c *Walrusiq) AddApp(value any) {
 	c.values["app"] = value
 }

go/pkg/qtag/generated_test.go

@@ -0,0 +1,41 @@
+package qtag
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestSundeck_AddIcecap(t *testing.T) {
+	i := &Icecap{}
+	i.init()
+	i.AddTarget_size("Small")
+	i.AddNo_route_reason([]string{"MissingScalarFunction", "UnableToResolve"})
+	i.AddUsed(true)
+
+	c := &Sundeck{}
+	c.init()
+	c.AddIcecap(i.Values())
+	tags, err := c.Format()
+	require.NoError(t, err)
+	expectedTags := `{"app":"sundeck","icecap":{"no_route_reason":["MissingScalarFunction","UnableToResolve"],"target_size":"Small","used":true}}`
+	require.Equal(t, expectedTags, tags)
+
+	queryText := "select 1; -- " + tags
+	extractor := NewExtractor()
+	qtags := extractor.Extract(queryText, false, false)
+	require.Len(t, qtags, 2)
+	for _, tag := range qtags {
+		if tag.Key == "app" {
+			require.Equal(t, "sundeck", tag.Value)
+		} else if tag.Key == "icecap" {
+			icMap, ok := tag.Value.(map[string]interface{})
+			require.True(t, ok)
+			require.Equal(t, "Small", icMap["target_size"])
+			require.Equal(t, []interface{}{"MissingScalarFunction", "UnableToResolve"}, icMap["no_route_reason"])
+			require.Equal(t, true, icMap["used"])
+		} else {
+			require.Fail(t, "unexpected tag")
+		}
+	}
+}

tests/test.yaml

@@ -119,7 +119,7 @@
 - name: test sundeck tags
   query: |
     select 1
-    -- {"app": "sundeck", "warehouse_updated": true, "query_text_updated": true, "flow_name": "DEFAULT", "query_rejected": false, "hooks_applied": ["hook1", "hook2"], "reject_message": "unknown", "workload": "dev", "kind" : "pre_hook"}
+    -- {"app": "sundeck", "warehouse_updated": true, "query_text_updated": true, "flow_name": "DEFAULT", "query_rejected": false, "hooks_applied": ["hook1", "hook2"], "reject_message": "unknown", "workload": "dev", "kind" : "pre_hook", "icecap" : {"target_size": "Small", "used": true}}
   outcome:
     - source: sundeck
       key: app
@@ -157,6 +157,12 @@
       key: kind
       value: pre_hook
       type: DIMENSION
+    - source: sundeck
+      key: icecap
+      value:
+        target_size: "Small"
+        used: true
+      type: DIMENSION
 - name: test sundeck service tags
   query: |
     select 1
@@ -253,3 +259,26 @@
       key: suggested_warehouse_name
       value: COMPUTE_WH
       type: DIMENSION
+- name: test icecap tags
+  query: |
+    select 1
+    -- {"app": "icecap", "target_size": "Small", "used": true, "no_route_reason": ["MissingType", "UnableToTranspile"]}
+  outcome:
+    - source: icecap
+      key: app
+      value: icecap
+      type: APPLICATION
+    - source: icecap
+      key: target_size
+      value: Small
+      type: DIMENSION
+    - source: icecap
+      key: used
+      value: true
+      type: DIMENSION
+    - source: icecap
+      key: no_route_reason
+      value:
+        - MissingType
+        - UnableToTranspile
+      type: TRACE