Skip to content

Commit

Permalink
Merge pull request #8930 from cyril-ui-developer/display-operand-inst…
Browse files Browse the repository at this point in the history 
…ances-managed-namespaces

CONSOLE-2321: Allow operators installed globally to display operand instances for all managed namespaces in their details
  • Loading branch information
@openshift-merge-robot
openshift-merge-robot committed Jun 8, 2022
2 parents 8703892 + 9335658 commit 8e22765
Show file tree
Hide file tree
Showing 9 changed files with 547 additions and 251 deletions.
9 changes: 7 additions & 2 deletions frontend/packages/operator-lifecycle-manager/locales/en/olm.json
View file
Expand Up @@ -208,14 +208,19 @@
"Advanced configuration": "Advanced configuration",
"Note: Some fields may not be represented in this form. Please select \"YAML View\" for full control of object creation.": "Note: Some fields may not be represented in this form. Please select \"YAML View\" for full control of object creation.",
"Fix above errors": "Fix above errors",
"No operands found": "No operands found",
"Operands are declarative components used to define the behavior of the application.": "Operands are declarative components used to define the behavior of the application.",
"No provided APIs defined": "No provided APIs defined",
"This application was not properly installed or configured.": "This application was not properly installed or configured.",
"No operands found": "No operands found",
"Operands are declarative components used to define the behavior of the application.": "Operands are declarative components used to define the behavior of the application.",
"Resource Kind": "Resource Kind",
"All Instances": "All Instances",
"Create new": "Create new",
"{{kind}} overview": "{{kind}} overview",
"{{item}} details": "{{item}} details",
"Resources": "Resources",
"Show operands in:": "Show operands in:",
"All namespaces": "All namespaces",
"Current namespace only": "Current namespace only",
"The Operator Lifecycle Manager will not watch this Namespace because it is not configured with an OperatorGroup.": "The Operator Lifecycle Manager will not watch this Namespace because it is not configured with an OperatorGroup.",
"Create one here.": "Create one here.",
"Select OperatorGroup": "Select OperatorGroup",
Expand Down
32 changes: 32 additions & 0 deletions ...erator-lifecycle-manager/src/components/operand/ShowOperandsInAllNamespacesRadioGroup.tsx
View file
@@ -0,0 +1,32 @@
import * as React from 'react';
import { useTranslation } from 'react-i18next';
import { RadioGroup } from '@console/internal/components/radio';
import { useShowOperandsInAllNamespaces } from './useShowOperandsInAllNamespaces';

