Merge pull request #185 from streamdevs/179-pull-request-payload-builder

test: new 'PullRequestPayloadBuilder'

Author: orestes

package.json

@@ -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",
@@ -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"
 	}
 }

src/schemas/github/pull-request-payload.ts

@@ -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 };
 }

test/builders/github/pull-request-payload-builder.ts

@@ -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;
+	}
+}

test/reactions/github/pull-request-merged.spec.ts

@@ -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;
@@ -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 () => {

test/reactions/github/pull-request-opened.spec.ts

@@ -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;
@@ -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 () => {