refactor: enhance GitHub API integration by adding user retrieval and updating related logic in tests

Author: virgofx

__tests__/helpers/octokit.ts

@@ -19,6 +19,7 @@ type EndpointNames = {
   issues: 'createComment' | 'deleteComment' | 'listComments';
   pulls: 'listCommits' | 'listFiles';
   repos: 'getCommit' | 'listTags' | 'listReleases' | 'createRelease' | 'deleteRelease';
+  users: 'getByUsername';
 };
 
 // Type guard that ensures the method name is valid for the given namespace K.
@@ -164,12 +165,26 @@ export function resetMockStore() {
           headers: {},
         },
       },
+      users: {
+        getByUsername: {
+          data: {
+            login: 'github-actions[bot]',
+            id: 41898282,
+            type: 'Bot',
+            site_admin: false,
+          },
+          status: 200,
+          url: 'https://api.github.com/users/github-actions[bot]',
+          headers: {},
+        },
+      },
     },
     implementations: {
       git: {},
       issues: {},
       pulls: {},
       repos: {},
+      users: {},
     },
   };
 }
@@ -302,6 +317,9 @@ export function createDefaultOctokitMock(): OctokitRestApi {
         createRelease: vi.fn().mockImplementation(() => getMockResponse('repos.createRelease')),
         deleteRelease: vi.fn().mockImplementation(() => getMockResponse('repos.deleteRelease')),
       },
