paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 23 Packages Projects Releases Wiki Activity

add kubernetes custom hook tests

Browse Source 
Signed-off-by: mclarke <mclarke@spotify.com>
This commit is contained in:
mclarke
2021-03-11 14:44:10 +00:00
parent 9804a5273e
commit b16a480275
6 changed files with 291 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/kubernetes/configuration.md
+1 -1
View File
@@ -128,7 +128,7 @@ regions.
Configures which [custom resources][3] to look for when returning an entity's
Kubernetes resources.
Defaults to empty array. router.ts Example:
Defaults to empty array. Example:
```yaml
---
plugins/kubernetes/package.json
+1
View File
@@ -55,6 +55,7 @@
"@backstage/test-utils": "^0.1.8",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/react-hooks": "^5.1.0",
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^14.14.32",
plugins/kubernetes/src/components/Pods/PodsTable.tsx
Generated
+1 -1
View File
@@ -57,7 +57,7 @@ type DeploymentTablesProps = {
};
export const PodsTable = ({ pods }: DeploymentTablesProps) => {
const tableStyle: React.CSSProperties = {
const tableStyle = {
minWidth: '0',
width: '100%',
};
plugins/kubernetes/src/hooks/useKubernetesObjects.test.ts
+182
View File
@@ -0,0 +1,182 @@
/*
* Copyright 2021 Spotify AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { useKubernetesObjects } from './useKubernetesObjects';
import { Entity } from '@backstage/catalog-model';
import { useApi } from '@backstage/core';
import { renderHook } from '@testing-library/react-hooks';
jest.mock('@backstage/core');
const entity = {
metadata: {
name: 'some-entity',
},
} as Entity;
const entityWithAuthToken = {
auth: {
google: 'some-token',
},
entity,
};
const mockResponse = {
items: [
{
cluster: { name: 'some-cluster' },
resources: [
{
type: 'pods',
resources: [
{
metadata: {
name: 'some-pod',
},
},
],
},
],
errors: [],
},
],
};
const getClustersResponse = [
{
name: 'cluster-a',
authProvider: 'google',
},
{
name: 'cluster-b',
authProvider: 'authprovider2',
},
];
describe('useKubernetesObjects', () => {
const mockGetClusters = jest.fn();
const mockGetObjectsByEntity = jest.fn();
const mockDecorateRequestBodyForAuth = jest.fn();
const expectMocksCalledCorrectly = () => {
expect(mockGetClusters).toBeCalledTimes(1);
expect(mockGetClusters).toHaveBeenLastCalledWith();
expect(mockDecorateRequestBodyForAuth).toBeCalledTimes(2);
expect(mockDecorateRequestBodyForAuth).toHaveBeenCalledWith('google', {
entity,
});
expect(mockDecorateRequestBodyForAuth).toHaveBeenCalledWith(
'authprovider2',
entityWithAuthToken,
);
expect(mockGetObjectsByEntity).toBeCalledTimes(1);
expect(mockGetObjectsByEntity).toHaveBeenLastCalledWith(
entityWithAuthToken,
);
};
afterEach(() => {
jest.resetAllMocks();
});
it('should return objects', async () => {
(useApi as any).mockReturnValue({
getClusters: mockGetClusters.mockResolvedValue(getClustersResponse),
getObjectsByEntity: mockGetObjectsByEntity.mockResolvedValue(
mockResponse,
),
decorateRequestBodyForAuth: mockDecorateRequestBodyForAuth.mockResolvedValue(
entityWithAuthToken,
),
});
const { result, waitForNextUpdate } = renderHook(() =>
useKubernetesObjects(entity),
);
await waitForNextUpdate();
expect(result.current.error).toBeUndefined();
expect(result.current.kubernetesObjects).toStrictEqual(mockResponse);
expectMocksCalledCorrectly();
});
it('should return error when getObjectsByEntity throws', async () => {
(useApi as any).mockReturnValue({
getClusters: mockGetClusters.mockResolvedValue(getClustersResponse),
getObjectsByEntity: mockGetObjectsByEntity.mockRejectedValue({
message: 'some error',
}),
decorateRequestBodyForAuth: mockDecorateRequestBodyForAuth.mockResolvedValue(
entityWithAuthToken,
),
});
const { result, waitForNextUpdate } = renderHook(() =>
useKubernetesObjects(entity),
);
await waitForNextUpdate();
expect(result.current.error).toBe('some error');
expect(result.current.kubernetesObjects).toBeUndefined();
expectMocksCalledCorrectly();
});
it('should return error when getClusters throws', async () => {
(useApi as any).mockReturnValue({
getClusters: mockGetClusters.mockRejectedValue({ message: 'some-error' }),
getObjectsByEntity: mockGetObjectsByEntity,
decorateRequestBodyForAuth: mockDecorateRequestBodyForAuth,
});
const { result, waitForNextUpdate } = renderHook(() =>
useKubernetesObjects(entity),
);
await waitForNextUpdate();
expect(result.current.error).toBe('some-error');
expect(result.current.kubernetesObjects).toBeUndefined();
expect(mockGetClusters).toBeCalledTimes(1);
expect(mockGetClusters).toHaveBeenLastCalledWith();
expect(mockDecorateRequestBodyForAuth).toBeCalledTimes(0);
expect(mockGetObjectsByEntity).toBeCalledTimes(0);
});
it('should return error when decorateRequestBodyForAuth throws', async () => {
(useApi as any).mockReturnValue({
getClusters: mockGetClusters.mockResolvedValue(getClustersResponse),
decorateRequestBodyForAuth: mockDecorateRequestBodyForAuth.mockRejectedValue(
{ message: 'some-error' },
),
getObjectsByEntity: mockGetObjectsByEntity,
});
const { result, waitForNextUpdate } = renderHook(() =>
useKubernetesObjects(entity),
);
await waitForNextUpdate();
expect(result.current.error).toBe('some-error');
expect(result.current.kubernetesObjects).toBeUndefined();
expect(mockGetClusters).toBeCalledTimes(1);
expect(mockGetClusters).toHaveBeenLastCalledWith();
expect(mockDecorateRequestBodyForAuth).toBeCalledTimes(1);
expect(mockDecorateRequestBodyForAuth).toHaveBeenCalledWith('google', {
entity,
});
expect(mockGetObjectsByEntity).toBeCalledTimes(0);
});
});
plugins/kubernetes/src/hooks/useKubernetesObjects.ts
+26 -14
View File
@@ -40,7 +40,15 @@ export const useKubernetesObjects = (entity: Entity): KubernetesObjects => {
useEffect(() => {
(async () => {
const clusters = await kubernetesApi.getClusters();
let clusters = [];
try {
clusters = await kubernetesApi.getClusters();
} catch (e) {
setError(e.message);
return;
}
const authProviders: string[] = [
...new Set(clusters.map(c => c.authProvider)),
];
@@ -50,21 +58,25 @@ export const useKubernetesObjects = (entity: Entity): KubernetesObjects => {
};
for (const authProviderStr of authProviders) {
// Multiple asyncs done sequentially instead of all at once to prevent same requestBody from being modified simultaneously
requestBody = await kubernetesAuthProvidersApi.decorateRequestBodyForAuth(
authProviderStr,
requestBody,
);
try {
requestBody = await kubernetesAuthProvidersApi.decorateRequestBodyForAuth(
authProviderStr,
requestBody,
);
} catch (e) {
setError(e.message);
return;
}
}
// TODO: Add validation on contents/format of requestBody
kubernetesApi
.getObjectsByEntity(requestBody)
.then(result => {
setKubernetesObjects(result);
})
.catch(e => {
setError(e.message);
});
try {
setKubernetesObjects(
await kubernetesApi.getObjectsByEntity(requestBody),
);
} catch (e) {
setError(e.message);
return;
}
})();
/* eslint-disable react-hooks/exhaustive-deps */
}, [entity.metadata.name, kubernetesApi, kubernetesAuthProvidersApi]);
yarn.lock
+80 -23
View File
@@ -1744,7 +1744,7 @@
to-fast-properties "^2.0.0"
"@backstage/catalog-model@^0.2.0":
version "0.7.3"
version "0.7.4"
dependencies:
"@backstage/config" "^0.1.3"
"@types/json-schema" "^7.0.5"
@@ -1756,7 +1756,7 @@
yup "^0.29.3"
"@backstage/catalog-model@^0.3.0":
version "0.7.3"
version "0.7.4"
dependencies:
"@backstage/config" "^0.1.3"
"@types/json-schema" "^7.0.5"
@@ -1768,11 +1768,11 @@
yup "^0.29.3"
"@backstage/core@^0.3.0":
version "0.7.0"
version "0.7.1"
dependencies:
"@backstage/config" "^0.1.3"
"@backstage/core-api" "^0.2.12"
"@backstage/theme" "^0.2.3"
"@backstage/core-api" "^0.2.13"
"@backstage/theme" "^0.2.4"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
@@ -1809,11 +1809,11 @@
zen-observable "^0.8.15"
"@backstage/core@^0.6.0":
version "0.7.0"
version "0.7.1"
dependencies:
"@backstage/config" "^0.1.3"
"@backstage/core-api" "^0.2.12"
"@backstage/theme" "^0.2.3"
"@backstage/core-api" "^0.2.13"
"@backstage/theme" "^0.2.4"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
@@ -1850,11 +1850,11 @@
zen-observable "^0.8.15"
"@backstage/core@^0.6.1":
version "0.7.0"
version "0.7.1"
dependencies:
"@backstage/config" "^0.1.3"
"@backstage/core-api" "^0.2.12"
"@backstage/theme" "^0.2.3"
"@backstage/core-api" "^0.2.13"
"@backstage/theme" "^0.2.4"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
@@ -1891,14 +1891,14 @@
zen-observable "^0.8.15"
"@backstage/plugin-catalog@^0.2.1":
version "0.4.1"
version "0.4.2"
dependencies:
"@backstage/catalog-client" "^0.3.6"
"@backstage/catalog-model" "^0.7.3"
"@backstage/core" "^0.7.0"
"@backstage/integration" "^0.5.0"
"@backstage/catalog-client" "^0.3.7"
"@backstage/catalog-model" "^0.7.4"
"@backstage/core" "^0.7.1"
"@backstage/integration" "^0.5.1"
"@backstage/plugin-catalog-react" "^0.1.1"
"@backstage/theme" "^0.2.3"
"@backstage/theme" "^0.2.4"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
@@ -1914,14 +1914,14 @@
swr "^0.3.0"
"@backstage/plugin-catalog@^0.3.1":
version "0.4.1"
version "0.4.2"
dependencies:
"@backstage/catalog-client" "^0.3.6"
"@backstage/catalog-model" "^0.7.3"
"@backstage/core" "^0.7.0"
"@backstage/integration" "^0.5.0"
"@backstage/catalog-client" "^0.3.7"
"@backstage/catalog-model" "^0.7.4"
"@backstage/core" "^0.7.1"
"@backstage/integration" "^0.5.1"
"@backstage/plugin-catalog-react" "^0.1.1"
"@backstage/theme" "^0.2.3"
"@backstage/theme" "^0.2.4"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
@@ -5713,6 +5713,18 @@
"@babel/runtime" "^7.5.4"
"@types/testing-library__react-hooks" "^3.4.0"
"@testing-library/react-hooks@^5.1.0":
version "5.1.0"
resolved "https://registry.npmjs.org/@testing-library/react-hooks/-/react-hooks-5.1.0.tgz#6014b7536d0e9427a1e73ce1d073c49a6af5fb3b"
integrity sha512-ChRyyA14e0CeVkWGp24v8q/IiWUqH+B8daRx4lGZme4dsudmMNWz+Qo2Q2NzbD2O5rAVXh2hSbS/KTKeqHYhkw==
dependencies:
"@babel/runtime" "^7.12.5"
"@types/react" ">=16.9.0"
"@types/react-dom" ">=16.9.0"
"@types/react-test-renderer" ">=16.9.0"
filter-console "^0.1.1"
react-error-boundary "^3.1.0"
"@testing-library/react@^11.2.5":
version "11.2.5"
resolved "https://registry.npmjs.org/@testing-library/react/-/react-11.2.5.tgz#ae1c36a66c7790ddb6662c416c27863d87818eb9"
@@ -6665,6 +6677,13 @@
"@types/webpack" "*"
"@types/webpack-dev-server" "*"
"@types/react-dom@>=16.9.0":
version "17.0.2"
resolved "https://registry.npmjs.org/@types/react-dom/-/react-dom-17.0.2.tgz#35654cf6c49ae162d5bc90843d5437dc38008d43"
integrity sha512-Icd9KEgdnFfJs39KyRyr0jQ7EKhq8U6CcHRMGAS45fp5qgUvxL3ujUCfWFttUK2UErqZNj97t9gsVPNAqcwoCg==
dependencies:
"@types/react" "*"
"@types/react-dom@^16.9.8":
version "16.9.8"
resolved "https://registry.npmjs.org/@types/react-dom/-/react-dom-16.9.8.tgz#fe4c1e11dfc67155733dfa6aa65108b4971cb423"
@@ -6708,6 +6727,13 @@
dependencies:
"@types/react" "*"
"@types/react-test-renderer@>=16.9.0":
version "17.0.1"
resolved "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-17.0.1.tgz#3120f7d1c157fba9df0118dae20cb0297ee0e06b"
integrity sha512-3Fi2O6Zzq/f3QR9dRnlnHso9bMl7weKCviFmfF6B4LS1Uat6Hkm15k0ZAQuDz+UBq6B3+g+NM6IT2nr5QgPzCw==
dependencies:
"@types/react" "*"
"@types/react-text-truncate@^0.14.0":
version "0.14.0"
resolved "https://registry.npmjs.org/@types/react-text-truncate/-/react-text-truncate-0.14.0.tgz#588bbabbc7f2a13815e805f3a48942db73fe65fe"
@@ -6744,6 +6770,15 @@
dependencies:
csstype "^2.2.0"
"@types/react@>=16.9.0":
version "17.0.3"
resolved "https://registry.npmjs.org/@types/react/-/react-17.0.3.tgz#ba6e215368501ac3826951eef2904574c262cc79"
integrity sha512-wYOUxIgs2HZZ0ACNiIayItyluADNbONl7kt8lkLjVK8IitMH5QMyAh75Fwhmo37r1m7L2JaFj03sIfxBVDvRAg==
dependencies:
"@types/prop-types" "*"
"@types/scheduler" "*"
csstype "^3.0.2"
"@types/reactcss@*":
version "1.2.3"
resolved "https://registry.npmjs.org/@types/reactcss/-/reactcss-1.2.3.tgz#af28ae11bbb277978b99d04d1eedfd068ca71834"
@@ -6825,6 +6860,11 @@
"@types/node" "*"
rollup "^0.63.4"
"@types/scheduler@*":
version "0.16.1"
resolved "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.1.tgz#18845205e86ff0038517aab7a18a62a6b9f71275"
integrity sha512-EaCxbanVeyxDRTQBkdLb3Bvl/HK7PBK6UJjsSixB0iHKoWxE5uu2Q/DgtpOhPIojN0Zl1whvOd7PoHs2P0s5eA==
"@types/semver@^6.0.0":
version "6.2.1"
resolved "https://registry.npmjs.org/@types/semver/-/semver-6.2.1.tgz#a236185670a7860f1597cf73bea2e16d001461ba"
@@ -10966,6 +11006,11 @@ csstype@^2.2.0, csstype@^2.5.2, csstype@^2.5.5, csstype@^2.5.7, csstype@^2.6.5,
resolved "https://registry.npmjs.org/csstype/-/csstype-2.6.9.tgz#05141d0cd557a56b8891394c1911c40c8a98d098"
integrity sha512-xz39Sb4+OaTsULgUERcCk+TJj8ylkL4aSVDQiX/ksxbELSqwkgt4d4RD7fovIdgJGSuNYqwZEiVjYY5l0ask+Q==
csstype@^3.0.2:
version "3.0.7"
resolved "https://registry.npmjs.org/csstype/-/csstype-3.0.7.tgz#2a5fb75e1015e84dd15692f71e89a1450290950b"
integrity sha512-KxnUB0ZMlnUWCsx2Z8MUsr6qV6ja1w9ArPErJaJaF8a5SOWoHLIszeCTKGRGRgtLgYrs1E8CHkNSP1VZTTPc9g==
csv-generate@^3.2.4:
version "3.2.4"
resolved "https://registry.npmjs.org/csv-generate/-/csv-generate-3.2.4.tgz#440dab9177339ee0676c9e5c16f50e2b3463c019"
@@ -13343,6 +13388,11 @@ fill-range@^7.0.1:
dependencies:
to-regex-range "^5.0.1"
filter-console@^0.1.1:
version "0.1.1"
resolved "https://registry.npmjs.org/filter-console/-/filter-console-0.1.1.tgz#6242be28982bba7415bcc6db74a79f4a294fa67c"
integrity sha512-zrXoV1Uaz52DqPs+qEwNJWJFAWZpYJ47UNmpN9q4j+/EYsz85uV0DC9k8tRND5kYmoVzL0W+Y75q4Rg8sRJCdg==
finalhandler@~1.1.2:
version "1.1.2"
resolved "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.2.tgz#b7e7d000ffd11938d0fdb053506f6ebabe9f587d"
@@ -21861,6 +21911,13 @@ react-draggable@^4.0.3:
classnames "^2.2.5"
prop-types "^15.6.0"
react-error-boundary@^3.1.0:
version "3.1.1"
resolved "https://registry.npmjs.org/react-error-boundary/-/react-error-boundary-3.1.1.tgz#932c5ca5cbab8ec4fe37fd7b415aa5c3a47597e7"
integrity sha512-W3xCd9zXnanqrTUeViceufD3mIW8Ut29BUD+S2f0eO2XCOU8b6UrJfY46RDGe5lxCJzfe4j0yvIfh0RbTZhKJw==
dependencies:
"@babel/runtime" "^7.12.5"
react-error-overlay@^6.0.7, react-error-overlay@^6.0.9:
version "6.0.9"
resolved "https://registry.npmjs.org/react-error-overlay/-/react-error-overlay-6.0.9.tgz#3c743010c9359608c375ecd6bc76f35d93995b0a"