From e9fda1308308cdeaf452d922bb9b0cbc31672548 Mon Sep 17 00:00:00 2001 From: Kevin Snyder Date: Tue, 15 Apr 2025 11:03:30 -0700 Subject: [PATCH] Remove try-catch blocks from tests Signed-off-by: Kevin Snyder --- .../src/actions/github.test.ts | 12 +++++++----- .../src/actions/githubActionsDispatch.test.ts | 6 +----- .../src/actions/githubAutolinks.test.ts | 6 +----- .../src/actions/githubBranchProtection.test.ts | 6 +----- .../src/actions/githubDeployKey.test.ts | 13 ++++++++----- .../src/actions/githubEnvironment.test.ts | 6 +----- .../src/actions/githubIssuesLabel.test.ts | 6 +----- .../src/actions/githubPagesEnable.test.ts | 6 +----- .../src/actions/githubRepoCreate.test.ts | 12 +++++++----- .../src/actions/githubRepoPush.test.ts | 13 ++++++++----- .../src/actions/githubWebhook.test.ts | 6 +----- 11 files changed, 37 insertions(+), 55 deletions(-) diff --git a/plugins/scaffolder-backend-module-github/src/actions/github.test.ts b/plugins/scaffolder-backend-module-github/src/actions/github.test.ts index 97867226c6..903ec28225 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/github.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/github.test.ts @@ -140,11 +140,13 @@ describe('publish:github', () => { afterEach(jest.resetAllMocks); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + mockOctokit.rest.users.getByUsername.mockResolvedValue({ + data: { type: 'Organization' }, + }); + + mockOctokit.rest.repos.createInOrg.mockResolvedValue({ data: {} }); + + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubActionsDispatch.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubActionsDispatch.test.ts index 6924d909d9..7739259c5d 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubActionsDispatch.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubActionsDispatch.test.ts @@ -72,11 +72,7 @@ describe('github:actions:dispatch', () => { }); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubAutolinks.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubAutolinks.test.ts index 0c63376a15..c378afa17d 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubAutolinks.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubAutolinks.test.ts @@ -71,11 +71,7 @@ describe('github:autolinks:create', () => { workspacePath, }); - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubBranchProtection.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubBranchProtection.test.ts index 5f26b9d298..190743c556 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubBranchProtection.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubBranchProtection.test.ts @@ -73,11 +73,7 @@ describe('github:branch-protection:create', () => { afterEach(jest.resetAllMocks); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubDeployKey.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubDeployKey.test.ts index e1e7885a15..794ec2cf65 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubDeployKey.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubDeployKey.test.ts @@ -73,11 +73,14 @@ describe('github:deployKey:create', () => { }); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + mockOctokit.rest.actions.getRepoPublicKey.mockResolvedValue({ + data: { + key: publicKey, + key_id: 'keyid', + }, + }); + + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubEnvironment.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubEnvironment.test.ts index ebef47a06b..6a75bde69f 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubEnvironment.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubEnvironment.test.ts @@ -141,11 +141,7 @@ describe('github:environment:create', () => { afterEach(jest.resetAllMocks); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubIssuesLabel.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubIssuesLabel.test.ts index e792c7d91f..b1e1c6e87c 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubIssuesLabel.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubIssuesLabel.test.ts @@ -80,11 +80,7 @@ describe('github:issues:label', () => { }); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubPagesEnable.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubPagesEnable.test.ts index 46d9394606..23e3077861 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubPagesEnable.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubPagesEnable.test.ts @@ -73,11 +73,7 @@ describe('github:pages', () => { afterEach(jest.resetAllMocks); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubRepoCreate.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubRepoCreate.test.ts index 186d0daeea..6f901d1d84 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubRepoCreate.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubRepoCreate.test.ts @@ -111,11 +111,13 @@ describe('github:repo:create', () => { afterEach(jest.resetAllMocks); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + mockOctokit.rest.users.getByUsername.mockResolvedValue({ + data: { type: 'Organization' }, + }); + + mockOctokit.rest.repos.createInOrg.mockResolvedValue({ data: {} }); + + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubRepoPush.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubRepoPush.test.ts index e845d69954..842f63bef2 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubRepoPush.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubRepoPush.test.ts @@ -106,11 +106,14 @@ describe('github:repo:push', () => { }); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + mockOctokit.rest.repos.get.mockResolvedValue({ + data: { + clone_url: 'https://github.com/clone/url.git', + html_url: 'https://github.com/html/url', + }, + }); + + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }), diff --git a/plugins/scaffolder-backend-module-github/src/actions/githubWebhook.test.ts b/plugins/scaffolder-backend-module-github/src/actions/githubWebhook.test.ts index cc0fa28ae3..a42d251c49 100644 --- a/plugins/scaffolder-backend-module-github/src/actions/githubWebhook.test.ts +++ b/plugins/scaffolder-backend-module-github/src/actions/githubWebhook.test.ts @@ -73,11 +73,7 @@ describe('github:repository:webhook:create', () => { }); it('should pass context logger to Octokit client', async () => { - try { - await action.handler(mockContext); - } catch (e) { - // no-op - } + await action.handler(mockContext); expect(octokitMock).toHaveBeenCalledWith( expect.objectContaining({ log: mockContext.logger }),