ci(docs-infra): change AIO preview server stuff to pull builds from CircleCI

Previously, Travis pushed the build artitfacts to the preview server.
This required us to use JWT to secure the POST request from Travis, to
ensure we couldn't receive malicious builds.

JWT has been deprecated and we are moving our builds to CircleCI.

This commit rewrites the TypeScript part of the preview server that
handles converting build artifact into hosted previews of the docs.

aio/aio-builds-setup/dockerbuild/scripts-js/test/common/github-pull-requests.spec.ts

@@ -1,20 +1,27 @@
 // Imports
+import {GithubApi} from '../../lib/common/github-api';
 import {GithubPullRequests} from '../../lib/common/github-pull-requests';
 
 // Tests
 describe('GithubPullRequests', () => {
 
+  let githubApi: jasmine.SpyObj<GithubApi>;
+
+  beforeEach(() => {
+    githubApi = jasmine.createSpyObj('githubApi', ['post', 'get', 'getPaginated']);
+  });
+
   describe('constructor()', () => {
 
-    it('should throw if \'githubToken\' is missing or empty', () => {
-      expect(() => new GithubPullRequests('', 'foo/bar')).
-        toThrowError('Missing or empty required parameter \'githubToken\'!');
+    it('should throw if \'githubOrg\' is missing or empty', () => {
+      expect(() => new GithubPullRequests(githubApi, '', 'bar')).
+        toThrowError('Missing or empty required parameter \'githubOrg\'!');
     });
 
 
-    it('should throw if \'repoSlug\' is missing or empty', () => {
-      expect(() => new GithubPullRequests('12345', '')).
-        toThrowError('Missing or empty required parameter \'repoSlug\'!');
+    it('should throw if \'githubRepo\' is missing or empty', () => {
+      expect(() => new GithubPullRequests(githubApi, 'foo', '')).
+        toThrowError('Missing or empty required parameter \'githubRepo\'!');
     });
 
   });
@@ -22,17 +29,9 @@ describe('GithubPullRequests', () => {
 
   describe('addComment()', () => {
     let prs: GithubPullRequests;
-    let deferred: {resolve: (v: any) => void, reject: (v: any) => void};
 
     beforeEach(() => {
-      prs = new GithubPullRequests('12345', 'foo/bar');
-
-      spyOn(prs, 'post').and.callFake(() => new Promise((resolve, reject) => deferred = {resolve, reject}));
-    });
-
-
-    it('should return a promise', () => {
-      expect(prs.addComment(42, 'body')).toEqual(jasmine.any(Promise));
+      prs = new GithubPullRequests(githubApi, 'foo', 'bar');
     });
 
 
@@ -47,30 +46,28 @@ describe('GithubPullRequests', () => {
     });
 
 
-    it('should call \'post()\' with the correct pathname, params and data', () => {
+    it('should make a POST request to Github with the correct pathname, params and data', () => {
+      githubApi.post.and.callFake(() => Promise.resolve());
       prs.addComment(42, 'body');
-
-      expect(prs.post).toHaveBeenCalledWith('/repos/foo/bar/issues/42/comments', null, {body: 'body'});
+      expect(githubApi.post).toHaveBeenCalledWith('/repos/foo/bar/issues/42/comments', null, {body: 'body'});
     });
 
 
     it('should reject if the request fails', done => {
+      githubApi.post.and.callFake(() => Promise.reject('Test'));
       prs.addComment(42, 'body').catch(err => {
         expect(err).toBe('Test');
         done();
       });
-
-      deferred.reject('Test');
     });
 
 
-    it('should resolve with the returned response', done => {
+    it('should resolve with the data from the Github POST', done => {
+      githubApi.post.and.callFake(() => Promise.resolve('Test'));
       prs.addComment(42, 'body').then(data => {
-        expect(data as any).toBe('Test');
+        expect(data).toBe('Test');
         done();
       });
-
-      deferred.resolve('Test');
     });
 
   });
@@ -78,35 +75,34 @@ describe('GithubPullRequests', () => {
 
   describe('fetch()', () => {
     let prs: GithubPullRequests;
-    let prsGetSpy: jasmine.Spy;
 
     beforeEach(() => {
-      prs = new GithubPullRequests('12345', 'foo/bar');
-      prsGetSpy = spyOn(prs as any, 'get');
+      prs = new GithubPullRequests(githubApi, 'foo', 'bar');
     });
 
 
-    it('should call \'get()\' with the correct pathname', () => {
+    it('should make a GET request to GitHub with the correct pathname', () => {
       prs.fetch(42);
-      expect(prsGetSpy).toHaveBeenCalledWith('/repos/foo/bar/issues/42');
+      expect(githubApi.get).toHaveBeenCalledWith('/repos/foo/bar/issues/42');
     });
 
 
-    it('should forward the value returned by \'get()\'', () => {
-      prsGetSpy.and.returnValue('Test');
-      expect(prs.fetch(42) as any).toBe('Test');
+    it('should resolve with the data returned from GitHub', done => {
+      const expected: any = {number: 42};
+      githubApi.get.and.callFake(() => Promise.resolve(expected));
+      prs.fetch(42).then(data => {
+        expect(data).toEqual(expected);
+        done();
+      });
     });
-
   });
 
 
   describe('fetchAll()', () => {
     let prs: GithubPullRequests;
-    let prsGetPaginatedSpy: jasmine.Spy;
 
     beforeEach(() => {
-      prs = new GithubPullRequests('12345', 'foo/bar');
-      prsGetPaginatedSpy = spyOn(prs as any, 'getPaginated');
+      prs = new GithubPullRequests(githubApi, 'foo', 'bar');
       spyOn(console, 'log');
     });
 
@@ -118,24 +114,48 @@ describe('GithubPullRequests', () => {
       prs.fetchAll('closed');
       prs.fetchAll('open');
 
-      expect(prsGetPaginatedSpy).toHaveBeenCalledTimes(3);
-      expect(prsGetPaginatedSpy.calls.argsFor(0)).toEqual([expectedPathname, {state: 'all'}]);
-      expect(prsGetPaginatedSpy.calls.argsFor(1)).toEqual([expectedPathname, {state: 'closed'}]);
-      expect(prsGetPaginatedSpy.calls.argsFor(2)).toEqual([expectedPathname, {state: 'open'}]);
+      expect(githubApi.getPaginated).toHaveBeenCalledTimes(3);
+      expect(githubApi.getPaginated.calls.argsFor(0)).toEqual([expectedPathname, {state: 'all'}]);
+      expect(githubApi.getPaginated.calls.argsFor(1)).toEqual([expectedPathname, {state: 'closed'}]);
+      expect(githubApi.getPaginated.calls.argsFor(2)).toEqual([expectedPathname, {state: 'open'}]);
     });
 
 
     it('should default to \'all\' if no state is specified', () => {
       prs.fetchAll();
-      expect(prsGetPaginatedSpy).toHaveBeenCalledWith('/repos/foo/bar/pulls', {state: 'all'});
+      expect(githubApi.getPaginated).toHaveBeenCalledWith('/repos/foo/bar/pulls', {state: 'all'});
     });
 
 
     it('should forward the value returned by \'getPaginated()\'', () => {
-      prsGetPaginatedSpy.and.returnValue('Test');
+      githubApi.getPaginated.and.returnValue('Test');
       expect(prs.fetchAll() as any).toBe('Test');
     });
-
   });
 
+  describe('fetchFiles()', () => {
+    let prs: GithubPullRequests;
+
+    beforeEach(() => {
+      prs = new GithubPullRequests(githubApi, 'foo', 'bar');
+    });
+
+
+    it('should make a GET request to GitHub with the correct pathname', () => {
+      prs.fetchFiles(42);
+      expect(githubApi.get).toHaveBeenCalledWith('/repos/foo/bar/pulls/42/files');
+    });
+
+
+    it('should resolve with the data returned from GitHub', done => {
+      const expected: any = [{ sha: 'ABCDE', filename: 'a/b/c'}, { sha: '12345', filename: 'x/y/z' }];
+      githubApi.get.and.callFake(() => Promise.resolve(expected));
+      prs.fetch(42).then(data => {
+        expect(data).toEqual(expected);
+        done();
+      });
+    });
+  });
+
+
 });