adding category examples tests

x-pack/test/api_integration/apis/ml/results/get_category_definition.ts

@@ -123,7 +123,7 @@ export default ({ getService }: FtrProviderContext) => {
       );
     });
 
-    it('should produce the correct category for the job', async () => {
+    it('should not produce the correct category for the job', async () => {
       const resp = await getCategoryDefinition(jobIdSpace1, '2', USER.ML_POWERUSER, 200, idSpace1);
 
       expect(resp).to.not.eql(

x-pack/test/api_integration/apis/ml/results/get_category_examples.ts

@@ -0,0 +1,204 @@
+/*
+ * 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 expect from '@kbn/expect';
+import { FtrProviderContext } from '../../../ftr_provider_context';
+import { USER } from '../../../../functional/services/ml/security_common';
+import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api';
+import { Datafeed } from '../../../../../plugins/ml/common/types/anomaly_detection_jobs';
+
+export default ({ getService }: FtrProviderContext) => {
+  const esArchiver = getService('esArchiver');
+  const supertest = getService('supertestWithoutAuth');
+  const ml = getService('ml');
+  const spacesService = getService('spaces');
+
+  const jobIdSpace1 = `sample_logs_${Date.now()}`;
+  const idSpace1 = 'space1';
+  const idSpace2 = 'space2';
+
+  const PARTITION_FIELD_NAME = 'event.dataset';
+  const testJobConfig = {
+    job_id: jobIdSpace1,
+    groups: ['sample_logs', 'bootstrap', 'categorization'],
+    description: "count by mlcategory (message) on 'sample logs' dataset with 15m bucket span",
+    analysis_config: {
+      bucket_span: '15m',
+      categorization_field_name: 'message',
+      per_partition_categorization: { enabled: true, stop_on_warn: true },
+      detectors: [
+        {
+          function: 'count',
+          by_field_name: 'mlcategory',
+          partition_field_name: PARTITION_FIELD_NAME,
+        },
+      ],
+      influencers: ['mlcategory'],
+    },
+    analysis_limits: { model_memory_limit: '26MB' },
+    data_description: { time_field: '@timestamp', time_format: 'epoch_ms' },
+    model_plot_config: { enabled: false, annotations_enabled: true },
+    model_snapshot_retention_days: 10,
+    daily_model_snapshot_retention_after_days: 1,
+    allow_lazy_open: false,
+  };
+  // @ts-expect-error not full interface
+  const testDatafeedConfig: Datafeed = {
+    datafeed_id: `datafeed-${jobIdSpace1}`,
+    indices: ['ft_module_sample_logs'],
+    job_id: jobIdSpace1,
+    query: { bool: { must: [{ match_all: {} }] } },
+  };
+
+  const expectedCategoryExamples1 = {
+    '1': [
+      '130.246.123.197 - - [2018-07-22T03:26:21.326Z] "GET /beats/metricbeat HTTP/1.1" 200 6850 "-" "Mozilla/5.0 (X11; Linux x86_64; rv:6.0a1) Gecko/20110421 Firefox/6.0a1"',
+    ],
+  };
+  const expectedCategoryExamples3 = {
+    '1': [
+      '130.246.123.197 - - [2018-07-22T03:26:21.326Z] "GET /beats/metricbeat HTTP/1.1" 200 6850 "-" "Mozilla/5.0 (X11; Linux x86_64; rv:6.0a1) Gecko/20110421 Firefox/6.0a1"',
+      '130.246.123.197 - - [2018-07-22T03:26:21.326Z] "GET /beats/metricbeat_1 HTTP/1.1" 200 6850 "-" "Mozilla/5.0 (X11; Linux x86_64; rv:6.0a1) Gecko/20110421 Firefox/6.0a1"',
+      '223.87.60.27 - - [2018-07-22T00:39:02.912Z] "GET /elasticsearch/elasticsearch-6.3.2.deb HTTP/1.1" 200 6219 "-" "Mozilla/5.0 (X11; Linux x86_64; rv:6.0a1) Gecko/20110421 Firefox/6.0a1"',
+    ],
+  };
+
+  async function getCategoryExamples(
+    jobId: string,
+    categoryIds: string[],
+    maxExamples: number,
+    user: USER,
+    expectedStatusCode: number,
+    space?: string
+  ) {
+    const { body } = await supertest
+      .post(`${space ? `/s/${space}` : ''}/api/ml/results/category_examples`)
+      .auth(user, ml.securityCommon.getPasswordForUser(user))
+      .set(COMMON_REQUEST_HEADERS)
+      .send({ jobId, categoryIds, maxExamples })
+      .expect(expectedStatusCode);
+
+    return body;
+  }
+
+  describe('get category_examples', function () {
+    before(async () => {
+      await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/ml/module_sample_logs');
+      await ml.testResources.setKibanaTimeZoneToUTC();
+      await spacesService.create({ id: idSpace1, name: 'space_one', disabledFeatures: [] });
+      await spacesService.create({ id: idSpace2, name: 'space_two', disabledFeatures: [] });
+
+      await ml.api.createAndRunAnomalyDetectionLookbackJob(
+        // @ts-expect-error not full interface
+        testJobConfig,
+        testDatafeedConfig,
+        idSpace1
+      );
+    });
+
+    after(async () => {
+      await spacesService.delete(idSpace1);
+      await spacesService.delete(idSpace2);
+      await ml.testResources.deleteIndexPatternByTitle('ft_module_sample_logs');
+      await ml.api.cleanMlIndices();
+    });
+
+    it('should produce the correct 1 example for the job', async () => {
+      const resp = await getCategoryExamples(
+        jobIdSpace1,
+        Object.keys(expectedCategoryExamples1),
+        1,
+        USER.ML_POWERUSER,
+        200,
+        idSpace1
+      );
+
+      expect(resp).to.eql(
+        expectedCategoryExamples1,
+        `response should be ${JSON.stringify(expectedCategoryExamples1)} (got ${JSON.stringify(
+          resp
+        )})`
+      );
+    });
+
+    it('should produce the correct 3 examples for the job', async () => {
+      const resp = await getCategoryExamples(
+        jobIdSpace1,
+        Object.keys(expectedCategoryExamples3),
+        3,
+        USER.ML_POWERUSER,
+        200,
+        idSpace1
+      );
+
+      expect(resp).to.eql(
+        expectedCategoryExamples3,
+        `response should be ${JSON.stringify(expectedCategoryExamples3)} (got ${JSON.stringify(
+          resp
+        )})`
+      );
+    });
+
+    it('should not produce the correct example for the job', async () => {
+      const resp = await getCategoryExamples(
+        jobIdSpace1,
+        ['2'],
+        3,
+        USER.ML_POWERUSER,
+        200,
+        idSpace1
+      );
+
+      expect(resp).to.not.eql(
+        expectedCategoryExamples3,
+        `response should not be ${JSON.stringify(expectedCategoryExamples3)} (got ${JSON.stringify(
+          resp
+        )})`
+      );
+    });
+
+    it('should not produce the correct examples for the job in the wrong space', async () => {
+      await getCategoryExamples(
+        jobIdSpace1,
+        Object.keys(expectedCategoryExamples1),
+        3,
+        USER.ML_POWERUSER,
+        404,
+        idSpace2
+      );
+    });
+
+    it('should produce the correct example for the job for the ml viewer user', async () => {
+      const resp = await getCategoryExamples(
+        jobIdSpace1,
+        Object.keys(expectedCategoryExamples3),
+        3,
+        USER.ML_VIEWER,
+        200,
+        idSpace1
+      );
+
+      expect(resp).to.eql(
+        expectedCategoryExamples3,
+        `response should be ${JSON.stringify(expectedCategoryExamples3)} (got ${JSON.stringify(
+          resp
+        )})`
+      );
+    });
+
+    it('should not produce the correct example for the job for the ml unauthorized user', async () => {
+      await getCategoryExamples(
+        jobIdSpace1,
+        Object.keys(expectedCategoryExamples3),
+        3,
+        USER.ML_UNAUTHORIZED,
+        403,
+        idSpace1
+      );
+    });
+  });
+};

x-pack/test/api_integration/apis/ml/results/index.ts

@@ -13,5 +13,6 @@ export default function ({ loadTestFile }: FtrProviderContext) {
     loadTestFile(require.resolve('./get_categorizer_stats'));
     loadTestFile(require.resolve('./get_stopped_partitions'));
     loadTestFile(require.resolve('./get_category_definition'));
+    loadTestFile(require.resolve('./get_category_examples'));
   });
 }