Merge pull request #2 from jonathan-buttner/convert-cases-unit-tests

[Cases] Migrate deletion unit tests to integration tests
elastic · Apr 13, 2021 · 77e9a93 · 77e9a93
2 parents 25736b3 + a099313
commit 77e9a93
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 200 deletions.
diff --git a/x-pack/plugins/cases/server/routes/api/cases/delete_cases.test.ts b/x-pack/plugins/cases/server/routes/api/cases/delete_cases.test.ts
diff --git a/x-pack/test/case_api_integration/common/lib/utils.ts b/x-pack/test/case_api_integration/common/lib/utils.ts
@@ -448,7 +448,7 @@ export const removeServerGeneratedPropertiesFromComments = (
 
 export const deleteAllCaseItems = async (es: KibanaClient) => {
   await Promise.all([
-    deleteCases(es),
+    deleteCasesByESQuery(es),
     deleteSubCases(es),
     deleteCasesUserActions(es),
     deleteComments(es),
@@ -468,7 +468,7 @@ export const deleteCasesUserActions = async (es: KibanaClient): Promise<void> =>
   });
 };
 
-export const deleteCases = async (es: KibanaClient): Promise<void> => {
+export const deleteCasesByESQuery = async (es: KibanaClient): Promise<void> => {
   await es.deleteByQuery({
     index: '.kibana',
     // @ts-expect-error @elastic/elasticsearch DeleteByQueryRequest doesn't accept q parameter
@@ -600,6 +600,27 @@ export const createCase = async (
   return theCase;
 };
 
+/**
+ * Sends a delete request for the specified case IDs.
+ */
+export const deleteCases = async ({
+  supertest,
+  caseIDs,
+  expectedHttpCode = 204,
+}: {
+  supertest: st.SuperTest<supertestAsPromised.Test>;
+  caseIDs: string[];
+  expectedHttpCode?: number;
+}) => {
+  const { body } = await supertest
+    .delete(`${CASES_URL}?ids=${JSON.stringify(caseIDs)}`)
+    .set('kbn-xsrf', 'true')
+    .send()
+    .expect(expectedHttpCode);
+
+  return body;
+};
+
 export const createComment = async (
   supertest: st.SuperTest<supertestAsPromised.Test>,
   caseId: string,

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/basic/cases/push_case.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/basic/cases/push_case.ts
@@ -9,7 +9,7 @@ import { FtrProviderContext } from '../../../../../common/ftr_provider_context';
 
 import { postCaseReq } from '../../../../common/lib/mock';
 import {
-  deleteCases,
+  deleteCasesByESQuery,
   deleteCasesUserActions,
   deleteComments,
   deleteConfiguration,
@@ -29,7 +29,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('push_case', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
       await deleteComments(es);
       await deleteConfiguration(es);
       await deleteCasesUserActions(es);

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/delete_cases.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/delete_cases.ts
@@ -9,15 +9,19 @@ import expect from '@kbn/expect';
 import { FtrProviderContext } from '../../../../../common/ftr_provider_context';
 
 import { CASES_URL } from '../../../../../../plugins/cases/common/constants';
-import { postCaseReq, postCommentUserReq } from '../../../../common/lib/mock';
+import { getPostCaseRequest, postCommentUserReq } from '../../../../common/lib/mock';
 import {
   createCaseAction,
   createSubCase,
   deleteAllCaseItems,
   deleteCaseAction,
-  deleteCases,
+  deleteCasesByESQuery,
   deleteCasesUserActions,
   deleteComments,
+  createCase,
+  deleteCases,
+  createComment,
+  getComment,
 } from '../../../../common/lib/utils';
 import { getSubCaseDetailsUrl } from '../../../../../../plugins/cases/common/api/helpers';
 import { CaseResponse } from '../../../../../../plugins/cases/common/api';
@@ -29,65 +33,32 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('delete_cases', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
       await deleteComments(es);
       await deleteCasesUserActions(es);
     });
 
     it('should delete a case', async () => {
-      const { body: postedCase } = await supertest
-        .post(CASES_URL)
-        .set('kbn-xsrf', 'true')
-        .send(postCaseReq)
-        .expect(200);
-
-      const { body } = await supertest
-        .delete(`${CASES_URL}?ids=["${postedCase.id}"]`)
-        .set('kbn-xsrf', 'true')
-        .send()
-        .expect(204);
+      const postedCase = await createCase(supertest, getPostCaseRequest());
+      const body = await deleteCases({ supertest, caseIDs: [postedCase.id] });
 
       expect(body).to.eql({});
     });
 
     it(`should delete a case's comments when that case gets deleted`, async () => {
-      const { body: postedCase } = await supertest
-        .post(CASES_URL)
-        .set('kbn-xsrf', 'true')
-        .send(postCaseReq)
-        .expect(200);
-
-      const { body: patchedCase } = await supertest
-        .post(`${CASES_URL}/${postedCase.id}/comments`)
-        .set('kbn-xsrf', 'true')
-        .send(postCommentUserReq)
-        .expect(200);
-
-      await supertest
-        .get(`${CASES_URL}/${postedCase.id}/comments/${patchedCase.comments[0].id}`)
-        .set('kbn-xsrf', 'true')
-        .send()
-        .expect(200);
-
-      await supertest
-        .delete(`${CASES_URL}?ids=["${postedCase.id}"]`)
-        .set('kbn-xsrf', 'true')
-        .send()
-        .expect(204);
-
-      await supertest
-        .get(`${CASES_URL}/${postedCase.id}/comments/${patchedCase.comments[0].id}`)
-        .set('kbn-xsrf', 'true')
-        .send()
-        .expect(404);
+      const postedCase = await createCase(supertest, getPostCaseRequest());
+      const patchedCase = await createComment(supertest, postedCase.id, postCommentUserReq);
+      // ensure that we can get the comment before deleting the case
+      await getComment(supertest, postedCase.id, patchedCase.comments![0].id);
+
+      await deleteCases({ supertest, caseIDs: [postedCase.id] });
+
+      // make sure the comment is now gone
+      await getComment(supertest, postedCase.id, patchedCase.comments![0].id, 404);
     });
 
     it('unhappy path - 404s when case is not there', async () => {
-      await supertest
-        .delete(`${CASES_URL}?ids=["fake-id"]`)
-        .set('kbn-xsrf', 'true')
-        .send()
-        .expect(404);
+      await deleteCases({ supertest, caseIDs: ['fake-id'], expectedHttpCode: 404 });
     });
 
     // ENABLE_CASE_CONNECTOR: once the case connector feature is completed unskip these tests
@@ -107,11 +78,7 @@ export default ({ getService }: FtrProviderContext): void => {
         const { newSubCaseInfo: caseInfo } = await createSubCase({ supertest, actionID });
         expect(caseInfo.subCases![0].id).to.not.eql(undefined);
 
-        const { body } = await supertest
-          .delete(`${CASES_URL}?ids=["${caseInfo.id}"]`)
-          .set('kbn-xsrf', 'true')
-          .send()
-          .expect(204);
+        const body = await deleteCases({ supertest, caseIDs: [caseInfo.id] });
 
         expect(body).to.eql({});
         await supertest
@@ -138,11 +105,7 @@ export default ({ getService }: FtrProviderContext): void => {
         // make sure we can get the second comment
         await supertest.get(subCaseCommentUrl).set('kbn-xsrf', 'true').send().expect(200);
 
-        await supertest
-          .delete(`${CASES_URL}?ids=["${caseInfo.id}"]`)
-          .set('kbn-xsrf', 'true')
-          .send()
-          .expect(204);
+        await deleteCases({ supertest, caseIDs: [caseInfo.id] });
 
         await supertest.get(subCaseCommentUrl).set('kbn-xsrf', 'true').send().expect(404);
       });

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/get_case.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/get_case.ts
@@ -17,7 +17,7 @@ import {
   postCommentUserReq,
 } from '../../../../common/lib/mock';
 import {
-  deleteCases,
+  deleteCasesByESQuery,
   createCase,
   getCase,
   createComment,
@@ -32,7 +32,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('get_case', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
     });
 
     it('should return a case with no comments', async () => {

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/post_case.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/post_case.ts
@@ -16,7 +16,7 @@ import {
 import { getPostCaseRequest, postCaseResp, defaultUser } from '../../../../common/lib/mock';
 import {
   createCaseAsUser,
-  deleteCases,
+  deleteCasesByESQuery,
   createCase,
   removeServerGeneratedPropertiesFromCase,
   removeServerGeneratedPropertiesFromUserAction,
@@ -40,7 +40,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('post_case', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
     });
 
     describe('happy path', () => {

diff --git a/...st/case_api_integration/security_and_spaces/tests/common/cases/reporters/get_reporters.ts b/...st/case_api_integration/security_and_spaces/tests/common/cases/reporters/get_reporters.ts
@@ -10,7 +10,7 @@ import { FtrProviderContext } from '../../../../../../common/ftr_provider_contex
 
 import { CASES_URL, CASE_REPORTERS_URL } from '../../../../../../../plugins/cases/common/constants';
 import { defaultUser, postCaseReq } from '../../../../../common/lib/mock';
-import { deleteCases } from '../../../../../common/lib/utils';
+import { deleteCasesByESQuery } from '../../../../../common/lib/utils';
 
 // eslint-disable-next-line import/no-default-export
 export default ({ getService }: FtrProviderContext): void => {
@@ -19,7 +19,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('get_reporters', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
     });
 
     it('should return reporters', async () => {

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/status/get_status.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/status/get_status.ts
@@ -11,7 +11,7 @@ import { FtrProviderContext } from '../../../../../../common/ftr_provider_contex
 import { CaseStatuses } from '../../../../../../../plugins/cases/common/api';
 import { postCaseReq } from '../../../../../common/lib/mock';
 import {
-  deleteCases,
+  deleteCasesByESQuery,
   createCase,
   updateCase,
   getAllCasesStatuses,
@@ -24,7 +24,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('get_status', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
     });
 
     it('should return case statuses', async () => {

diff --git a/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/tags/get_tags.ts b/x-pack/test/case_api_integration/security_and_spaces/tests/common/cases/tags/get_tags.ts
@@ -10,7 +10,7 @@ import { FtrProviderContext } from '../../../../../../common/ftr_provider_contex
 
 import { CASES_URL, CASE_TAGS_URL } from '../../../../../../../plugins/cases/common/constants';
 import { postCaseReq } from '../../../../../common/lib/mock';
-import { deleteCases } from '../../../../../common/lib/utils';
+import { deleteCasesByESQuery } from '../../../../../common/lib/utils';
 
 // eslint-disable-next-line import/no-default-export
 export default ({ getService }: FtrProviderContext): void => {
@@ -19,7 +19,7 @@ export default ({ getService }: FtrProviderContext): void => {
 
   describe('get_tags', () => {
     afterEach(async () => {
-      await deleteCases(es);
+      await deleteCasesByESQuery(es);
     });
 
     it('should return case tags', async () => {