/* * Copyright 2020 The Backstage Authors * * 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 { setupServer } from 'msw/node'; import { MockFetchApi, setupRequestMockHandlers, TestApiRegistry, } from '@backstage/test-utils'; import { ComponentEntity } from '@backstage/catalog-model'; import { renderInTestApp } from '@backstage/test-utils'; import { EntityVaultTable } from './EntityVaultTable'; import { ApiProvider, UrlPatternDiscovery } from '@backstage/core-app-api'; import { VaultSecret, vaultApiRef, VaultClient, ListSecretsResponse, } from '../../api'; import { rest } from 'msw'; describe('EntityVaultTable', () => { let vaultClient: VaultClient; let apis: TestApiRegistry; let listSecretsSpy: jest.SpyInstance>; const server = setupServer(); setupRequestMockHandlers(server); const mockBaseUrl = 'https://api-vault.com/api/vault'; const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl); const fetchApi = new MockFetchApi(); const entity = (secretPath: string, secretEngine?: string | undefined) => { const annotations: Record = { 'vault.io/secrets-path': secretPath, }; if (secretEngine) { annotations['vault.io/secrets-engine'] = secretEngine; } return { apiVersion: 'backstage.io/v1alpha1', kind: 'Component', metadata: { name: 'test', description: 'This is the description', annotations, }, spec: { lifecycle: 'production', owner: 'owner', type: 'service', }, } as ComponentEntity; }; const entityOk = entity('test/success'); const entityOkWithEngine = entity('test/success', 'kv'); const entityEmpty = entity('test/path'); const entityNotOk = entity('test/error'); const mockSecretsResult: { items: VaultSecret[] } = { items: [ { name: 'secret::one', path: 'test/success', editUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/edit/test/success/secret::one`, showUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/show/test/success/secret::one`, }, { name: 'secret::two', path: 'test/success', editUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/edit/test/success/secret::two`, showUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/show/test/success/secret::two`, }, ], }; const setupHandlers = () => { server.use( rest.get(`${mockBaseUrl}/v1/secrets/:path`, (req, res, ctx) => { const { path } = req.params; if (path === 'test/success') { return res(ctx.json(mockSecretsResult)); } else if (path === 'test/empty') { return res(ctx.json({ items: [] })); } return res(ctx.status(400)); }), rest.get( `${mockBaseUrl}/v1/secrets/:path/create-url`, (req, res, ctx) => { const { path } = req.params; if (path === 'test/path') { return res( ctx.json({ createUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/create?initialKey=test/path`, }), ); } return res(ctx.status(400)); }, ), ); }; beforeEach(() => { jest.resetAllMocks(); vaultClient = new VaultClient({ discoveryApi, fetchApi }); apis = TestApiRegistry.from([vaultApiRef, vaultClient]); listSecretsSpy = jest.spyOn(vaultClient, 'listSecrets'); }); it('should render secrets', async () => { setupHandlers(); const rendered = await renderInTestApp( , ); expect(await rendered.findAllByText(/secret::one/)).toBeDefined(); expect(await rendered.findAllByText(/secret::two/)).toBeDefined(); expect(listSecretsSpy).toHaveBeenCalledTimes(1); expect(listSecretsSpy).toHaveBeenCalledWith('test/success', { secretEngine: undefined, }); }); it('should render secrets with custom engine', async () => { setupHandlers(); const rendered = await renderInTestApp( , ); expect(await rendered.findAllByText(/secret::one/)).toBeDefined(); expect(await rendered.findAllByText(/secret::two/)).toBeDefined(); expect(listSecretsSpy).toHaveBeenCalledTimes(1); expect(listSecretsSpy).toHaveBeenCalledWith('test/success', { secretEngine: 'kv', }); }); it('should render no secrets found', async () => { setupHandlers(); const rendered = await renderInTestApp( , ); expect(rendered.getByText(/No secrets/)).toBeInTheDocument(); expect(rendered.getByText(/create one/)).toBeInTheDocument(); }); it('should show create link when the Vault API responds unsuccessfully', async () => { setupHandlers(); const rendered = await renderInTestApp( , ); // When there's an error, the component catches it and shows the create link expect(rendered.getByText(/No secrets/)).toBeInTheDocument(); expect(rendered.getByText(/create one/)).toBeInTheDocument(); }); it('should render secrets from multiple secret paths', async () => { const multiPathEntity = { ...entityOk, metadata: { ...entityOk.metadata, annotations: { 'vault.io/secrets-path': 'test/success,test/extra', }, }, }; const mockExtraSecrets = { items: [ { name: 'secret::three', path: 'test/extra', editUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/edit/test/extra/secret::three`, showUrl: `${mockBaseUrl}/ui/vault/secrets/secrets/show/test/extra/secret::three`, }, ], }; server.use( rest.get(`${mockBaseUrl}/v1/secrets/:path`, (req, res, ctx) => { const { path } = req.params; if (path === 'test/success') { return res(ctx.json(mockSecretsResult)); } else if (path === 'test/extra') { return res(ctx.json(mockExtraSecrets)); } return res(ctx.status(400)); }), ); const rendered = await renderInTestApp( , ); expect(await rendered.findAllByText(/secret::one/)).toBeDefined(); expect(await rendered.findAllByText(/secret::two/)).toBeDefined(); expect(await rendered.findAllByText(/secret::three/)).toBeDefined(); expect(listSecretsSpy).toHaveBeenCalledWith('test/success', { secretEngine: undefined, }); expect(listSecretsSpy).toHaveBeenCalledWith('test/extra', { secretEngine: undefined, }); expect(listSecretsSpy).toHaveBeenCalledTimes(2); }); });