Merge pull request #16 from crowi/test

Add test library and set up CircleCI

Gruntfile.js

@@ -1,11 +1,12 @@
 /*
- * @package RMW
+ * @package Crowi
  */
 
 module.exports = function(grunt) {
 
   var paths = {
-        scripts: ['Gruntfile.js', 'app.js', 'lib/**/*.js', 'models/**/*.js', 'routes/**/*.js', 'form/**/*.js', 'resource/js/**/*.js'],
+        scripts: ['Gruntfile.js', 'app.js', 'lib/**/*.js', 'resource/js/**/*.js'],
+        tests: ['test/**/*.test.js'],
         styles: ['resource/css/*.scss'],
         all: []
       };
@@ -99,6 +100,18 @@ module.exports = function(grunt) {
       },
       all: paths.scripts
     },
+    mochaTest: {
+      all: {
+        src: ['test/**/*.test.js'],
+        options: {
+          globals: ['chai'],
+          require: ['test/bootstrap.js'],
+          timeout: 3000,
+          quiet: false,
+          clearRequireCache: true,
+        },
+      }
+    },
     watch: {
       css: {
         files: paths.styles,
@@ -108,6 +121,10 @@ module.exports = function(grunt) {
         files: paths.all,
         tasks: ['dev'],
       },
+      test: {
+        files: paths.all,
+        tasks: ['test'],
+      },
       default: {
         files: paths.all,
         tasks: ['default'],
@@ -121,10 +138,11 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-contrib-concat');
   grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-sass');
-
+  grunt.loadNpmTasks('grunt-mocha-test');
 
   // grunt watch dev
   grunt.registerTask('default', ['sass', 'concat', 'uglify']);
   grunt.registerTask('dev', ['sass:dev', 'concat', 'jshint']);
+  grunt.registerTask('test', ['mochaTest']);
 
 };

README.md

@@ -4,6 +4,8 @@ Crowi - The Simple & Powerful Communication Tool Based on Wiki
 
 [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 
+[![Circle CI](https://circleci.com/gh/crowi/crowi.svg?style=svg)](https://circleci.com/gh/crowi/crowi)
+
 
 Crowi is:
 

app.js

@@ -13,7 +13,7 @@ var express  = require('express')
   , facebook = require('facebook-node-sdk')
   , mongo    = require('mongoose')
   , socketio = require('socket.io')
-  , middleware = require('./lib/middlewares')
+  , middleware = require('./lib/util/middlewares')
   , time     = require('time')
   , async    = require('async')
   , session  = require('express-session')
@@ -74,18 +74,18 @@ app.use(express.logger());
 app.engine('html', cons.swig);
 app.set('view cache', false);
 app.set('view engine', 'html');
-app.set('views', __dirname + '/views');
+app.set('views', __dirname + '/lib/views');
 app.use(express.methodOverride());
 app.use(express.bodyParser());
 app.use(express.cookieParser());
 app.use(session(sessionConfig));
 app.use(flash());
 
-configModel = require('./models/config')(app);
+configModel = require('./lib/models/config')(app);
 
 async.series([
   function (next) {
-    configModel.getConfigArray(function(err, doc) {
+    configModel.loadAllConfig(function(err, doc) {
       app.set('config', doc);
 
       return next();
@@ -96,9 +96,9 @@ async.series([
       ;
 
 
-    app.set('mailer', require('./lib/mailer')(app));
+    app.set('mailer', require('./lib/util/mailer')(app));
 
-    models = require('./models')(app);
+    models = require('./lib/models')(app);
     models.Config = configModel;
 
     // configure application
@@ -190,7 +190,7 @@ async.series([
     });
 
     app.set('io', io);
-    require('./routes')(app);
+    require('./lib/routes')(app);
 
     next();
   }

circle.yml

@@ -0,0 +1,19 @@
+machine:
+  timezone: UTC
+  services:
+    - mongodb
+  environment:
+    MONGO_URI: mongodb://127.0.0.1/crowi_test
+deployment:
+  demo:
+    branch: master
+    heroku:
+      appname: crowi-demo
+  dev:
+    branch: /(master|wip-v.*)/
+    heroku:
+      appname: crowi-dev
+  strk:
+    branch: master
+    heroku:
+      appname: strk-wiki

config/default.js.dist

@@ -1,35 +0,0 @@
-/**
- * default config
- */
-
-module.exports = {
-  app: {
-    title: 'Crocos Wiki'
-  },
-  security: {
-    confidential: '',
-    passwordSeed: "j9a5gt", // please change here
-    registrationMode: 'Restricted', // Open, Restricted, Closed
-    registrationWhiteList: []
-  },
-  aws: {
-    bucket: 'crowi',
-    region: 'ap-northeast-1',
-    accessKeyId: '',
-    secretAccessKey: ''
-  },
-  searcher: {
-    url: 'https:// ...' // crocos-wikis
-  },
-  google: {
-    clientId: '',
-    clientSecret: ''
-  },
-  facebook: {
-    appId: '',
-    secret: ''
-  },
-  session: {
-    secret: 'please input here some string',
-  }
-}

form/admin/sec.js → lib/form/admin/sec.js

@@ -2,8 +2,8 @@
 
 var form = require('express-form')
   , field = form.field
-  , stringToArray = require('../../lib/formUtil').stringToArrayFilter
-  , normalizeCRLF = require('../../lib/formUtil').normalizeCRLFFilter
+  , stringToArray = require('../../util/formUtil').stringToArrayFilter
+  , normalizeCRLF = require('../../util/formUtil').normalizeCRLFFilter
   ;
 
 module.exports = form(

models/config.js → lib/models/config.js

@@ -141,7 +141,7 @@ module.exports = function(app) {
   {
   };
 
-  configSchema.statics.getConfigArray = function(callback)
+  configSchema.statics.loadAllConfig = function(callback)
   {
     var Config = this
       , config = {};

routes/index.js → lib/routes/index.js

@@ -1,5 +1,5 @@
 module.exports = function(app) {
-  var middleware = require('../lib/middlewares')
+  var middleware = require('../util/middlewares')
     , form      = require('../form')
     , page      = require('./page')(app)
     , login     = require('./login')(app)

routes/login.js → lib/routes/login.js

@@ -81,7 +81,7 @@ module.exports = function(app) {
   };
 
   actions.loginGoogle = function(req, res) {
-    var googleAuth = require('../lib/googleAuth')(app);
+    var googleAuth = require('../util/googleAuth')(app);
     var code = req.session.googleAuthCode || null;
 
     if (!code) {
@@ -134,7 +134,7 @@ module.exports = function(app) {
 
   actions.register = function(req, res) {
     var registerForm = req.form.registerForm || {};
-    var googleAuth = require('../lib/googleAuth')(app);
+    var googleAuth = require('../util/googleAuth')(app);
 
     // ログイン済みならさようなら
     if (req.user) {
@@ -258,7 +258,7 @@ module.exports = function(app) {
   };
 
   actions.registerGoogle = function(req, res) {
-    var googleAuth = require('../lib/googleAuth')(app);
+    var googleAuth = require('../util/googleAuth')(app);
     googleAuth.createAuthUrl(req, function(err, redirectUrl) {
       if (err) {
         // TODO

routes/me.js → lib/routes/me.js

@@ -12,7 +12,7 @@ module.exports = function(app) {
   actions.api = api;
 
   api.uploadPicture = function (req, res) {
-    var fileUploader = require('../lib/fileUploader')(app);
+    var fileUploader = require('../util/fileUploader')(app);
     var tmpFile = req.files.userPicture || null;
     if (!tmpFile) {
       return res.json({
@@ -164,7 +164,7 @@ module.exports = function(app) {
   };
 
   actions.authGoogle = function(req, res) {
-    var googleAuth = require('../lib/googleAuth')(app);
+    var googleAuth = require('../util/googleAuth')(app);
 
     var userData = req.user;
 
@@ -191,7 +191,7 @@ module.exports = function(app) {
   };
 
   actions.authGoogleCallback = function(req, res) {
-    var googleAuth = require('../lib/googleAuth')(app);
+    var googleAuth = require('../util/googleAuth')(app);
     var userData = req.user;
 
     googleAuth.handleCallback(req, function(err, tokenInfo) {

lib/middlewares.js → lib/util/middlewares.js

@@ -23,7 +23,7 @@ exports.loginChecker = function(app, models) {
 
 exports.swigFunctions = function(app) {
   return function(req, res, next) {
-    res.locals(require('../lib/swigFunctions')(app));
+    res.locals(require('../util/swigFunctions')(app));
     next();
   };
 };

package.json

@@ -12,6 +12,11 @@
   "contributors": [
     "Keisuke SATO <riaf@me.com> (http://riaf.jp)"
   ],
+  "config": {
+    "blanket": {
+      "pattern": "./lib/**/*.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/crowi/crowi.git"
@@ -34,13 +39,14 @@
     "express-session": "~1.9.3",
     "facebook-node-sdk": "=0.1.10",
     "googleapis": "=0.4.7",
-    "grunt": "~0.4.1",
+    "grunt": "~0.4.5",
     "grunt-cli": "~0.1.13",
     "grunt-contrib-concat": "~0.5.0",
     "grunt-contrib-jshint": "^0.10.0",
     "grunt-contrib-uglify": "~0.2.2",
     "grunt-contrib-watch": "~0.5.3",
-    "grunt-sass": "~0.14.1",
+    "grunt-mocha-test": "^0.12.7",
+    "grunt-sass": "~0.17.0",
     "mongoose": "=3.8.14",
     "mongoose-paginate": "~3.1.0",
     "nodemailer": "~1.2.2",
@@ -51,7 +57,14 @@
     "swig": "=1.3.2",
     "time": "=0.10.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "blanket": "^1.1.6",
+    "chai": "^1.10.0",
+    "mocha": "~2.1.0",
+    "proxyquire": "~1.3.0",
+    "sinon": "^1.12.2",
+    "sinon-chai": "^2.7.0"
+  },
   "license": [
     {
       "type": "MIT",
@@ -60,6 +73,7 @@
   ],
   "scripts": {
     "start": "node app.js",
+    "test": "./node_modules/.bin/grunt test",
     "postinstall": "./node_modules/.bin/bower cache clean && ./node_modules/.bin/bower install && ./node_modules/.bin/grunt"
   },
   "env": {

test/bootstrap.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var express = require('express')
+  , async = require('async')
+  , mongoose= require('mongoose')
+  , MODEL_DIR = __dirname + '/../lib/models'
+  , mongoUri
+  , testDBUtil
+  ;
+
+mongoUri = process.env.MONGOLAB_URI || process.env.MONGOHQ_URL || process.env.MONGO_URI || null;
+
+
+testDBUtil = {
+  generateFixture: function (conn, model, fixture, cb) {
+    var m = conn.model(model);
+    async.each(fixture, function(data, next) {
+      var newDoc = new m;
+
+      Object.keys(data).forEach(function(k) {
+        newDoc[k] = data[k];
+      });
+      newDoc.save(next);
+
+    }, function(err) {
+      cb();
+    });
+  },
+  cleanUpDb: function (conn, model, cb) {
+    if (!model) {
+      return cb(null, null);
+    }
+
+    var m = conn.model(model);
+    m.remove({}, cb);
+  },
+};
+
+global.express = express;
+global.mongoose = mongoose;
+global.mongoUri = mongoUri;
+global.MODEL_DIR = MODEL_DIR;
+global.testDBUtil = testDBUtil;

test/models/config.test.js

@@ -0,0 +1,78 @@
+var chai = require('chai')
+  , expect = chai.expect
+  , sinon = require('sinon')
+  , sinonChai = require('sinon-chai')
+  , proxyquire = require('proxyquire')
+  ;
+chai.use(sinonChai);
+
+describe('Config model test', function () {
+  var conn
+    , app = new express()
+    , Config = proxyquire(MODEL_DIR + '/config.js', {mongoose: mongoose})(app)
+    ;
+
+  before(function (done) {
+    if (mongoUri) {
+      // 基本的に mongoUri がセットされてたら、そのURIにはつながる前提
+      conn = mongoose.createConnection(mongoUri, function(err) {
+        if (err) {
+          done(); // ここで skip したいなあ
+        }
+
+        Config = conn.model('Config');
+        var fixture = [
+          {ns: 'crowi', key: 'test:test', value: JSON.stringify('crowi test value')},
+          {ns: 'crowi', key: 'test:test2', value: JSON.stringify(11111)},
+          {ns: 'crowi', key: 'test:test3', value: JSON.stringify([1, 2, 3, 4, 5])},
+          {ns: 'plugin', key: 'other:config', value: JSON.stringify('this is data')},
+        ];
+
+        testDBUtil.generateFixture(conn, 'Config', fixture, done);
+      });
+    }
+  });
+
+  beforeEach(function () {
+  });
+
+  after(function (done) {
+    if (mongoUri) {
+      testDBUtil.cleanUpDb(conn, 'Config', function(err, doc) {
+        conn.close();
+        done();
+      });
+    }
+  });
+
+  describe('.CONSTANTS', function () {
+    it('Config has constants', function() {
+      expect(Config.SECURITY_REGISTRATION_MODE_OPEN).to.have.string('Open');
+      expect(Config.SECURITY_REGISTRATION_MODE_RESTRICTED).to.have.string('Resricted');
+      expect(Config.SECURITY_REGISTRATION_MODE_CLOSED).to.have.string('Closed');
+    });
+  });
+
+  describe('.loadAllConfig', function () {
+    it('Get config array', function(done) {
+      Config.loadAllConfig(function(err, config) {
+
+        expect(config.crowi).to.be.an('Object');
+        expect(config.crowi).to.have.property('test:test')
+          .and.equal('crowi test value');
+        expect(config.crowi).to.have.property('test:test2')
+          .and.equal(11111);
+        expect(config.crowi).to.have.property('test:test3')
+          .and.to.be.instanceof(Array)
+          .and.deep.equal([1, 2, 3, 4, 5]);
+
+        expect(config.plugin).to.be.an('Object')
+          .and.have.property('other:config')
+          .and.equal('this is data');
+
+        done();
+      });
+    });
+  });
+});
+