Merge branch 'master' into feature/github-issue-template-layout

CHANGELOG.md

@@ -13,6 +13,7 @@
 
 ## Master
 
+- Fix #614 - Posting status updates to Github using issue workflow broken - [@sgtcoolguy][]
 - Fix vertical alignment in GitHub issue template - [@patrickkempff][]
 
 # 5.0.1, err. 6.0.0

source/danger-incoming-process-schema.json

@@ -898,7 +898,7 @@
         },
         "private": {
           "description": "Is the repo publicly accessible?",
-          "type": "{boolean}"
+          "type": "boolean"
         }
       },
       "type": "object"
@@ -982,15 +982,24 @@
         },
         "created_files": {
           "description": "Newly created filepaths relative to the git root",
-          "type": "{string[]}"
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
         },
         "deleted_files": {
           "description": "Removed filepaths relative to the git root",
-          "type": "{string[]}"
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
         },
         "modified_files": {
           "description": "Filepaths with changes relative to the git root",
-          "type": "{string[]}"
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
         }
       },
       "type": "object"

source/dsl/GitDSL.ts

@@ -69,19 +69,16 @@ export interface JSONDiff {
 export interface GitJSONDSL {
   /**
    * Filepaths with changes relative to the git root
-   * @type {string[]}
    */
   readonly modified_files: string[]
 
   /**
    * Newly created filepaths relative to the git root
-   * @type {string[]}
    */
   readonly created_files: string[]
 
   /**
    * Removed filepaths relative to the git root
-   * @type {string[]}
    */
   readonly deleted_files: string[]
 

source/dsl/GitHubDSL.ts

@@ -318,7 +318,6 @@ export interface GitHubRepo {
 
   /**
    * Is the repo publicly accessible?
-   * @type {boolean}
    */
   private: boolean
 

source/platforms/github/GitHubAPI.ts

@@ -344,17 +344,21 @@ export class GitHubAPI {
     return res.ok ? res.json() : { labels: [] }
   }
 
-  updateStatus = async (passed: boolean, message: string, url?: string): Promise<any> => {
+  updateStatus = async (passed: boolean | "pending", message: string, url?: string): Promise<any> => {
     const repo = this.repoMetadata.repoSlug
 
     const prJSON = await this.getPullRequestInfo()
     const ref = prJSON.head.sha
+    let state = passed ? "success" : "failure"
+    if (passed === "pending") {
+      state = "pending"
+    }
     const res = await this.post(
       `repos/${repo}/statuses/${ref}`,
       {},
       {
-        state: passed ? "success" : "failure",
-        context: process.env["PERIL_INTEGRATION_ID"] ? "Peril" : "Danger",
+        state: state,
+        context: process.env["PERIL_BOT_USER_ID"] ? "Peril" : "Danger",
         target_url: url || "http://danger.systems/js",
         description: message,
       }

source/platforms/github/_tests/_github_api.test.ts

@@ -147,6 +147,82 @@ describe("API testing", () => {
     await expect(api.postInlinePRComment("", "", "", 0)).rejects.toEqual(expectedJSON)
   })
 
+  it("updateStatus('pending') success", async () => {
+    api.fetch = jest.fn().mockReturnValue({ ok: true })
+    api.getPullRequestInfo = await requestWithFixturedJSON("github_pr.json")
+
+    await expect(api.updateStatus("pending", "message")).resolves.toEqual(true)
+    expect(api.fetch).toHaveBeenCalledWith(
+      "https://api.github.com/repos/artsy/emission/statuses/cfa8fb80d2b65f4c4fa0b54d25352a3a0ff58f75",
+      {
+        headers: {
+          Authorization: "token ABCDE",
+          "Content-Type": "application/json",
+        },
+        method: "POST",
+        body: '{"state":"pending","context":"Danger","target_url":"http://danger.systems/js","description":"message"}',
+      },
+      undefined
+    )
+  })
+
+  it("updateStatus(false) success", async () => {
+    api.fetch = jest.fn().mockReturnValue({ ok: true })
+    api.getPullRequestInfo = await requestWithFixturedJSON("github_pr.json")
+
+    await expect(api.updateStatus(false, "message")).resolves.toEqual(true)
+    expect(api.fetch).toHaveBeenCalledWith(
+      "https://api.github.com/repos/artsy/emission/statuses/cfa8fb80d2b65f4c4fa0b54d25352a3a0ff58f75",
+      {
+        headers: {
+          Authorization: "token ABCDE",
+          "Content-Type": "application/json",
+        },
+        method: "POST",
+        body: '{"state":"failure","context":"Danger","target_url":"http://danger.systems/js","description":"message"}',
+      },
+      undefined
+    )
+  })
+
+  it("updateStatus(true, 'message', 'http://example.org') success", async () => {
+    api.fetch = jest.fn().mockReturnValue({ ok: true })
+    api.getPullRequestInfo = await requestWithFixturedJSON("github_pr.json")
+
+    await expect(api.updateStatus(true, "message", "http://example.org")).resolves.toEqual(true)
+    expect(api.fetch).toHaveBeenCalledWith(
+      "https://api.github.com/repos/artsy/emission/statuses/cfa8fb80d2b65f4c4fa0b54d25352a3a0ff58f75",
+      {
+        headers: {
+          Authorization: "token ABCDE",
+          "Content-Type": "application/json",
+        },
+        method: "POST",
+        body: '{"state":"success","context":"Danger","target_url":"http://example.org","description":"message"}',
+      },
+      undefined
+    )
+  })
+
+  it("updateStatus(true) failed", async () => {
+    api.fetch = jest.fn().mockReturnValue({ ok: false })
+    api.getPullRequestInfo = await requestWithFixturedJSON("github_pr.json")
+
+    await expect(api.updateStatus(true, "message")).resolves.toEqual(false)
+    expect(api.fetch).toHaveBeenCalledWith(
+      "https://api.github.com/repos/artsy/emission/statuses/cfa8fb80d2b65f4c4fa0b54d25352a3a0ff58f75",
+      {
+        headers: {
+          Authorization: "token ABCDE",
+          "Content-Type": "application/json",
+        },
+        method: "POST",
+        body: '{"state":"success","context":"Danger","target_url":"http://danger.systems/js","description":"message"}',
+      },
+      undefined
+    )
+  })
+
   it("deleteCommentWithID", async () => {
     api.fetch = jest.fn().mockReturnValue({ status: 204 })
     await api.deleteCommentWithID(123)

source/platforms/github/comms/issueCommenter.ts

@@ -55,31 +55,8 @@ export const GitHubIssueCommenter = (api: GitHubAPI) => {
      * Fails the current build, if status setting succeeds
      * then return true.
      */
-
-    updateStatus: async (passed: boolean | "pending", message: string, url?: string): Promise<boolean> => {
-      const ghAPI = api.getExternalAPI()
-
-      const prJSON = await api.getPullRequestInfo()
-      const ref = prJSON.head
-      try {
-        await ghAPI.repos.createStatus({
-          repo: ref.repo.name,
-          owner: ref.repo.owner.login,
-          sha: ref.sha,
-          state: passed ? "success" : "failure",
-          context: process.env["PERIL_BOT_USER_ID"] ? "Peril" : "Danger",
-          target_url: url || "http://danger.systems/js",
-          description: message,
-        })
-        return true
-      } catch (error) {
-        // @ts-ignore
-        if (global.verbose) {
-          console.log("Got an error with creating a commit status", error)
-        }
-        return false
-      }
-    },
+    updateStatus: async (passed: boolean | "pending", message: string, url?: string): Promise<boolean> =>
+      api.updateStatus(passed, message, url),
 
     /**
      * Gets inline comments for current PR

source/platforms/platform.ts

@@ -17,19 +17,15 @@ export type Comment = {
   /**
    *  UUID for the comment
    *
-   * @type {string}
    */
   id: string
   /**
    * Textual representation of comment
    *
-   * @type {string} body string
    */
   body: string
   /**
    * Was this posted by the account Danger has access to?
-   *
-   * @type {boolean} true if Danger can edit
    */
   ownedByDanger: boolean
 }