From 7c15a489aafb7b564ac5bb32927ac30c13ab70d2 Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Mon, 15 Mar 2021 10:20:15 +0100 Subject: [PATCH] Use scm integration Signed-off-by: Oliver Sand --- .changeset/angry-boats-hunt.md | 2 +- .../AnnotateScmSlugEntityProcessor.test.ts | 18 ++++++++++--- .../AnnotateScmSlugEntityProcessor.ts | 25 ++++++++++++++++++- 3 files changed, 39 insertions(+), 6 deletions(-) diff --git a/.changeset/angry-boats-hunt.md b/.changeset/angry-boats-hunt.md index 32933579ca..81f5460933 100644 --- a/.changeset/angry-boats-hunt.md +++ b/.changeset/angry-boats-hunt.md @@ -11,5 +11,5 @@ builder. To add it to your instance, add it to your `CatalogBuilder` using ```typescript const builder = new CatalogBuilder(env); -builder.addProcessor(new AnnotateScmSlugEntityProcessor()); +builder.addProcessor(AnnotateScmSlugEntityProcessor.fromConfig(env.config)); ``` diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts index d31122b6f7..f74fd9c779 100644 --- a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts +++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.test.ts @@ -14,8 +14,19 @@ * limitations under the License. */ import { Entity, LocationSpec } from '@backstage/catalog-model'; +import { ConfigReader } from '@backstage/config'; import { AnnotateScmSlugEntityProcessor } from './AnnotateScmSlugEntityProcessor'; +const config = new ConfigReader({ + /* integrations: { + github: [ + { + host: 'github.com', + }, + ], + },*/ +}); + describe('AnnotateScmSlugEntityProcessor', () => { describe('github', () => { it('adds annotation', async () => { @@ -32,7 +43,7 @@ describe('AnnotateScmSlugEntityProcessor', () => { 'https://github.com/backstage/backstage/blob/master/catalog-info.yaml', }; - const processor = new AnnotateScmSlugEntityProcessor(); + const processor = AnnotateScmSlugEntityProcessor.fromConfig(config); expect(await processor.preProcessEntity(entity, location)).toEqual({ apiVersion: 'backstage.io/v1alpha1', @@ -63,7 +74,7 @@ describe('AnnotateScmSlugEntityProcessor', () => { 'https://github.com/backstage/backstage/blob/master/catalog-info.yaml', }; - const processor = new AnnotateScmSlugEntityProcessor(); + const processor = AnnotateScmSlugEntityProcessor.fromConfig(config); expect(await processor.preProcessEntity(entity, location)).toEqual({ apiVersion: 'backstage.io/v1alpha1', @@ -91,14 +102,13 @@ describe('AnnotateScmSlugEntityProcessor', () => { 'https://gitlab.com/backstage/backstage/-/blob/master/catalog-info.yaml', }; - const processor = new AnnotateScmSlugEntityProcessor(); + const processor = AnnotateScmSlugEntityProcessor.fromConfig(config); expect(await processor.preProcessEntity(entity, location)).toEqual({ apiVersion: 'backstage.io/v1alpha1', kind: 'Component', metadata: { name: 'my-component', - annotations: {}, }, }); }); diff --git a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts index d74e9521e0..312693cc07 100644 --- a/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts +++ b/plugins/catalog-backend/src/ingestion/processors/AnnotateScmSlugEntityProcessor.ts @@ -14,6 +14,11 @@ * limitations under the License. */ import { Entity, LocationSpec } from '@backstage/catalog-model'; +import { Config } from '@backstage/config'; +import { + ScmIntegrationRegistry, + ScmIntegrations, +} from '@backstage/integration'; import parseGitUrl from 'git-url-parse'; import { identity, merge, pickBy } from 'lodash'; import { CatalogProcessor } from './types'; @@ -21,6 +26,16 @@ import { CatalogProcessor } from './types'; const GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug'; export class AnnotateScmSlugEntityProcessor implements CatalogProcessor { + constructor( + private readonly opts: { scmIntegrationRegistry: ScmIntegrationRegistry }, + ) {} + + static fromConfig(config: Config): AnnotateScmSlugEntityProcessor { + return new AnnotateScmSlugEntityProcessor({ + scmIntegrationRegistry: ScmIntegrations.fromConfig(config), + }); + } + async preProcessEntity( entity: Entity, location: LocationSpec, @@ -29,11 +44,19 @@ export class AnnotateScmSlugEntityProcessor implements CatalogProcessor { return entity; } + const scmIntegration = this.opts.scmIntegrationRegistry.byUrl( + location.target, + ); + + if (!scmIntegration || scmIntegration.type !== 'github') { + return entity; + } + const gitUrl = parseGitUrl(location.target); let githubProjectSlug = entity.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION]; - if (gitUrl.source === 'github.com' && !githubProjectSlug) { + if (!githubProjectSlug) { githubProjectSlug = `${gitUrl.owner}/${gitUrl.name}`; }