Skip to content

test: new 'PullRequestPayloadBuilder' #185

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

Merged
merged 2 commits into from
May 3, 2020
Merged

test: new 'PullRequestPayloadBuilder' #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
864a9e3
test: new 'PullRequestPayloadBuilder'
SantiMA10 May 3, 2020
a314694
test: fix pull request payload types
SantiMA10 May 3, 2020
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
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
"tmi.js": "^1.5.0"
},
"devDependencies": {
"lodash": "^4.17.15",
"@types/faker": "^4.1.11",
"@types/hapi__hapi": "^19.0.2",
"@types/hapi__joi": "^16.0.12",
Expand All @@ -36,10 +35,12 @@
"husky": "^4.2.5",
"jest": "^25.2.7",
"lint-staged": ">=10",
"lodash": "^4.17.15",
"nock": "^12.0.3",
"nodemon": "^2.0.3",
"prettier": "^2.0.4",
"ts-jest": "^25.4.0",
"typescript": "^3.8.3"
"typescript": "^3.8.3",
"utility-types": "^3.10.0"
}
}
17 changes: 15 additions & 2 deletions src/schemas/github/pull-request-payload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
import { RepositoryWebhookPayload } from './repository-webhook-payload';

export interface PullRequestPayload extends RepositoryWebhookPayload {
action: string;
pull_request: { user: { login: string }; merged?: boolean };
action:
| 'assigned'
| 'unassigned'
| 'review_requested'
| 'review_request_removed'
| 'labeled'
| 'unlabeled'
| 'opened'
| 'edited'
| 'closed'
| 'ready_for_review'
| 'locked'
| 'unlocked'
| 'reopened';
pull_request: { user: { login: string }; merged?: boolean; html_url: string };
}
37 changes: 37 additions & 0 deletions test/builders/github/pull-request-payload-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { internet, random } from 'faker';
import { merge } from 'lodash';
import { PullRequestPayload } from '../../../src/schemas/github/pull-request-payload';
import { DeepPartial } from 'utility-types';

export class PullRequestPayloadBuilder {
private payload: PullRequestPayload = {
action: random.arrayElement([
'assigned',
'unassigned',
'review_requested',
'review_request_removed',
'labeled',
'unlabeled',
'opened',
'edited',
'closed',
'ready_for_review',
'locked',
'unlocked',
'reopened',
]),
pull_request: { user: { login: internet.userName() }, html_url: internet.url() },
repository: { html_url: internet.url(), full_name: 'streamdevs/webhook' },
sender: { login: internet.userName() },
};

public with(payload: DeepPartial<PullRequestPayload>): PullRequestPayloadBuilder {
merge(this.payload, payload);

return this;
}

public getInstance(): PullRequestPayload {
return this.payload;
}
}
21 changes: 12 additions & 9 deletions test/reactions/github/pull-request-merged.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { PullRequestMerged } from '../../../src/reactions/github/pull-request-me
import { PullRequestPayload } from '../../../src/schemas/github/pull-request-payload';
import { TwitchChatMock } from '../../__mocks__/TwitchChat';
import { StreamLabsMock } from '../../__mocks__/StreamLabs';
import { PullRequestPayloadBuilder } from '../../builders/github/pull-request-payload-builder';

describe('PullRequestMerged', () => {
let streamlabs: StreamLabsMock;
Expand All @@ -16,15 +17,17 @@ describe('PullRequestMerged', () => {
let payload: PullRequestPayload;

beforeEach(() => {
payload = {
action: 'closed',
repository: {
full_name: 'streamdevs/webhook',
html_url: 'https://github.com/streamdevs/webhook',
},
pull_request: { user: { login: 'SantiMA10' }, merged: true },
sender: { login: 'pepe' },
};
payload = new PullRequestPayloadBuilder()
.with({
action: 'closed',
repository: {
full_name: 'streamdevs/webhook',
html_url: 'https://github.com/streamdevs/webhook',
},
pull_request: { user: { login: 'SantiMA10' }, merged: true },
sender: { login: 'pepe' },
})
.getInstance();
});

it("returns 'twitchChat.notified' === false if something goes wrong with TwitchChat", async () => {
Expand Down
21 changes: 12 additions & 9 deletions test/reactions/github/pull-request-opened.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { PullRequestPayload } from '../../../src/schemas/github/pull-request-pay
import { StreamLabsMock } from '../../__mocks__/StreamLabs';
import { TwitchChatMock } from '../../__mocks__/TwitchChat';
import { Config } from '../../../src/config';
import { PullRequestPayloadBuilder } from '../../builders/github/pull-request-payload-builder';

describe('PullRequestOpened', () => {
let streamlabs: StreamLabsMock;
Expand All @@ -17,15 +18,17 @@ describe('PullRequestOpened', () => {
let payload: PullRequestPayload;

beforeEach(() => {
payload = {
action: 'opened',
repository: {
full_name: 'streamdevs/webhook',
html_url: 'https://github.com/streamdevs/webhook',
},
pull_request: { user: { login: 'SantiMA10' } },
sender: { login: 'pepe' },
};
payload = new PullRequestPayloadBuilder()
.with({
action: 'opened',
repository: {
full_name: 'streamdevs/webhook',
html_url: 'https://github.com/streamdevs/webhook',
},
pull_request: { user: { login: 'SantiMA10' } },
sender: { login: 'pepe' },
})
.getInstance();
});

it("returns 'twitchChat.notified' === false if something goes wrong with TwitchChat", async () => {
Expand Down
Loading