moving tests and examples to async

Author: Comick

README.md

@@ -20,9 +20,9 @@ examplelibrary.js:
 ```js
 'use strict';
 
-var readdir = require('promise').denodeify(require('fs').readdir),
-    robot = require('../lib/robotremote'),
-    assert = require('assert');
+const { readdir } = require('fs').promises;
+const robot = require('../lib/robotremote');
+const assert = require('assert');
 
 var lib = module.exports;
 
@@ -39,11 +39,9 @@ var lib = module.exports;
  *
  * @param path directory path to count item in.
  */
- lib.countItemsInDirectory = function (path) {
-    return readdir(path).then(function (files) {
-        return files.length;
-    });
-};
+lib.countItemsInDirectory = async function(path) {
+    return (await readdir(path)).length;
+}
 // The doc attribute is used for inspection on the command line of client and doc generation.
 // It's optional and defaults to empty string when missing.
 lib.countItemsInDirectory.doc = 'Returns the number of items in the directory specified by `path`.';
@@ -67,15 +65,15 @@ lib.countItemsInDirectory.doc = 'Returns the number of items in the directory sp
  * @param str1
  * @param str2
  */
-lib.stringsShouldBeEqual = function (str1, str2) {
+lib.stringsShouldBeEqual = (str1, str2) => {
     this.output.warn('Comparing \'%s\' to \'%s\'', str1, str2);
     assert.equal(str1, str2, 'Given strings are not equal');
 };
 
 
 // Run this keyword library if the library itself is called explicitly.
 if (!module.parent) {
-    var server = new robot.Server([lib], { host: 'localhost', port: 8270 });
+    const server = new robot.Server([lib], { host: 'localhost', port: 8270 });
 }
 ```
 

bin/botclient.js

@@ -1,19 +1,37 @@
 #!/usr/bin/env node
 'use strict';
 
-var robot = require('../lib/robotremote'),
-    repl = require('repl');
+const robot = require('../lib/robotremote');
+const repl = require('repl');
 
+const options = {
+    host: process.argv[2] || 'localhost',
+    port: parseInt(process.argv[3], 10) || 8270
+};
+const serverString = options.host + ':' + options.port;
 
-var options = {host: process.argv[2] || 'localhost', port: parseInt(process.argv[3], 10) || 8270};
-var serverString = options.host + ':' + options.port;
-
-robot.createClient(options).then(keywords -> {
+async function reloadKeywords(serverString) {
+    let keywords = await robot.createClient(options);
     console.log('Connected to remote server at "' + serverString + '"');
     console.log('Available keywords: ' + Object.keys(keywords).join(', '));
-    repl.start(serverString + '> ').context.keywords = keywords;
-}, err -> {
-    console.log('Could not connected to remote server at "' + serverString + '"');
-    throw err;
-});
+    return keywords;
+}
+
+(async () => {
+    try {
+        let keywords = await reloadKeywords(serverString);
+        const replServer = repl.start(serverString + '> ')
+        replServer.context.keywords = keywords;
+        replServer.defineCommand('reload', {
+            help: 'Reload remote keyword definitions',
+            async action() {
+                replServer.context.keywords = await reloadKeywords(serverString);
+                this.displayPrompt();
+            }
+        }); 
+    } catch (err) {
+        console.log('Could not connected to remote server at "' + serverString + '"');
+        throw err;
+    }
+})();
 

example/examplelibrary.js

@@ -1,8 +1,8 @@
 'use strict';
 
-var readdir = require('promise').denodeify(require('fs').readdir),
-    robot = require('../lib/robotremote'),
-    assert = require('assert');
+const { readdir } = require('fs').promises;
+const robot = require('../lib/robotremote');
+const assert = require('assert');
 
 var lib = module.exports;
 
@@ -19,11 +19,9 @@ var lib = module.exports;
  *
  * @param path directory path to count item in.
  */
