a better way to test REST API

README.md

@@ -43,10 +43,11 @@ Models are declared by adding a `.json` model file in the `models/doctype` folde
 
 ```js
 const frappe = require('frappe-core');
-frappe.init();
+await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // sync all schema from `models` folders in all apps
-frappe.migrate();
+await frappe.migrate();
 ```
 
 ## Managing Documents
@@ -64,6 +65,7 @@ Documents are initialized with the `frappe.get_doc` method. If `doctype` and `na
 ```js
 const frappe = require('frappe-core');
 await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // make a new todo
 let todo = await frappe.get_doc({doctype: 'ToDo', subject: 'something'});
@@ -76,6 +78,7 @@ You can insert a document in the backend with the `insert` method.
 ```js
 const frappe = require('frappe-core');
 await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // make a new todo
 let todo = await frappe.get_doc({doctype: 'ToDo', subject: 'something'});
@@ -89,6 +92,7 @@ You can read a document from the backend with the `frappe.get_doc` method
 ```js
 const frappe = require('frappe-core');
 await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // get all open todos
 let todos = await frappe.db.get_all('ToDo', ['name'], {status: "Open"});
@@ -102,6 +106,7 @@ The `update` method updates a document.
 ```js
 const frappe = require('frappe-core');
 await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // get all open todos
 let todos = await frappe.db.get_all('ToDo', ['name'], {status: "Open"});
@@ -118,6 +123,7 @@ The `delete` method deletes a document.
 ```js
 const frappe = require('frappe-core');
 await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 // get all open todos
 let todos = await frappe.db.get_all('ToDo', ['name'], {status: "Open"});
@@ -132,7 +138,8 @@ Metadata are first class objects in Frappe. You can get a metadata object by `fr
 
 ```js
 const frappe = require('frappe-core');
-frappe.init();
+await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 let todo_meta = frappe.get_meta('ToDo');
 
@@ -189,7 +196,8 @@ You can also directly write SQL with `frappe.db.sql`
 
 ```js
 const frappe = require('frappe-core');
-frappe.init();
+await frappe.init();
+await frappe.init_db('sqlite', {db_path: 'test.db'});
 
 all_todos = frappe.db.sql('select name from todo');
 ```

frappe/app.js

@@ -1,6 +1,11 @@
 const app = require('express')();
 const frappe = require('frappe-core');
 
-// setup frappe REST routes
+async function start() {
-frappe.init({app:app}).then(frappe.start());
+	await frappe.init();
+	await frappe.init_db('sqlite', {db_path: 'test.db'});
+	await frappe.init_app(app);
+	await frappe.start();
+}
 
+start();

frappe/backends/sqlite.js

@@ -1,18 +1,18 @@
 const frappe = require('frappe-core');
 const sqlite3 = require('sqlite3').verbose();
 
