Setup (and fix) tests to run against Postgres as well as MySQL. Issue #59

Author: techniq

README.md

@@ -78,6 +78,40 @@ the first place
     - `DB_HOST`: `localhost`
     - `DB_NAME`: `circle_test`
     - `DB_USER`: `ubuntu`
+  - You may use `docker`/`docker-compose` to create MySql and Postgres containers to test against
+    - `docker-compose up -d`
+      - Start containers named `js-data-sql-mysql` and `js-data-sql-pg`
+    - MySQL
+      - Environment variables
+        - `DB_CLIENT` = `mysql` 
+        - `DB_USER` = `root`
+        - `DB_HOST` = `IP of docker-machine if not localhost`
+      - Populate schema
+        - `DB_CLIENT=mysql DB_USER=root npm run migrate-db`
+        - Also set `DB_HOST` if different from `localhost`
+      - Run tests
+      - `npm run mocha-mysql`
+        - Set `DB_HOST` if different from `localhost`
+      - Run cli
+        - `docker exec -it js-data-sql-mysql mysql circle_test`
+    - Postgres
+      - Environment variables
+        - `DB_CLIENT` = `pg` 
+        - `DB_USER` = `ubuntu`
+        - `DB_HOST` = `IP of docker-machine if not localhost`
+      - Populate schema
+        - `DB_CLIENT=pg npm run migrate-db`
+        - Also set `DB_HOST` if different from `localhost`
+      - Run tests
+        - `npm run mocha-pg`
+        - Also set `DB_HOST` if different from `localhost`
+      - `docker exec -it js-data-sql-pg psql -U ubuntu -d circle_test`
+        - Run cli
+    - All databases
+      - Run all tests against MySQL and Postgres
+        - `npm run mocha-all`
+        - Also set `DB_HOST` if different from `localhost`
+        
 1. Your code will be linted and checked for formatting, the tests will be run
 1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They
 will be committed when a release is cut.

circle.yml

@@ -4,7 +4,8 @@ machine:
 
 database:
   override:
-    - mysql -u ubuntu circle_test < test/setup.sql
+    - DB_CLIENT=mysql npm run migrate-db
+    - DB_CLIENT=pg npm run migrate-db
 test:
   override:
     - npm run ci

docker-compose.yml

@@ -0,0 +1,20 @@
+mysql:
+  image: mysql:5.6.28
+  container_name: 'js-data-sql-mysql'
+  environment: 
+  - MYSQL_DATABASE=circle_test
+  # - MYSQL_USER=ubuntu
+  # - MYSQL_PASSWORD=
+  - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+  ports:
+    - "3306:3306"
+    
+postgres:
+  image: postgres:9.4.5
+  container_name: 'js-data-sql-pg'
+  ports:
+    - "5432:5432"
+  environment: 
+  - POSTGRES_DB=circle_test
+  - POSTGRES_USER=ubuntu
+

mocha.start.js

