chore: extract and extend ECS dashboard tests

fourTheorem · Nov 28, 2023 · c4deb00 · c4deb00
1 parent aa93629
commit c4deb00
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 24 deletions.
diff --git a/core/dashboards/dashboard.ts b/core/dashboards/dashboard.ts
@@ -460,7 +460,8 @@ export default function addDashboard (dashboardConfig: SlicWatchInputDashboardCo
                 ServiceName: `\${${logicalId}.Name}`,
                 ClusterName: clusterName
               },
-              stat
+              stat,
+              yAxis: metricConfig.yAxis
             })
           }
         }

diff --git a/core/dashboards/tests/dashboard-ecs.test.ts b/core/dashboards/tests/dashboard-ecs.test.ts
@@ -0,0 +1,106 @@
+import { merge } from 'lodash'
+import { test } from 'tap'
+import { type MetricWidgetProperties } from 'cloudwatch-dashboard-types'
+
+import { type ResourceType } from '../../cf-template'
+import addDashboard from '../dashboard'
+import defaultConfig from '../../inputs/default-config'
+
+import { createTestCloudFormationTemplate, getDashboardFromTemplate, getDashboardWidgetsByTitle } from '../../tests/testing-utils'
+
+test('dashboard contains configured ECS resources', (t) => {
+  t.test('dashboard includes ECS metrics', (t) => {
+    const template = createTestCloudFormationTemplate()
+    addDashboard(defaultConfig.dashboard, template)
+    const { dashboard } = getDashboardFromTemplate(template)
+
+    const widgets = getDashboardWidgetsByTitle(dashboard, /ECS/)
+    const [ecsWidget] = widgets
+
+    t.ok(ecsWidget)
+    t.same((ecsWidget.properties as MetricWidgetProperties).metrics, [
+      ['AWS/ECS', 'MemoryUtilization', 'ServiceName', '${ecsService.Name}', 'ClusterName', '${ecsCluster}', { stat: 'Average', yAxis: 'left' }],
+      ['AWS/ECS', 'CPUUtilization', 'ServiceName', '${ecsService.Name}', 'ClusterName', '${ecsCluster}', { stat: 'Average', yAxis: 'left' }]
+    ])
+
+    const props: MetricWidgetProperties = ecsWidget.properties as MetricWidgetProperties
+    t.ok((props.metrics?.length ?? 0) > 0)
+    t.equal(props.period, 300)
+    t.equal(props.view, 'timeSeries')
+
+    t.end()
+  })
+
+  t.test('service config overrides take precedence', (t) => {
+    const template = createTestCloudFormationTemplate()
+    addDashboard(merge({}, defaultConfig.dashboard, {
+      widgets: {
+        ECS: {
+          metricPeriod: 900,
+          width: 8,
+          height: 12,
+          MemoryUtilization: {
+            Statistic: ['P99']
+          },
+          CPUUtilization: {
+            Statistic: ['P95'],
+            yAxis: 'right'
+          }
+        }
+      }
+    }), template)
+    const { dashboard } = getDashboardFromTemplate(template)
+
+    const widgets = getDashboardWidgetsByTitle(dashboard, /ECS/)
+    const [ecsWidget] = widgets
+
+    t.ok(ecsWidget)
+    t.same((ecsWidget.properties as MetricWidgetProperties).metrics, [
+      ['AWS/ECS', 'MemoryUtilization', 'ServiceName', '${ecsService.Name}', 'ClusterName', '${ecsCluster}', { stat: 'P99', yAxis: 'left' }],
+      ['AWS/ECS', 'CPUUtilization', 'ServiceName', '${ecsService.Name}', 'ClusterName', '${ecsCluster}', { stat: 'P95', yAxis: 'right' }]
+    ])
+    const props: MetricWidgetProperties = ecsWidget.properties as MetricWidgetProperties
+    t.ok((props.metrics?.length ?? 0) > 0)
+    t.equal(props.period, 900)
+    t.equal(props.view, 'timeSeries')
+
+    t.end()
+  })
+
+  t.test('resource config overrides take precedence', (t) => {
+    const template = createTestCloudFormationTemplate();
+
+    (template.Resources as ResourceType).ecsService.Metadata = {
+      slicWatch: {
+        dashboard: {
+          MemoryUtilization: {
+            Statistic: ['P90'],
+            yAxis: 'right'
+          },
+          CPUUtilization: {
+            Statistic: ['P50'],
+            yAxis: 'left',
+            enabled: false
+          }
+        }
+      }
+    }
+    addDashboard(defaultConfig.dashboard, template)
+    const { dashboard } = getDashboardFromTemplate(template)
+
+    const widgets = getDashboardWidgetsByTitle(dashboard, /ECS/)
+    const [ecsWidget] = widgets
+
+    t.ok(ecsWidget)
+    t.same((ecsWidget.properties as MetricWidgetProperties).metrics, [
+      ['AWS/ECS', 'MemoryUtilization', 'ServiceName', '${ecsService.Name}', 'ClusterName', '${ecsCluster}', { stat: 'P90', yAxis: 'right' }]
+    ])
+    const props: MetricWidgetProperties = ecsWidget.properties as MetricWidgetProperties
+    t.ok((props.metrics?.length ?? 0) > 0)
+    t.equal(props.period, 300)
+    t.equal(props.view, 'timeSeries')
+    t.end()
+  })
+
+  t.end()
+})
diff --git a/core/dashboards/tests/dashboard.test.ts b/core/dashboards/tests/dashboard.test.ts
@@ -30,29 +30,6 @@ test('A dashboard includes metrics', (t) => {
 
   t.ok(dashboard.start)
 
-  t.test('dashboard includes ECS metrics', (t) => {
-    const widgets = dashboard.widgets.filter(({ properties }) =>
-      ((properties as MetricWidgetProperties).title ?? '').startsWith('ECS')
-    )
-    t.equal(widgets.length, 1)
-    const namespaces = new Set()
-    for (const widget of widgets) {
-      for (const metric of (widget.properties as MetricWidgetProperties).metrics ?? []) {
-        namespaces.add(metric[0])
-      }
-    }
-    t.same(namespaces, new Set(['AWS/ECS']))
-    const expectedTitles = new Set([
-      'ECS Service ${ecsService.Name}'
-    ])
-
-    const actualTitles = new Set(
-      widgets.map((widget) => (widget.properties as MetricWidgetProperties).title)
-    )
-    t.same(actualTitles, expectedTitles)
-    t.end()
-  })
-
   t.end()
 })