Merge pull request #194 from danger/preparation_for_peril

[WIP] Changes made during Peril work
danger · Mar 30, 2017 · 0e54770 · 0e54770
2 parents d388b29 + 5eef02d
commit 0e54770
Show file tree

Hide file tree

Showing 19 changed files with 523 additions and 369 deletions.
diff --git a/.npmignore b/.npmignore
@@ -13,3 +13,4 @@ dangerfile.js
 env
 .eslintrc.json
 jsconfig.json
+coverage
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,13 @@
 ### master
 
-//  Add your own contribution below
+//  Add your own contribution below, ideally with a consumer's perspective in mind.
+
+* Updated jest-* dependencies to 19.x - orta
+
+  Updating the jest-* dependencies seems to be exhibiting strange behavior in tests for windows if you update, and 
+  use windows, can you please confirm that everything is 👍
+
+* Added type shapings to `JSONPatchForFile` - orta
 
 ### 0.14.2
 

diff --git a/package.json b/package.json
@@ -78,31 +78,31 @@
     "@types/debug": "0.0.29",
     "@types/jest": "^19.2.1",
     "@types/node-fetch": "^1.6.6",
-    "babel-cli": "^6.16.0",
+    "babel-cli": "6.16",
     "babel-plugin-syntax-async-functions": "^6.13.0",
-    "babel-plugin-transform-flow-strip-types": "^6.8.0",
-    "babel-plugin-transform-regenerator": "^6.16.1",
-    "babel-preset-es2015": "^6.16.0",
-    "babel-preset-stage-3": "^6.17.0",
+    "babel-plugin-transform-flow-strip-types": "^6.22.0",
+    "babel-plugin-transform-regenerator": "^6.22.0",
+    "babel-preset-es2015": "^6.24.0",
+    "babel-preset-stage-3": "^6.22.0",
     "husky": "^0.12.0",
     "in-publish": "^2.0.0",
     "jest": "^19.0.2",
     "lint-staged": "^3.2.5",
     "madge": "^1.4.4",
     "shx": "^0.2.1",
-    "ts-jest": "^19.0.0",
+    "ts-jest": "^19.0.2",
     "ts-node": "^3.0.0",
