Skip to content

[Cases] Fixing types #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathan-buttner merged 3 commits into from
Apr 14, 2021
Merged

[Cases] Fixing types #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d12d9c2
Adding mocks
jonathan-buttner Apr 13, 2021
d38dceb
Merge branch 'convert_unit_tests_to_integration_tests' of github.com:…
jonathan-buttner Apr 13, 2021
be2897f
fixing types and removing unneeded functions
jonathan-buttner Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion x-pack/plugins/cases/server/client/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import Boom from '@hapi/boom';

import { CasesClientArgs } from './types';
import { CasesSubClient, createCasesSubClient } from './cases/client';
Expand Down
53 changes: 0 additions & 53 deletions x-pack/plugins/cases/server/client/index.test.ts
View file
Open in desktop

This file was deleted.

170 changes: 68 additions & 102 deletions x-pack/plugins/cases/server/client/mocks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,115 +5,81 @@
* 2.0.
*/

import { ElasticsearchClient, KibanaRequest } from 'kibana/server';
import { DeeplyMockedKeys } from 'packages/kbn-utility-types/target/jest';
import {
loggingSystemMock,
elasticsearchServiceMock,
savedObjectsServiceMock,
} from '../../../../../src/core/server/mocks';
import {
AlertServiceContract,
CaseConfigureService,
CaseService,
CaseUserActionService,
ConnectorMappingsService,
} from '../services';
import { CasesClient } from './types';
import { authenticationMock } from '../routes/api/__fixtures__';
import { featuresPluginMock } from '../../../features/server/mocks';
import { PublicContract, PublicMethodsOf } from '@kbn/utility-types';

import { CasesClient, CasesClientInternal } from '.';
import { AttachmentsSubClient } from './attachments/client';
import { CasesSubClient } from './cases/client';
import { CasesClientFactory } from './factory';
import { KibanaFeature } from '../../../features/common';

export type CasesClientPluginContractMock = jest.Mocked<CasesClient>;
export const createExternalCasesClientMock = (): CasesClientPluginContractMock => ({
addComment: jest.fn(),
create: jest.fn(),
get: jest.fn(),
push: jest.fn(),
getAlerts: jest.fn(),
getFields: jest.fn(),
getMappings: jest.fn(),
getUserActions: jest.fn(),
update: jest.fn(),
updateAlertsStatus: jest.fn(),
find: jest.fn(),
});

