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

test optional entity filename for search

Browse Source 
Signed-off-by: Kiss Miklos <miklos@roadie.io>
This commit is contained in:
Kiss Miklos
2022-09-27 19:21:21 +02:00
parent fe99c5d414
commit 11f8f63b07
7 changed files with 164 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/catalog-backend/api-report.md
+1
View File
@@ -78,6 +78,7 @@ export type AnalyzeLocationGenerateEntity = {
// @public (undocumented)
export type AnalyzeLocationRequest = {
location: LocationSpec;
catalogFilename?: string;
};
// @public (undocumented)
plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts
+1
View File
@@ -65,6 +65,7 @@ export class RepoLocationAnalyzer implements LocationAnalyzer {
analyzer = new GitHubLocationAnalyzer({
integration,
discovery: this.discovery,
catalogFilename: request.catalogFilename,
});
break;
case 'gitlab':
plugins/catalog-backend/src/ingestion/analyzers/GitHubLocationAnalyzer.test.ts
+26 -5
View File
@@ -94,6 +94,10 @@ describe('GitHubLocationAnalyzer', () => {
);
}),
);
octokit.repos.get.mockResolvedValue({
data: { default_branch: 'my_default_branch' },
});
});
it('should analyze', async () => {
@@ -106,10 +110,6 @@ describe('GitHubLocationAnalyzer', () => {
return Promise.reject();
});
octokit.repos.get.mockResolvedValue({
data: { default_branch: 'my_default_branch' },
});
const analyzer = new GitHubLocationAnalyzer({
discovery: mockDiscoveryApi,
integration,
@@ -123,5 +123,26 @@ describe('GitHubLocationAnalyzer', () => {
'https://github.com/foo/bar/blob/my_default_branch/catalog-info.yaml',
});
});
it('should');
it('should use the provided entity filename for search', async () => {
octokit.search.code.mockImplementation((opts: { q: string }) => {
if (opts.q === 'filename:anvil.yaml repo:foo/bar') {
return Promise.resolve({
data: { items: [{ path: 'anvil.yaml' }], total_count: 1 },
});
}
return Promise.reject();
});
const analyzer = new GitHubLocationAnalyzer({
discovery: mockDiscoveryApi,
integration,
catalogFilename: 'anvil.yaml',
});
const result = await analyzer.analyze('https://github.com/foo/bar');
expect(result[0].location).toEqual({
type: 'url',
target: 'https://github.com/foo/bar/blob/my_default_branch/anvil.yaml',
});
});
});
plugins/catalog-backend/src/ingestion/types.ts
+1
View File
@@ -34,6 +34,7 @@ export type LocationAnalyzer = {
/** @public */
export type AnalyzeLocationRequest = {
location: LocationSpec;
catalogFilename?: string;
};
/** @public */
plugins/catalog-backend/src/service/createRouter.ts
+8 -2
View File
@@ -229,9 +229,15 @@ export async function createRouter(
router.post('/analyze-location', async (req, res) => {
const body = await validateRequestBody(
req,
z.object({ location: locationInput }),
z.object({
location: locationInput,
catalogFilename: z.string().optional(),
}),
);
const schema = z.object({ location: locationInput });
const schema = z.object({
location: locationInput,
catalogFilename: z.string().optional(),
});
const output = await locationAnalyzer.analyzeLocation(schema.parse(body));
res.status(200).json(output);
});
plugins/catalog-import/src/api/CatalogImportClient.test.ts
+120 -42
View File
@@ -297,7 +297,7 @@ describe('CatalogImportClient', () => {
it('should find locations from github', async () => {
(new Octokit().search.code as any as jest.Mock).mockResolvedValueOnce({
data: {
total_count: 2,
total_count: 3,
items: [
{ path: 'simple/path/catalog-info.yaml' },
{ path: 'co/mple/x/path/catalog-info.yaml' },
@@ -305,24 +305,72 @@ describe('CatalogImportClient', () => {
],
},
});
catalogApi.addLocation.mockImplementation(async ({ type, target }) => ({
location: {
id: 'id-0',
type: type ?? 'url',
target,
},
entities: [
{
apiVersion: '1',
kind: 'k',
metadata: {
name: 'e',
namespace: 'n',
server.use(
rest.post(`${mockBaseUrl}/analyze-location`, (req, res, ctx) => {
expect(req.body).toEqual({
location: {
target: 'https://github.com/backstage/backstage',
type: 'url',
},
},
],
}));
});
return res(
ctx.json({
generateEntities: [],
existingEntityFiles: [
{
isRegistered: false,
location: {
type: 'url',
target:
'https://github.com/backstage/backstage/blob/main/simple/path/catalog-info.yaml',
},
entity: {
apiVersion: '1',
kind: 'k',
metadata: {
name: 'e',
namespace: 'n',
},
},
},
{
isRegistered: false,
location: {
type: 'url',
target:
'https://github.com/backstage/backstage/blob/main/co/mple/x/path/catalog-info.yaml',
},
entity: {
apiVersion: '1',
kind: 'k',
metadata: {
name: 'e',
namespace: 'n',
},
},
},
{
isRegistered: false,
location: {
type: 'url',
target:
'https://github.com/backstage/backstage/blob/main/catalog-info.yaml',
},
entity: {
apiVersion: '1',
kind: 'k',
metadata: {
name: 'e',
namespace: 'n',
},
},
},
],
}),
);
}),
);
await expect(
catalogImportClient.analyzeUrl(
@@ -332,16 +380,19 @@ describe('CatalogImportClient', () => {
locations: [
{
entities: [{ kind: 'k', name: 'e', namespace: 'n' }],
exists: false,
target:
'https://github.com/backstage/backstage/blob/main/simple/path/catalog-info.yaml',
},
{
entities: [{ kind: 'k', name: 'e', namespace: 'n' }],
exists: false,
target:
'https://github.com/backstage/backstage/blob/main/co/mple/x/path/catalog-info.yaml',
},
{
entities: [{ kind: 'k', name: 'e', namespace: 'n' }],
exists: false,
target:
'https://github.com/backstage/backstage/blob/main/catalog-info.yaml',
},
@@ -426,31 +477,57 @@ describe('CatalogImportClient', () => {
}),
);
catalogApi.addLocation.mockImplementation(async ({ type, target }) => ({
location: {
id: 'id-0',
type: type ?? 'url',
target,
},
entities: [
{
apiVersion: '1',
kind: 'Location',
metadata: {
name: 'my-entity',
namespace: 'my-namespace',
server.use(
rest.post(`${mockBaseUrl}/analyze-location`, (req, res, ctx) => {
expect(req.body).toEqual({
location: {
target: 'https://github.com/acme-corp/our-awesome-api',
type: 'url',
},
},
{
apiVersion: '1',
kind: 'Component',
metadata: {
name: 'my-entity',
namespace: 'my-namespace',
},
},
],
}));
catalogFilename: 'anvil.yaml',
});
return res(
ctx.json({
generateEntities: [],
existingEntityFiles: [
{
isRegistered: false,
location: {
type: 'url',
target:
'https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml',
},
entity: {
apiVersion: '1',
kind: 'Location',
metadata: {
name: 'my-entity',
namespace: 'my-namespace',
},
},
},
{
isRegistered: false,
location: {
type: 'url',
target:
'https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml',
},
entity: {
apiVersion: '1',
kind: 'Component',
metadata: {
name: 'my-entity',
namespace: 'my-namespace',
},
},
},
],
}),
);
}),
);
await expect(
catalogImportClient.analyzeUrl(repositoryUrl),
@@ -470,6 +547,7 @@ describe('CatalogImportClient', () => {
},
],
target: `${repositoryUrl}/blob/main/${entityFilename}`,
exists: false,
},
],
type: 'locations',
plugins/catalog-import/src/api/CatalogImportClient.ts
+7
View File
@@ -209,6 +209,13 @@ the component will become available.\n\nFor more information, read an \
method: 'POST',
body: JSON.stringify({
location: { type: 'url', target: options.repo },
...(this.configApi.getOptionalString(
'catalog.import.entityFilename',
) && {
catalogFilename: this.configApi.getOptionalString(
'catalog.import.entityFilename',
),
}),
}),
},
).catch(e => {