@@ -29,12 +29,16 @@ for (var key in globals) {
 test.globals(testGlobals);
 
 var config = {
-  client: 'mysql',
+  client: process.env.DB_CLIENT || 'mysql',
   connection: {
     host: process.env.DB_HOST || 'localhost',
     user: process.env.DB_USER || process.env.C9_USER || 'ubuntu',
     database: process.env.DB_NAME || (process.env.C9_USER ? 'c9' : 'circle_test')
   },
+  pool: {
+    min: 0,
+    max: 10
+  },
   debug: process.env.DEBUG || false
 };
 

package.json

@@ -28,10 +28,16 @@
   "scripts": {
     "lint": "standard src/index.js",
     "build": "webpack --config webpack.config.js --progress --colors",
-    "mocha": "mocha --timeout 20000 --reporter dot mocha.start.js test/*.spec.js",
+    "mocha-mysql": "DB_CLIENT=mysql DB_USER=root mocha --timeout 20000 --reporter dot mocha.start.js test/*.spec.js",
+    "mocha-pg": "DB_CLIENT=pg mocha --timeout 20000 --reporter dot mocha.start.js test/*.spec.js",
+    "mocha-all": "npm run mocha-mysql && npm run mocha-pg",
     "cover": "istanbul cover --hook-run-in-context node_modules/mocha/bin/_mocha -- --timeout 20000 --reporter dot mocha.start.js test/*.spec.js",
     "test": "npm run lint && npm run build && npm run cover",
-    "ci": "npm run test && cat coverage/lcov.info | coveralls || true && cat ./coverage/lcov.info | codacy-coverage || true"
+    "ci": "npm run test && cat coverage/lcov.info | coveralls || true && cat ./coverage/lcov.info | codacy-coverage || true",
+    
+    "create-migration": "knex --cwd=test migrate:make",
+    "migrate-db": "knex --cwd=test migrate:latest",
+    "rollback-db": "knex --cwd=test migrate:rollback"
   },
   "standard": {
     "parser": "babel-eslint"

src/index.js

@@ -314,17 +314,17 @@ class DSSqlAdapter {
                 }
               } else if (relation.type === 'hasMany') {
                 // Perform `WHERE EXISTS` subquery for hasMany property
-                let table = getTable(localResourceConfig)
-                let localId = `${table}.${localResourceConfig.idAttribute}`
-
-                let relationTable = getTable(relationResourceConfig)
-                let foreignId = `${relationTable}.${relation.foreignKey}`
-
                 let existsParams = {
-                  [foreignId]: {'===': knex.raw(localId)},
                   [parts[0]]: criteria
                 };
-                query.whereExists(this.filterQuery(relationResourceConfig, existsParams, options));
+                let subQuery = this.filterQuery(relationResourceConfig, existsParams, options)
+                  .whereRaw('??.??=??.??', [
+                    getTable(relationResourceConfig),
+                    relation.foreignKey,
+                    getTable(localResourceConfig),
+                    localResourceConfig.idAttribute
+                  ])
+                query.whereExists(subQuery);
                 criteria = null; // criteria handled by EXISTS subquery
               }
 

test/filterQuery.spec.js

@@ -2,60 +2,100 @@ describe('DSSqlAdapter#filterQuery', function () {
 
   it('should use built-in query if no custom query provided', function* () {
     var filterQuery = adapter.filterQuery(User);
-    assert.equal(filterQuery.toString(), 'select `user`.* from `user`')
+    var expectedQuery = adapter.query
+      .from('user')
+      .select('user.*')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should use custom query if passed as params (second parameter)', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, query);
-    assert.equal(filterQuery.toString(), 'select * from `test`')
+    var expectedQuery = adapter.query
+      .from('test')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should use custom query if passed as options.query', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, null, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test`')
+    var expectedQuery = adapter.query
+      .from('test')
+    
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should apply where from params to custom query', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { name: 'Sean' }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` where `name` = \'Sean\'')
+    var expectedQuery = adapter.query
+      .from('test')
+      .where({name: 'Sean'})
+    
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should apply limit from params to custom query', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { limit: 2 }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` limit 2')
+    var expectedQuery = adapter.query
+      .from('test')
+      .limit(2)
+    
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should apply order from params to custom query', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { orderBy: 'name' }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` order by `name` asc')
+    var expectedQuery = adapter.query
+      .from('test')
+      .orderBy('name', 'asc')
+    
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should convert == null to IS NULL', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { name: { '==' : null } }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` where `name` is null')
+    var expectedQuery = adapter.query
+      .from('test')
+      .whereNull('name')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should convert != null to IS NOT NULL', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { name: { '!=' : null } }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` where `name` is not null')
+    var expectedQuery = adapter.query
+      .from('test')
+      .whereNotNull('name')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should convert |== null to OR field IS NULL', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { name: 'Sean', age: { '|==' : null } }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` where `name` = \'Sean\' or `age` is null')
+    var expectedQuery = adapter.query
+      .from('test')
+      .where('name', 'Sean')
+      .orWhereNull('age')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 
   it('should convert |!= null to OR field IS NOT NULL', function* () {
     var query = adapter.query.from('test');
     var filterQuery = adapter.filterQuery(User, { name: 'Sean', age: { '|!=' : null } }, { query });
-    assert.equal(filterQuery.toString(), 'select * from `test` where `name` = \'Sean\' or `age` is not null')
+    var expectedQuery = adapter.query
+      .from('test')
+      .where('name', 'Sean')
+      .orWhereNotNull('age')
+      
+    assert.equal(filterQuery.toString(), expectedQuery.toString())
   });
 });

