test(Provider): Wrote some tests, testing integration with travisCi

Author: Cvmcosta

.eslintrc.json

@@ -2,7 +2,8 @@
     "env": {
         "commonjs": true,
         "es6": true,
-        "node": true
+        "node": true,
+        "mocha": true
     },
     "extends": "eslint:recommended",
     "globals": {

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+node_js:
+  - "10"
+services: mongodb
+cache:
+  directories:
+  - node_modules
+before_script:
+  - sleep 15
+  - mongo mydb_test --eval 'db.createUser({user:"travis",pwd:"test",roles:["readWrite"]});'
+jobs:
+  include:
+    - stage: "Testing"
+      script: npm test
+      if: branch = master

dist/Provider/Provider.js

@@ -227,12 +227,12 @@ class Provider {
         let isApiRequest = false;
         let cookies = req.signedCookies; // Validate issuer_code to see if its a route or normal request
 
-        if (issuer.search('plat') === -1) isApiRequest = true;
+        if (issuer.indexOf('plat') === -1) isApiRequest = true;
 
         if (!isApiRequest) {
           try {
             let decode = Buffer.from(decodeURIComponent(issuer.split('plat')[1]), 'base64').toString('ascii');
-            if (!validator.isURL(decode) && decode.search('localhost') === -1) isApiRequest = true;
+            if (!validator.isURL(decode) && decode.indexOf('localhost') === -1) isApiRequest = true;
           } catch (err) {
             provMainDebug(err);
             isApiRequest = true;
@@ -327,7 +327,7 @@ class Provider {
             for (let key of Object.keys(cookies).sort((a, b) => b.length - a.length)) {
               if (key === issuer) continue;
 
-              if (path.search(key) !== -1) {
+              if (path.indexOf(key) !== -1) {
                 isPath = cookies[key];
                 break;
               }
@@ -391,6 +391,7 @@ class Provider {
   /**
      * @description Starts listening to a given port for LTI requests and opens connection to the database.
      * @param {number} port - The port the Provider should listen to.
+     * @returns {Promise<true| false>}
      */
 
 
@@ -425,8 +426,8 @@ class Provider {
       });
       if (this.db.readyState === 0) await mongoose.connect((0, _classPrivateFieldGet2.default)(this, _dbConnection).url, (0, _classPrivateFieldGet2.default)(this, _dbConnection).options);
     } catch (err) {
-      provMainDebug('Error in MongoDb connection: ' + err);
-      throw new Error('Unable to connect to database');
+      provMainDebug(err);
+      return false;
     }
     /* In case no port is provided uses 3000 */
 
@@ -436,6 +437,22 @@ class Provider {
     (0, _classPrivateFieldGet2.default)(this, _server).listen(port, 'Lti Provider tool is listening on port ' + port + '!\n\nLTI provider config: \n>Initiate login URL: ' + (0, _classPrivateFieldGet2.default)(this, _loginUrl) + '\n>App Url: ' + (0, _classPrivateFieldGet2.default)(this, _appUrl) + '\n>Session Timeout Url: ' + (0, _classPrivateFieldGet2.default)(this, _sessionTimeoutUrl) + '\n>Invalid Token Url: ' + (0, _classPrivateFieldGet2.default)(this, _invalidTokenUrl));
     return true;
   }
+  /**
+   * @description Closes connection to database and stops server.
+   * @returns {Promise<true | false>}
+   */
+
+
+  async close() {
+    try {
+      await (0, _classPrivateFieldGet2.default)(this, _server).close();
+      this.db.removeAllListeners();
+      await this.db.close();
+      return true;
+    } catch (err) {
+      return false;
+    }
+  }
   /**
      * @description Sets the callback function called whenever theres a sucessfull connection, exposing a Conection object containing the id_token decoded parameters.
      * @param {Function} _connectCallback - Function that is going to be called everytime a platform sucessfully connects to the provider.
@@ -444,6 +461,7 @@ class Provider {
      * @param {Function} [options.sessionTimeout] - Route function executed everytime the session expires. It must in the end return a 401 status, even if redirects ((req, res, next) => {res.sendStatus(401)}).
      * @param {Function} [options.invalidToken] - Route function executed everytime the system receives an invalid token or cookie. It must in the end return a 401 status, even if redirects ((req, res, next) => {res.sendStatus(401)}).
      * @example .onConnect((conection, response)=>{response.send(connection)}, {secure: true})
+     * @returns {true}
      */
 
 
@@ -454,51 +472,64 @@ class Provider {
       if (options.invalidToken) (0, _classPrivateFieldSet2.default)(this, _invalidToken, options.invalidToken);
     }
 
-    (0, _classPrivateFieldSet2.default)(this, _connectCallback2, _connectCallback);
+    if (_connectCallback) {
+      (0, _classPrivateFieldSet2.default)(this, _connectCallback2, _connectCallback);
+      return true;
+    }
+
+    throw new Error('Missing callback');
   }
   /**
      * @description Gets/Sets login Url responsible for dealing with the OIDC login flow. If no value is set "/login" is used.
      * @param {string} url - Login url.
      * @example provider.loginUrl('/login')
+     * @returns {String}
      */
 
 
   loginUrl(url) {
     if (!url) return (0, _classPrivateFieldGet2.default)(this, _loginUrl);
     (0, _classPrivateFieldSet2.default)(this, _loginUrl, url);
+    return (0, _classPrivateFieldGet2.default)(this, _loginUrl);
   }
   /**
      * @description Gets/Sets main application Url that will receive the final decoded Idtoken. If no value is set "/" (root) is used.
      * @param {string} url - App url.
      * @example provider.appUrl('/app')
+     * @returns {String}
      */
 
 
   appUrl(url) {
     if (!url) return (0, _classPrivateFieldGet2.default)(this, _appUrl);
     (0, _classPrivateFieldSet2.default)(this, _appUrl, url);
+    return (0, _classPrivateFieldGet2.default)(this, _appUrl);
   }
   /**
      * @description Gets/Sets session timeout Url that will be called whenever the system encounters a session timeout. If no value is set "/sessionTimeout" is used.
      * @param {string} url - Session timeout url.
      * @example provider.sessionTimeoutUrl('/sesstimeout')
+     * @returns {String}
      */
 
 
   sessionTimeoutUrl(url) {
     if (!url) return (0, _classPrivateFieldGet2.default)(this, _sessionTimeoutUrl);
     (0, _classPrivateFieldSet2.default)(this, _sessionTimeoutUrl, url);
+    return (0, _classPrivateFieldGet2.default)(this, _sessionTimeoutUrl);
   }
   /**
      * @description Gets/Sets invalid token Url that will be called whenever the system encounters a invalid token or cookie. If no value is set "/invalidToken" is used.
      * @param {string} url - Invalid token url.
      * @example provider.invalidTokenUrl('/invtoken')
+     * @returns {String}
      */
 
 
   invalidTokenUrl(url) {
     if (!url) return (0, _classPrivateFieldGet2.default)(this, _invalidTokenUrl);
     (0, _classPrivateFieldSet2.default)(this, _invalidTokenUrl, url);
+    return (0, _classPrivateFieldGet2.default)(this, _invalidTokenUrl);
   }
   /**
      * @description Registers a platform.
@@ -509,6 +540,7 @@ class Provider {
      * @param {object} authConfig - Authentication method and key for verifying messages from the platform. {method: "RSA_KEY", key:"PUBLIC KEY..."}
      * @param {String} authConfig.method - Method of authorization "RSA_KEY" or "JWK_KEY" or "JWK_SET".
      * @param {String} authConfig.key - Either the RSA public key provided by the platform, or the JWK key, or the JWK keyset address.
+     * @returns {Promise<Platform|false>}
      */
 
 
@@ -552,6 +584,7 @@ class Provider {
      * @description Gets a platform.
      * @param {String} url - Platform url.
      * @param {String} [ENCRYPTIONKEY] - Encryption key. THIS PARAMETER IS ONLY IN A FEW SPECIFIC CALLS, DO NOT USE IN YOUR APPLICATION.
+     * @returns {Promise<Platform | false>}
      */
 
 
@@ -582,6 +615,7 @@ class Provider {
   /**
      * @description Deletes a platform.
      * @param {string} url - Platform url.
+     * @returns {Promise<true | false>}
      */
 
 
@@ -593,6 +627,7 @@ class Provider {
   }
   /**
      * @description Gets all platforms.
+     * @returns {Promise<Array<Platform>| false>}
      */
 
 
@@ -639,14 +674,17 @@ class Provider {
       let lineitemRes = await got.get(lineitemsEndpoint, {
         headers: {
           Authorization: tokenRes.token_type + ' ' + tokenRes.access_token
-        }
+        },
+        body: JSON.stringify({
+          request: 'lineitems'
+        })
       });
       let resourceId = idtoken.platformContext.resource;
       let lineitem = find(JSON.parse(lineitemRes.body), ['resourceLinkId', resourceId.id]);
       let lineitemUrl = lineitem.id;
       let scoreUrl = lineitemUrl + '/scores';
 
-      if (lineitemUrl.split('\?') !== -1) {
+      if (lineitemUrl.indexOf('?') !== -1) {
         let query = lineitemUrl.split('\?')[1];
         let url = lineitemUrl.split('\?')[0];
         scoreUrl = url + '/scores?' + query;
@@ -657,15 +695,20 @@ class Provider {
       message.timestamp = new Date(Date.now()).toISOString();
       message.scoreMaximum = lineitem.scoreMaximum;
       provMainDebug(message);
-      await got.post(scoreUrl, {
+      let finalRes = await got.post(scoreUrl, {
         headers: {
           Authorization: tokenRes.token_type + ' ' + tokenRes.access_token,
           'Content-Type': 'application/vnd.ims.lis.v1.score+json'
         },
         body: JSON.stringify(message)
       });
-      provMainDebug('Message successfully sent');
-      return true;
+
+      if (finalRes.statusCode === 200) {
+        provMainDebug('Message successfully sent');
+        return true;
+      }
+
+      return false;
     } catch (err) {
       provMainDebug(err);
       return false;
@@ -675,7 +718,7 @@ class Provider {
    * @description Redirect to a new location and sets it's cookie if the location represents a separate resource
    * @param {Object} res - Express response object
    * @param {String} path - Redirect path
-   * @param {Boolea} [isNewResource = false] - If true creates new resource and its cookie
+   * @param {Boolean} [isNewResource = false] - If true creates new resource and its cookie
    * @example lti.generatePathCookie(response, '/path', true)
    */
 

dist/Utils/Auth.js

@@ -89,7 +89,11 @@ class Auth {
           provAuthDebug('Retrieving key from jwk_set');
           if (!kid) throw new Error('NoKidFoundInToken');
           let keysEndpoint = authConfig.key;
-          let res = await got.get(keysEndpoint);
+          let res = await got.get(keysEndpoint, {
+            body: JSON.stringify({
+              request: 'keyset'
+            })
+          });
           let keyset = JSON.parse(res.body).keys;
           if (!keyset) throw new Error('NoKeySetFound');
           let key = jwk.jwk2pem(find(keyset, ['kid', kid]));

dist/Utils/Platform.js

@@ -278,29 +278,17 @@ class Platform {
     if (!token) {
       provPlatformDebug('Access_token for ' + (0, _classPrivateFieldGet2.default)(this, _platformUrl) + ' not found');
       provPlatformDebug('Attempting to generate new access_token for ' + (0, _classPrivateFieldGet2.default)(this, _platformUrl));
-
-      try {
-        let res = await Auth.getAccessToken(this, (0, _classPrivateFieldGet2.default)(this, _ENCRYPTIONKEY2));
-        return res;
-      } catch (err) {
-        provPlatformDebug(err);
-        return false;
-      }
+      let res = await Auth.getAccessToken(this, (0, _classPrivateFieldGet2.default)(this, _ENCRYPTIONKEY2));
+      return res;
     } else {
       provPlatformDebug('Access_token found');
 
       if ((Date.now() - token[0].createdAt) / 1000 > token[0].expires_in) {
         provPlatformDebug('Token expired');
         provPlatformDebug('Access_token for ' + (0, _classPrivateFieldGet2.default)(this, _platformUrl) + ' not found');
         provPlatformDebug('Attempting to generate new access_token for ' + (0, _classPrivateFieldGet2.default)(this, _platformUrl));
-
-        try {
-          let res = await Auth.getAccessToken(this, (0, _classPrivateFieldGet2.default)(this, _ENCRYPTIONKEY2));
-          return res;
-        } catch (err) {
-          provPlatformDebug(err);
-          return false;
-        }
+        let res = await Auth.getAccessToken(this, (0, _classPrivateFieldGet2.default)(this, _ENCRYPTIONKEY2));
+        return res;
       }
 
       return token[0].token;

dist/Utils/Server.js

@@ -13,9 +13,12 @@ const cookieParser = require('cookie-parser');
 
 const cors = require('cors');
 
+const serverdebug = require('debug')('provider:server');
+
 class Server {
   constructor(https, ssl, ENCRYPTIONKEY) {
     this.app = express();
+    this.server = false;
     this.ssl = false;
     if (https) this.ssl = ssl;
     this.app.use(helmet({
@@ -32,13 +35,17 @@ class Server {
   }
 
   listen(port, message) {
-    if (this.ssl) https.createServer(this.ssl, this.app).listen(port, () => console.log(message));else this.app.listen(port, () => console.log(message));
+    if (this.ssl) this.server = https.createServer(this.ssl, this.app).listen(port, () => serverdebug(message));else this.server = this.app.listen(port, () => serverdebug(message));
   }
 
   setStaticPath(path) {
     this.app.use('/', express.static(path));
   }
 
+  close() {
+    if (this.server) this.server.close();
+  }
+
 }
 
 module.exports = Server;

docs/provider.md

@@ -140,7 +140,7 @@ Express server object.
 
 **Type**: ```Express```
 
-#### Provider.constructor(encryptionkey, database, [, options]) 
+#### Provider.constructor(encryptionkey, database [, options]) 
 
 Exposes methods for easy manipulation of the LTI 1.3 standard as a LTI Provider and a "app" object to manipulate the [Express](https://expressjs.com/) server.
 
@@ -185,6 +185,18 @@ Starts listening to a given port for LTI requests and opens connection to the co
 
 
 
+
+#### async Provider.close() 
+
+Closes connection to database and stops server.
+
+
+##### Returns
+
+- Promise that resolves ```true``` when it's done or ```false``` if something fails.
+
+
+
 #### Provider.onConnect(_connectCallback[, options]) 
 
 Sets the callback function called whenever theres a sucessfull connection, exposing a Conection object containing the id_token decoded parameters.
@@ -416,7 +428,7 @@ Sends a grade message to [Platform](platform.md).
 - Promise that resolves ```true``` if it succeeds and ```false``` if it fails.
 
 
-#### async Provider.redirect(idToken, message) 
+#### async Provider.redirect(response, path [, isNewResource]) 
 
 Redirects to another route, handles the context in the url and if the route is a specific resource, generates the context cookie for it.
 
@@ -427,7 +439,7 @@ Redirects to another route, handles the context in the url and if the route is a
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| res | `Object`  | Espress response object.|   |
+| response | `Object`  | Espress response object.|   |
 | path | `String`  | Redirect path. |   |
 | isNewResource | `Boolean`  | = false] Set to true if path is a resource, the tool will create a new context cookie. | *Optional* |