[Security Solution][lists] Adds tests for exception lists and items p…

…art 2 (elastic#74815) (elastic#74921) ## Summary This is the basics of end to end tests, so there could be a lot more, but this ties to cover the basics of the tests. Test with: ```ts node scripts/functional_tests --config x-pack/test/lists_api_integration/security_and_spaces/config.ts ``` Adds these tests for the route counter parts: * create_exception_list_items.ts * create_exception_lists.ts * delete_exception_list_items.ts * delete_exception_lists.ts * find_exception_list_items.ts * find_exception_lists.ts * read_exception_list_items.ts * read_exception_lists.ts * update_exception_list_items.ts * update_exception_lists.ts Fixes a few minor strings, other tests, but no large bugs found with these tests ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
walterra · Aug 13, 2020 · a427eb5 · a427eb5
1 parent 8991c4f
commit a427eb5
Show file tree

Hide file tree

Showing 26 changed files with 1,444 additions and 46 deletions.
diff --git a/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.mock.ts b/x-pack/plugins/lists/common/schemas/request/create_exception_list_item_schema.mock.ts
@@ -8,6 +8,7 @@ import {
   COMMENTS,
   DESCRIPTION,
   ENTRIES,
+  ITEM_ID,
   ITEM_TYPE,
   LIST_ID,
   META,
@@ -32,3 +33,26 @@ export const getCreateExceptionListItemSchemaMock = (): CreateExceptionListItemS
   tags: TAGS,
   type: ITEM_TYPE,
 });
+
+/**
+ * Useful for end to end testing
+ */
+export const getCreateExceptionListItemMinimalSchemaMock = (): CreateExceptionListItemSchema => ({
+  description: DESCRIPTION,
+  entries: ENTRIES,
+  item_id: ITEM_ID,
+  list_id: LIST_ID,
+  name: NAME,
+  type: ITEM_TYPE,
+});
+
+/**
+ * Useful for end to end testing
+ */
+export const getCreateExceptionListItemMinimalSchemaMockWithoutId = (): CreateExceptionListItemSchema => ({
+  description: DESCRIPTION,
+  entries: ENTRIES,
+  list_id: LIST_ID,
+  name: NAME,
+  type: ITEM_TYPE,
+});
diff --git a/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.mock.ts b/x-pack/plugins/lists/common/schemas/request/create_exception_list_schema.mock.ts
@@ -7,6 +7,7 @@
 import {
   DESCRIPTION,
   ENDPOINT_TYPE,
+  LIST_ID,
   META,
   NAME,
   NAMESPACE_TYPE,
@@ -26,3 +27,22 @@ export const getCreateExceptionListSchemaMock = (): CreateExceptionListSchema =>
   type: ENDPOINT_TYPE,
   version: VERSION,
 });
+
+/**
+ * Useful for end to end testing
+ */
+export const getCreateExceptionListMinimalSchemaMock = (): CreateExceptionListSchema => ({
+  description: DESCRIPTION,
+  list_id: LIST_ID,
+  name: NAME,
+  type: ENDPOINT_TYPE,
+});
+
+/**
+ * Useful for end to end testing
+ */
+export const getCreateExceptionListMinimalSchemaMockWithoutId = (): CreateExceptionListSchema => ({
+  description: DESCRIPTION,
+  name: NAME,
+  type: ENDPOINT_TYPE,
+});
diff --git a/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.mock.ts b/x-pack/plugins/lists/common/schemas/request/update_exception_list_item_schema.mock.ts
@@ -9,6 +9,7 @@ import {
   DESCRIPTION,
   ENTRIES,
   ID,
+  ITEM_ID,
   ITEM_TYPE,
   LIST_ITEM_ID,
   META,
@@ -34,3 +35,15 @@ export const getUpdateExceptionListItemSchemaMock = (): UpdateExceptionListItemS
   tags: TAGS,
   type: ITEM_TYPE,
 });
+
+/**
+ * Useful for end to end tests and other mechanisms which want to fill in the values
+ * after doing a get of the structure.
+ */
+export const getUpdateMinimalExceptionListItemSchemaMock = (): UpdateExceptionListItemSchema => ({
+  description: DESCRIPTION,
+  entries: ENTRIES,
+  item_id: ITEM_ID,
+  name: NAME,
+  type: ITEM_TYPE,
+});
diff --git a/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.mock.ts b/x-pack/plugins/lists/common/schemas/request/update_exception_list_schema.mock.ts
@@ -20,3 +20,14 @@ export const getUpdateExceptionListSchemaMock = (): UpdateExceptionListSchema =>
   tags: ['malware'],
   type: 'endpoint',
 });
