mixin-utils: add disable option to showClassicHistogramQuery (#1567)

For the case when you want to migrate some query , but the namespace
it acts on isn't fully migrated yet.

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>

Author: krajorama

mixin-utils/test/test_native-classic-histogram.libsonnet

@@ -258,3 +258,59 @@ test.new(std.thisFile)
     }
   )
 )
++ test.case.new(
+  name='showClassicHistogramQuery defaults',
+  test=test.expect.eq(
+    actual=utils.showClassicHistogramQuery({ classic: 'foo' }),
+    expected='(foo) and on() (vector($latency_metrics) == 1)',
+  )
+)
++ test.case.new(
+  name='showClassicHistogramQuery other variable',
+  test=test.expect.eq(
+    actual=utils.showClassicHistogramQuery({ classic: 'foo' }, dashboard_variable='my_var'),
+    expected='(foo) and on() (vector($my_var) == 1)',
+  )
+)
++ test.case.new(
+  name='showClassicHistogramQuery disable',
+  test=test.expect.eq(
+    actual=utils.showClassicHistogramQuery({ classic: 'foo' }, disable=true),
+    expected='(foo) and on() (vector(1) == 1)',
+  )
+)
++ test.case.new(
+  name='showClassicHistogramQuery disable ignore dashboard variable',
+  test=test.expect.eq(
+    actual=utils.showClassicHistogramQuery({ classic: 'foo' }, dashboard_variable='my_var', disable=true),
+    expected='(foo) and on() (vector(1) == 1)',
+  )
+)
++ test.case.new(
+  name='showNativeHistogramQuery defaults',
+  test=test.expect.eq(
+    actual=utils.showNativeHistogramQuery({ native: 'foo' }),
+    expected='(foo) and on() (vector($latency_metrics) == -1)',
+  )
+)
++ test.case.new(
+  name='showNativeHistogramQuery other variable',
+  test=test.expect.eq(
+    actual=utils.showNativeHistogramQuery({ native: 'foo' }, dashboard_variable='my_var'),
+    expected='(foo) and on() (vector($my_var) == -1)',
+  )
+)
++ test.case.new(
+  name='showNativeHistogramQuery disable',
+  test=test.expect.eq(
+    actual=utils.showNativeHistogramQuery({ native: 'foo' }, disable=true),
+    expected='(foo) and on() (vector(1) == -1)',
+  )
+)
++ test.case.new(
+  name='showNativeHistogramQuery disable ignore dashboard variable',
+  test=test.expect.eq(
+    actual=utils.showNativeHistogramQuery({ native: 'foo' }, dashboard_variable='my_var', disable=true),
+    expected='(foo) and on() (vector(1) == -1)',
+  )
+)

mixin-utils/utils.libsonnet

@@ -187,10 +187,17 @@ local g = import 'grafana-builder/grafana.libsonnet';
 
   // showClassicHistogramQuery wraps a query defined as map {classic: q, native: q}, and compares the classic query
   // to dashboard variable which should take -1 or +1 as values in order to hide or show the classic query.
-  showClassicHistogramQuery(query, dashboard_variable='latency_metrics'):: '(%s) and on() (vector($%s) == 1)' % [query.classic, dashboard_variable],
+  // If "disable" is true it ignores the dashboard variable and shows the classic query.
+  showClassicHistogramQuery(query, dashboard_variable='latency_metrics', disable=false)::
+    local testAgainst = if disable then '1' else '$%s' % dashboard_variable;
+    '(%s) and on() (vector(%s) == 1)' % [query.classic, testAgainst],
+
   // showNativeHistogramQuery wraps a query defined as map {classic: q, native: q}, and compares the native query
   // to dashboard variable which should take -1 or +1 as values in order to show or hide the native query.
-  showNativeHistogramQuery(query, dashboard_variable='latency_metrics'):: '(%s) and on() (vector($%s) == -1)' % [query.native, dashboard_variable],
+  // If "disable" is true it ignores the dashboard variable and hides the native query.
+  showNativeHistogramQuery(query, dashboard_variable='latency_metrics', disable=false)::
+    local testAgainst = if disable then '1' else '$%s' % dashboard_variable;
+    '(%s) and on() (vector(%s) == -1)' % [query.native, testAgainst],
 
   histogramRules(metric, labels, interval='1m', record_native=false)::
     local vars = {