Skip to content
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

Jump to bottom

[Cases] Get connector's information from actionsTypeRegistry #101279

Merged
merged 4 commits into from
Jun 8, 2021
Merged

[Cases] Get connector's information from actionsTypeRegistry #101279

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4846fae
[Alerting UI] Replace direct components links in Cases plugin with th…
YulNaumenko May 22, 2021
68a4569
Fix tests
cnasikas Jun 4, 2021
f62728a
PR Feedback
cnasikas Jun 7, 2021
c161adb
Switch to client-side mock
cnasikas Jun 8, 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
10 changes: 9 additions & 1 deletion x-pack/plugins/cases/public/common/lib/kibana/kibana_react.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,24 @@
* 2.0.
*/

/* eslint-disable @kbn/eslint/no-restricted-paths */

import React from 'react';

import { RecursivePartial } from '@elastic/eui/src/components/common';
import { coreMock } from '../../../../../../../src/core/public/mocks';
import { KibanaContextProvider } from '../../../../../../../src/plugins/kibana_react/public';
import { StartServices } from '../../../types';
import { EuiTheme } from '../../../../../../../src/plugins/kibana_react/common';
import { securityMock } from '../../../../../security/server/mocks';
cnasikas marked this conversation as resolved.
Show resolved Hide resolved
import { triggersActionsUiMock } from '../../../../../triggers_actions_ui/public/mocks';

export const createStartServicesMock = (): StartServices =>
(coreMock.createStart() as unknown) as StartServices;
(({
...coreMock.createStart(),
security: securityMock.createStart(),
triggersActionsUi: triggersActionsUiMock.createStart(),
} as unknown) as StartServices);

export const createWithKibanaMock = () => {
const services = createStartServicesMock();
Expand Down
7 changes: 7 additions & 0 deletions x-pack/plugins/cases/public/components/case_view/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,21 @@ import { useConnectors } from '../../containers/configure/use_connectors';
import { connectorsMock } from '../../containers/configure/mock';
import { usePostPushToService } from '../../containers/use_post_push_to_service';
import { CaseType, ConnectorTypes } from '../../../common';
import { useKibana } from '../../common/lib/kibana';

jest.mock('../../containers/use_update_case');
jest.mock('../../containers/use_get_case_user_actions');
jest.mock('../../containers/use_get_case');
jest.mock('../../containers/configure/use_connectors');
jest.mock('../../containers/use_post_push_to_service');
jest.mock('../user_action_tree/user_action_timestamp');
jest.mock('../../common/lib/kibana');

const useUpdateCaseMock = useUpdateCase as jest.Mock;
const useGetCaseUserActionsMock = useGetCaseUserActions as jest.Mock;
const useConnectorsMock = useConnectors as jest.Mock;
const usePostPushToServiceMock = usePostPushToService as jest.Mock;
const useKibanaMock = useKibana as jest.Mocked<typeof useKibana>;

const alertsHit = [
{
Expand Down Expand Up @@ -160,6 +163,10 @@ describe('CaseView ', () => {
pushCaseToExternalService,
}));
useConnectorsMock.mockImplementation(() => ({ connectors: connectorsMock, loading: false }));
useKibanaMock().services.triggersActionsUi.actionTypeRegistry.get = jest.fn().mockReturnValue({
Copy link
Contributor

Choose a reason for hiding this comment

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

Will the tests throughout this PR fail if get returns undefined? I'm just wondering if it's sufficient to jest.mock('../../common/lib/kibana')

Seems like we do this in some places: https:/elastic/kibana/pull/101279/files#diff-94a9922e9734d8791131f05c1124fd6197bdceb756e6bc2770191639b905e169R85

Copy link
Member Author

Choose a reason for hiding this comment

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

I see what you mean! It is not sufficient because of the way the mock is being created (triggersActionsUiMock.createStart() in x-pack/plugins/cases/public/common/lib/kibana/kibana_react.mock.ts). The actionTypeRegistry is not mocked so when the flyout access the actionTypeRegistry to get the connector type you will get an error that the type is not registered.

actionTypeTitle: '.servicenow',
iconClass: 'logoSecurity',
});
});

