Autorun manual jobs before merge (#63)

Author: pepakriz

README.md

@@ -21,6 +21,7 @@ Reasons can be for example:
 ### Advanced features
 
 - Autogenerated commit message based on MR title (Suffixed with link to the original MR).
+- The blocking jobs are triggered automatically. Very useful for E2E testing etc.
 - Bot skips squashing when `bot:skip-squash` label is present on the MR.
 - Bot assigns MR to the beginning of the queue when `bot:hi-priority` is present. Useful for hotfixes etc.
 
@@ -89,5 +90,6 @@ GITLAB_AUTH_TOKEN="<token>" yarn run start
 | `MR_CHECK_INTERVAL` | `20` | Time between merge-requests checks (in seconds) |
 | `REMOVE_BRANCH_AFTER_MERGE` | `true` | It'll remove branch after merge |
 | `SQUASH_MERGE_REQUEST` | `true` | It'll squash commits on merge |
+| `AUTORUN_MANUAL_BLOCKING_JOBS` | `true` | It'll autorun manual blocking jobs before merge |
 | `SKIP_SQUASHING_LABEL` | `bot:skip-squash` | It'll skip squash when MR contains this label |
 | `HI_PRIORITY_LABEL` | `bot:hi-priority` | It'll put MR with this label to the beginning of the queue |

charts/gitlab-merger-bot/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 appVersion: "1.0"
 description: A Helm chart for Kubernetes
 name: gitlab-merger-bot
-version: 1.2.1
+version: 1.2.2
 home: https://github.com/pepakriz/gitlab-merger-bot
 maintainers:
   - name: pepakriz

charts/gitlab-merger-bot/templates/deployment.yaml

@@ -45,6 +45,8 @@ spec:
           value: "{{ .Values.settings.ciCheckInterval }}"
         - name: MR_CHECK_INTERVAL
           value: "{{ .Values.settings.mrCheckInterval }}"
+        - name: AUTORUN_MANUAL_BLOCKING_JOBS
+          value: "{{ .Values.settings.autorunManualBlockingJobs }}"
         - name: SENTRY_DSN
           value: "{{ .Values.settings.sentryDsn }}"
         - name: SKIP_SQUASHING_LABEL

charts/gitlab-merger-bot/values.yaml

@@ -26,5 +26,6 @@ settings:
   sentryDsn: ""
   ciCheckInterval: 10
   mrCheckInterval: 20
+  autorunManualBlockingJobs: true
   skipSquashingLabel: ""
   hiPriorityLabel: ""

src/GitlabApi.ts

@@ -78,6 +78,21 @@ export interface MergeRequestPipeline {
 	status: PipelineStatus;
 }
 
+export enum PipelineJobStatus {
+	Manual = 'manual',
+	Failed = 'failed',
+	Canceled = 'canceled',
+	Pending = 'pending',
+	Started = 'started',
+	Running = 'running',
+}
+
+export interface PipelineJob {
+	id: number;
+	allow_failure: boolean;
+	status: PipelineJobStatus;
+}
+
 export interface MergeRequestInfo extends MergeRequest {
 	sha: string;
 	diff_refs: {
@@ -137,6 +152,10 @@ export class GitlabApi {
 		return this.sendRequestWithMultiResponse(`/api/v4/projects/${projectId}/merge_requests/${mergeRequestIid}/pipelines`, RequestMethod.Get);
 	}
 
+	public async getPipelineJobs(projectId: number, pipelineId: number): Promise<PipelineJob[]> {
+		return this.sendRequestWithMultiResponse(`/api/v4/projects/${projectId}/pipelines/${pipelineId}/jobs`, RequestMethod.Get);
+	}
+
 	public async getMergeRequestApprovals(projectId: number, mergeRequestIid: number): Promise<MergeRequestApprovals> {
 		return this.sendRequestWithSingleResponse(`/api/v4/projects/${projectId}/merge_requests/${mergeRequestIid}/approvals`, RequestMethod.Get);
 	}
@@ -168,6 +187,11 @@ export class GitlabApi {
 		this.validateResponseStatus(response);
 	}
 
+	public async runJob(projectId: number, jobId: number): Promise<void> {
+		const response = await this.sendRawRequest(`/api/v4/projects/${projectId}/jobs/${jobId}/play`, RequestMethod.Post);
+		this.validateResponseStatus(response);
+	}
+
 	private async sendRequestWithSingleResponse(url: string, method: RequestMethod, body?: ParsedUrlQueryInput): Promise<any> {
 		const response = await this.sendRawRequest(url, method, body);
 		this.validateResponseStatus(response);

src/MergeRequestAcceptor.ts

@@ -1,9 +1,12 @@
 import {
 	GitlabApi,
-	MergeRequest, MergeRequestApprovals,
-	MergeRequestInfo, MergeRequestPipeline,
+	MergeRequest,
+	MergeRequestApprovals,
+	MergeRequestInfo,
+	MergeRequestPipeline,
 	MergeState,
 	MergeStatus,
+	PipelineJobStatus,
 	PipelineStatus,
 	RequestMethod,
 	User,
@@ -106,6 +109,7 @@ interface AcceptMergeRequestOptions {
 	removeBranchAfterMerge: boolean;
 	squashMergeRequest: boolean;
 	skipSquashingLabel: string;
+	autorunManualBlockingJobs: boolean;
 }
 
 export enum BotLabels {
@@ -318,6 +322,18 @@ export const acceptMergeRequest = async (gitlabApi: GitlabApi, mergeRequest: Mer
 				};
 			}
 
+			if (options.autorunManualBlockingJobs && currentPipeline.status === PipelineStatus.Manual) {
+				const jobs = await gitlabApi.getPipelineJobs(mergeRequestInfo.project_id, currentPipeline.id);
+				const jobsToRun = jobs.filter((job) => job.status === PipelineJobStatus.Manual && !job.allow_failure);
+
+				if (jobsToRun.length > 0) {
+					console.log(`[MR][${mergeRequestInfo.iid}] there are some blocking manual jobs. triggering`);
+					await Promise.all(jobsToRun.map((job) => gitlabApi.runJob(mergeRequestInfo.project_id, job.id)));
+					await Promise.all(tasks);
+					continue;
+				}
+			}
+
 			if (currentPipeline.status === PipelineStatus.Manual) {
 				return {
 					kind: AcceptMergeRequestResultKind.WaitingPipeline,

src/index.ts

@@ -25,6 +25,7 @@ const CI_CHECK_INTERVAL = env.get('CI_CHECK_INTERVAL').default('10').asIntPositi
 const MR_CHECK_INTERVAL = env.get('MR_CHECK_INTERVAL').default('20').asIntPositive() * 1000;
 const REMOVE_BRANCH_AFTER_MERGE = env.get('REMOVE_BRANCH_AFTER_MERGE').default('true').asBoolStrict();
 const SQUASH_MERGE_REQUEST = env.get('SQUASH_MERGE_REQUEST').default('true').asBoolStrict();
+const AUTORUN_MANUAL_BLOCKING_JOBS = env.get('AUTORUN_MANUAL_BLOCKING_JOBS').default('true').asBoolStrict();
 const SKIP_SQUASHING_LABEL = env.get('SKIP_SQUASHING_LABEL').default('bot:skip-squash').asString();
 const HI_PRIORITY_LABEL = env.get('HI_PRIORITY_LABEL').default('bot:hi-priority').asString();
 
@@ -242,6 +243,7 @@ const runMergeRequestCheckerLoop = async (user: User) => {
 				removeBranchAfterMerge: REMOVE_BRANCH_AFTER_MERGE,
 				squashMergeRequest: SQUASH_MERGE_REQUEST,
 				skipSquashingLabel: SKIP_SQUASHING_LABEL,
+				autorunManualBlockingJobs: AUTORUN_MANUAL_BLOCKING_JOBS,
 			}),
 		).then(resolveMergeRequestResult);