Merge pull request #154 from streamdevs/152-gitlab-mr-merged

feat: new 'MergeRequestMerged' reaction

Author: orestes

src/reactions/gitlab/merge-request-merged.ts

@@ -0,0 +1,16 @@
+import { MergeRequestPayload } from '../../schemas/gitlab/merge-request-payload';
+import { Reaction, ReactionCanHandleOptions, ReactionHandleOptions } from '../github/reaction';
+
+export class MergeRequestMerged extends Reaction<MergeRequestPayload> {
+	getStreamLabsMessage({ payload }: ReactionHandleOptions<MergeRequestPayload>): string {
+		return `The merge request from *${payload.user.username}* has been merged into *${payload.repository.name}*`;
+	}
+
+	getTwitchChatMessage({ payload }: ReactionHandleOptions<MergeRequestPayload>): string {
+		return `The merge request from ${payload.user.username} has been merged into ${payload.repository.homepage}`;
+	}
+
+	canHandle({ payload, event }: ReactionCanHandleOptions<MergeRequestPayload>): boolean {
+		return event === 'Merge Request Hook' && payload.object_attributes.state === 'merged';
+	}
+}

src/schemas/gitlab/merge-request-payload.ts

@@ -0,0 +1,18 @@
+type url = string;
+
+export interface MergeRequestPayload {
+	user: {
+		name: string;
+		username: string;
+		avatar_url: url;
+	};
+	repository: {
+		name: string;
+		url: url;
+		description: string;
+		homepage: url;
+	};
+	object_attributes: {
+		state: 'merged' | 'created' | 'updated' | 'closed' | 'opened';
+	};
+}

test/builders/payload/gitlab/merge-request-payload-builder.ts

@@ -0,0 +1,32 @@
+import { MergeRequestPayload } from '../../../../src/schemas/gitlab/merge-request-payload';
+import { merge } from 'lodash';
+
+export class MergeRequestPayloadBuilder {
+	private payload: MergeRequestPayload = {
+		user: {
+			name: 'Administrator',
+			username: 'root',
+			avatar_url:
+				'http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon',
+		},
+		repository: {
+			name: 'Gitlab Test',
+			url: 'http://example.com/gitlabhq/gitlab-test.git',
+			description: 'Aut reprehenderit ut est.',
+			homepage: 'http://example.com/gitlabhq/gitlab-test',
+		},
+		object_attributes: {
+			state: 'merged',
+		},
+	};
+
+	public with(payload: Partial<MergeRequestPayload>): MergeRequestPayloadBuilder {
+		merge(this.payload, payload);
+
+		return this;
+	}
+
+	public getInstance(): MergeRequestPayload {
+		return this.payload;
+	}
+}

test/reactions/gitlab/merge-request-merged.spec.ts

@@ -0,0 +1,82 @@
+import { MergeRequestMerged } from '../../../src/reactions/gitlab/merge-request-merged';
+import { MergeRequestPayloadBuilder } from '../../builders/payload/gitlab/merge-request-payload-builder';
+import { StreamLabsMock } from '../../__mocks__/StreamLabs';
+import { TwitchChatMock } from '../../__mocks__/TwitchChat';
+
+describe('MergeRequestMerged', () => {
+	const twitchChat = new TwitchChatMock();
+	const streamlabs = new StreamLabsMock();
+
+	describe('#canHandle', () => {
+		it("returns true if the event is 'Merge Request Hook' and 'object_attributes.state' is 'merged'", () => {
+			const payload = new MergeRequestPayloadBuilder()
+				.with({ object_attributes: { state: 'merged' } })
+				.getInstance();
+			const subject = new MergeRequestMerged(twitchChat, streamlabs);
+
+			const result = subject.canHandle({ event: 'Merge Request Hook', payload });
+
+			expect(result).toEqual(true);
+		});
+
+		it("returns false if the event is 'test' and 'object_attributes.state' is 'merged'", () => {
+			const payload = new MergeRequestPayloadBuilder()
+				.with({ object_attributes: { state: 'merged' } })
+				.getInstance();
+			const subject = new MergeRequestMerged(twitchChat, streamlabs);
+
+			const result = subject.canHandle({ event: 'test', payload });
+
+			expect(result).toEqual(false);
+		});
+
+		it("returns false if the event is 'Merge Request Hook' and 'object_attributes.state' is 'opened'", () => {
+			const payload = new MergeRequestPayloadBuilder()
+				.with({ object_attributes: { state: 'opened' } })
+				.getInstance();
+			const subject = new MergeRequestMerged(twitchChat, streamlabs);
+
+			const result = subject.canHandle({ event: 'Merge Request Hook', payload });
+
+			expect(result).toEqual(false);
+		});
+	});
+
+	describe('#handle', () => {
+		it("sends the proper message to 'TwitchChat'", async () => {
+			const payload = new MergeRequestPayloadBuilder()
+				.with({ object_attributes: { state: 'merged' } })
+				.getInstance();
+			const subject = new MergeRequestMerged(twitchChat, streamlabs);
+
+			const result = await subject.handle({ payload });
+
+			expect(result).toEqual(
+				expect.objectContaining({
+					twitchChat: {
+						notified: true,
+						message: `The merge request from ${payload.user.username} has been merged into ${payload.repository.homepage}`,
+					},
+				}),
+			);
+		});
+
+		it("sends the proper message to 'StreamLabs'", async () => {
+			const payload = new MergeRequestPayloadBuilder()
+				.with({ object_attributes: { state: 'merged' } })
+				.getInstance();
+			const subject = new MergeRequestMerged(twitchChat, streamlabs);
+
+			const result = await subject.handle({ payload });
+
+			expect(result).toEqual(
+				expect.objectContaining({
+					streamlabs: {
+						notified: true,
+						message: `The merge request from *${payload.user.username}* has been merged into *${payload.repository.name}*`,
+					},
+				}),
+			);
+		});
+	});
+});