Responding to feedback

microsoft · Sep 18, 2018 · 08ad406 · 08ad406
1 parent d4799db
commit 08ad406
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 55 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,7 +13,9 @@ $ npm run build
 
 ## Test
 
-You should test with node 4.x, 6.x and 8.x LTS.  We recommend using nvm ([linux](https://github.com/creationix/nvm) / [windows](https://github.com/coreybutler/nvm-windows)). To run units:
+You should test with node 4.x, 6.x and 8.x LTS.  We recommend using nvm ([linux](https://github.com/creationix/nvm) / [windows](https://github.com/coreybutler/nvm-windows)).
+
+To run units:
 
 ```
 npm units

diff --git a/make.js b/make.js
@@ -42,7 +42,7 @@ target.build = function() {
 
 
 target.units = function() {
-    pushd('test')
+    pushd('test');
     run('npm install ../_build');
     popd();
 
@@ -52,17 +52,7 @@ target.units = function() {
 }
 
 target.test = function() {
-    pushd('test')
-    run('npm install ../_build');
-    popd();
-
-    console.log("-------Unit Tests-------");
-    run('tsc -p ./test/units');
-    run('mocha test/units');
-
-    console.log("-------Other Tests-------");
-    run('tsc -p ./test/tests');
-    run('mocha test/tests');
+    target.units();
 }
 
 target.samples = function() {

diff --git a/test/tests/tsconfig.json b/test/tests/tsconfig.json
diff --git a/test/tests/vsoClientTests.ts b/test/tests/vsoClientTests.ts
diff --git a/test/units/vsoClientTests.ts b/test/units/vsoClientTests.ts
@@ -3,15 +3,15 @@ import nock = require('nock');
 import vsom = require('../../api/VsoClient');
 import * as rm from 'typed-rest-client/RestClient';
 import { resolve } from 'path';
+import { ApiResourceLocation } from '../../api/interfaces/common/VsoBaseInterfaces';
+
 describe('VSOClient Units', function () {
     let rest: rm.RestClient;
     let vsoClient: vsom.VsoClient
-    const baseUrl = 'https://dev.azure.com/';
+    const baseUrl: string = 'https://dev.azure.com/';
     before(() => {
-        const userAgent = "testAgent";
-        const handlers = [];
-        const options = null;
-        rest = new rm.RestClient(userAgent, null, handlers, options);
+        const userAgent: string = "testAgent";
+        rest = new rm.RestClient(userAgent, null, []);
         vsoClient = new vsom.VsoClient(baseUrl, rest);
     });
 
@@ -26,15 +26,15 @@ describe('VSOClient Units', function () {
     it('constructs', () => {
         this.timeout(1000);
         const baseUrl = 'https://dev.azure.com/';
-        const userAgent = "testAgent";
-        const handlers = [];
-        const options = null;
-        const rest = new rm.RestClient(userAgent, null, handlers, options);
+        const userAgent: string = "testAgent";
+        const rest: rm.RestClient = new rm.RestClient(userAgent, null, []);
         const vso: vsom.VsoClient = new vsom.VsoClient('https://microsoft.com', rest);
+
         assert(vso, 'VsoClient should not be null');
     });
 
     it('gets versioning data where the max version and released version are identical', async () => {
+        //Arrange
         nock('https://dev.azure.com/_apis/testArea', {
             reqheaders: {
                 'accept': 'application/json',
@@ -43,13 +43,18 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '1', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea', resourceName: 'testName', resourceVersion: '1'}]
-               });
-        const res = await vsoClient.getVersioningData('1', 'testArea', 'testLocation', {'testKey': 'testValue'}, null);
+        });
+
+        //Act
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('1', 'testArea', 'testLocation', {'testKey': 'testValue'}, null);
+
+        //Assert
         assert(res.apiVersion === '1');
         assert(res.requestUrl === 'https://dev.azure.com/testTemplate');
     });
 
     it('gets versioning data where ther requested version is greater than the max version', async () => {
+        //Arrange
         nock('https://dev.azure.com/_apis/testArea2', {
             reqheaders: {
                 'accept': 'application/json',
@@ -58,13 +63,18 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '2', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea', resourceName: 'testName', resourceVersion: '1'}]
-               });
-        const res = await vsoClient.getVersioningData('3', 'testArea2', 'testLocation', {'testKey': 'testValue'}, null);
+        });
+
+        //Act
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('3', 'testArea2', 'testLocation', {'testKey': 'testValue'}, null);
+
+        //Assert
         assert(res.apiVersion === '2-preview.1');
         assert(res.requestUrl === 'https://dev.azure.com/testTemplate');
     });
 
     it('gets versioning data where ther requested version is less than the max version', async () => {
+        //Arrange
         nock('https://dev.azure.com/_apis/testArea3', {
             reqheaders: {
                 'accept': 'application/json',
@@ -73,13 +83,18 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '2', releasedVersion: '2', routeTemplate: 'testTemplate', area: 'testArea', resourceName: 'testName', resourceVersion: '1'}]
-               });
-        const res = await vsoClient.getVersioningData('1', 'testArea3', 'testLocation', {'testKey': 'testValue'}, null);
+        });
+
+        //Act
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('1', 'testArea3', 'testLocation', {'testKey': 'testValue'}, null);
+
+        //Assert
         assert(res.apiVersion === '1');
         assert(res.requestUrl === 'https://dev.azure.com/testTemplate');
     });
 
     it('gets versioning data with simple query params', async () => {
+        //Arrange
         nock('https://dev.azure.com/_apis/testArea4', {
             reqheaders: {
                 'accept': 'application/json',
@@ -88,14 +103,19 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '1', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea4', resourceName: 'testName', resourceVersion: '1'}]
-               });
+        });
+
+        //Act
         const queryParams = {status: 2};
-        const res = await vsoClient.getVersioningData('1', 'testArea4', 'testLocation', {'testKey': 'testValue'}, queryParams);
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('1', 'testArea4', 'testLocation', {'testKey': 'testValue'}, queryParams);
+
+        //Assert
         assert(res.apiVersion === '1');
         assert(res.requestUrl === 'https://dev.azure.com/testTemplate?status=2');
     });
 
     it('gets versioning data with nested query params', async () => {
+        //Arrange
         nock('https://dev.azure.com/_apis/testArea5', {
             reqheaders: {
                 'accept': 'application/json',
@@ -104,14 +124,19 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '1', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea5', resourceName: 'testName', resourceVersion: '1'}]
-               });
+        });
+
+        //Act
         const queryParams = {status: {innerstatus: 2}};
-        const res = await vsoClient.getVersioningData('1', 'testArea5', 'testLocation', {'testKey': 'testValue'}, queryParams);
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('1', 'testArea5', 'testLocation', {'testKey': 'testValue'}, queryParams);
+
+        //Assert
         assert(res.apiVersion === '1');
         assert(res.requestUrl === 'https://dev.azure.com/testTemplate?innerstatus=2');
     });
 
     it('gets versioning data after an initialization promise', async () => {
+        //Arrange
         nock('https://newbase.com/_apis/testArea6', {
             reqheaders: {
                 'accept': 'application/json',
@@ -120,30 +145,37 @@ describe('VSOClient Units', function () {
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '1', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea6', resourceName: 'testName', resourceVersion: '1'}]
-               });
+        });
+
+        //Act
         vsoClient._setInitializationPromise(new Promise(() => {
             vsoClient.baseUrl = 'https://newbase.com';
             resolve();
         }));
         vsoClient._setInitializationPromise(Promise.resolve());
-        const res = await vsoClient.getVersioningData('1', 'testArea6', 'testLocation', {'testKey': 'testValue'}, null);
+        const res: vsom.ClientVersioningData = await vsoClient.getVersioningData('1', 'testArea6', 'testLocation', {'testKey': 'testValue'}, null);
+
+        //Assert
         assert(res.apiVersion === '1');
         assert(res.requestUrl === 'https://newbase.com/testTemplate');
-
-        vsoClient = new vsom.VsoClient(baseUrl, rest);
     });
 
     it('gets the location', async () => {
         nock('https://dev.azure.com/_apis/testArea7', {
+            //Arrange
             reqheaders: {
                 'accept': 'application/json',
                 'user-agent': 'testAgent'
             }})
             .options('')
             .reply(200, {
                 value: [{id: 'testLocation', maxVersion: '1', releasedVersion: '1', routeTemplate: 'testTemplate', area: 'testArea7', resourceName: 'testName', resourceVersion: '1'}]
-               });
-        const res = await vsoClient.beginGetLocation('testArea7', 'testLocation');
+        });
+
+        //Act
+        const res: ApiResourceLocation = await vsoClient.beginGetLocation('testArea7', 'testLocation');
+
+        //Assert
         assert(res.id === "testLocation");
     });
 });