it('should render CaseComponent', async () => {
Expand Down
8 changes: 8 additions & 0 deletions x-pack/plugins/cases/public/components/configure_cases/connectors.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import { TestProviders } from '../../common/mock';
import { ConnectorsDropdown } from './connectors_dropdown';
import { connectors } from './__mock__';
import { ConnectorTypes } from '../../../common';
import { useKibana } from '../../common/lib/kibana';

jest.mock('../../common/lib/kibana');
const useKibanaMock = useKibana as jest.Mocked<typeof useKibana>;

describe('Connectors', () => {
let wrapper: ReactWrapper;
Expand All @@ -31,6 +35,10 @@ describe('Connectors', () => {
};

beforeAll(() => {
useKibanaMock().services.triggersActionsUi.actionTypeRegistry.get = jest.fn().mockReturnValue({
actionTypeTitle: 'test',
iconClass: 'logoSecurity',
});
wrapper = mount(<Connectors {...props} />, { wrappingComponent: TestProviders });
});

Expand Down
54 changes: 19 additions & 35 deletions x-pack/plugins/cases/public/components/configure_cases/connectors_dropdown.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import { EuiSuperSelect } from '@elastic/eui';
import { ConnectorsDropdown, Props } from './connectors_dropdown';
import { TestProviders } from '../../common/mock';
import { connectors } from './__mock__';
import { useKibana } from '../../common/lib/kibana';

jest.mock('../../common/lib/kibana');
const useKibanaMock = useKibana as jest.Mocked<typeof useKibana>;

describe('ConnectorsDropdown', () => {
let wrapper: ReactWrapper;
Expand All @@ -24,6 +28,10 @@ describe('ConnectorsDropdown', () => {
};

beforeAll(() => {
useKibanaMock().services.triggersActionsUi.actionTypeRegistry.get = jest.fn().mockReturnValue({
actionTypeTitle: '.servicenow',
iconClass: 'logoSecurity',
});
wrapper = mount(<ConnectorsDropdown {...props} />, { wrappingComponent: TestProviders });
});

Expand Down Expand Up @@ -73,14 +81,7 @@ describe('ConnectorsDropdown', () => {
>
<Styled(EuiIcon)
size="m"
type={
Object {
"$$typeof": Symbol(react.lazy),
"_ctor": [Function],
"_result": null,
"_status": -1,
}
}
type="logoSecurity"
/>
</EuiFlexItem>
<EuiFlexItem>
Expand All @@ -103,14 +104,7 @@ describe('ConnectorsDropdown', () => {
>
<Styled(EuiIcon)
size="m"
type={
Object {
"$$typeof": Symbol(react.lazy),
"_ctor": [Function],
"_result": null,
"_status": -1,
}
}
type="logoSecurity"
/>
</EuiFlexItem>
<EuiFlexItem>
Expand All @@ -133,14 +127,7 @@ describe('ConnectorsDropdown', () => {
>
<Styled(EuiIcon)
size="m"
type={
Object {
"$$typeof": Symbol(react.lazy),
"_ctor": [Function],
"_result": null,
"_status": -1,
}
}
type="logoSecurity"
/>
</EuiFlexItem>
<EuiFlexItem>
Expand All @@ -163,14 +150,7 @@ describe('ConnectorsDropdown', () => {
>
<Styled(EuiIcon)
size="m"
type={
Object {
"$$typeof": Symbol(react.lazy),
"_ctor": [Function],
"_result": null,
"_status": -1,
}
}
type="logoSecurity"
/>
</EuiFlexItem>
<EuiFlexItem>
Expand Down Expand Up @@ -210,9 +190,13 @@ describe('ConnectorsDropdown', () => {
wrappingComponent: TestProviders,
});

expect(newWrapper.find('button span:not([data-euiicon-type])').at(1).text()).toBe(
'My Connector'
);
expect(
newWrapper
.find('[data-test-subj="dropdown-connectors"]')
.first()
.text()
.includes('My Connector, is selected')
).toBeTruthy();
});

test('if the props hideConnectorServiceNowSir is true, the connector should not be part of the list of options ', () => {
Expand Down
8 changes: 6 additions & 2 deletions x-pack/plugins/cases/public/components/configure_cases/connectors_dropdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import styled from 'styled-components';

import { ConnectorTypes } from '../../../common';
import { ActionConnector } from '../../containers/configure/types';
import { connectorsConfiguration } from '../connectors';
import * as i18n from './translations';
import { useKibana } from '../../common/lib/kibana';

export interface Props {
connectors: ActionConnector[];
Expand Down Expand Up @@ -65,6 +65,7 @@ const ConnectorsDropdownComponent: React.FC<Props> = ({
appendAddConnectorButton = false,
hideConnectorServiceNowSir = false,
}) => {
const { triggersActionsUi } = useKibana().services;
const connectorsAsOptions = useMemo(() => {
const connectorsFormatted = connectors.reduce(
(acc, connector) => {
Expand All @@ -80,7 +81,10 @@ const ConnectorsDropdownComponent: React.FC<Props> = ({
<EuiFlexGroup gutterSize="none" alignItems="center" responsive={false}>
<EuiFlexItem grow={false}>
<EuiIconExtended
type={connectorsConfiguration[connector.actionTypeId]?.logo ?? ''}
type={
triggersActionsUi.actionTypeRegistry.get(connector.actionTypeId)?.iconClass ??
''
}
size={ICON_SIZE}
/>
</EuiFlexItem>
Expand Down
9 changes: 9 additions & 0 deletions x-pack/plugins/cases/public/components/configure_cases/field_mapping.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import { FieldMapping, FieldMappingProps } from './field_mapping';
import { mappings } from './__mock__';
import { TestProviders } from '../../common/mock';
import { FieldMappingRowStatic } from './field_mapping_row_static';
import { useKibana } from '../../common/lib/kibana';

jest.mock('../../common/lib/kibana');
const useKibanaMock = useKibana as jest.Mocked<typeof useKibana>;

describe('FieldMappingRow', () => {
let wrapper: ReactWrapper;
Expand All @@ -22,8 +26,13 @@ describe('FieldMappingRow', () => {
};

beforeAll(() => {
useKibanaMock().services.triggersActionsUi.actionTypeRegistry.get = jest.fn().mockReturnValue({
actionTypeTitle: '.servicenow',
iconClass: 'logoSecurity',
});
wrapper = mount(<FieldMapping {...props} />, { wrappingComponent: TestProviders });
});

test('it renders', () => {
expect(
wrapper.find('[data-test-subj="case-configure-field-mappings-row-wrapper"]').first().exists()
Expand Down
8 changes: 5 additions & 3 deletions x-pack/plugins/cases/public/components/configure_cases/field_mapping.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { FieldMappingRowStatic } from './field_mapping_row_static';
import * as i18n from './translations';

import { CaseConnectorMapping } from '../../containers/configure/types';
import { connectorsConfiguration } from '../connectors';
import { useKibana } from '../../common/lib/kibana';

const FieldRowWrapper = styled.div`
margin: 10px 0;
Expand All @@ -31,8 +31,10 @@ const FieldMappingComponent: React.FC<FieldMappingProps> = ({
isLoading,
mappings,
}) => {
const { triggersActionsUi } = useKibana().services;
const selectedConnector = useMemo(
() => connectorsConfiguration[connectorActionTypeId] ?? { fields: {} },
() => triggersActionsUi.actionTypeRegistry.get(connectorActionTypeId) ?? { fields: {} },
// eslint-disable-next-line react-hooks/exhaustive-deps
[connectorActionTypeId]
);
return mappings.length ? (
Expand All @@ -45,7 +47,7 @@ const FieldMappingComponent: React.FC<FieldMappingProps> = ({
</EuiFlexItem>
<EuiFlexItem>
<span className="euiFormLabel">
{i18n.FIELD_MAPPING_SECOND_COL(selectedConnector.name)}
{i18n.FIELD_MAPPING_SECOND_COL(selectedConnector.actionTypeTitle ?? '')}
</span>
</EuiFlexItem>
<EuiFlexItem>
Expand Down
Loading