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

tsc

Browse Source
This commit is contained in:
Erik Larsson
2021-01-22 23:44:26 +01:00
parent 05a6c4c394
commit b3e9b08fd7
11 changed files with 142 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/catalog-client/src/CatalogClient.test.ts
+16 -10
View File
@@ -72,7 +72,7 @@ describe('CatalogClient', () => {
});
it('should entities from correct endpoint', async () => {
const response = await client.getEntities(token);
const response = await client.getEntities({}, { token });
expect(response).toEqual(defaultResponse);
});
@@ -86,13 +86,16 @@ describe('CatalogClient', () => {
}),
);
const response = await client.getEntities(token, {
filter: {
a: '1',
b: ['2', '3'],
ö: '=',
const response = await client.getEntities(
{
filter: {
a: '1',
b: ['2', '3'],
ö: '=',
},
},
});
{ token },
);
expect(response.items).toEqual([]);
});
@@ -107,9 +110,12 @@ describe('CatalogClient', () => {
}),
);
const response = await client.getEntities(token, {
fields: ['a.b', 'ö'],
});
const response = await client.getEntities(
{
fields: ['a.b', 'ö'],
},
{ token },
);
expect(response.items).toEqual([]);
});
plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.ts
+4 -1
View File
@@ -48,7 +48,10 @@ export class CatalogIdentityClient {
filter[`metadata.annotations.${key}`] = value;
}
const { items } = await this.catalogClient.getEntities(token, { filter });
const { items } = await this.catalogClient.getEntities(
{ filter },
{ token },
);
if (items.length !== 1) {
if (items.length > 1) {
plugins/auth-backend/src/providers/aws-alb/provider.test.ts
+10 -14
View File
@@ -14,6 +14,7 @@
* limitations under the License.
*/
import { getVoidLogger } from '@backstage/backend-common';
import { CatalogClient } from '@backstage/catalog-client';
import express from 'express';
import { JWT } from 'jose';
@@ -43,6 +44,9 @@ jest.mock('cross-fetch', () => ({
},
}));
jest.mock('@backstage/catalog-client');
const MockedCatalogClient = CatalogClient as jest.Mock<CatalogClient>;
const identityResolutionCallbackMock = async (): Promise<AuthResponse<any>> => {
return {
backstageIdentity: {
@@ -67,15 +71,7 @@ beforeEach(() => {
});
describe('AwsALBAuthProvider', () => {
const catalogApi = {
/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
addLocation: jest.fn(),
getEntities: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
getEntityByName: jest.fn(),
};
const catalogClient = new MockedCatalogClient();
const mockResponseSend = jest.fn();
const mockRequest = ({
@@ -95,7 +91,7 @@ describe('AwsALBAuthProvider', () => {
describe('should transform to type OAuthResponse', () => {
it('when JWT is valid and identity is resolved successfully', async () => {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogApi, {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogClient, {
region: 'us-west-2',
identityResolutionCallback: identityResolutionCallbackMock,
issuer: 'foo',
@@ -121,7 +117,7 @@ describe('AwsALBAuthProvider', () => {
});
describe('should fail when', () => {
it('JWT is missing', async () => {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogApi, {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogClient, {
region: 'us-west-2',
identityResolutionCallback: identityResolutionCallbackMock,
issuer: 'foo',
@@ -133,7 +129,7 @@ describe('AwsALBAuthProvider', () => {
});
it('JWT is invalid', async () => {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogApi, {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogClient, {
region: 'us-west-2',
identityResolutionCallback: identityResolutionCallbackMock,
issuer: 'foo',
@@ -149,7 +145,7 @@ describe('AwsALBAuthProvider', () => {
});
it('issuer is invalid', async () => {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogApi, {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogClient, {
region: 'us-west-2',
identityResolutionCallback: identityResolutionCallbackMock,
issuer: 'foobar',
@@ -163,7 +159,7 @@ describe('AwsALBAuthProvider', () => {
});
it('identity resolution callback rejects', async () => {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogApi, {
const provider = new AwsAlbAuthProvider(getVoidLogger(), catalogClient, {
region: 'us-west-2',
identityResolutionCallback: identityResolutionCallbackRejectedMock,
issuer: 'foo',
plugins/auth-backend/src/providers/aws-alb/provider.ts
+5 -5
View File
@@ -25,7 +25,7 @@ import { KeyObject } from 'crypto';
import { Logger } from 'winston';
import NodeCache from 'node-cache';
import { JWT } from 'jose';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogClient } from '@backstage/catalog-client';
const ALB_JWT_HEADER = 'x-amzn-oidc-data';
/**
@@ -44,13 +44,13 @@ export const getJWTHeaders = (input: string) => {
export class AwsAlbAuthProvider implements AuthProviderRouteHandlers {
private logger: Logger;
private readonly catalogClient: CatalogApi;
private readonly catalogClient: CatalogClient;
private options: AwsAlbAuthProviderOptions;
private readonly keyCache: NodeCache;
constructor(
logger: Logger,
catalogClient: CatalogApi,
catalogClient: CatalogClient,
options: AwsAlbAuthProviderOptions,
) {
this.logger = logger;
@@ -108,14 +108,14 @@ export class AwsAlbAuthProvider implements AuthProviderRouteHandlers {
export const createAwsAlbProvider = ({
logger,
catalogApi,
catalogClient,
config,
identityResolver,
}: AuthProviderFactoryOptions) => {
const region = config.getString('region');
const issuer = config.getOptionalString('iss');
if (identityResolver !== undefined) {
return new AwsAlbAuthProvider(logger, catalogApi, {
return new AwsAlbAuthProvider(logger, catalogClient, {
region,
issuer,
identityResolutionCallback: identityResolver,
plugins/auth-backend/src/providers/types.ts
+1 -1
View File
@@ -122,7 +122,7 @@ export type ExperimentalIdentityResolver = (
* An object containing information specific to the auth provider.
*/
payload: object,
catalogApi: CatalogApi,
catalogClient: CatalogClient,
) => Promise<AuthResponse<any>>;
export type AuthProviderFactoryOptions = {
plugins/catalog-import/src/api/CatalogImportClient.test.ts
+15
View File
@@ -45,10 +45,25 @@ jest.mock('@octokit/rest', () => ({
}));
describe('CatalogImportClient', () => {
const identityApi = {
getUserId: () => {
return 'user';
},
getProfile: () => {
return {};
},
getIdToken: () => {
return Promise.resolve('token');
},
signOut: () => {
return Promise.resolve();
},
};
describe('checkForExistingCatalogInfo', () => {
const cic = new CatalogImportClient({
discoveryApi: { getBaseUrl: () => Promise.resolve('base') },
githubAuthApi: { getAccessToken: (_, __) => Promise.resolve('token') },
identityApi,
configApi: {} as any,
});
it('should return the closest-to-root catalog-info from multiple responses', async () => {
plugins/catalog-import/src/components/ImportComponentForm.test.tsx
+16
View File
@@ -35,6 +35,21 @@ describe('<RegisterComponentForm />', () => {
error$: jest.fn(),
};
const identityApi = {
getUserId: () => {
return 'user';
},
getProfile: () => {
return {};
},
getIdToken: () => {
return Promise.resolve('token');
},
signOut: () => {
return Promise.resolve();
},
};
beforeEach(() => {
apis = ApiRegistry.from([
[catalogApiRef, new CatalogClient({ discoveryApi: {} as DiscoveryApi })],
@@ -45,6 +60,7 @@ describe('<RegisterComponentForm />', () => {
githubAuthApi: {
getAccessToken: (_, __) => Promise.resolve('token'),
},
identityApi,
configApi: {} as any,
}),
],
plugins/catalog-import/src/components/ImportComponentPage.test.tsx
+16
View File
@@ -70,6 +70,21 @@ describe('<ImportComponentPage />', () => {
const server = setupServer();
msw.setupDefaultHandlers(server);
const identityApi = {
getUserId: () => {
return 'user';
},
getProfile: () => {
return {};
},
getIdToken: () => {
return Promise.resolve('token');
},
signOut: () => {
return Promise.resolve();
},
};
beforeEach(() => {
server.use(
rest.post('https://backend.localhost/locations', (_, res, ctx) => {
@@ -112,6 +127,7 @@ describe('<ImportComponentPage />', () => {
githubAuthApi: {
getAccessToken: (_, __) => Promise.resolve('token'),
},
identityApi,
configApi: {} as any,
}),
],
plugins/catalog/src/CatalogClientWrapper.ts
+6 -6
View File
@@ -36,33 +36,33 @@ export class CatalogClientWrapper implements CatalogApi {
async getLocationById(id: String): Promise<Location | undefined> {
const token = await this.identityApi.getIdToken();
return await this.client.getLocationById(token, id);
return await this.client.getLocationById(id, { token });
}
async getEntities(
request?: CatalogEntitiesRequest,
): Promise<CatalogListResponse<Entity>> {
const token = await this.identityApi.getIdToken();
return await this.client.getEntities(token, request);
return await this.client.getEntities(request, { token });
}
async getEntityByName(compoundName: EntityName): Promise<Entity | undefined> {
const token = await this.identityApi.getIdToken();
return await this.client.getEntityByName(token, compoundName);
return await this.client.getEntityByName(compoundName, { token });
}
async addLocation(request: AddLocationRequest): Promise<AddLocationResponse> {
const token = await this.identityApi.getIdToken();
return await this.client.addLocation(token, request);
return await this.client.addLocation(request, { token });
}
async getLocationByEntity(entity: Entity): Promise<Location | undefined> {
const token = await this.identityApi.getIdToken();
return await this.client.getLocationByEntity(token, entity);
return await this.client.getLocationByEntity(entity, { token });
}
async removeEntityByUid(uid: string): Promise<void> {
const token = await this.identityApi.getIdToken();
return await this.client.removeEntityByUid(token, uid);
return await this.client.removeEntityByUid(uid, { token });
}
}
plugins/scaffolder-backend/src/lib/catalog/CatalogEntityClient.ts
+8 -5
View File
@@ -37,12 +37,15 @@ export class CatalogEntityClient {
token: string | undefined,
templateName: string,
): Promise<TemplateEntityV1alpha1> {
const { items: templates } = (await this.catalogClient.getEntities(token, {
filter: {
kind: 'template',
'metadata.name': templateName,
const { items: templates } = (await this.catalogClient.getEntities(
{
filter: {
kind: 'template',
'metadata.name': templateName,
},
},
})) as { items: TemplateEntityV1alpha1[] };
{ token },
)) as { items: TemplateEntityV1alpha1[] };
if (templates.length !== 1) {
if (templates.length > 1) {
yarn.lock
+45
View File
@@ -2645,6 +2645,46 @@
remark-gfm "^1.0.0"
zen-observable "^0.8.15"
"@backstage/core@^0.4.3":
version "0.4.4"
resolved "https://registry.npmjs.org/@backstage/core/-/core-0.4.4.tgz#83d5ce5c8dd8a9803badc1dde389b5bde963e959"
integrity sha512-UEZhPBC7DAZEOCRAYQ9XcXch5JDuPn+wYNp65Ik60SSz/RFjqhq8D3P7V074cMQqWLAddVDj5dUrNeN8N1gAUQ==
dependencies:
"@backstage/config" "^0.1.2"
"@backstage/core-api" "^0.2.8"
"@backstage/theme" "^0.2.2"
"@material-ui/core" "^4.11.0"
"@material-ui/icons" "^4.9.1"
"@material-ui/lab" "4.0.0-alpha.45"
"@types/dagre" "^0.7.44"
"@types/prop-types" "^15.7.3"
"@types/react" "^16.9"
"@types/react-sparklines" "^1.7.0"
classnames "^2.2.6"
clsx "^1.1.0"
d3-selection "^2.0.0"
d3-shape "^2.0.0"
d3-zoom "^2.0.0"
dagre "^0.8.5"
immer "^7.0.9"
lodash "^4.17.15"
material-table "^1.69.1"
prop-types "^15.7.2"
qs "^6.9.4"
rc-progress "^3.0.0"
react "^16.12.0"
react-dom "^16.12.0"
react-helmet "6.1.0"
react-hook-form "^6.6.0"
react-markdown "^5.0.2"
react-router "6.0.0-beta.0"
react-router-dom "6.0.0-beta.0"
react-sparklines "^1.7.0"
react-syntax-highlighter "^13.5.1"
react-use "^15.3.3"
remark-gfm "^1.0.0"
zen-observable "^0.8.15"
"@bcoe/v8-coverage@^0.2.3":
version "0.2.3"
resolved "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
@@ -15469,6 +15509,11 @@ immer@1.10.0:
resolved "https://registry.npmjs.org/immer/-/immer-1.10.0.tgz#bad67605ba9c810275d91e1c2a47d4582e98286d"
integrity sha512-O3sR1/opvCDGLEVcvrGTMtLac8GJ5IwZC4puPrLuRj3l7ICKvkmA0vGuU9OW8mV9WIBRnaxp5GJh9IEAaNOoYg==
immer@^7.0.9:
version "7.0.15"
resolved "https://registry.npmjs.org/immer/-/immer-7.0.15.tgz#dc3bc6db87401659d2e737c67a21b227c484a4ad"
integrity sha512-yM7jo9+hvYgvdCQdqvhCNRRio0SCXc8xDPzA25SvKWa7b1WVPjLwQs1VYU5JPXjcJPTqAa5NP5dqpORGYBQ2AA==
immer@^8.0.1:
version "8.0.1"
resolved "https://registry.npmjs.org/immer/-/immer-8.0.1.tgz#9c73db683e2b3975c424fb0572af5889877ae656"