Update database authentication method to resolve issue with special characters (apache#155)

* Add intellij to .gitginore
* Fix database authentication issue with special characters
* Update script for deploying catalog

Author: KeonHee

.gitignore

@@ -7,6 +7,12 @@ action/*.zip
 action/package.json
 package-lock.json
 
+# IntelliJ
+.idea
+*.class
+*.iml
+out/
+
 # Eclipse
 bin/
 **/.project

action/alarmWebAction.js

@@ -148,7 +148,7 @@ function main(params) {
         return new Promise(function (resolve, reject) {
             common.verifyTriggerAuth(triggerData, false)
             .then(() => {
-                db = new Database(params.DB_URL, params.DB_NAME);
+                db = new Database(params.DB_URL, params.DB_NAME, params.DB_USERNAME, params.DB_PASSWORD);
                 return db.getWorkerID(workers);
             })
             .then((worker) => {
@@ -174,7 +174,7 @@ function main(params) {
         return new Promise(function (resolve, reject) {
             common.verifyTriggerAuth(triggerData, false)
             .then(() => {
-                db = new Database(params.DB_URL, params.DB_NAME);
+                db = new Database(params.DB_URL, params.DB_NAME, params.DB_USERNAME, params.DB_PASSWORD);
                 return db.getTrigger(triggerID);
             })
             .then(doc => {
@@ -224,7 +224,7 @@ function main(params) {
 
             common.verifyTriggerAuth(triggerData, false)
             .then(() => {
-                db = new Database(params.DB_URL, params.DB_NAME);
+                db = new Database(params.DB_URL, params.DB_NAME, params.DB_USERNAME, params.DB_PASSWORD);
                 return db.getTrigger(triggerID);
             })
             .then(trigger => {
@@ -342,7 +342,7 @@ function main(params) {
         return new Promise(function (resolve, reject) {
             common.verifyTriggerAuth(triggerData, true)
             .then(() => {
-                db = new Database(params.DB_URL, params.DB_NAME);
+                db = new Database(params.DB_URL, params.DB_NAME, params.DB_USERNAME, params.DB_PASSWORD);
                 return db.getTrigger(triggerID);
             })
             .then(trigger => {

action/lib/Database.js

@@ -18,8 +18,8 @@
 const common = require('./common');
 
 // constructor for DB object - a thin, promise-loving wrapper around nano
-module.exports = function(dbURL, dbName) {
-    var nano = require('nano')(dbURL);
+module.exports = function(dbURL, dbName, dbUsername, dbPassword) {
+    var nano = require('nano')(common.createUrl(dbURL, dbUsername, dbPassword));
     this.db = nano.db.use(dbName);
     var utilsDB = this;
 

action/lib/common.js

@@ -138,12 +138,21 @@ function constructObject(data, isPayload) {
     return jsonObject;
 }
 
+function createUrl(url, username, password) {
+    if (username && password) {
+      var urlComponents = url.split('://');
+      return urlComponents[0] + '://' + encodeURIComponent(username) + ':' + encodeURIComponent(password) + '@' + urlComponents[1];
+    } else {
+      return url;
+    }
+}
 
 module.exports = {
     'requestHelper': requestHelper,
     'createWebParams': createWebParams,
     'verifyTriggerAuth': verifyTriggerAuth,
     'parseQName': parseQName,
     'sendError': sendError,
-    'constructObject': constructObject
+    'constructObject': constructObject,
+    'createUrl': createUrl
 };

installCatalog.sh

@@ -20,25 +20,38 @@
 # use the command line interface to install standard actions deployed
 # automatically
 #
-# To run this command
-# ./installCatalog.sh <authkey> <edgehost> <dburl> <dbprefix> <apihost> <workers>
+# If the authentication information in your database contains special characters that require encoding,
+# run the script in the following format:
+# ./installCatalog.sh <authkey> <edgehost> <apihost> <workers> <dburl> <dbprefix> <dbusername> <dbpassword>
+#
+# Otherwise, run it in the following format:
+# ./installCatalog.sh <authkey> <edgehost> <apihost> <workers> <dburl> <dbprefix>
 
 set -e
 set -x
 
 : ${OPENWHISK_HOME:?"OPENWHISK_HOME must be set and non-empty"}
 WSK_CLI="$OPENWHISK_HOME/bin/wsk"
 
-if [ $# -eq 0 ]; then
-    echo "Usage: ./installCatalog.sh <authkey> <edgehost> <dburl> <dbprefix> <apihost> <workers>"
+
+if [ $# -ne 6 ] && [ $# -ne 8 ]; then
+    echo "
+If the authentication information in your database contains special characters that require encoding,
+run the script in the following format:
+./installCatalog.sh <authkey> <edgehost> <apihost> <workers> <dburl> <dbprefix> <dbusername> <dbpassword>
+ Otherwise, run it in the following format:
+./installCatalog.sh <authkey> <edgehost> <apihost> <workers> <dburl> <dbprefix>"
+    exit 1
 fi
 
 AUTH="$1"
 EDGEHOST="$2"
-DB_URL="$3"
-DB_NAME="${4}alarmservice"
-APIHOST="$5"
-WORKERS="$6"
+APIHOST="$3"
+WORKERS="$4"
+DB_URL="$5"
+DB_NAME="${6}alarmservice"
+DB_USERNAME="$7"
+DB_PASSWORD="$8"
 LIMIT_CRON_FIELDS="${LIMIT_CRON_FIELDS}"
 ACTION_RUNTIME_VERSION=${ACTION_RUNTIME_VERSION:="nodejs:10"}
 
@@ -104,6 +117,11 @@ COMMAND=" -i --apihost $EDGEHOST package update --auth $AUTH --shared no alarmsW
     -p DB_NAME $DB_NAME \
     -p apihost $APIHOST"
 
+if [ -n "$DB_USERNAME" ] && [ -n "$DB_PASSWORD" ]; then
+    COMMAND+=" -p DB_USERNAME $DB_USERNAME"
+    COMMAND+=" -p DB_PASSWORD $DB_PASSWORD"
+fi
+
 if [ -n "$WORKERS" ]; then
     COMMAND+=" -p workers $WORKERS"
 fi

provider/app.js

@@ -66,7 +66,7 @@ function createDatabase() {
     var method = 'createDatabase';
     logger.info(method, 'creating the trigger database');
 
-    var nano = require('nano')(dbProtocol + '://' + dbUsername + ':' + dbPassword + '@' + dbHost);
+    var nano = require('nano')(dbProtocol + '://' + encodeURIComponent(dbUsername) + ':' + encodeURIComponent(dbPassword) + '@' + dbHost);
 
     if (nano !== null) {
         return new Promise(function (resolve, reject) {