Add Config File Parsing

src/config.ts

@@ -0,0 +1,27 @@
+/**
+ * Format of the .github/ops-bot.yaml file that can be
+ * set in each repository
+ */
+export type OpsBotConfig = {
+ auto_merger: boolean;
+ branch_checker: boolean;
+ label_checker: boolean;
+ release_drafter: boolean;
+ external_contributors: boolean;
+};
+
+/**
+ * Default configuration options if no config is present in repository
+ */
+export const DefaultOpsBotConfig: OpsBotConfig = {
+ auto_merger: false,
+ branch_checker: false,
+ label_checker: false,
+ release_drafter: false,
+ external_contributors: true,
+};
+
+/**
+ * Configuration file path in repositories
+ */
+export const OpsBotConfigPath = ".github/ops-bot.yaml";

src/plugins/AutoMerger/auto_merger.ts

@@ -7,6 +7,7 @@ import {
  UsersGetByUsernameResponseData,
 } from "../../types";
 import strip from "strip-comments";
+import { exitIfFeatureIsDisabled } from "../../shared";
 
 const MERGE_COMMENT = "@gpucibot merge";
 
@@ -18,6 +19,7 @@ export class AutoMerger {
 
  async maybeMergePR(): Promise<any> {
  const context = this.context;
+ await exitIfFeatureIsDisabled(context, "auto_merger");
  const { repository: repo } = context.payload;
  let prNumbers: number[] = []; // will usually only contain 1 number, except in rare instances w/ status contexts
 

src/plugins/BranchChecker/pull_request.ts

@@ -1,3 +1,4 @@
+import { exitIfFeatureIsDisabled } from "../../shared";
 import { PRContext } from "../../types";
 import { checkPR } from "./check_pr";
 
@@ -10,6 +11,7 @@ export class PRBranchChecker {
 
  async checkPR() {
  const { context } = this;
+ await exitIfFeatureIsDisabled(context, "branch_checker");
  await checkPR(context.octokit, context.payload.pull_request);
  }
 }

src/plugins/BranchChecker/repository.ts

@@ -1,3 +1,4 @@
+import { exitIfFeatureIsDisabled } from "../../shared";
 import { RepositoryContext } from "../../types";
 import { checkPR } from "./check_pr";
 
@@ -10,6 +11,7 @@ export class RepositoryBranchChecker {
 
  async checkAllPRs() {
  const { context } = this;
+ await exitIfFeatureIsDisabled(context, "branch_checker");
  const repo = context.payload.repository;
 
  const prs = await context.octokit.paginate(context.octokit.pulls.list, {

src/plugins/LabelChecker/label_checker.ts

@@ -1,4 +1,8 @@
-import { createSetCommitStatus, isReleasePR } from "../../shared";
+import {
+ createSetCommitStatus,
+ exitIfFeatureIsDisabled,
+ isReleasePR,
+} from "../../shared";
 import { PRContext } from "../../types";
 
 export class LabelChecker {
@@ -11,6 +15,8 @@ export class LabelChecker {
  async checkLabels(): Promise<any> {
  const context = this.context;
 
+ await exitIfFeatureIsDisabled(context, "label_checker");
+
  const setCommitStatus = createSetCommitStatus(context.octokit, {
  context: "Label Checker",
  owner: context.payload.repository.owner.login,
@@ -47,7 +53,7 @@ export class LabelChecker {
 
  const categoryLabels = ["bug", "doc", "feature request", "improvement"];
  const breakingLabels = ["breaking", "non-breaking"];
- const doNotMergeLabelText = 'do not merge';
+ const doNotMergeLabelText = "do not merge";
  const labelsOnPR = context.payload.pull_request.labels;
 
  let categoryLabelCount = 0;
@@ -58,7 +64,7 @@ export class LabelChecker {
 
  if (label.name.trim().toLowerCase().includes(doNotMergeLabelText)) {
  return await setCommitStatus(
- "Contains a \`DO NOT MERGE\` label",
+ "Contains a `DO NOT MERGE` label",
  "failure"
  );
  }

src/plugins/ReleaseDrafter/release_drafter.ts

@@ -7,7 +7,11 @@ import { basename } from "path";
 import { resolve } from "path";
 import { readFileSync } from "fs";
 import nunjucks from "nunjucks";
-import { getVersionFromBranch, isVersionedBranch } from "../../shared";
+import {
+ exitIfFeatureIsDisabled,
+ getVersionFromBranch,
+ isVersionedBranch,
+} from "../../shared";
 
 export class ReleaseDrafter {
  context: PushContext;
@@ -32,6 +36,7 @@ export class ReleaseDrafter {
 
  async draftRelease(): Promise<any> {
  const { context, branchName, repo } = this;
+ await exitIfFeatureIsDisabled(context, "release_drafter");
  const { created, deleted } = context.payload;
 
  // Don't run on branch created/delete pushes

src/shared.ts

@@ -1,3 +1,5 @@
+import { Context } from "probot";
+import { DefaultOpsBotConfig, OpsBotConfig, OpsBotConfigPath } from "./config";
 import { CommitStatus, ProbotOctokit, PullsGetResponseData } from "./types";
 
 /**
@@ -59,3 +61,26 @@ export const isReleasePR = (
  pullRequest.title.toLowerCase().includes("[release]")
  );
 };
+
+/**
+ *
+ * Exits the NodeJS process if a specified feature is not enabled.
+ * The configuration file is fetched from the repository's default branch.
+ */
+export const exitIfFeatureIsDisabled = async (
+ context: Context,
+ feature: keyof OpsBotConfig
+): Promise<any> => {
+ const repoParams = context.repo();
+ const { config } = await context.octokit.config.get({
+ ...repoParams,
+ path: OpsBotConfigPath,
+ defaults: DefaultOpsBotConfig,
+ });
+
+ console.log(`${repoParams.repo} config: `, JSON.stringify(config, null, 2));
+ if (config[feature]) return;
+
+ console.warn(`${feature} is not enabled on ${repoParams.repo}. Exiting...`);
+ process.exit(0);
+};

test/auto_merger.test.ts

@@ -10,6 +10,9 @@ import { default as user_permission } from "./fixtures/responses/get_collaborato
 import { default as commitPRs } from "./fixtures/responses/list_pull_requests_associated_with_commit.json";
 import { user, userNoName } from "./fixtures/responses/get_by_username";
 import {
+ mockConfigGet,
+ mockContextRepo,
+ mockExit,
  mockGetByUsername,
  mockGetUserPermissionLevel,
  mockListComments,
@@ -19,6 +22,8 @@ import {
  mockPaginate,
  mockPullsGet,
 } from "./mocks";
+import { default as repoResp } from "./fixtures/responses/context_repo.json";
+import { makeConfigReponse } from "./fixtures/responses/get_config";
 
 describe("Auto Merger", () => {
  beforeEach(() => {
@@ -32,6 +37,16 @@ describe("Auto Merger", () => {
  mockPullsGet.mockReset();
  });
 
+ beforeAll(() => {
+ mockContextRepo.mockReturnValue(repoResp);
+ mockExit.mockReset();
+ mockConfigGet.mockResolvedValue(makeConfigReponse({ auto_merger: true }));
+ });
+
+ afterAll(() => {
+ expect(mockExit).toBeCalledTimes(0);
+ });
+
  test("status context", async () => {
  mockListPullRequestsFromCommit.mockResolvedValueOnce(commitPRs);
  mockPullsGet.mockResolvedValueOnce(pulls_get);

test/branch_checker.test.ts

@@ -2,10 +2,19 @@ import { PRBranchChecker } from "../src/plugins/BranchChecker/pull_request";
 import { RepositoryBranchChecker } from "../src/plugins/BranchChecker/repository";
 import { makePRContext } from "./fixtures/contexts/pull_request";
 import { makeRepositoryContext } from "./fixtures/contexts/repository";
-import { mockCreateCommitStatus, mockListPulls, mockPaginate } from "./mocks";
+import {
+ mockConfigGet,
+ mockContextRepo,
+ mockCreateCommitStatus,
+ mockExit,
+ mockListPulls,
+ mockPaginate,
+} from "./mocks";
 import { branch_checker as listPullsResp } from "./fixtures/responses/list_pulls.json";
 import { default as releasesJson } from "./fixtures/responses/releases.json";
 import axios from "axios";
+import { default as repoResp } from "./fixtures/responses/context_repo.json";
+import { makeConfigReponse } from "./fixtures/responses/get_config";
 
 jest.mock("axios");
 const mockedAxios = axios as jest.Mocked<typeof axios>;
@@ -14,9 +23,20 @@ describe("Label Checker", () => {
  describe("Pull Request Event", () => {
  beforeEach(() => {
  mockCreateCommitStatus.mockReset();
+ });
 
+ beforeAll(() => {
+ mockContextRepo.mockReturnValue(repoResp);
  const resp = { data: releasesJson };
  mockedAxios.get.mockResolvedValue(resp);
+ mockExit.mockReset();
+ mockConfigGet.mockResolvedValue(
+ makeConfigReponse({ branch_checker: true })
+ );
+ });
+
+ afterAll(() => {
+ expect(mockExit).toBeCalledTimes(0);
  });
 
  test("release PR", async () => {
@@ -87,7 +107,7 @@ describe("Label Checker", () => {
  "Base branch is under active development"
  );
  });
- 
+
  test("next development branch", async () => {
  const context = makePRContext({
  baseRef: "branch-21.08",
@@ -115,7 +135,7 @@ describe("Label Checker", () => {
  "Base branch is not under active development"
  );
  });
-});
+ });
 
  describe("Repository Event", () => {
  beforeEach(() => {

test/exit_if_feature_disabled.test.ts

@@ -0,0 +1,25 @@
+import { LabelChecker } from "../src/plugins/LabelChecker/label_checker";
+import { makePRContext } from "./fixtures/contexts/pull_request";
+import { mockConfigGet, mockContextRepo, mockExit } from "./mocks";
+import { default as repoResp } from "./fixtures/responses/context_repo.json";
+import { makeConfigReponse } from "./fixtures/responses/get_config";
+
+const context = makePRContext({ labels: [] });
+mockContextRepo.mockReturnValue(repoResp);
+
+describe("Config Checker", () => {
+ beforeEach(() => {
+ mockExit.mockReset();
+ });
+
+ test.each([
+ { enabled: true, mockExitCalls: 0 },
+ { enabled: false, mockExitCalls: 1 },
+ ])("label_checker: $enabled", async ({ enabled, mockExitCalls }) => {
+ mockConfigGet.mockResolvedValueOnce(
+ makeConfigReponse({ label_checker: enabled })
+ );
+ await new LabelChecker(context).checkLabels();
+ expect(mockExit).toBeCalledTimes(mockExitCalls);
+ });
+});

test/fixtures/contexts/base.ts

@@ -1,4 +1,6 @@
 import {
+ mockConfigGet,
+ mockContextRepo,
  mockCreateCommitStatus,
  mockCreateRelease,
  mockGetByUsername,
@@ -21,6 +23,7 @@ export const makeContext = (payload, name: EmitterWebhookEventName) => {
  return {
  name,
  payload,
+ repo: mockContextRepo,
  octokit: {
  issues: {
  listComments: mockListComments,
@@ -43,10 +46,13 @@ export const makeContext = (payload, name: EmitterWebhookEventName) => {
  users: {
  getByUsername: mockGetByUsername,
  },
- orgs : {
- checkMembershipForUser: mockOrgMembership
+ orgs: {
+ checkMembershipForUser: mockOrgMembership,
  },
  paginate: mockPaginate,
+ config: {
+ get: mockConfigGet,
+ },
  },
  };
 };

test/fixtures/responses/context_repo.json

@@ -0,0 +1,4 @@
+{
+ "owner": "rapidsai",
+ "repo": "cudf"
+}

test/fixtures/responses/get_config.ts

@@ -0,0 +1,7 @@
+import { OpsBotConfig } from "../../../src/config";
+
+export const makeConfigReponse = <E extends Partial<OpsBotConfig>>(
+ opsBotConfig: E
+): { config: E } => {
+ return { config: opsBotConfig };
+};

test/label_checker.test.ts

@@ -1,12 +1,29 @@
 import { LabelChecker } from "../src/plugins/LabelChecker/label_checker";
 import { makePRContext } from "./fixtures/contexts/pull_request";
-import { mockCreateCommitStatus } from "./mocks";
+import { makeConfigReponse } from "./fixtures/responses/get_config";
+import {
+ mockConfigGet,
+ mockContextRepo,
+ mockCreateCommitStatus,
+ mockExit,
+} from "./mocks";
+import { default as repoResp } from "./fixtures/responses/context_repo.json";
 
 describe("Label Checker", () => {
  beforeEach(() => {
  mockCreateCommitStatus.mockReset();
  });
 
+ beforeAll(() => {
+ mockContextRepo.mockReturnValue(repoResp);
+ mockExit.mockReset();
+ mockConfigGet.mockResolvedValue(makeConfigReponse({ label_checker: true }));
+ });
+
+ afterAll(() => {
+ expect(mockExit).toBeCalledTimes(0);
+ });
+
  test("no labels", async () => {
  const context = makePRContext({ labels: [] });
  await new LabelChecker(context).checkLabels();
@@ -127,7 +144,7 @@ describe("Label Checker", () => {
  );
  expect(mockCreateCommitStatus.mock.calls[1][0].state).toBe("failure");
  expect(mockCreateCommitStatus.mock.calls[1][0].description).toBe(
- "Contains a \`DO NOT MERGE\` label"
+ "Contains a `DO NOT MERGE` label"
  );
  expect(mockCreateCommitStatus.mock.calls[1][0].target_url).toBe(
  "https://docs.rapids.ai/resources/label-checker/"

test/mocks.ts

@@ -1,16 +1,21 @@
+export const mockConfigGet = jest.fn();
+export const mockContextRepo = jest.fn();
 export const mockCreateCommitStatus = jest.fn();
 export const mockCreateRelease = jest.fn();
-export const mockListCommits = jest.fn();
-export const mockListPullRequestsFromCommit = jest.fn();
+export const mockExit = jest
+ .spyOn(process, "exit")
+ .mockImplementation(() => null as never);
+export const mockGetByUsername = jest.fn();
 export const mockGetReleaseByTag = jest.fn();
-export const mockUpdateRelease = jest.fn();
-export const mockPullsGet = jest.fn();
-export const mockPaginate = jest.fn();
-export const mockListComments = jest.fn();
 export const mockGetUserPermissionLevel = jest.fn();
-export const mockGetByUsername = jest.fn();
+export const mockListComments = jest.fn();
+export const mockListCommits = jest.fn();
+export const mockListPullRequestsFromCommit = jest.fn();
+export const mockListPulls = jest.fn();
 export const mockListReviews = jest.fn();
 export const mockMerge = jest.fn();
-export const mockListPulls = jest.fn();
-export const mockUpdateRef = jest.fn();
 export const mockOrgMembership = jest.fn();
+export const mockPaginate = jest.fn();
+export const mockPullsGet = jest.fn();
+export const mockUpdateRef = jest.fn();
+export const mockUpdateRelease = jest.fn();