-lib.countItemsInDirectory = function (path) {
-    return readdir(path).then(function (files) {
-        return files.length;
-    });
-};
+lib.countItemsInDirectory = async function(path) {
+    return (await readdir(path)).length;
+}
 // The doc attribute is used for inspection on the command line of client and doc generation.
 // It's optional and defaults to empty string when missing.
 lib.countItemsInDirectory.doc = 'Returns the number of items in the directory specified by `path`.';
@@ -42,18 +40,18 @@ lib.countItemsInDirectory.doc = 'Returns the number of items in the directory sp
  * Each keyword also have the output writer, which enables logging at various levels.
  * Here warn level is showed as an example.
  * All robot levels are supported including messages with timestamp through timestamp`Level` function.
- * See http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.5#logging-information
+ * See http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#logging-information
  *
  * @param str1
  * @param str2
  */
-lib.stringsShouldBeEqual = function (str1, str2) {
+lib.stringsShouldBeEqual = (str1, str2) => {
     this.output.warn('Comparing \'%s\' to \'%s\'', str1, str2);
     assert.equal(str1, str2, 'Given strings are not equal');
 };
 
 
 // Run this keyword library if the library itself is called explicitly.
 if (!module.parent) {
-    var server = new robot.Server([lib], { host: 'localhost', port: 8270 });
+    const server = new robot.Server([lib], { host: 'localhost', port: 8270 });
 }

package.json

@@ -11,7 +11,7 @@
         "test",
         "ATDD"
     ],
-    "version": "1.5.0",
+    "version": "1.5.1",
     "preferGlobal": false,
     "homepage": "https://github.com/comick/node-robotremoteserver",
     "author": {

test/testlibrary.js

@@ -37,50 +37,38 @@ lib.justFail = function () {
     throw new Error();
 };
 
-lib.doNothingAsync = function () {
-    return new Promise(function (resolve) {
-        resolve();
-    });
+lib.doNothingAsync = async function () {
+    return;
 };
 
-lib.concatenateArgumentsAsync = function (arg1, arg2) {
-    return new Promise(function (resolve) {
-        resolve(arg1 + arg2);
-    });
+lib.concatenateArgumentsAsync = async function (arg1, arg2) {
+    return arg1 + arg2;
 };
 
-lib.concatenateArgumentsWithVarArgumentsAsync = function (prefix, ...args) {
-    return new Promise(function (resolve) {
-        resolve(prefix + JSON.stringify(args));
-    });
+lib.concatenateArgumentsWithVarArgumentsAsync = async function (prefix, ...args) {
+    return prefix + JSON.stringify(args);
 };
 lib.concatenateArgumentsWithVarArgumentsAsync.args = ['prefix', '*args'];
 
-lib.concatenateArgumentsWithNamedArgumentsAsync = function (prefix, kwargs) {
-    return new Promise(function (resolve) {
-        resolve(prefix + JSON.stringify(kwargs));
-    });
+lib.concatenateArgumentsWithNamedArgumentsAsync = async function (prefix, kwargs) {
+    return prefix + JSON.stringify(kwargs);
 };
 lib.concatenateArgumentsWithNamedArgumentsAsync.args = ['prefix', '**kwargs'];
 
 // For language constraints, var arguments should be declared at the end, so the last
 // args will be kwargs
-lib.concatenateArgumentsWithVarAndNamedArgumentsAsync = function (prefix, ...args) {
-    return new Promise(function (resolve) {
-        resolve(prefix + JSON.stringify(args));
-    });
+lib.concatenateArgumentsWithVarAndNamedArgumentsAsync = async function (prefix, ...args) {
+    return prefix + JSON.stringify(args);
 };
 lib.concatenateArgumentsWithVarAndNamedArgumentsAsync.args = ['prefix', '*args', '**kwargs'];
 
-lib.justFailAsync = function () {
-    return new Promise(function (resolve, reject) {
-        reject(new Error());
-    });
+lib.justFailAsync = async function () {
+    throw new Error();
 };
 
-lib.neverReturn = function () {
-    return new Promise(function (resolve, reject) {
-    });
+lib.neverReturn = async function () {
+    const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
+    await sleep(1000 * 60 * 60);
 };
 
 // Run this keyword library if the library itself is called explicitly.