-class SQLLiteDatabase {
+class sqliteDatabase {
-	constructor(db_name) {
+	constructor({db_path}) {
-		this.conn_name = db_name;
+		this.db_path = db_path;
 		this.init_type_map();
 	}
 
-	connect(db_name) {
+	connect(db_path) {
-		if (db_name) {
+		if (db_path) {
-			this.conn_name = db_name;
+			this.db_path = db_path;
 		}
 		return new Promise(resolve => {
-			this.conn = new sqlite3.Database(this.conn_name, () => {
+			this.conn = new sqlite3.Database(this.db_path, () => {
 				resolve();
 			});
 		});
@@ -211,4 +211,4 @@ class SQLLiteDatabase {
 
 }
 
-module.exports = { Database: SQLLiteDatabase };
+module.exports = { Database: sqliteDatabase };

frappe/index.js

@@ -2,21 +2,21 @@ const path = require('path');
 const bodyParser = require('body-parser');
 
 module.exports = {
-	async init({db_name ='test.db', user, user_key, for_test} = {}) {
+	async init() {
-		this.db_name = db_name;
 		if (this._initialized) return;
 		this.init_config();
 		this.init_errors();
 		this.init_globals();
 		this.init_libs();
-		await this.init_db();
 		this._initialized = true;
-		this.login(user, user_key);
+
+		// login as guest
+		this.login();
 	},
 
 	init_config() {
 		this.config = {
-			backend: 'sqllite'
+			backend: 'sqlite'
 		};
 	},
 
@@ -56,10 +56,20 @@ module.exports = {
 		this.server = this.app.listen(port);
 	},
 
-	async init_db() {
+	async init_db(db_type, options) {
-		let database = require('./backends/' + this.config.backend);
+		var Database;
-		this.db = new database.Database(this.db_name);
+		switch (db_type) {
-		await this.db.connect(this.db_name);
+			case 'sqlite':
+				Database = require('./backends/sqlite').Database;
+				break;
+			case 'rest':
+				Database = require('./backends/rest_client').Database;
+				break;
+			default:
+				throw new Error(`${db_type} is not a supported database type`);
+		}
+		this.db = new Database(options);
+		await this.db.connect();
 	},
 
 	get_meta(doctype) {
@@ -86,7 +96,7 @@ module.exports = {
 		return await doc.insert();
 	},
 
-	login(user, user_key) {
+	login(user='guest', user_key) {
 		this.session = new this.session_lib.Session(user);
 		if (user && user_key) {
 			this.login(user_key);
@@ -95,6 +105,9 @@ module.exports = {
 
 	close() {
 		this.db.close();
-		this.server.close();
+
+		if (this.server) {
+			this.server.close();
+		}
 	}
 };

frappe/rest_server.js

@@ -19,13 +19,13 @@ module.exports = {
 			return response.json(doc.get_valid_dict());
 		});
 
-		// get list
+		// get document
 		app.get('/api/resource/:doctype/:name', async function(request, response) {
 			let data = await frappe.get_doc(request.params.doctype, request.params.name).get_valid_dict();
 			return response.json(data);
 		});
 
-		// get list
+		// delete
 		app.delete('/api/resource/:doctype/:name', async function(request, response) {
 			let data = await frappe.get_doc(request.params.doctype, request.params.name).delete();
 			return response.json(data);

frappe/tests/helpers.js

@@ -0,0 +1,9 @@
+const frappe = require('frappe-core');
+
+module.exports = {
+	async init_sqlite() {
+		await frappe.init();
+		await frappe.init_db('sqlite', {db_path: 'test.db'});
+		await frappe.db.migrate();
+	}
+}

frappe/tests/test_controller.js

@@ -1,10 +1,10 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
+const helpers = require('./helpers');
 
 describe('Controller', () => {
 	before(async function() {
-		await frappe.init();
+		await helpers.init_sqlite();
-		await frappe.db.migrate();
 	});
 
 	it('should call controller method', async () => {

frappe/tests/test_database.js

@@ -1,10 +1,10 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
+const helpers = require('./helpers');
 
 describe('Database', () => {
 	before(async function() {
-		await frappe.init();
+		await helpers.init_sqlite();
-		await frappe.db.migrate();
 	});
 
 	it('should insert and get values', async () => {

frappe/tests/test_document.js

@@ -1,10 +1,10 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
+const helpers = require('./helpers');
 
 describe('Document', () => {
 	before(async function() {
-		await frappe.init();
+		await helpers.init_sqlite();
-		await frappe.db.migrate();
 	});
 
 	it('should insert a doc', async () => {

frappe/tests/test_meta.js

@@ -1,10 +1,10 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
+const helpers = require('./helpers');
 
 describe('Meta', () => {
 	before(async function() {
-		await frappe.init();
+		await helpers.init_sqlite();
-		await frappe.db.migrate();
 	});
 
 	it('should get init from json file', () => {

frappe/tests/test_models.js

@@ -1,10 +1,10 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
+const helpers = require('./helpers');
 
 describe('Models', () => {
 	before(async function() {
-		await frappe.init();
+		await helpers.init_sqlite();
-		await frappe.db.migrate();
 	});
 
 	it('should get todo json', () => {

frappe/tests/test_rest_api.js

@@ -1,22 +1,33 @@
 const assert = require('assert');
 const frappe = require('frappe-core');
 const fetch = require('node-fetch');
+const helpers = require('./helpers');
+const { spawn } = require('child_process');
+const process = require('process');
 
-describe('Models', () => {
+// create a copy of frappe
+
+var test_server;
+
+describe('REST', () => {
 	before(async function() {
-		var app = require('express')();
+		await helpers.init_sqlite();
-		await frappe.init();
+		test_server = spawn('node', ['frappe/tests/test_server.js'], {
-		frappe.init_app(app);
+			stdio: [0, 'pipe', 'pipe' ]
-		await frappe.start();
+		});
+
+		// wait for server to start
+		await frappe.sleep(1);
 	});
 
 	after(() => {
 		frappe.close();
+		test_server.kill();
 	});
 
 	it('should create a document', async () => {
 		let res = await fetch('http://localhost:8000/api/resource/todo', {
-			method: 'post',
+			method: 'POST',
 			headers: {
 			  'Accept': 'application/json',
 			  'Content-Type': 'application/json'
@@ -29,9 +40,8 @@ describe('Models', () => {
 	});
 
 	// it('should create a document with rest backend', async () => {
-	// 	frappe.set_backend('rest', {
+
-	// 		server: 'http://localhost:8000'
+	// 	frappe.init_db('rest', { server: 'http://localhost:8000' });
-	// 	});
 
 	// 	let doc = await frappe.get_doc({doctype: 'ToDo', subject: 'test rest backend 1'});
 	// 	await doc.insert();

frappe/tests/test_server.js

@@ -0,0 +1,14 @@
+const app = require('express')();
+const frappe = require('frappe-core');
+
+async function start_server() {
+	console.log('Starting test server...');
+	await frappe.init();
+	await frappe.init_db('sqlite', {db_path: 'test.db'});
+	await frappe.init_app(app);
+	await frappe.start();
+}
+
+if (require.main === module) {
+	start_server();
+}

frappe/utils.js

@@ -19,5 +19,10 @@ module.exports = {
 			// number
 			return value + '';
 		}
+	},
+	async sleep(seconds) {
+		return new Promise(resolve => {
+			setTimeout(resolve, seconds * 1000);
+		});
 	}
 }

package.json

@@ -12,7 +12,6 @@
     "express": "^4.16.2",
     "node-fetch": "^1.7.3",
     "nodemon": "^1.14.7",
-    "sql.js": "^0.4.0",
     "sqlite3": "^3.1.13",
     "walk": "^2.3.9"
   },