-    "tslint": "^4.4.0",
+    "tslint": "^4.5.1",
     "typescript": "2.2.1"
   },
   "dependencies": {
     "babel-polyfill": "^6.20.0",
     "chalk": "^1.1.1",
     "commander": "^2.9.0",
     "debug": "^2.6.0",
-    "jest-config": "^18.0.0",
-    "jest-environment-node": "^18.1.0",
-    "jest-runtime": "^18.0.0",
+    "jest-config": "^19.0.2",
+    "jest-environment-node": "^19.0.2",
+    "jest-runtime": "^19.0.2",
     "jsome": "^2.3.25",
     "jsonpointer": "^4.0.1",
     "lodash.find": "^4.6.0",

diff --git a/source/ci_source/ci_source.ts b/source/ci_source/ci_source.ts
@@ -1,6 +1,15 @@
+
 /** A json object that represents the outer ENV */
 export type Env = any
 
+/** Key details about a repo */
+export interface RepoMetaData {
+  /** A path like "artsy/eigen" */
+  repoSlug: string,
+  /** The ID for the pull/merge request "11" */
+  pullRequestID: string
+}
+
 /** The shape of an object that represents an individual CI */
 export interface CISource {
   /** The project name, mainly for showing errors */

diff --git a/source/ci_source/ci_source_helpers.ts b/source/ci_source/ci_source_helpers.ts
@@ -1,4 +1,4 @@
-import { Env, CISource } from "./ci_source"
+import { Env, RepoMetaData } from "./ci_source"
 import { GitHubAPI } from "../platforms/github/GitHubAPI"
 import { GitHubPRDSL } from "../dsl/GitHubDSL"
 import * as find from "lodash.find"
@@ -42,12 +42,12 @@ export function ensureEnvKeysAreInt(env: Env, keys: Array<string>): boolean {
  * @returns {number} The pull request ID, if any.  Otherwise 0 (Github starts from #1).
  * If there are multiple pull requests open for a branch, returns the first.
  */
-export async function getPullRequestIDForBranch(source: CISource, env: Env, branch: string): Promise<number> {
+export async function getPullRequestIDForBranch(metadata: RepoMetaData, env: Env, branch: string): Promise<number> {
   const token = env["DANGER_GITHUB_API_TOKEN"]
   if (!token) {
     return 0
   }
-  const api = new GitHubAPI(source, token)
+  const api = new GitHubAPI(metadata, token)
   const prs = await api.getPullRequests() as any[]
   const prForBranch: GitHubPRDSL = find(prs, (pr: GitHubPRDSL) => pr.head.ref === branch)
   if (prForBranch) {

diff --git a/source/danger.d.ts b/source/danger.d.ts
@@ -140,6 +140,11 @@ export interface JSONDiffValue {
   removed?: any[]
 }
 
+/** A map of string keys to JSONDiffValue */
+export interface JSONDiff {
+  [name: string]: JSONDiffValue
+}
+
 // This is `danger.git`
 
 /** The git specific metadata for a PR */
@@ -190,7 +195,7 @@ export interface GitDSL {
    *
    * @param {string} filename the path to the json file
    */
-  JSONDiffForFile(filename: string): Promise<any>,
+  JSONDiffForFile(filename: string): Promise<JSONDiff>,
 
   /** The Git commit metadata */
   readonly commits: Array<GitCommit>

diff --git a/source/dsl/GitDSL.ts b/source/dsl/GitDSL.ts
@@ -32,6 +32,11 @@ export interface JSONDiffValue {
   removed?: any[]
 }
 
+/** A map of string keys to JSONDiffValue */
+export interface JSONDiff {
+  [name: string]: JSONDiffValue
+}
+
 // This is `danger.git`
 
 /** The git specific metadata for a PR */
@@ -85,7 +90,7 @@ export interface GitDSL {
    *
    * @param {string} filename the path to the json file
    */
-  JSONDiffForFile(filename: string): Promise<any>,
+  JSONDiffForFile(filename: string): Promise<JSONDiff>,
 
   /** The Git commit metadata */
   readonly commits: Array<GitCommit>

diff --git a/source/platforms/_tests/GitHub.test.ts b/source/platforms/_tests/GitHub.test.ts
@@ -17,8 +17,7 @@ export const requestWithFixturedJSON = async (path: string): Promise<() => Promi
 
 describe("with fixtured data", () => {
   it("returns the correct github data", async () => {
-    const mockSource = new FakeCI({})
-    const api = new GitHubAPI(mockSource)
+    const api = new GitHubAPI({ repoSlug: "unused/metadata", pullRequestID: "1" })
     const github = new GitHub(api)
     api.getPullRequestInfo = await requestWithFixturedJSON("github_pr.json")
 

diff --git a/source/platforms/_tests/fixtures/readme.md b/source/platforms/_tests/fixtures/readme.md
@@ -0,0 +1,5 @@
+Here's an example CURL request to add a new fixture
+
+```sh
+curl -H "Authorization: XXX" curl -H "Accept: application/vnd.github.black-cat-preview+json" --request GET https://api.github.com/repos/artsy/emission/pulls/327/requested_reviewers  > source/platforms/_tests/fixtures/requested_reviewers.json
+```
diff --git a/source/platforms/_tests/fixtures/requested_reviewers.json b/source/platforms/_tests/fixtures/requested_reviewers.json
@@ -0,0 +1,21 @@
+[
+  {
+    "login": "ArtsyOpenSource",
+    "id": 12397828,
+    "avatar_url": "https://avatars1.githubusercontent.com/u/12397828?v=3",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/ArtsyOpenSource",
+    "html_url": "https://github.com/ArtsyOpenSource",
+    "followers_url": "https://api.github.com/users/ArtsyOpenSource/followers",
+    "following_url": "https://api.github.com/users/ArtsyOpenSource/following{/other_user}",
+    "gists_url": "https://api.github.com/users/ArtsyOpenSource/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/ArtsyOpenSource/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/ArtsyOpenSource/subscriptions",
+    "organizations_url": "https://api.github.com/users/ArtsyOpenSource/orgs",
+    "repos_url": "https://api.github.com/users/ArtsyOpenSource/repos",
+    "events_url": "https://api.github.com/users/ArtsyOpenSource/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/ArtsyOpenSource/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+]
diff --git a/source/platforms/_tests/fixtures/reviews.json b/source/platforms/_tests/fixtures/reviews.json
@@ -0,0 +1,146 @@
+[
+  {
+    "id": 2332973,
+    "user": {
+      "login": "orta",
+      "id": 49038,
+      "avatar_url": "https://avatars1.githubusercontent.com/u/49038?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/orta",
+      "html_url": "https://github.com/orta",
+      "followers_url": "https://api.github.com/users/orta/followers",
+      "following_url": "https://api.github.com/users/orta/following{/other_user}",
+      "gists_url": "https://api.github.com/users/orta/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/orta/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/orta/subscriptions",
+      "organizations_url": "https://api.github.com/users/orta/orgs",
+      "repos_url": "https://api.github.com/users/orta/repos",
+      "events_url": "https://api.github.com/users/orta/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/orta/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "body": "Generally speaking, there's a _lot_ of similar shaped code here that seems to mainly only be different to the artist a tiny amount\n",
+    "state": "COMMENTED",
+    "html_url": "https://github.com/artsy/emission/pull/327#pullrequestreview-2332973",
+    "pull_request_url": "https://api.github.com/repos/artsy/emission/pulls/327",
+    "_links": {
+      "html": {
+        "href": "https://github.com/artsy/emission/pull/327#pullrequestreview-2332973"
+      },
+      "pull_request": {
+        "href": "https://api.github.com/repos/artsy/emission/pulls/327"
+      }
+    },
+    "submitted_at": "2016-09-30T14:14:11Z",
+    "commit_id": "76c122e47ee36170c86739bb6cc665b6114e308c"
+  },
+  {
+    "id": 2343835,
+    "user": {
+      "login": "orta",
+      "id": 49038,
+      "avatar_url": "https://avatars1.githubusercontent.com/u/49038?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/orta",
+      "html_url": "https://github.com/orta",
+      "followers_url": "https://api.github.com/users/orta/followers",
+      "following_url": "https://api.github.com/users/orta/following{/other_user}",
+      "gists_url": "https://api.github.com/users/orta/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/orta/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/orta/subscriptions",
+      "organizations_url": "https://api.github.com/users/orta/orgs",
+      "repos_url": "https://api.github.com/users/orta/repos",
+      "events_url": "https://api.github.com/users/orta/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/orta/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "body": "",
+    "state": "COMMENTED",
+    "html_url": "https://github.com/artsy/emission/pull/327#pullrequestreview-2343835",
+    "pull_request_url": "https://api.github.com/repos/artsy/emission/pulls/327",
+    "_links": {
+      "html": {
+        "href": "https://github.com/artsy/emission/pull/327#pullrequestreview-2343835"
+      },
+      "pull_request": {
+        "href": "https://api.github.com/repos/artsy/emission/pulls/327"
+      }
+    },
+    "submitted_at": "2016-09-30T15:08:12Z",
+    "commit_id": "466bdef69fdbcdceb3b35242370edc328605ae1e"
+  },
+  {
+    "id": 2344085,
+    "user": {
+      "login": "orta",
+      "id": 49038,
+      "avatar_url": "https://avatars1.githubusercontent.com/u/49038?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/orta",
+      "html_url": "https://github.com/orta",
+      "followers_url": "https://api.github.com/users/orta/followers",
+      "following_url": "https://api.github.com/users/orta/following{/other_user}",
+      "gists_url": "https://api.github.com/users/orta/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/orta/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/orta/subscriptions",
+      "organizations_url": "https://api.github.com/users/orta/orgs",
+      "repos_url": "https://api.github.com/users/orta/repos",
+      "events_url": "https://api.github.com/users/orta/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/orta/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "body": "",
+    "state": "COMMENTED",
+    "html_url": "https://github.com/artsy/emission/pull/327#pullrequestreview-2344085",
+    "pull_request_url": "https://api.github.com/repos/artsy/emission/pulls/327",
+    "_links": {
+      "html": {
+        "href": "https://github.com/artsy/emission/pull/327#pullrequestreview-2344085"
+      },
+      "pull_request": {
+        "href": "https://api.github.com/repos/artsy/emission/pulls/327"
+      }
+    },
+    "submitted_at": "2016-09-30T15:09:27Z",
+    "commit_id": "466bdef69fdbcdceb3b35242370edc328605ae1e"
+  },
+  {
+    "id": 2344137,
+    "user": {
+      "login": "orta",
+      "id": 49038,
+      "avatar_url": "https://avatars1.githubusercontent.com/u/49038?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/orta",
+      "html_url": "https://github.com/orta",
+      "followers_url": "https://api.github.com/users/orta/followers",
+      "following_url": "https://api.github.com/users/orta/following{/other_user}",
+      "gists_url": "https://api.github.com/users/orta/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/orta/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/orta/subscriptions",
+      "organizations_url": "https://api.github.com/users/orta/orgs",
+      "repos_url": "https://api.github.com/users/orta/repos",
+      "events_url": "https://api.github.com/users/orta/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/orta/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "body": "",
+    "state": "COMMENTED",
+    "html_url": "https://github.com/artsy/emission/pull/327#pullrequestreview-2344137",
+    "pull_request_url": "https://api.github.com/repos/artsy/emission/pulls/327",
+    "_links": {
+      "html": {
+        "href": "https://github.com/artsy/emission/pull/327#pullrequestreview-2344137"
+      },
+      "pull_request": {
+        "href": "https://api.github.com/repos/artsy/emission/pulls/327"
+      }
+    },
+    "submitted_at": "2016-09-30T15:09:47Z",
+    "commit_id": "466bdef69fdbcdceb3b35242370edc328605ae1e"
+  }
+]