test/findAll.spec.js

@@ -60,10 +60,10 @@ describe('DSSqlAdapter#findAll', function () {
     let post6 = yield adapter.create(Post, {userId: user3.id, content: 'bar'});
     let post7 = yield adapter.create(Post, {userId: user3.id, content: 'baz'});
 
-    let users = yield adapter.findAll(User, {where: {'post.content': {'==': 'foo'} }});
+    let users = yield adapter.findAll(User, {where: {'post.content': {'==': 'foo'} }, orderBy: 'name'});
     assert.equal(users.length, 2);
-    assert.equal(users[0].name, 'Sean');
-    assert.equal(users[1].name, 'Jason');
+    assert.equal(users[0].name, 'Jason');
+    assert.equal(users[1].name, 'Sean');
   });
 
   it("should filter using a hasMany relation's localField", function* () {
@@ -80,10 +80,10 @@ describe('DSSqlAdapter#findAll', function () {
     let post6 = yield adapter.create(Post, {userId: user3.id, content: 'bar'});
     let post7 = yield adapter.create(Post, {userId: user3.id, content: 'baz'});
 
-    let users = yield adapter.findAll(User, {where: {'posts.content': {'==': 'foo'} }});
+    let users = yield adapter.findAll(User, {where: {'posts.content': {'==': 'foo'} }, orderBy: 'name'});
     assert.equal(users.length, 2);
-    assert.equal(users[0].name, 'Sean');
-    assert.equal(users[1].name, 'Jason');
+    assert.equal(users[0].name, 'Jason');
+    assert.equal(users[1].name, 'Sean');
   });
 
   describe('near', function () {

test/knexfile.js

@@ -0,0 +1,12 @@
+module.exports = {
+  client: process.env.DB_CLIENT || 'mysql',
+  connection: {
+    host: process.env.DB_HOST || 'localhost',
+    database: process.env.DB_NAME || 'circle_test',
+    user: process.env.DB_USER || 'ubuntu'
+  },
+  migrations: {
+    tableName: 'migrations'
+  },
+  debug: process.env.DEBUG || false
+}

test/migrations/20160124161805_initial_schema.js

@@ -0,0 +1,62 @@
+
+exports.up = function(knex, Promise) {
+
+  return knex.schema
+    .createTable('profile', function (table) {
+      table.increments('id').primary();
+      table.string('email');
+    })
+    
+    .createTable('address', function (table) {
+      table.increments('id').primary();
+      table.string('name');
+      table.decimal('latitude', 10, 7)
+      table.decimal('longitude', 10, 7)
+    })
+    
+    .createTable('user', function (table) {
+      table.increments('id').primary();
+      table.string('name');
+      table.integer('age').unsigned();
+      
+      table.integer('profileId')
+        .unsigned()
+        .references('profile.id');
+        
+      table.integer('addressId')
+        .unsigned()
+        .references('address.id');
+    })
+    
+    .createTable('post', function (table) {
+      table.increments('id').primary();
+      table.text('content');
+      
+      table.integer('userId')
+        .unsigned()
+        .references('user.id');
+    })
+    
+    .createTable('comment', function (table) {
+      table.increments('id').primary();
+      table.text('content');
+      
+      table.integer('userId')
+        .unsigned()
+        .references('user.id');
+        
+      table.integer('postId')
+        .unsigned()
+        .references('post.id');
+    })
+};
+
+exports.down = function(knex, Promise) {
+  return knex.schema
+    .dropTableIfExists('comment')
+    .dropTableIfExists('post')
+    .dropTableIfExists('user')
+    .dropTableIfExists('address')
+    .dropTableIfExists('profile')
+  ;
+};