export const ShowOperandsInAllNamespacesRadioGroup: React.FC = () => {
const { t } = useTranslation();
const [
showOperandsInAllNamespaces,
setShowOperandsInAllNamespaces,
] = useShowOperandsInAllNamespaces();
return (
<RadioGroup
label={t('olm~Show operands in:')}
currentValue={showOperandsInAllNamespaces ? 'true' : 'false'}
inline
items={[
{
value: 'true',
title: t('olm~All namespaces'),
},
{
value: 'false',
title: t('olm~Current namespace only'),
},
]}
onChange={({ currentTarget }) =>
setShowOperandsInAllNamespaces(currentTarget.value === 'true')
}
/>
);
};
203 changes: 111 additions & 92 deletions frontend/packages/operator-lifecycle-manager/src/components/operand/index.spec.tsx
View file
Expand Up @@ -2,19 +2,27 @@ import * as React from 'react';
import { shallow, ShallowWrapper, mount, ReactWrapper } from 'enzyme';
import * as _ from 'lodash';
import { Provider } from 'react-redux';
import { Router } from 'react-router';
import { match as RouterMatch } from 'react-router-dom';
import { Table, DetailsPage, MultiListPage, ListPage } from '@console/internal/components/factory';
import { ListPageBody } from '@console/dynamic-plugin-sdk';
import { Table, DetailsPage, MultiListPage } from '@console/internal/components/factory';
import {
ListPageCreateLink,
ListPageCreateDropdown,
} from '@console/internal/components/factory/ListPage/ListPageCreate';
import ListPageFilter from '@console/internal/components/factory/ListPage/ListPageFilter';
import ListPageHeader from '@console/internal/components/factory/ListPage/ListPageHeader';
import {
history,
Timestamp,
LabelList,
StatusBox,
ResourceKebab,
FirehoseResourcesResult,
ResourceLink,
} from '@console/internal/components/utils';
import * as k8sModels from '@console/internal/module/k8s';
import store from '@console/internal/redux';
import * as extensionHooks from '@console/plugin-sdk';
import { referenceForProvidedAPI } from '..';
import {
testCRD,
testResourceInstance,
Expand Down Expand Up @@ -107,11 +115,17 @@ jest.mock('react-redux', () => ({
const i18nNS = 'public';

describe(OperandTableRow.displayName, () => {
let wrapper: ShallowWrapper<OperandTableRowProps>;
let wrapper: ReactWrapper<OperandTableRowProps>;

beforeEach(() => {
spyOn(extensionHooks, 'useExtensions').and.returnValue([]);
wrapper = shallow(<OperandTableRow obj={testResourceInstance} columns={[]} />);
wrapper = mount(<OperandTableRow obj={testResourceInstance} columns={[]} />, {
wrappingComponent: (props) => (
<Router history={history}>
<Provider store={store} {...props} />
</Router>
),
});
});

it('renders column for resource name', () => {
Expand All @@ -124,25 +138,30 @@ describe(OperandTableRow.displayName, () => {
it('renders column for resource type', () => {
const col = wrapper.childAt(1);

expect(col.shallow().text()).toEqual(testResourceInstance.kind);
expect(col.text()).toEqual(testResourceInstance.kind);
});
it('renders column for resource namespace', () => {
const col = wrapper.childAt(2);
const link = col.find(ResourceLink);

expect(link.props().name).toEqual(testResourceInstance.metadata.namespace);
});
it('renders column for resource status', () => {
const col = wrapper.childAt(2);
const col = wrapper.childAt(3);

expect(col.find(OperandStatus).props().operand).toEqual(testResourceInstance);
});

it('renders column for resource labels', () => {
const col = wrapper.childAt(3);
const col = wrapper.childAt(4);
const labelList = col.find(LabelList);

expect(labelList.props().kind).toEqual(testResourceInstance.kind);
expect(labelList.props().labels).toEqual(testResourceInstance.metadata.labels);
});

it('renders column for last updated timestamp', () => {
const col = wrapper.childAt(4);
const col = wrapper.childAt(5);
const timestamp = col.find(Timestamp);

expect(timestamp.props().timestamp).toEqual(testResourceInstance.metadata.creationTimestamp);
Expand All @@ -163,30 +182,37 @@ describe(OperandTableRow.displayName, () => {
});

describe(OperandList.displayName, () => {
let wrapper: ShallowWrapper<OperandListProps>;
let wrapper: ReactWrapper<OperandListProps>;
let resources: k8sModels.K8sResourceKind[];

beforeEach(() => {
resources = [testResourceInstance];
spyOn(extensionHooks, 'useExtensions').and.returnValue([]);
// eslint-disable-next-line react/jsx-pascal-case
wrapper = shallow(<OperandList loaded data={resources} />);
wrapper = mount(<OperandList loaded data={resources} />, {
wrappingComponent: (props) => (
<Router history={history}>
<Provider store={store} {...props} />
</Router>
),
});
});

it('renders a `Table` of the custom resource instances of the given kind', () => {
const table: ShallowWrapper<any> = wrapper.find(Table);
const table: ReactWrapper<any> = wrapper.find(Table);

expect(
Object.keys(wrapper.props()).reduce(
(k, prop) => table.prop(prop) === wrapper.prop(prop),
(k, prop) => _.isEqual(table.prop(prop), wrapper.prop(prop)),
false,
),
).toBe(true);
expect(table.props().Header().length).toEqual(6);
expect(table.props().Header().length).toEqual(7);
expect(table.props().Header()[0].title).toEqual('Name');
expect(table.props().Header()[1].title).toEqual('Kind');
expect(table.props().Header()[2].title).toEqual('Status');
expect(table.props().Header()[3].title).toEqual('Labels');
expect(table.props().Header()[4].title).toEqual('Last updated');
expect(table.props().Header()[2].title).toEqual('Namespace');
expect(table.props().Header()[3].title).toEqual('Status');
expect(table.props().Header()[4].title).toEqual('Labels');
expect(table.props().Header()[5].title).toEqual('Last updated');
expect(_.isFunction(table.props().Row)).toBe(true);
});
});
Expand Down Expand Up @@ -498,45 +524,37 @@ describe(OperandDetailsPage.displayName, () => {
});

describe(ProvidedAPIsPage.displayName, () => {
let wrapper: ShallowWrapper<ProvidedAPIsPageProps>;
let wrapper: ReactWrapper<ProvidedAPIsPageProps>;

beforeAll(() => {
// Since crd models have not been loaded into redux state, just force return of the correct model type
spyOn(k8sModels, 'modelFor').and.returnValue(testModel);
});

beforeEach(() => {
wrapper = shallow(<ProvidedAPIsPage obj={testClusterServiceVersion} />);
wrapper = mount(<ProvidedAPIsPage obj={testClusterServiceVersion} />, {
wrappingComponent: (props) => (
<Router history={history}>
<Provider store={store} {...props} />
</Router>
),
});
});

it('renders a `StatusBox` if given app has no owned or required custom resources', () => {
const obj = _.cloneDeep(testClusterServiceVersion);
obj.spec.customresourcedefinitions = {};
wrapper.setProps({ obj });

expect(wrapper.find(MultiListPage).exists()).toBe(false);
expect(wrapper.find(StatusBox).props().loaded).toBe(true);
expect(wrapper.find(StatusBox).props().EmptyMsg).toBeDefined();
it('render listpage components', () => {
expect(wrapper.find(ListPageHeader).exists()).toBe(true);
expect(wrapper.find(ListPageCreateDropdown).exists()).toBe(true);
expect(wrapper.find(ListPageBody).exists()).toBe(true);
expect(wrapper.find(ListPageFilter).exists()).toBe(true);
});

it('renders a `MultiListPage` with correct props', () => {
const { owned = [], required = [] } = testClusterServiceVersion.spec.customresourcedefinitions;
const listPage = wrapper.find(MultiListPage);

expect(listPage.props().ListComponent).toEqual(OperandList);
expect(listPage.props().filterLabel).toEqual('Resources by name');
expect(listPage.props().canCreate).toBe(true);
expect(listPage.props().resources).toEqual(
owned.concat(required).map((crdDesc) => ({
kind: referenceForProvidedAPI(crdDesc),
namespaced: true,
prop: crdDesc.kind,
})),
);
expect(listPage.props().namespace).toEqual(testClusterServiceVersion.metadata.namespace);
it('render ListPageCreateDropdown with the correct text', () => {
expect(
wrapper
.find(ListPageCreateDropdown)
.children()
.text(),
).toEqual('Create new');
});

it('passes `createProps` for dropdown create button if app has multiple owned CRDs', () => {
it('passes `items` props and render ListPageCreateDropdown create button if app has multiple owned CRDs', () => {
const obj = _.cloneDeep(testClusterServiceVersion);
obj.spec.customresourcedefinitions.owned.push({
name: 'foobars.testapp.coreos.com',
Expand All @@ -545,64 +563,65 @@ describe(ProvidedAPIsPage.displayName, () => {
kind: 'FooBar',
});
wrapper.setProps({ obj });
const listPage = wrapper.find(MultiListPage);
const listPageCreateDropdown = wrapper.find(ListPageCreateDropdown);

expect(listPage.props().createButtonText).toEqual('Create new');
expect(listPage.props().createProps.to).not.toBeDefined();
expect(listPage.props().createProps.items).toEqual({
expect(listPageCreateDropdown.props().items).toEqual({
'testresources.testapp.coreos.com': 'Test Resource',
'foobars.testapp.coreos.com': 'Foo Bars',
});
expect(
listPage.props().createProps.createLink(obj.spec.customresourcedefinitions.owned[0].name),
).toEqual(
`/k8s/ns/default/${ClusterServiceVersionModel.plural}/testapp/testapp.coreos.com~v1alpha1~TestResource/~new`,
);
});

it('passes `createProps` for single create button if app has only one owned CRD', () => {
const listPage = wrapper.find(MultiListPage);

expect(listPage.props().createButtonText).toEqual('Create Test Resource');
expect(listPage.props().createProps.items).not.toBeDefined();
expect(listPage.props().createProps.createLink).not.toBeDefined();
expect(listPage.props().createProps.to).toEqual(
`/k8s/ns/default/${ClusterServiceVersionModel.plural}/testapp/testapp.coreos.com~v1alpha1~TestResource/~new`,
);
});

it('passes `flatten` function which removes `required` resources with owner references to items not in the same list', () => {
const otherResourceInstance = _.cloneDeep(testOwnedResourceInstance);
otherResourceInstance.metadata.ownerReferences[0].uid = 'abfcd938-b991-11e7-845d-0eb774f2814a';
const resources: FirehoseResourcesResult = {
TestOwnedResource: {
data: [testOwnedResourceInstance, otherResourceInstance],
loaded: true,
loadError: undefined,
},
TestResource: {
data: [testResourceInstance],
loaded: true,
loadError: undefined,
},
};

const { flatten } = wrapper.find(MultiListPage).props();
const data = flatten(resources);

expect(data.length).toEqual(2);
it('check if ListPageBody component renders the correct children', () => {
expect(
wrapper
.find(ListPageBody)
.children()
.children().length,
).toBe(2);
});
});

describe(ProvidedAPIPage.displayName, () => {
let wrapper: ShallowWrapper<ProvidedAPIPageProps>;
let wrapper: ReactWrapper<ProvidedAPIPageProps>;

it('does not allow creation if "create" not included in the verbs for the model', () => {
wrapper = shallow(
beforeEach(() => {
wrapper = mount(
<ProvidedAPIPage kind="TestResourceRO" csv={testClusterServiceVersion} namespace="foo" />,
{
wrappingComponent: (props) => (
<Router history={history}>
<Provider store={store} {...props} />
</Router>
),
},
);
});

expect(wrapper.find(ListPage).props().canCreate).toBe(false);
it('render listpage components', () => {
expect(wrapper.find(ListPageHeader).exists()).toBe(true);
expect(wrapper.find(ListPageCreateLink).exists()).toBe(true);
expect(wrapper.find(ListPageBody).exists()).toBe(true);
expect(wrapper.find(ListPageFilter).exists()).toBe(true);
});
it('render ListPageCreateLink with the correct props for create button if app has single owned CRDs', () => {
expect(wrapper.find(ListPageCreateLink).props().to).toEqual(
`/k8s/ns/default/${ClusterServiceVersionModel.plural}/testapp/TestResourceRO/~new`,
);
});
it('render ListPageCreateLink with the correct text', () => {
expect(
wrapper
.find(ListPageCreateLink)
.children()
.text(),
).toEqual('Create Test Resource');
});
it('check if ListPageBody component renders the correct children', () => {
expect(
wrapper
.find(ListPageBody)
.children()
.children().length,
).toBe(2);
});
});

Expand Down

0 comments on commit 8e22765

Please sign in to comment.