From 98d06e02aafe88d66407ce3bacc894260097b573 Mon Sep 17 00:00:00 2001 From: Phred Date: Tue, 4 Apr 2023 09:16:18 -0500 Subject: [PATCH] renamed utility to entityRefToName based on code review Signed-off-by: Phred --- .../actions/builtin/github/githubRepoCreate.test.ts | 4 ++-- .../src/scaffolder/actions/builtin/github/helpers.ts | 6 +++--- .../src/scaffolder/actions/builtin/helpers.test.ts | 10 +++------- .../src/scaffolder/actions/builtin/helpers.ts | 2 +- .../scaffolder/actions/builtin/publish/github.test.ts | 10 +++++----- 5 files changed, 14 insertions(+), 18 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubRepoCreate.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubRepoCreate.test.ts index 58747d57ef..4f23839fca 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubRepoCreate.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubRepoCreate.test.ts @@ -28,7 +28,7 @@ import { import { when } from 'jest-when'; import { PassThrough } from 'stream'; import { createGithubRepoCreateAction } from './githubRepoCreate'; -import { familiarizeEntityName } from '../helpers'; +import { entityRefToName } from '../helpers'; const mockOctokit = { rest: { @@ -90,7 +90,7 @@ describe('github:repo:create', () => { integrations, githubCredentialsProvider, }); - (familiarizeEntityName as jest.Mock).mockImplementation((s: string) => s); + (entityRefToName as jest.Mock).mockImplementation((s: string) => s); }); afterEach(jest.resetAllMocks); diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts index 23f6b804b7..57be72bc73 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts @@ -29,7 +29,7 @@ import { initRepoAndPush, } from '../helpers'; import { getRepoSourceDirectory, parseRepoUrl } from '../publish/util'; -import { familiarizeEntityName } from '../../builtin/helpers'; +import { entityRefToName } from '../../builtin/helpers'; const DEFAULT_TIMEOUT_MS = 60_000; @@ -219,13 +219,13 @@ export async function createGithubRepoWithCollaboratorsAndTopics( await client.rest.repos.addCollaborator({ owner, repo, - username: familiarizeEntityName(collaborator.user), + username: entityRefToName(collaborator.user), permission: collaborator.access, }); } else if ('team' in collaborator) { await client.rest.teams.addOrUpdateRepoPermissionsInOrg({ org: owner, - team_slug: familiarizeEntityName(collaborator.team), + team_slug: entityRefToName(collaborator.team), owner, repo, permission: collaborator.access, diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.test.ts index 8cde257d64..239f7c7351 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.test.ts @@ -15,11 +15,7 @@ */ import { Git, getVoidLogger } from '@backstage/backend-common'; -import { - commitAndPushRepo, - familiarizeEntityName, - initRepoAndPush, -} from './helpers'; +import { commitAndPushRepo, entityRefToName, initRepoAndPush } from './helpers'; jest.mock('@backstage/backend-common', () => ({ Git: { @@ -306,7 +302,7 @@ describe('commitAndPushRepo', () => { }); }); -describe('familiarizeEntityName', () => { +describe('entityRefToName', () => { it.each([ 'user:default/catpants', 'group:default/catpants', @@ -316,6 +312,6 @@ describe('familiarizeEntityName', () => { 'group:custom/catpants', 'catpants', ])('should parse: "%s"', (entityName: string) => { - expect(familiarizeEntityName(entityName)).toEqual('catpants'); + expect(entityRefToName(entityName)).toEqual('catpants'); }); }); diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.ts index 30b75d9e6f..c1630d0bf7 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/helpers.ts @@ -297,6 +297,6 @@ export function getGitCommitMessage( : config.getOptionalString('scaffolder.defaultCommitMessage'); } -export function familiarizeEntityName(name: string): string { +export function entityRefToName(name: string): string { return name.replace(/^.*[:/]/g, ''); } diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.test.ts index 3347ca2e05..8c6b02c1c3 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.test.ts @@ -29,7 +29,7 @@ import { when } from 'jest-when'; import { PassThrough } from 'stream'; import { enableBranchProtectionOnDefaultRepoBranch, - familiarizeEntityName, + entityRefToName, initRepoAndPush, } from '../helpers'; import { createPublishGithubAction } from './github'; @@ -69,7 +69,7 @@ describe('publish:github', () => { }, }); - const { familiarizeEntityName: realFamiliarizeEntityName } = + const { entityRefToName: realFamiliarizeEntityName } = jest.requireActual('../helpers'); const integrations = ScmIntegrations.fromConfig(config); let githubCredentialsProvider: GithubCredentialsProvider; @@ -99,7 +99,7 @@ describe('publish:github', () => { }); // restore real implmentation - (familiarizeEntityName as jest.Mock).mockImplementation( + (entityRefToName as jest.Mock).mockImplementation( realFamiliarizeEntityName, ); }); @@ -709,8 +709,8 @@ describe('publish:github', () => { permission: 'push', }); - expect(familiarizeEntityName).toHaveBeenCalledWith('user:robot-1'); - expect(familiarizeEntityName).toHaveBeenCalledWith('group:default/robot-2'); + expect(entityRefToName).toHaveBeenCalledWith('user:robot-1'); + expect(entityRefToName).toHaveBeenCalledWith('group:default/robot-2'); }); it('should ignore failures when adding multiple collaborators', async () => {