Added specs for server logs for console.log and test progress/errors

Author: vedharish

tests/behaviour/server.js

@@ -0,0 +1,148 @@
+'use strict';
+
+var assert = require('assert'),
+  sinon = require('sinon'),
+  path = require('path'),
+  http = require('http'),
+  chalk = require('chalk'),
+  serverPort = 8888,
+  browserStackRunnerServer = require('../../lib/server.js');
+
+var getBaseConfig = function() {
+  return { 
+    username: 'BROWSERSTACK_USER',
+    key: 'BROWSERSTACK_KEY',
+    test_framework: 'qunit',
+    test_path: path.resolve(__dirname, 'resources', 'qunit_sample.html'),
+    build: 'BrowserStack Runner Behaviour Tests',
+    browsers: [ { 
+      browser: 'firefox',
+      browser_version: '47.0',
+      os: 'Windows',
+      os_version: '7'
+    } ]
+  }
+};
+
+var requestServer = function(path, requestBody, appendHeaders, callback) {
+  var headers = {
+    'Content-Length': Buffer.byteLength(requestBody)
+  }
+  var request = http.request({
+    hostname: 'localhost',
+    port: serverPort,
+    path: path,
+    method: 'POST',
+    headers: Object.assign(headers, appendHeaders),
+  }, (res) => {
+    var responseData = '';
+
+    res.on('data', (data) => {
+      responseData += data.toString();
+    });
+    res.on('end', () => {
+      callback(null, responseData, res.statusCode);
+    });
+  }).on('error', (e) => {
+    callback(e);
+  });
+  request.write(requestBody);
+  request.end();
+};
+
+describe('Server Assertions', function() {
+  describe('Assert logs from the browserstack-runner server', function() {
+    var sandBox, bsClient, infoLoggerStub, server, reports, workers = {};
+
+    beforeEach(function() {
+      sandBox = sinon.sandbox.create();
+      bsClient = sandBox.stub();
+      infoLoggerStub = sandBox.stub(browserStackRunnerServer.logger, 'info');
+
+      server = browserStackRunnerServer.Server(bsClient, workers, getBaseConfig(), function(error, reports) {
+        console.log('Dude!', reports);
+      });
+      server.listen(serverPort);
+    });
+
+    afterEach(function() {
+      sandBox.restore();
+      server.close();
+    });
+
+    it('logs', function(done) {
+      var browserString = 'OS X Chrome 54'
+      requestServer('/_log', '{"arguments":["Random String"]}', {
+        'x-browser-string': browserString
+      }, function(error) {
+        if(error) done(error);
+        assert.equal(infoLoggerStub.called, true);
+        assert.equal(infoLoggerStub.callCount, 1);
+        assert.equal(infoLoggerStub.getCalls()[0].args, '[' + browserString + '] ' + 'Random String');
+
+        requestServer('/_log', '{"arguments":["Invalid Random String', {
+          'x-browser-string': browserString
+        }, function(error) {
+          if(error) done(error);
+          assert.equal(infoLoggerStub.callCount, 2);
+          assert.equal(infoLoggerStub.getCalls()[1].args, '[' + browserString + '] ' + '{"arguments":["Invalid Random String');
+          done();
+        });
+      });
+    });
+
+    it('test errors', function(done) {
+      this.timeout(0);
+      var browserUUIDString = 'abcd-efgh-1234-5678',
+        browserInfoString = 'browserInfo';
+
+      workers[browserUUIDString] = {
+        getTestBrowserInfo: sandBox.stub().returns(browserInfoString),
+        string: 'workerString'
+      };
+      var requestBodyObject = {
+        test: {
+          errors: [{
+            message: "failedTestMessage",
+            actual: "ActualValue",
+            expected: "expectedValue",
+            source: "LongStackTrace"
+          }],
+          name:"customTestName",
+          suiteName:"customSuiteName"
+        }
+      };
+
+      requestServer('/_progress', JSON.stringify(requestBodyObject), {
+        'x-worker-uuid': browserUUIDString
+      }, function(error) {
+        if(error) done(error);
+        assert.equal(infoLoggerStub.called, true);
+        assert.equal(infoLoggerStub.callCount, 1);
+        assert.equal(infoLoggerStub.getCalls()[0].args.length, 3);
+        assert.equal(infoLoggerStub.getCalls()[0].args[0], '[%s] ' + chalk.red('Error:'));
+        assert.equal(infoLoggerStub.getCalls()[0].args[1], browserInfoString);
+        assert.equal(infoLoggerStub.getCalls()[0].args[2], 
+          '"customTestName" failed, failedTestMessage\n' + chalk.blue('Expected: ') + 'expectedValue' +
+          '\n' + chalk.blue('  Actual: ') + 'ActualValue' +
+          '\n' + chalk.blue('  Source: ') + 'LongStackTrace'
+        );
+
+        requestServer('/_progress', '{"arguments":["Invalid Random String', {
+          'x-worker-uuid': browserUUIDString
+        }, function(error) {
+          if(error) done(error);
+          assert.equal(infoLoggerStub.callCount, 3);
+          assert.equal(infoLoggerStub.getCalls()[1].args.length, 2);
+          assert.equal(infoLoggerStub.getCalls()[1].args[0], '[%s] Exception in parsing log');
+          assert.equal(infoLoggerStub.getCalls()[1].args[1], 'workerString');
+
+          assert.equal(infoLoggerStub.getCalls()[2].args.length, 2);
+          assert.equal(infoLoggerStub.getCalls()[2].args[0], '[%s] Log: undefined');
+          assert.equal(infoLoggerStub.getCalls()[2].args[1], 'workerString');
+          done();
+        });
+      });
+    });
+  });
+});