GPII-1987: Implement data loaders to load preferences and authorization test data into CouchDB

scripts/README.md

@@ -0,0 +1,83 @@
+This directory contains these scripts:
+
+* **browserifyTestDependency.js**: To browserify test dependencies required for running some web tests.
+* **dataLoader-auth.js**: To load authorization test data into CouchDB.
+* **dataLoader-prefs.js**: To load preferences test data into CouchDB.
+
+## Browserify Test Dependencies:
+
+**Script name:** `browserifyTestDependency.js`
+
+This script runs as a npm postinstall step to browserify some node modules that are required for running a few web tests. The creation of this script is to work around the issue that some of these node modules are only pulled in as `devDependencies`(see [GPII package.json](../package.json)), which means the browserifying should only occurs when GPII runs in the development mode. This script ensures the present of these node modules before proceeding with the browserifying. It prevents the failure of running `npm install` when setting up GPII in the production mode.
+
+To start this script, run the following command in the `universal` directory:
+
+```
+node scripts/browserifyTestDependency.js
+```
+
+## Data Loaders
+
+Data loaders are used for setting up GPII production environment by loading authorization and/or preferences test data into CouchDB. See [Data Loader issue ticket](https://issues.gpii.net/browse/GPII-1987) for details.
+
+### Preferences Data Loader
+
+**Script name:** `dataLoader-prefs.js`
+
+Preferences Data Loader reads all json files from the given directory. Each json file is loaded as a individual CouchDB document with its file name as the corresponding document id.
+
+To start the data loading, run the following command in the `universal` directory:
+
+```
+node scripts/dataLoader-prefs.js
+```
+
+#### How to config Preferences Data Loader
+
+`dataLoader-prefs.js` instantiates the infusion component `gpii.dataLoader.prefsDataLoader`  to load preferences data.
+
+#### Component Options
+
+| Option            | Type       | Description | Default |
+| ----------------- | ---------- | ----------- | ------- |
+| `dbName` | String | Required. The name of the CouchDB database to be created for loading preferences data. If the dabase already exists, delete it and recreate. | preferences |
+| `dataPath` | String | Required. The directory where all preference json files reside. | %universal/testData/preferences/ |
+| `couchDbUrl` | String | Required. The URL to the CouchDB. | http://localhost:5984 |
+
+#### Supported Events
+
+| Event | Description | Parameters | Parameters Description |
+| ----- | ----------- | ---------- | ---------------------- |
+| `onDataLoaded` | Fires when all preference data has been loaded into the CouchDB. | None |  |
+| `onDataLoadedError` | Fires when an error occurs at loading preference data. | errorMsg | The error message. |
+
+### Authorization Data Loader
+
+**Script name:** `dataLoader-auth.js`
+
+Authorization Data Loader reads given json files from the file system and load them into CouchDB as they are.
+
+To start the data loading, run the following command in the `universal` directory:
+
+```
+node scripts/dataLoader-auth.js
+```
+
+#### How to config Authorization Data Loader
+
+`dataLoader-auth.js` instantiates the infusion component `gpii.dataLoader.authDataLoader`  to load authorization data. 
+
+#### Component Options
+
+| Option            | Type       | Description | Default |
+| ----------------- | ---------- | ----------- | ------- |
+| `dbName` | String | Required. The name of the CouchDB database to be created for loading authorization data. If the dabase already exists, delete it and recreate. | auth |
+| `dataFile` | Array | Required. An array of data files to be loaded. | ["%universal/testData/security/TestOAuth2DataStore.json", "%universal/gpii/node_modules/gpii-oauth2/gpii-oauth2-datastore/dbViews/views.json"] |
+| `couchDbUrl` | String | Required. The URL to the CouchDB. | `http://localhost:5984` |
+
+#### Supported Events
+
+| Event | Description | Parameters | Parameters Description |
+| ----- | ----------- | ---------- | ---------------------- |
+| `onDataLoaded` | Fires when all preference data has been loaded into the CouchDB. | None |  |
+| `onDataLoadedError` | Fires when an error occurs at loading preference data. | errorMsg | The error message. |

scripts/dataLoader-auth.js

@@ -0,0 +1,36 @@
+/*!
+Copyright 2016-2017 OCAD University
+
+Licensed under the New BSD license. You may not use this file except in
+compliance with this License.
+
+The research leading to these results has received funding from the European Union's
+Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 289016.
+
+You may obtain a copy of the License at
+https://github.com/GPII/universal/blob/master/LICENSE.txt
+*/
+
+/**
+ * The data loader to load GPII authorization server data into CouchDB.
+ * Before running this script, make sure CouchDB is started and ready for handling
+ * database operation requests.
+ */
+
+"use strict";
+
+var fluid = require("infusion"),
+    gpii = fluid.registerNamespace("gpii");
+
+fluid.setLogging(true);
+
+require("./shared/authDataLoader.js");
+
+gpii.dataLoader.authDataLoader({
+    dbName: "auth",
+    dataFile: [
+        "%universal/testData/security/TestOAuth2DataStore.json",
+        "%universal/gpii/node_modules/gpii-oauth2/gpii-oauth2-datastore/dbViews/views.json"
+    ],
+    couchDbUrl: "http://localhost:5984"
+});

scripts/dataLoader-prefs.js

@@ -0,0 +1,33 @@
+/*!
+Copyright 2016-2017 OCAD University
+
+Licensed under the New BSD license. You may not use this file except in
+compliance with this License.
+
+The research leading to these results has received funding from the European Union's
+Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 289016.
+
+You may obtain a copy of the License at
+https://github.com/GPII/universal/blob/master/LICENSE.txt
+*/
+
+/**
+ * The data loader to load GPII preferences data into CouchDB.
+ * Before running this script, make sure CouchDB is started and ready for handling
+ * database operation requests.
+ */
+
+"use strict";
+
+var fluid = require("infusion"),
+    gpii = fluid.registerNamespace("gpii");
+
+fluid.setLogging(true);
+
+require("./shared/prefsDataLoader.js");
+
+gpii.dataLoader.prefsDataLoader({
+    dbName: "preferences",
+    dataPath: "%universal/testData/preferences/",
+    couchDbUrl: "http://localhost:5984"
+});

scripts/shared/authDataLoader.js

@@ -0,0 +1,48 @@
+/*!
+Copyright 2017 OCAD University
+
+Licensed under the New BSD license. You may not use this file except in
+compliance with this License.
+
+The research leading to these results has received funding from the European Union's
+Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 289016.
+
+You may obtain a copy of the License at
+https://github.com/GPII/universal/blob/master/LICENSE.txt
+*/
+
+"use strict";
+
+var fluid = require("infusion"),
+    gpii = fluid.registerNamespace("gpii");
+
+require("./dataLoader.js");
+
+fluid.defaults("gpii.dataLoader.authDataLoader", {
+    gradeNames: ["gpii.dataLoader", "gpii.dataLoader.reporter"],
+    databases: {
+        expander: {
+            funcName: "gpii.dataLoader.authDataLoader.constructAuthData",
+            args: ["{that}.options.dbName", "{that}.options.dataFile"]
+        }
+    },
+    listeners: {
+        "onCreate.load": {
+            listener: "gpii.dataLoader.performLoad",
+            args: ["{that}.options.dbName", "{that}"]
+        }
+    }
+});
+
+/**
+ * Construct the value of `options.databases` that to be accepted by `gpii.dataLoader` (See dataLoader.js).
+ *
+ * @param dbName {String} The database name;
+ * @param dataFile {Array} An array of data paths to files to be loaded into the database.
+ */
+gpii.dataLoader.authDataLoader.constructAuthData = function (dbName, dataFile) {
+    var togo = {};
+    fluid.set(togo, dbName + ".dataFile", dataFile);
+
+    return togo;
+};