Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[No QA][TS migration] Migrate postTestBuildComment to typescript #37027

Merged
merged 9 commits into from
Mar 14, 2024
Merged

[No QA][TS migration] Migrate postTestBuildComment to typescript #37027

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7064cfe
[TS migration] Migrate postTestBuildComment to typescript
ruben-rebelo Feb 21, 2024
0ead9f4
[TS migration][postTestBuildComment] Added last ts issue fix
ruben-rebelo Feb 21, 2024
a5ea70b
[TS migration][postTestBuildComment] Updated asMutable to the util
ruben-rebelo Feb 22, 2024
dfad426
[TS migration][postTestBuildComment] Changed file location and name
ruben-rebelo Feb 22, 2024
14f652c
Rename AsMutable.ts to asMutable.ts
ruben-rebelo Feb 28, 2024
5a33f68
[TS migration][postTestBuildComments] Feedback
ruben-rebelo Feb 28, 2024
c4a3b32
Merge branch 'ts-migration/unit-postTestBuildComment' of https://gith…
ruben-rebelo Feb 28, 2024
96dc9e0
[TS migration][postTestBuildComment] Issue fixed
ruben-rebelo Mar 8, 2024
3a9f784
Merge branch 'main' into ts-migration/unit-postTestBuildComment
ruben-rebelo Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions tests/unit/postTestBuildComment.js → tests/unit/postTestBuildComment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
import * as core from '@actions/core';
import {when} from 'jest-when';
import asMutable from '@src/types/utils/asMutable';
import ghAction from '../../.github/actions/javascript/postTestBuildComment/postTestBuildComment';
import GithubUtils from '../../.github/libs/GithubUtils';

const mockGetInput = jest.fn();
const mockCreateComment = jest.fn();
const createCommentMock = jest.spyOn(GithubUtils, 'createComment');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is changed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was changed because we couldn't assign a jest.mock into GithubUtils.createComment, this way we mock the createComment correctly and avoid TS errors.

const mockListComments = jest.fn();
const mockGraphql = jest.fn();
jest.spyOn(GithubUtils, 'octokit', 'get').mockReturnValue({
issues: {
listComments: mockListComments,
},
});
jest.spyOn(GithubUtils, 'paginate', 'get').mockReturnValue((endpoint, params) => endpoint(params).then(({data}) => data));

jest.spyOn(GithubUtils, 'paginate', 'get').mockReturnValue(<T, TData>(endpoint: (params: Record<string, T>) => Promise<{data: TData}>, params: Record<string, T>) =>
endpoint(params).then((response) => response.data),
);

jest.spyOn(GithubUtils, 'graphql', 'get').mockReturnValue(mockGraphql);

jest.mock('@actions/github', () => ({
Expand Down Expand Up @@ -52,12 +57,11 @@ const message = `:test_tube::test_tube: Use the links below to test this adhoc b
describe('Post test build comments action tests', () => {
beforeAll(() => {
// Mock core module
core.getInput = mockGetInput;
GithubUtils.createComment = mockCreateComment;
asMutable(core).getInput = mockGetInput;
});

test('Test GH action', async () => {
when(core.getInput).calledWith('PR_NUMBER', {required: true}).mockReturnValue(12);
when(core.getInput).calledWith('PR_NUMBER', {required: true}).mockReturnValue('12');
when(core.getInput).calledWith('ANDROID', {required: true}).mockReturnValue('success');
when(core.getInput).calledWith('IOS', {required: true}).mockReturnValue('success');
when(core.getInput).calledWith('WEB', {required: true}).mockReturnValue('success');
Expand All @@ -66,11 +70,12 @@ describe('Post test build comments action tests', () => {
when(core.getInput).calledWith('IOS_LINK').mockReturnValue('https://expensify.app/IOS_LINK');
when(core.getInput).calledWith('WEB_LINK').mockReturnValue('https://expensify.app/WEB_LINK');
when(core.getInput).calledWith('DESKTOP_LINK').mockReturnValue('https://expensify.app/DESKTOP_LINK');
GithubUtils.createComment.mockResolvedValue(true);
createCommentMock.mockResolvedValue(true);
mockListComments.mockResolvedValue({
data: [
{
body: ':test_tube::test_tube: Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing!',
// eslint-disable-next-line @typescript-eslint/naming-convention
node_id: 'IC_abcd',
},
],
Expand All @@ -86,7 +91,7 @@ describe('Post test build comments action tests', () => {
}
}
`);
expect(GithubUtils.createComment).toBeCalledTimes(1);
expect(GithubUtils.createComment).toBeCalledWith('App', 12, message);
expect(createCommentMock).toBeCalledTimes(1);
expect(createCommentMock).toBeCalledWith('App', '12', message);
});
});
Loading