Merge branch 'experiment-tests' into url-hash-placement-fix

Adding a set of tests for the experiment object so we can add the test for this branch on top of them.

Author: nselvidge

project.json

@@ -0,0 +1,5 @@
+{
+    "id": "12345",
+    "project_name": "my-project",
+    "include_jquery": "false"
+}

test/commands/create-experiment.test.js

@@ -1,4 +1,5 @@
 //Test the experiment command
+
 var fs = require('fs');
 
 var assert = require('chai').assert;

test/experiment.test.js

@@ -0,0 +1,207 @@
+var fs = require('fs');
+var chai = require('chai');
+chai.config.truncateThreshold = 0; // disable truncating
+var expect = chai.expect;
+var proxyquire = require('proxyquire');
+var quickTemp = require('quick-temp');
+var _ = require('lodash');
+var Project = require('../lib/project.js');
+var Experiment = require('../lib/experiment.js');
+var Variation = require('../lib/variation.js');
+var functionCalls = [];
+/**
+ * Used to push any function calls and their 
+ * arguments to the funcitonCalls array. We 
+ * can use this function to replace any 
+ * function calls that we aren't trying to 
+ * test. 
+ * @param  {String}   functionName    name of the function being called
+ * @param  {Object}   [returnObject]  object to return after recording the funciton call
+ * @return {Function}                 function that when called will record functionName and it's arguments
+ */
+var recordFunctionCalls = function(functionName, returnObject){
+  return function(){
+    var callRecorder = {functionName : functionName};
+    for(var i = 0; i < arguments.length; i++){
+      callRecorder[i] = arguments[i];
+    }
+    functionCalls.push(callRecorder);
+    return returnObject;
+  };
+};
+
+var experiment;
+var folder = '/new-experiment';
+var description = 'My new experiment';
+var edit_url = 'http://www.example.com';
+var project_id = 154321;
+var directories = {};
+var experimentData = {
+  description : description,
+  edit_url : edit_url
+};
+quickTemp.makeOrRemake(directories, 'project');
+var experimentPath = directories.project + folder;
+
+describe('Experiment Object', function (){
+  before(function(done){
+    experiment = Experiment.create({
+      description: description,
+      edit_url: edit_url
+    }, experimentPath);
+    fs.writeFile(directories.project + '/project.json', '{"id":"'+project_id+'","include_jquery":"false","project_name":"my project"}', function(err){
+      if(!err){
+        done()
+      } else {
+        done(err)
+      }
+    });
+  });
+  after(function(done){
+    quickTemp.remove(directories, 'experiment');
+    done();
+  })
+  describe('#create()', function() {
+    it('Should create an experiment directory', function (done){
+      fs.exists(experimentPath, function(exists){
+        expect(exists).to.be.true;
+      });
+      done();
+    });
+    it('Should create a global.css file', function(done){
+      fs.exists(experimentPath + '/global.css', function(exists){
+        expect(exists).to.be.true;
+        done();
+      })
+    });
+    it('Should create a global.js file', function(done){
+      fs.exists(experimentPath + '/global.js', function(exists){
+        expect(exists).to.be.true;
+        done();
+      })
+    });
+    it('Should create an experiment.json file', function(done){
+      fs.readFile(experimentPath + '/experiment.json', function(err, data){
+        expect(err).to.be.null;
+        expect(JSON.parse(data)).to.deep.equal({
+          'description': description, 
+          'edit_url': edit_url
+        });
+        done();
+      });
+    });
+    it('Should return an experiment object', function(){
+      expect(experiment).to.be.an.instanceOf(Experiment);
+    });
+  });
+  describe('#locateAndLoad()', function(){
+    var experiment;
+    before(function(done){
+      experiment = Experiment.locateAndLoad(experimentPath);
+      done();
+    });
+    after(function(done){
+      done();
+    })
+    it('Should locate the experiment.json', function(){
+      expect(experiment).to.be.an.instanceOf(Experiment);
+    });
+    it('Should load the experiment.json', function(){
+      expect(experiment.attributes).to.deep.equal(experimentData);
+    });
+  });
+  describe('#getJSPath()', function(){
+    it('Should return the JS Path', function(){
+      var experiment = Experiment.locateAndLoad(experimentPath);
+      expect(experiment.getJSPath()).to.equal(experimentPath + '/global.js');
+    })
+  });
+  describe('#getCSSPath()', function(){
+    it('Should return the CSS Path', function(){
+      var experiment = Experiment.locateAndLoad(experimentPath);
+      expect(experiment.getCSSPath()).to.equal(experimentPath + '/global.css');
+    })
+  });
+  describe('#getCSS()',function(){
+    it('Should return global.css contents', function(done){
+      var mockCSS = '.my-class {background: white;}';
+      fs.writeFile(experimentPath + '/global.css', mockCSS, function(err, data){
+        var experiment = Experiment.locateAndLoad(experimentPath);
+        expect(experiment.getCSS()).to.equal(mockCSS);
+        done();
+      });
+    });
+  });
+  describe('#getJS()', function(){
+    it('Should return global.js contents', function(done){
+      var mockJS = '$(\'body\').addClass(\'my-class\');';
+      fs.writeFile(experimentPath + '/global.js', mockJS, function(err, data){
+        expect(err).to.be.null;
+        var experiment = Experiment.locateAndLoad(experimentPath);
+        expect(experiment.getJS()).to.equal(mockJS);
+        done();
+      });
+    });
+  });
+  describe('#getVariations()', function(){
+    before(function(done){
+      variationOne = experimentPath + '/variation1';
+      variationTwo = experimentPath + '/variation2';
+      Variation.create({
+        description: description,
+      }, variationOne);
+      Variation.create({
+        description: description,
+      }, variationTwo);
+      done();
+    })
+    it('Should return an array with location of variations', function(){
+      var experiment = Experiment.locateAndLoad(experimentPath);
+      expect(experiment.getVariations()).to.deep.equal([variationOne + '/variation.json', variationTwo + '/variation.json']);
+    })
+  });
+  describe('#createRemote()', function(){
+    it('Should create a remote experiment', function(){
+
+      functionCalls = [];
+      var experiment = Experiment.locateAndLoad(experimentPath);
+      var client = {
+        createExperiment: recordFunctionCalls('updateExperiment', 
+          {then: recordFunctionCalls('then', 
+            {
+              catch: recordFunctionCalls('catch')
+            })
+          })
+      }
+      var expArgs = _.clone(experiment.attributes);
+      expArgs['custom_css'] = experiment.getCSS();
+      expArgs['custom_js'] = experiment.getJS();
+      expArgs['project_id'] = String(project_id);
+
+      experiment.createRemote(client);
+      expect(functionCalls[0]).to.have.a.property('functionName', 'updateExperiment');
+      expect(functionCalls[0][0]).to.deep.equal(expArgs);
+    });
+  });
+  describe('#updateRemote()', function(){
+    it('Should update a remote experiment', function(){
+      functionCalls = [];
+      var experiment = Experiment.locateAndLoad(experimentPath);
+      var client = {
+        updateExperiment: recordFunctionCalls('updateExperiment', 
+          {then: recordFunctionCalls('then', 
+            {
+              catch: recordFunctionCalls('catch')
+            })
+          })
+      };
+      var expArgs = _.clone(experiment.attributes);
+      expArgs['custom_css'] = experiment.getCSS();
+      expArgs['custom_js'] = experiment.getJS();
+
+      experiment.updateRemote(client);
+      expect(functionCalls[0]).to.have.a.property('functionName', 'updateExperiment');
+      expect(functionCalls[0][0]).to.deep.equal(expArgs);
+    });
+  });
+});

test/mocha.opts

@@ -1,2 +1 @@
---recursive
---ui bdd
+