getESQLForLayer: Add file to test top N (terms aggregation)

Author: mariairiartef

x-pack/platform/plugins/shared/lens/public/datasources/form_based/to_esql_top_n.test.ts

@@ -0,0 +1,153 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { createCoreSetupMock } from '@kbn/core-lifecycle-browser-mocks/src/core_setup.mock';
+import type { FormBasedLayer, GenericIndexPatternColumn, IndexPattern } from '@kbn/lens-common';
+
+import { getESQLForLayer } from './to_esql';
+
+const defaultUiSettingsGet = (key: string) => {
+  switch (key) {
+    case 'dateFormat':
+      return 'MMM D, YYYY @ HH:mm:ss.SSS';
+    case 'dateFormat:scaled':
+      return [[]];
+    case 'dateFormat:tz':
+      return 'UTC';
+    case 'histogram:barTarget':
+      return 50;
+    case 'histogram:maxBars':
+      return 100;
+  }
+};
+
+const aggEntries: Array<readonly [string, GenericIndexPatternColumn]> = [
+  [
+    '1',
+    {
+      label: 'Top 5 values of host.keyword',
+      dataType: 'string',
+      operationType: 'terms',
+      sourceField: 'host.keyword',
+      isBucketed: true,
+      params: {
+        size: 5,
+        orderBy: {
+          type: 'column',
+          columnId: '1',
+        },
+        orderDirection: 'desc',
+        otherBucket: true,
+        missingBucket: false,
+        parentFormat: {
+          id: 'terms',
+        },
+        include: [],
+        exclude: [],
+        includeIsRegex: false,
+        excludeIsRegex: false,
+        secondaryFields: [],
+      },
+    },
+  ],
+  [
+    '2',
+    {
+      label: 'Average of bytes',
+      dataType: 'number',
+      operationType: 'average',
+      sourceField: 'bytes',
+      isBucketed: false,
+      params: {
+        // emptyAsNull: true,
+      },
+    },
+  ],
+];
+
+const indexPattern = {
+  title: 'kibana_sample_data_logs',
+  timeFieldName: 'timestamp',
+  getFieldByName: (field: string) => {
+    if (field === 'records') return undefined;
+    return { name: field };
+  },
+  getFormatterForField: () => ({ convert: (v: unknown) => v }),
+} as unknown as IndexPattern;
+
+const layer: FormBasedLayer = {
+  columns: {
+    '1': {
+      label: 'Top 5 values of host.keyword',
+      dataType: 'string',
+      operationType: 'terms',
+      sourceField: 'host.keyword',
+      isBucketed: true,
+      params: {
+        size: 5,
+        orderBy: {
+          type: 'column',
+          columnId: 'd9abe9de-cd59-47d4-b9b3-b0772e489ee5',
+        },
+        orderDirection: 'desc',
+        otherBucket: true,
+        missingBucket: false,
+        parentFormat: {
+          id: 'terms',
+        },
+        include: [],
+        exclude: [],
+        includeIsRegex: false,
+        excludeIsRegex: false,
+        secondaryFields: [],
+      },
+    },
+    '2': {
+      label: 'Average of bytes',
+      dataType: 'number',
+      operationType: 'average',
+      sourceField: 'bytes',
+      isBucketed: false,
+      params: {
+        emptyAsNull: true,
+      },
+    },
+  },
+  columnOrder: ['1', '2'],
+  incompleteColumns: {},
+  sampling: 1,
+  indexPatternId: indexPattern.id,
+};
+
+const dateRange = {
+  fromDate: '2021-01-01T00:00:00.000Z',
+  toDate: '2021-01-01T23:59:59.999Z',
+};
+
+const nowInstant = new Date();
+
+describe('to_esql top N', () => {
+  const { uiSettings } = createCoreSetupMock();
+  uiSettings.get.mockImplementation((key: string) => {
+    return defaultUiSettingsGet(key);
+  });
+
+  // Note: operationDefinitionMap for "terms" does not support toESQL
+  // should generate a valid ESQL query for top N terms and average aggregation
+  it('should return undefined for top N terms and average aggregation', () => {
+    const result = getESQLForLayer(
+      aggEntries,
+      layer,
+      indexPattern,
+      uiSettings,
+      dateRange,
+      nowInstant
+    );
+
+    expect(result?.esql).toEqual(undefined);
+  });
+});