Merge pull request #26 from saraf/unit

Added unit test cases for api and webapp

Author: Ilya Radchenko

lib/api.js

@@ -2,6 +2,7 @@ var _ = require('lodash');
 var async = require('async');
 var superagent = require('superagent');
 var debug = require('debug')('strider-gitlab:api');
+var util = require('util');
 
 module.exports = {
   get: get,
@@ -39,8 +40,13 @@ function get(config, uri, done) {
     .set('User-Agent', 'StriderCD (http://stridercd.com)')
     .end(function (error, res) {
       res = res || {};
+
+      if (error) {
+        return done(error, null, null);
+      }
+
       debug('Response body type: ' + typeof res.body);
-      debug('Response body received: ' + JSON.stringify(res.body));
+      debug('Response body received: ' + util.inspect(res.body, false, 10, true));
       if (res.error) {
         return done(res.error, null, res);
       }
@@ -103,6 +109,10 @@ function deleteHooks(config, repo_id, url, callback) {
     .end(function (err, res) {
       var deleted = false;
 
+      if (err) {
+        return callback(err);
+      }
+
       if (!res) {
         return callback(new Error("Empty response."));
       }
@@ -156,6 +166,11 @@ function removeDeployKey(config, repo_id, title, callback) {
     .query(qpm)
     .set('User-Agent', 'StriderCD (http://stridercd.com)')
     .end(function (err, res) {
+
+      if (err) {
+        return callback(err);
+      }
+
       var deleted = false;
 
       if (!res) {

lib/webapp.js

@@ -30,8 +30,8 @@ module.exports = {
     api.get(config, 'projects', function (err, repos) {
       if (err) return done(err);
 
-      if(!repos) {
-          return done(new Error("Could not get a list of projects from the GitLab repository. Please check the configuration in Account->GitLab."));
+      if (!repos) {
+        return done(new Error("Could not get a list of projects from the GitLab repository. Please check the configuration in Account->GitLab."));
       }
 
       // Parse and filter only git repos
@@ -59,7 +59,7 @@ module.exports = {
 
     debug("Getting URI " + uri);
     api.get(account, uri, function (err, branches) {
-    debug("We get the following as branches: " + JSON.stringify(branches));
+      debug("We get the following as branches: " + util.inspect(branches, false, 10, true));
 
       done(err, _.map(branches || [], function (branch) {
         return branch.name;

package.json

@@ -37,9 +37,10 @@
     "inline_icon": "bitbucket"
   },
   "devDependencies": {
-    "jshint": "~2.1.11",
     "expect.js": "~0.2.0",
-    "mocha": "~1.13.0"
+    "jshint": "~2.1.11",
+    "mocha": "~2.2.3",
+    "nock": "^2.10.0"
   },
   "dependencies": {
     "async": "~0.2.9",
@@ -48,7 +49,7 @@
     "lodash": "~2.2.0",
     "step": "0.0.5",
     "strider-git": "^0.2.4",
-    "superagent": "~0.15.4"
+    "superagent": "~1.3.0"
   },
   "bugs": {
     "url": "https://github.com/meric426/strider-gitlab/issues"

test/README.md

@@ -1,4 +1,80 @@
 strider-gitlab tests
 ====================
 
-The tests use mocha for testing and nock for mocking responses from a gitlab server.
+The tests use mocha for testing and [nock](https://github.com/pgte/nock) for mocking responses from a gitlab server.
+
+Start out by writing an outline of what you want to test by adding pending tests to a .js file in the test directory,
+(inside the appropriate describe blocks)
+
+like:
+
+```
+it('should do xyz when abc happens');
+it('should do lmn when opq happens');
+... as many as necessary
+```
+
+Now running npm test will show your tests as "pending" and marked with a "-".
+
+Next, observe the "happy path", the existing behavior of the code by using util.inspect to log the parameters passed to
+the function to be tested when the codepath is run (ensure that the codepath is run by using the Strider web gui if needed),
+in order to understand what needs to be passed to the function you want to test in the test file.
+
+In order to sniff and record the http traffic so that you can create a nock mock of the gitlab server,
+use code similar to the following inside the codepath that you want to test:
+
+```
+In file lib/api.js ...
+
+var nock = require('nock');
+...
+
+//for example, inside the removeDeployKey function in lib/api.js
+var appendLogToFile = function(content) {
+  fs.appendFile('/noderoot/gitlab_remove_deploykey.txt', content);
+};
+
+nock.recorder.rec({
+  logging: appendLogToFile,
+});
+```
+
+In the above example, the file gitlab_remove_deploykey.txt file will contain the statements generated by nock.
+
+Next write out the body of the pending tests, one at a time.
+After writing out the body of a test, do an 'npm test' run, with nock still recording.
+Before doing the npm test run, ensure that only the current describe() block is active by adding the .only suffix.
+Like so,
+```
+  describe.only('parseRepo', function(){
+      it('should correctly parse repo information as received from gitlab server into a repo object');
+      it('should throw an error if it gets an empty parameter as repo ?');
+      ...
+
+```
+This will ensure that only the tests for functionality currently under consideration will be run.
+Also, mark all tests other than the current one to be inactive by changing the "it('should ..." to "xit('should ...".
+Else, you can ensure that only the current test is run by changing 'it(' to 'it.only('
+
+Before the run, you must also comment out any code that asks nock to intercept calls - the usual place for which is in
+the before, after or beforeEach/afterEach blocks. For example, comment out all the lines inside the following blocks
+```
+  before('Setup the mock gitlab server', function setupNock() {
+    nock.cleanAll();                        //remove all interceptors
+    nock.disableNetConnect();               //prevent all network call from going to the actual server
+    require('./mocks/gitlab_add_key.js')(); //pull in the mock code to simulate the server for this block
+  });
+
+  after('Tear down mock Gitlab server', function tearDownNock() {
+    nock.cleanAll();                        //remove all interceptors
+  });
+```
+This will ensure that the actual interaction between our code and the gitlab server will be recorded by nock.
+Copy out the code generated by nock into a .js file in the mocks subdirectory (see existing files in mocks/ for example)
+
+Before moving on to writing the next test, empty out the file used by nock for recording, and mark the test already
+written with a "xit(" or a "it.skip("
+
+After you are done with writing the tests, remove or comment out the nock.recorder.rec code so that nock stops recording.
+Then, enable all the tests in the block and enable/de-comment out the code that asks nock to
+disableNetConnect and mock, and re-run "npm test" to see all your tests run with the gitlab server mocked out of the picture.

test/mocks/gitlab_add_key.js

@@ -0,0 +1,102 @@
+/*
+ Simulation of responses from server when we
+ request the addition of a deploy key.
+
+ nock will simulate a gitlab server running at
+ localhost:80, where Strider Tester, a user is
+ registered with the name "stridertester", and
+ has been registered with api token - zRtVsmeznn7ySatTrnrp
+ stridertester is an "owner" of a group named "testunion"
+ and has admin access to three projects -
+ testunion / unionproject1
+ Strider Tester / pubproject1
+ Strider Tester / privproject1
+ */
+
+var nock = require('nock');
+
+module.exports = function () {
+  //--------------------------------------------------------------------------------------
+  //simulate a Created 201 response when we try to deploy ssh keys for a project
+  nock('http://localhost:80')
+    .post('/api/v3/projects/5/keys', {
+      "title": "strider-stridertester/privproject1",
+      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAMoSHhKfeE3/oXanAQEZO0Sq20SMjvjmJlTy+CaGz/1uk+glLXi9u2RKtfPRZDceAgyEtRUpqya9Uo1v9bjkIckGLhQwXdSo2G6O3QuzpE3gc6AXTDPQ0ZkkXbSdU9VGL1Zzr+maBnvfwK6IlsNz3fLa4lNV7vz1LaGCg9D1jP+nufZjuDiCAno7D607oG1iHQ3x/BqzphUATav3DFQFT2FBmmittQT0l0mMJ4XsQCQXkwNbDjkLYNon8FYPm9U3AOlzicOGteebt5mhsQtfl9+lL99B8+fk8b24pEEbOxZ4l0HcwMI1R5OLoTzPwSvVw+bp3YPhH2IzfFwK5NUk7 stridertester/[email protected]\n"
+    })
+    .query({"private_token": "zRtVsmeznn7ySatTrnrp"})
+    .reply(201, {
+      "id": 12,
+      "title": "strider-stridertester/privproject1",
+      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAMoSHhKfeE3/oXanAQEZO0Sq20SMjvjmJlTy+CaGz/1uk+glLXi9u2RKtfPRZDceAgyEtRUpqya9Uo1v9bjkIckGLhQwXdSo2G6O3QuzpE3gc6AXTDPQ0ZkkXbSdU9VGL1Zzr+maBnvfwK6IlsNz3fLa4lNV7vz1LaGCg9D1jP+nufZjuDiCAno7D607oG1iHQ3x/BqzphUATav3DFQFT2FBmmittQT0l0mMJ4XsQCQXkwNbDjkLYNon8FYPm9U3AOlzicOGteebt5mhsQtfl9+lL99B8+fk8b24pEEbOxZ4l0HcwMI1R5OLoTzPwSvVw+bp3YPhH2IzfFwK5NUk7 stridertester/[email protected]",
+      "created_at": "2015-08-19T03:35:01.863Z"
+    }, {
+      server: 'nginx',
+      date: 'Wed, 19 Aug 2015 03:35:01 GMT',
+      'content-type': 'application/json',
+      'content-length': '534',
+      connection: 'close',
+      status: '201 Created',
+      etag: '"5a11f9a2bf20878df6e3de77364e297c"',
+      'cache-control': 'max-age=0, private, must-revalidate',
+      'x-request-id': '565d54e9-f03b-4077-8cf4-a93503060889',
+      'x-runtime': '0.099917'
+    });
+
+  //--------------------------------------------------------------------------------------
+  //simulate a 400 Bad Request response when an invalid key is sent
+  nock('http://localhost:80')
+    .post('/api/v3/projects/5/keys', {"title": "strider-stridertester/privproject1", "key": "invalid-key"})
+    .query({"private_token": "zRtVsmeznn7ySatTrnrp"})
+    .reply(400, {"message": {"key": ["is invalid"], "fingerprint": ["cannot be generated"]}}, {
+      server: 'nginx',
+      date: 'Wed, 19 Aug 2015 04:35:26 GMT',
+      'content-type': 'application/json',
+      'content-length': '72',
+      connection: 'close',
+      status: '400 Bad Request',
+      'cache-control': 'no-cache',
+      'x-request-id': '907e7139-cb13-407a-864f-a91ce108e419',
+      'x-runtime': '0.054109'
+    });
+
+  //--------------------------------------------------------------------------------------
+  //simulate a 401 Unauthorized response when invalid credentials are used
+  nock('http://localhost:80')
+    .post('/api/v3/projects/5/keys', {
+      "title": "strider-stridertester/privproject1",
+      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAMoSHhKfeE3/oXanAQEZO0Sq20SMjvjmJlTy+CaGz/1uk+glLXi9u2RKtfPRZDceAgyEtRUpqya9Uo1v9bjkIckGLhQwXdSo2G6O3QuzpE3gc6AXTDPQ0ZkkXbSdU9VGL1Zzr+maBnvfwK6IlsNz3fLa4lNV7vz1LaGCg9D1jP+nufZjuDiCAno7D607oG1iHQ3x/BqzphUATav3DFQFT2FBmmittQT0l0mMJ4XsQCQXkwNbDjkLYNon8FYPm9U3AOlzicOGteebt5mhsQtfl9+lL99B8+fk8b24pEEbOxZ4l0HcwMI1R5OLoTzPwSvVw+bp3YPhH2IzfFwK5NUk7 stridertester/[email protected]\n"
+    })
+    .query({"private_token": "zRtVsmeznn7ySatTrnra"})
+    .reply(401, {"message": "401 Unauthorized"}, {
+      server: 'nginx',
+      date: 'Wed, 19 Aug 2015 05:03:45 GMT',
+      'content-type': 'application/json',
+      'content-length': '30',
+      connection: 'close',
+      status: '401 Unauthorized',
+      'cache-control': 'no-cache',
+      'x-request-id': '282a2411-dd11-4026-90b3-8a36560c0512',
+      'x-runtime': '0.004726'
+    });
+
+  //--------------------------------------------------------------------------------------
+  //simulate a 404 response when project could not be found
+  nock('http://localhost:80')
+    .post('/api/v3/projects/wrong%20repo%20id/keys', {
+      "title": "strider-stridertester/privproject1",
+      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAMoSHhKfeE3/oXanAQEZO0Sq20SMjvjmJlTy+CaGz/1uk+glLXi9u2RKtfPRZDceAgyEtRUpqya9Uo1v9bjkIckGLhQwXdSo2G6O3QuzpE3gc6AXTDPQ0ZkkXbSdU9VGL1Zzr+maBnvfwK6IlsNz3fLa4lNV7vz1LaGCg9D1jP+nufZjuDiCAno7D607oG1iHQ3x/BqzphUATav3DFQFT2FBmmittQT0l0mMJ4XsQCQXkwNbDjkLYNon8FYPm9U3AOlzicOGteebt5mhsQtfl9+lL99B8+fk8b24pEEbOxZ4l0HcwMI1R5OLoTzPwSvVw+bp3YPhH2IzfFwK5NUk7 stridertester/[email protected]\n"
+    })
+    .query({"private_token": "zRtVsmeznn7ySatTrnrp"})
+    .reply(404, ["1f8b0800000000000003ab56ca4d2d2e4e4c4f55b252323130510828cacf4a4d2e51f0cb2f5170cb2fcd4b51aa050037095a2823000000"], {
+      server: 'nginx',
+      date: 'Wed, 19 Aug 2015 05:25:00 GMT',
+      'content-type': 'application/json',
+      'transfer-encoding': 'chunked',
+      connection: 'close',
+      status: '404 Not Found',
+      'cache-control': 'no-cache',
+      'x-request-id': '2c64ae26-d7b1-4caf-8efd-300893dedf37',
+      'x-runtime': '0.005714',
+      'content-encoding': 'gzip'
+    });
+}