+
+/**
+ * Useful for end to end tests and other mechanisms which want to fill in the values
+ * after doing a get of the structure.
+ */
+export const getUpdateMinimalExceptionListSchemaMock = (): UpdateExceptionListSchema => ({
+  description: DESCRIPTION,
+  list_id: LIST_ID,
+  name: NAME,
+  type: 'endpoint',
+});
diff --git a/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.mock.ts b/x-pack/plugins/lists/common/schemas/response/exception_list_item_schema.mock.ts
@@ -7,8 +7,11 @@ import {
   COMMENTS,
   DATE_NOW,
   DESCRIPTION,
+  ELASTIC_USER,
   ENTRIES,
+  ITEM_ID,
   ITEM_TYPE,
+  LIST_ID,
   META,
   NAME,
   NAMESPACE_TYPE,
@@ -38,3 +41,24 @@ export const getExceptionListItemSchemaMock = (): ExceptionListItemSchema => ({
   updated_at: DATE_NOW,
   updated_by: USER,
 });
+
+/**
+ * This is useful for end to end tests where we remove the auto generated parts for comparisons
+ * such as created_at, updated_at, and id.
+ */
+export const getExceptionListItemResponseMockWithoutAutoGeneratedValues = (): Partial<
+  ExceptionListItemSchema
+> => ({
+  _tags: [],
+  comments: [],
+  created_by: ELASTIC_USER,
+  description: DESCRIPTION,
+  entries: ENTRIES,
+  item_id: ITEM_ID,
+  list_id: LIST_ID,
+  name: NAME,
+  namespace_type: 'single',
+  tags: [],
+  type: ITEM_TYPE,
+  updated_by: ELASTIC_USER,
+});
diff --git a/x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts b/x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts
@@ -7,9 +7,12 @@
 import {
   DATE_NOW,
   DESCRIPTION,
+  ELASTIC_USER,
   ENDPOINT_TYPE,
   IMMUTABLE,
+  LIST_ID,
   META,
+  NAME,
   TIE_BREAKER,
   USER,
   VERSION,
@@ -18,6 +21,7 @@ import {
 import { ENDPOINT_LIST_ID } from '../..';
 
 import { ExceptionListSchema } from './exception_list_schema';
+
 export const getExceptionListSchemaMock = (): ExceptionListSchema => ({
   _tags: ['endpoint', 'process', 'malware', 'os:linux'],
   _version: _VERSION,
@@ -37,3 +41,23 @@ export const getExceptionListSchemaMock = (): ExceptionListSchema => ({
   updated_by: 'user_name',
   version: VERSION,
 });
+
+/**
+ * This is useful for end to end tests where we remove the auto generated parts for comparisons
+ * such as created_at, updated_at, and id.
+ */
+export const getExceptionResponseMockWithoutAutoGeneratedValues = (): Partial<
+  ExceptionListSchema
+> => ({
+  _tags: [],
+  created_by: ELASTIC_USER,
+  description: DESCRIPTION,
+  immutable: IMMUTABLE,
+  list_id: LIST_ID,
+  name: NAME,
+  namespace_type: 'single',
+  tags: [],
+  type: ENDPOINT_TYPE,
+  updated_by: ELASTIC_USER,
+  version: VERSION,
+});
diff --git a/x-pack/plugins/lists/server/routes/create_exception_list_item_route.ts b/x-pack/plugins/lists/server/routes/create_exception_list_item_route.ts
@@ -57,7 +57,7 @@ export const createExceptionListItemRoute = (router: IRouter): void => {
         });
         if (exceptionList == null) {
           return siemResponse.error({
-            body: `list id: "${listId}" does not exist`,
+            body: `exception list id: "${listId}" does not exist`,
             statusCode: 404,
           });
         } else {

diff --git a/x-pack/plugins/lists/server/routes/find_exception_list_item_route.ts b/x-pack/plugins/lists/server/routes/find_exception_list_item_route.ts
@@ -62,7 +62,7 @@ export const findExceptionListItemRoute = (router: IRouter): void => {
           });
           if (exceptionListItems == null) {
             return siemResponse.error({
-              body: `list id: "${listId}" does not exist`,
+              body: `exception list id: "${listId}" does not exist`,
               statusCode: 404,
             });
           }

diff --git a/x-pack/plugins/lists/server/routes/update_exception_list_item_route.ts b/x-pack/plugins/lists/server/routes/update_exception_list_item_route.ts
@@ -54,39 +54,46 @@ export const updateExceptionListItemRoute = (router: IRouter): void => {
           namespace_type: namespaceType,
           tags,
         } = request.body;
-        const exceptionLists = getExceptionListClient(context);
-        const exceptionListItem = await exceptionLists.updateExceptionListItem({
-          _tags,
-          _version,
-          comments,
-          description,
-          entries,
-          id,
-          itemId,
-          meta,
-          name,
-          namespaceType,
-          tags,
-          type,
-        });
-        if (exceptionListItem == null) {
-          if (id != null) {
-            return siemResponse.error({
-              body: `list item id: "${id}" not found`,
-              statusCode: 404,
-            });
-          } else {
-            return siemResponse.error({
-              body: `list item item_id: "${itemId}" not found`,
-              statusCode: 404,
-            });
-          }
+        if (id == null && itemId == null) {
+          return siemResponse.error({
+            body: 'either id or item_id need to be defined',
+            statusCode: 404,
+          });
         } else {
-          const [validated, errors] = validate(exceptionListItem, exceptionListItemSchema);
-          if (errors != null) {
-            return siemResponse.error({ body: errors, statusCode: 500 });
+          const exceptionLists = getExceptionListClient(context);
+          const exceptionListItem = await exceptionLists.updateExceptionListItem({
+            _tags,
+            _version,
+            comments,
+            description,
+            entries,
+            id,
+            itemId,
+            meta,
+            name,
+            namespaceType,
+            tags,
+            type,
+          });
+          if (exceptionListItem == null) {
+            if (id != null) {
+              return siemResponse.error({
+                body: `exception list item id: "${id}" does not exist`,
+                statusCode: 404,
+              });
+            } else {
+              return siemResponse.error({
+                body: `exception list item item_id: "${itemId}" does not exist`,
+                statusCode: 404,
+              });
+            }
           } else {
-            return response.ok({ body: validated ?? {} });
+            const [validated, errors] = validate(exceptionListItem, exceptionListItemSchema);
+            if (errors != null) {
+              return siemResponse.error({ body: errors, statusCode: 500 });
+            } else {
+              return response.ok({ body: validated ?? {} });
+            }
           }
         }
       } catch (err) {

diff --git a/x-pack/plugins/lists/server/routes/update_exception_list_route.ts b/x-pack/plugins/lists/server/routes/update_exception_list_route.ts
@@ -15,7 +15,7 @@ import {
   updateExceptionListSchema,
 } from '../../common/schemas';
 
-import { getExceptionListClient } from './utils';
+import { getErrorMessageExceptionList, getExceptionListClient } from './utils';
 
 export const updateExceptionListRoute = (router: IRouter): void => {
   router.put(
@@ -50,7 +50,7 @@ export const updateExceptionListRoute = (router: IRouter): void => {
         const exceptionLists = getExceptionListClient(context);
         if (id == null && listId == null) {
           return siemResponse.error({
-            body: `either id or list_id need to be defined`,
+            body: 'either id or list_id need to be defined',
             statusCode: 404,
           });
         } else {
@@ -69,7 +69,7 @@ export const updateExceptionListRoute = (router: IRouter): void => {
           });
           if (list == null) {
             return siemResponse.error({
-              body: `exception list id: "${id}" not found`,
+              body: getErrorMessageExceptionList({ id, listId }),
               statusCode: 404,
             });
           } else {

diff --git a/x-pack/plugins/lists/server/routes/utils/get_error_message_exception_list.ts b/x-pack/plugins/lists/server/routes/utils/get_error_message_exception_list.ts
@@ -12,10 +12,10 @@ export const getErrorMessageExceptionList = ({
   listId: string | undefined;
 }): string => {
   if (id != null) {
-    return `Exception list id: "${id}" does not exist`;
+    return `exception list id: "${id}" does not exist`;
   } else if (listId != null) {
-    return `Exception list list_id: "${listId}" does not exist`;
+    return `exception list list_id: "${listId}" does not exist`;
   } else {
-    return 'Exception list does not exist';
+    return 'exception list does not exist';
   }
 };
diff --git a/x-pack/plugins/lists/server/routes/utils/get_error_message_exception_list_item.ts b/x-pack/plugins/lists/server/routes/utils/get_error_message_exception_list_item.ts
@@ -12,10 +12,10 @@ export const getErrorMessageExceptionListItem = ({
   itemId: string | undefined;
 }): string => {
   if (id != null) {
-    return `Exception list item id: "${id}" does not exist`;
+    return `exception list item id: "${id}" does not exist`;
   } else if (itemId != null) {
-    return `Exception list item list_id: "${itemId}" does not exist`;
+    return `exception list item item_id: "${itemId}" does not exist`;
   } else {
-    return 'Exception list item does not exist';
+    return 'exception list item does not exist';
   }
 };