export const createCasesClientWithMockSavedObjectsClient = async ({
savedObjectsClient,
badAuth = false,
omitFromContext = [],
}: {
savedObjectsClient: any;
badAuth?: boolean;
omitFromContext?: string[];
}): Promise<{
client: CasesClient;
services: {
userActionService: jest.Mocked<CaseUserActionService>;
alertsService: jest.Mocked<AlertServiceContract>;
import { SubCasesClient } from './sub_cases/client';
import { UserActionsSubClient } from './user_actions/client';

type CasesSubClientMock = jest.Mocked<CasesSubClient>;

const createCasesSubClientMock = (): CasesSubClientMock => {
return {
create: jest.fn(),
find: jest.fn(),
get: jest.fn(),
push: jest.fn(),
update: jest.fn(),
};
esClient: DeeplyMockedKeys<ElasticsearchClient>;
}> => {
const esClient = elasticsearchServiceMock.createElasticsearchClient();
const log = loggingSystemMock.create().get('case');

const auth = badAuth ? authenticationMock.createInvalid() : authenticationMock.create();
const caseService = new CaseService(log, auth);
const caseConfigureServicePlugin = new CaseConfigureService(log);
const connectorMappingsServicePlugin = new ConnectorMappingsService(log);

const caseConfigureService = await caseConfigureServicePlugin.setup();

const connectorMappingsService = await connectorMappingsServicePlugin.setup();
const userActionService = {
getUserActions: jest.fn(),
postUserActions: jest.fn(),
};

type AttachmentsSubClientMock = jest.Mocked<AttachmentsSubClient>;

const createAttachmentsSubClientMock = (): AttachmentsSubClientMock => {
return {
add: jest.fn(),
};
};

const alertsService = {
initialize: jest.fn(),
updateAlertsStatus: jest.fn(),
getAlerts: jest.fn(),
type UserActionsSubClientMock = jest.Mocked<UserActionsSubClient>;

const createUserActionsSubClientMock = (): UserActionsSubClientMock => {
return {
getAll: jest.fn(),
};
};

// since the cases saved objects are hidden we need to use getScopedClient(), we'll just have it return the mock client
// that is passed in to createRouteContext
const savedObjectsService = savedObjectsServiceMock.createStartContract();
savedObjectsService.getScopedClient.mockReturnValue(savedObjectsClient);

// create a fake feature
const featureStart = featuresPluginMock.createStart();
featureStart.getKibanaFeatures.mockReturnValue([
// all the authorization class cares about is the `cases` field in the kibana feature so just cast it to that
({ cases: ['securitySolution'] } as unknown) as KibanaFeature,
]);

const factory = new CasesClientFactory(log);
factory.initialize({
alertsService,
caseConfigureService,
caseService,
connectorMappingsService,
userActionService,
featuresPluginStart: featureStart,
getSpace: async (req: KibanaRequest) => undefined,
// intentionally not passing the security plugin so that security will be disabled
});

// create a single reference to the caseClient so we can mock its methods
const casesClient = await factory.create({
savedObjectsService,
// Since authorization is disabled for these unit tests we don't need any information from the request object
// so just pass in an empty one
request: {} as KibanaRequest,
scopedClusterClient: esClient,
});
type SubCasesClientMock = jest.Mocked<SubCasesClient>;

const createSubCasesClientMock = (): SubCasesClientMock => {
return {
client: casesClient,
services: { userActionService, alertsService },
esClient,
delete: jest.fn(),
find: jest.fn(),
get: jest.fn(),
update: jest.fn(),
};
};

type CasesClientInternalMock = jest.Mocked<CasesClientInternal>;

export interface CasesClientMock extends CasesClient {
cases: CasesSubClientMock;
attachments: AttachmentsSubClientMock;
userActions: UserActionsSubClientMock;
subCases: SubCasesClientMock;
}

export const createCasesClientMock = (): CasesClientMock => {
const client: PublicContract<CasesClient> = {
casesClientInternal: (jest.fn() as unknown) as CasesClientInternalMock,
Copy link
Copy Markdown
Collaborator Author

@jonathan-buttner jonathan-buttner Apr 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When my PR gets merged we can remove this.

cases: createCasesSubClientMock(),
attachments: createAttachmentsSubClientMock(),
userActions: createUserActionsSubClientMock(),
subCases: createSubCasesClientMock(),
};
return (client as unknown) as CasesClientMock;
};

export type CasesClientFactoryMock = jest.Mocked<CasesClientFactory>;

export const createCasesClientFactory = (): CasesClientFactoryMock => {
const factory: PublicMethodsOf<CasesClientFactory> = {
initialize: jest.fn(),
create: jest.fn(),
};

return (factory as unknown) as CasesClientFactoryMock;
};
60 changes: 18 additions & 42 deletions x-pack/plugins/cases/server/connectors/case/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import { omit } from 'lodash/fp';
import { KibanaRequest, Logger } from '../../../../../../src/core/server';
import { Logger } from '../../../../../../src/core/server';
import { loggingSystemMock } from '../../../../../../src/core/server/mocks';
import { actionsMock } from '../../../../actions/server/mocks';
import { validateParams } from '../../../../actions/server/lib';
Expand All @@ -19,52 +19,28 @@ import {
CaseResponse,
CasesResponse,
} from '../../../common/api';
import {
connectorMappingsServiceMock,
createCaseServiceMock,
createConfigureServiceMock,
createUserActionServiceMock,
createAlertServiceMock,
} from '../../services/mocks';
import { CaseActionType, CaseActionTypeExecutorOptions, CaseExecutorParams } from './types';
import { getActionType } from '.';
import { createExternalCasesClientMock } from '../../client/mocks';
import { CasesClientFactory } from '../../client/factory';
import { featuresPluginMock } from '../../../../features/server/mocks';
import { securityMock } from '../../../../security/server/mocks';

const mockCasesClient = createExternalCasesClientMock();

jest.mock('../../client', () => ({
createExternalCasesClient: () => mockCasesClient,
}));
import {
CasesClientMock,
createCasesClientFactory,
createCasesClientMock,
} from '../../client/mocks';

const services = actionsMock.createServices();
let caseActionType: CaseActionType;

describe('case connector', () => {
let mockCasesClient: CasesClientMock;

beforeEach(() => {
jest.resetAllMocks();
const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
const caseService = createCaseServiceMock();
const caseConfigureService = createConfigureServiceMock();
const connectorMappingsService = connectorMappingsServiceMock();
const userActionService = createUserActionServiceMock();
const alertsService = createAlertServiceMock();
const factory = new CasesClientFactory(logger);

factory.initialize({
alertsService,
caseConfigureService,
caseService,
connectorMappingsService,
userActionService,
featuresPluginStart: featuresPluginMock.createStart(),
getSpace: async (req: KibanaRequest) => undefined,
securityPluginSetup: securityMock.createSetup(),
securityPluginStart: securityMock.createStart(),
});

mockCasesClient = createCasesClientMock();

const factory = createCasesClientFactory();
factory.create.mockReturnValue(Promise.resolve(mockCasesClient));
caseActionType = getActionType({
logger,
factory,
Expand Down Expand Up @@ -983,7 +959,7 @@ describe('case connector', () => {
owner: 'securitySolution',
};

mockCasesClient.create.mockReturnValue(Promise.resolve(createReturn));
mockCasesClient.cases.create.mockReturnValue(Promise.resolve(createReturn));

const actionId = 'some-id';
const params: CaseExecutorParams = {
Expand Down Expand Up @@ -1019,7 +995,7 @@ describe('case connector', () => {
const result = await caseActionType.executor(executorOptions);

expect(result).toEqual({ actionId, status: 'ok', data: createReturn });
expect(mockCasesClient.create).toHaveBeenCalledWith({
expect(mockCasesClient.cases.create).toHaveBeenCalledWith({
...params.subActionParams,
connector: {
id: 'jira',
Expand Down Expand Up @@ -1081,7 +1057,7 @@ describe('case connector', () => {
},
];

mockCasesClient.update.mockReturnValue(Promise.resolve(updateReturn));
mockCasesClient.cases.update.mockReturnValue(Promise.resolve(updateReturn));

const actionId = 'some-id';
const params: CaseExecutorParams = {
Expand Down Expand Up @@ -1109,7 +1085,7 @@ describe('case connector', () => {
const result = await caseActionType.executor(executorOptions);

expect(result).toEqual({ actionId, status: 'ok', data: updateReturn });
expect(mockCasesClient.update).toHaveBeenCalledWith({
expect(mockCasesClient.cases.update).toHaveBeenCalledWith({
// Null values have been striped out.
cases: [
{
Expand Down Expand Up @@ -1171,7 +1147,7 @@ describe('case connector', () => {
owner: 'securitySolution',
};

mockCasesClient.addComment.mockReturnValue(Promise.resolve(commentReturn));
mockCasesClient.attachments.add.mockReturnValue(Promise.resolve(commentReturn));

const actionId = 'some-id';
const params: CaseExecutorParams = {
Expand All @@ -1196,7 +1172,7 @@ describe('case connector', () => {
const result = await caseActionType.executor(executorOptions);

expect(result).toEqual({ actionId, status: 'ok', data: commentReturn });
expect(mockCasesClient.addComment).toHaveBeenCalledWith({
expect(mockCasesClient.attachments.add).toHaveBeenCalledWith({
caseId: 'case-id',
comment: {
comment: 'a comment',
Expand Down
Loading