Merge pull request #11 from duckduckgo/loremattei/check-dod

Asana Task: https://app.asana.com/0/1204165176092271/1209189118557663/f

Adds a check to verify that the "Conform to Definition of Done" checkbox has been checked.
Makes PR checks fail otherwise.

Author: ayoy

org/allPRs.ts

@@ -189,6 +189,13 @@ export const embeddedFilesURLMismatch = async() => {
     await privacyConfigMismatch(repo, modifiedFiles)
 }
 
+export const dodChecked = async () => {
+    // Warn when DOD checkbox is not checked
+    if (!danger.github.pr.body.toLowerCase().includes("* [x] does this pr satisfy our [definition of done]")) {
+        fail("Please, make sure this PR satisfies our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f) and the relevant checkbox is checked.");
+    }
+}
+
 // Default run
 export default async () => {
     await prSize()
@@ -198,4 +205,5 @@ export default async () => {
     await licensedFonts()
     await newColors()
     await embeddedFilesURLMismatch()
-}
+    await dodChecked()
+}   

tests/checkDod.allPRs.test.ts

@@ -0,0 +1,63 @@
+jest.mock("danger", () => jest.fn())
+import danger from 'danger'
+const dm = danger as any;
+
+import { dodChecked } from '../org/allPRs'
+
+beforeEach(() => {
+    dm.warn = jest.fn().mockReturnValue(true);
+    dm.fail = jest.fn().mockReturnValue(true);
+
+    dm.danger = {
+        github: {
+            pr: {
+                body: "",
+            }
+        },
+    }
+})
+
+describe("Definition of Done checked", () => {
+    it("does fail when Definition of Done checkbox is not in the body", async () => {
+        var prBody = "**Steps to test this PR**:\n1.\n2.\n"
+        prBody += "**Orientation Testing**:\n* [ ] Portrait\n* [ ] Landscape"
+        dm.danger.github.pr.body = prBody
+
+        await dodChecked()
+        
+        expect(dm.fail).toHaveBeenCalledWith("Please, make sure this PR satisfies our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f) and the relevant checkbox is checked.")
+    })
+
+    it("does fail when Definition of Done checkbox is not checked", async () => {
+        var prBody = "**Steps to test this PR**:\n1.\n2.\n"
+        prBody += "**Definition of Done (Internal Only)**:\n* [ ] Does this PR satisfy our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f)?\n"
+        prBody += "**Orientation Testing**:\n* [ ] Portrait\n* [ ] Landscape"
+        dm.danger.github.pr.body = prBody
+
+        await dodChecked()
+        
+        expect(dm.fail).toHaveBeenCalledWith("Please, make sure this PR satisfies our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f) and the relevant checkbox is checked.")
+    })
+
+    it("does not fail when Definition of Done checkbox is checked (Lower Case)", async () => {
+        var prBody = "**Steps to test this PR**:\n1.\n2.\n"
+        prBody += "**Definition of Done (Internal Only)**:\n* [x] Does this PR satisfy our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f)?\n"
+        prBody += "**Orientation Testing**:\n* [ ] Portrait\n* [ ] Landscape"
+        dm.danger.github.pr.body = prBody
+
+        await dodChecked()
+        
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+
+    it("does not fail when Definition of Done checkbox is checked (Upper Case)", async () => {
+        var prBody = "**Steps to test this PR**:\n1.\n2.\n"
+        prBody += "**Definition of Done (Internal Only)**:\n* [X] Does this PR satisfy our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f)?\n"
+        prBody += "**Orientation Testing**:\n* [ ] Portrait\n* [ ] Landscape"
+        dm.danger.github.pr.body = prBody
+
+        await dodChecked()
+        
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+})