+      users: {
+        getByUsername: vi.fn().mockImplementation((params) => getMockResponse('users.getByUsername', params)),
+      },
     },
     paginate: {
       iterator: <T>(

__tests__/pull-request.test.ts

@@ -5,12 +5,7 @@ import type { TerraformModule } from '@/terraform-module';
 import { stubOctokitImplementation, stubOctokitReturnData } from '@/tests/helpers/octokit';
 import { createMockTerraformModule } from '@/tests/helpers/terraform-module';
 import type { GitHubRelease } from '@/types';
-import {
-  BRANDING_COMMENT,
-  PR_RELEASE_MARKER,
-  PR_SUMMARY_MARKER,
-  WIKI_STATUS,
-} from '@/utils/constants';
+import { BRANDING_COMMENT, PR_RELEASE_MARKER, PR_SUMMARY_MARKER, WIKI_STATUS } from '@/utils/constants';
 import { debug, endGroup, info, startGroup } from '@actions/core';
 import { RequestError } from '@octokit/request-error';
 import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
@@ -54,7 +49,6 @@ describe('pull-request', () => {
       context.useMockOctokit();
     });
 
-
     it('should return true when release marker is found in comments', async () => {
       stubOctokitReturnData('issues.listComments', {
         data: [
@@ -64,7 +58,7 @@ describe('pull-request', () => {
         ],
       });
       expect(await hasReleaseComment()).toBe(true);
-    })
+    });
 
     it('should return false when no release marker is found', async () => {
       stubOctokitReturnData('issues.listComments', {

__tests__/utils/github.test.ts

@@ -1,6 +1,6 @@
 import { context } from '@/mocks/context';
 import { getGitHubActionsBotEmail } from '@/utils/github';
-import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { beforeAll, describe, expect, it } from 'vitest';
 
 describe('utils/github', () => {
   describe('getGitHubActionsBotEmail - real API queries', () => {
@@ -11,15 +11,10 @@ describe('utils/github', () => {
       await context.useRealOctokit();
     });
 
-    afterAll(() => {
-      context.useMockOctokit();
-    });
-
     it('should return the correct email format for GitHub.com public API', async () => {
       // This test uses the real GitHub API and expects the standard GitHub.com user ID
       // for the github-actions[bot] user, which is 41898282
-      
-      // Act
+
       const result = await getGitHubActionsBotEmail();
 
       // Assert

__tests__/wiki.test.ts

@@ -205,6 +205,7 @@ describe('wiki', async () => {
 
     afterAll(() => {
       vi.mocked(execFileSync).mockImplementation(vi.fn());
+      vi.resetAllMocks(); // Unclears the console.log
     });
 
     it('should generate all required wiki files', async () => {
@@ -259,11 +260,16 @@ describe('wiki', async () => {
   });
 
   describe('commitAndPushWikiChanges()', () => {
-    it('should commit and push changes when changes are detected', () => {
+    beforeAll(() => {
+      // Ensure we're using the mock octokit, not real one
+      context.useMockOctokit();
+    });
+
+    it('should commit and push changes when changes are detected', async () => {
       // Mock git status to indicate changes exist
       vi.mocked(execFileSync).mockImplementationOnce(() => Buffer.from('M  _Sidebar.md\n'));
 
-      commitAndPushWikiChanges();
+      await commitAndPushWikiChanges();
 
       // Verify git commands were called in correct order
       const gitCalls = vi.mocked(execFileSync).mock.calls.map((call) => call?.[1]?.join(' ') || '');
@@ -284,11 +290,11 @@ describe('wiki', async () => {
       expect(endGroup).toHaveBeenCalled();
     });
 
-    it('should skip commit and push when no changes are detected', () => {
+    it('should skip commit and push when no changes are detected', async () => {
       // Mock git status to indicate no changes
       vi.mocked(execFileSync).mockImplementationOnce(() => Buffer.from(''));
 
-      commitAndPushWikiChanges();
+      await commitAndPushWikiChanges();
 
       // Verify only status check was called
       const gitCalls = vi.mocked(execFileSync).mock.calls.map((call) => call?.[1]?.join(' ') || '');
@@ -301,23 +307,23 @@ describe('wiki', async () => {
       expect(endGroup).toHaveBeenCalled();
     });
 
-    it('should handle git command failures gracefully', () => {
+    it('should handle git command failures gracefully', async () => {
       // Mock git status to indicate changes exist but make add command fail
       vi.mocked(execFileSync)
         .mockImplementationOnce(() => Buffer.from('M  _Sidebar.md\n'))
         .mockImplementationOnce(() => {
           throw new Error('Git command failed');
         });
 
-      expect(() => commitAndPushWikiChanges()).toThrow('Git command failed');
+      await expect(commitAndPushWikiChanges()).rejects.toThrow('Git command failed');
 
       expect(startGroup).toHaveBeenCalledWith('Committing and pushing changes to wiki');
       expect(info).toHaveBeenCalledWith('Checking for changes in wiki repository');
       expect(info).toHaveBeenCalledWith('git status output: M  _Sidebar.md');
       expect(endGroup).toHaveBeenCalled();
     });
 
-    it('should not use complete PR information in commit message', () => {
+    it('should not use complete PR information in commit message', async () => {
       // Set up PR context with multiline body
       context.set({
         prBody: 'Line 1\nLine 2\nLine 3',
@@ -328,7 +334,7 @@ describe('wiki', async () => {
       // Mock git status to indicate changes exist
       vi.mocked(execFileSync).mockImplementationOnce(() => Buffer.from('M  _Sidebar.md\n'));
 
-      commitAndPushWikiChanges();
+      await commitAndPushWikiChanges();
 
       // Verify commit message format
       const commitCall = vi.mocked(execFileSync).mock.calls.find((call) => call?.[1]?.includes('commit'));

src/pull-request.ts

@@ -3,13 +3,7 @@ import { config } from '@/config';
 import { context } from '@/context';
 import { TerraformModule } from '@/terraform-module';
 import type { CommitDetails, GitHubRelease, WikiStatusResult } from '@/types';
-import {
-  BRANDING_COMMENT,
-  PROJECT_URL,
-  PR_RELEASE_MARKER,
-  PR_SUMMARY_MARKER,
-  WIKI_STATUS,
-} from '@/utils/constants';
+import { BRANDING_COMMENT, PROJECT_URL, PR_RELEASE_MARKER, PR_SUMMARY_MARKER, WIKI_STATUS } from '@/utils/constants';
 
 import { getWikiLink } from '@/wiki';
 import { debug, endGroup, info, startGroup } from '@actions/core';

src/utils/github.ts

@@ -4,16 +4,16 @@ import { GITHUB_ACTIONS_BOT_USERNAME } from '@/utils/constants';
 /**
  * Retrieves the GitHub Actions bot email address dynamically by querying the GitHub API.
  * This function handles both GitHub.com and GitHub Enterprise Server environments.
- * 
+ *
  * The email format follows GitHub's standard: {user_id}+{username}@users.noreply.github.com
- * 
+ *
  * @returns {Promise<string>} The GitHub Actions bot email address
  * @throws {Error} If the API request fails or the user information cannot be retrieved
  */
 export async function getGitHubActionsBotEmail(): Promise<string> {
-    const response = await context.octokit.rest.users.getByUsername({
-      username: GITHUB_ACTIONS_BOT_USERNAME,
-    });
-    
-    return `${response.data.id}+${GITHUB_ACTIONS_BOT_USERNAME}@users.noreply.github.com`;
+  const response = await context.octokit.rest.users.getByUsername({
+    username: GITHUB_ACTIONS_BOT_USERNAME,
+  });
+
+  return `${response.data.id}+${GITHUB_ACTIONS_BOT_USERNAME}@users.noreply.github.com`;
 }

src/wiki.ts

@@ -583,11 +583,11 @@ export async function commitAndPushWikiChanges(): Promise<void> {
 
     if (status !== null && status.toString().trim() !== '') {
       // There are changes, commit and push
-      const botEmail = await getGitHubActionsBotEmail();
-      
+      const githubActionsBotEmail = await getGitHubActionsBotEmail();
+
       for (const cmd of [
         ['config', '--local', 'user.name', GITHUB_ACTIONS_BOT_NAME],
-        ['config', '--local', 'user.email', botEmail],
+        ['config', '--local', 'user.email', githubActionsBotEmail],
         ['add', '.'],
         ['commit', '-m', commitMessage.trim()],
         ['push', 'origin'],