Unable to use async/await with mocha runner #2549

MancLad89 · 2020-11-26T19:08:06Z

MancLad89
Nov 26, 2020

Describe the bug

Hi,

I am trying to use the mocha as the test runner as per the guide here

However it seems I am unable to use async/await with mocha runner as I cannot access the the result of the promise.
The promise resolves but when logging or trying to use the result of the promise undefined is returned.

However when ran with --verbose the promise does look to resolve but I cannot access the result.

If any other information is required do let me know.

Response when ran with --verbose:

Response 200 GET http://hub-cloud.browserstack.com/wd/hub/session/5c0f4e54f6369af836f530a580f40db9ccbe6ca3/window/current/size (72ms)
   {
     state: 'success',
     sessionId: '5c0f4e54f6369af836f530a580f40db9ccbe6ca3',
     hCode: 838768783,
     value: {
       width: 1920,
       hCode: 30720,
       class: 'org.openqa.selenium.Dimension',
       height: 1080
     },
     class: 'org.openqa.selenium.remote.Response',
     status: 0
}

Sample test

sampleTest.js

describe('mocha test', async function() {
	it('async/await test', async function (browser) {
		browser.url('https://nightwatchjs.org/');

		browser.waitForElementVisible('.btn-download', 10000);

		//taken from https://nightwatchjs.org/api/getWindowSize.html
		const value = await browser.getWindowSize();
		console.log('value:', value);
	});
});

Run with command

$ nightwatch test/sampleTest.js --your-other-arguments-here

Verbose output

debug.log

⠋ Connecting to hub-cloud.browserstack.com on port 80...
   Request POST http://hub-cloud.browserstack.com /wd/hub/session  
   {
     desiredCapabilities: {
       browserName: 'firefox',
       'browserstack.user': '',
       'browserstack.key': '',
       'browserstack.tunnel': true,
       'browserstack.localIdentifier': 'test',
       'browserstack.local': true,
       name: 'Bstack-[Nightwatch] Parallel Test',
       acceptInsecureCerts: true,
       javascriptEnabled: true,
       acceptSslCerts: true,
       start_process: false,
       selenium_host: 'hub-cloud.browserstack.com',
       selenium_port: '80',
       browser: 'chrome',
       browser_version: 'latest',
       os: 'OS X',
       os_version: 'Mojave',
       resolution: '1920x1080',
       chromeOptions: { args: [ 'start-fullscreen' ] },
       build: 'nightwatch-test-build'
     }
⠏ Connecting to hub-cloud.browserstack.com on port 80...
   Response 200 POST http://hub-cloud.browserstack.com/wd/hub/session (5755ms)
   {
     state: null,
     sessionId: 'f9130f2c9f6d322450a42dc33723418710a3a432',
     hCode: 1452337548,
     value: {
       mobileEmulationEnabled: false,
       timeouts: { implicit: 0, pageLoad: 300000, script: 30000 },
       hasTouchScreen: false,
       platform: 'MAC',
       acceptSslCerts: true,
       'goog:chromeOptions': { debuggerAddress: 'localhost:49656' },
       acceptInsecureCerts: true,
       webStorageEnabled: true,
       browserName: 'chrome',
       takesScreenshot: true,
       javascriptEnabled: true,
       setWindowRect: true,
       unexpectedAlertBehaviour: 'ignore',
       applicationCacheEnabled: false,
       rotatable: false,
       networkConnectionEnabled: false,
       chrome: {
         chromedriverVersion: '87.0.4280.20 (c99e81631faa0b2a448e658c0dbd8311fb04ddbd-refs/branch-heads/4280@{#355})',
         userDataDir: '/var/folders/yj/h3bj394n2tn74bp3vdngj35c0000jy/T/.com.google.Chrome.EGKNOs'
       },
       takesHeapSnapshot: true,
       pageLoadStrategy: 'normal',
       strictFileInteractability: false,
       databaseEnabled: false,
       handlesAlerts: true,
       version: '87.0.4280.66',
       browserConnectionEnabled: false,
       nativeEvents: true,
       'webdriver.remote.sessionid': 'f9130f2c9f6d322450a42dc33723418710a3a432',
       locationContextEnabled: true,
       cssSelectorsEnabled: true,
       'webauthn:virtualAuthenticators': true
     },
     class: 'org.openqa.selenium.remote.Response',
     status: 0
ℹ Connected to hub-cloud.browserstack.com on port 80 (5844ms).
  Using: chrome (87.0.4280.66) on MAC platform.

 Received session with ID: f9130f2c9f6d322450a42dc33723418710a3a432

  mocha test
 
 → Running command: url ('https://nightwatchjs.org/')
value: undefined
   Request POST http://hub-cloud.browserstack.com /wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/url  
   { url: 'https://nightwatchjs.org/' }
   Response 200 POST http://hub-cloud.browserstack.com/wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/url (5414ms)
   {
     state: 'success',
     sessionId: 'f9130f2c9f6d322450a42dc33723418710a3a432',
     hCode: 1217158985,
     value: null,
     class: 'org.openqa.selenium.remote.Response',
     status: 0
}
  → Completed command: url ('https://nightwatchjs.org/') (5416ms)
 
 → Running command: waitForElementVisible ('.btn-download', 10000)
   Request POST http://hub-cloud.browserstack.com /wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/elements  
   { using: 'css selector', value: '.btn-download' }
   Response 200 POST http://hub-cloud.browserstack.com/wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/elements (133ms)
   {
     state: 'success',
     sessionId: 'f9130f2c9f6d322450a42dc33723418710a3a432',
     hCode: 859436973,
     value: [ { ELEMENT: '0' } ],
     class: 'org.openqa.selenium.remote.Response',
     status: 0
}
   Request GET http://hub-cloud.browserstack.com /wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/element/0/displayed  
   Response 200 GET http://hub-cloud.browserstack.com/wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/element/0/displayed (92ms)
   {
     state: 'success',
     sessionId: 'f9130f2c9f6d322450a42dc33723418710a3a432',
     hCode: 1364567886,
     value: true,
     class: 'org.openqa.selenium.remote.Response',
     status: 0
}
  → Completed command: waitForElementVisible ('.btn-download', 10000) (230ms)
 
 → Running command: getWindowSize ()
 
 → Running command: windowSize ('current', [Function])
   Request GET http://hub-cloud.browserstack.com /wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/window/current/size  
   Response 200 GET http://hub-cloud.browserstack.com/wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432/window/current/size (68ms)
   {
     state: 'success',
     sessionId: 'f9130f2c9f6d322450a42dc33723418710a3a432',
     hCode: 829668064,
     value: {
       width: 1920,
       hCode: 30720,
       class: 'org.openqa.selenium.Dimension',
       height: 1080
     },
     class: 'org.openqa.selenium.remote.Response',
     status: 0
}
  → Completed command: getWindowSize () (72ms)
  → Completed command: windowSize ('current', [Function]) (69ms)
    ✓ async/await test (5722ms)


  1 passing (12s)

[mochawesome] Report JSON saved to /Users/ha01794/vouchercodes/tests/functional/reports/customReportFilename.json

[mochawesome] Report HTML saved to /Users/ha01794/vouchercodes/tests/functional/reports/customReportFilename.html

   Request DELETE http://hub-cloud.browserstack.com /wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432  
   Response 200 DELETE http://hub-cloud.browserstack.com/wd/hub/session/f9130f2c9f6d322450a42dc33723418710a3a432 (218ms)
   { state: 'success', status: 0, value: '', hCode: '13579246' }

Configuration

nightwatch.json

nightwatch_config = { //global paths src_folders : [ "tests" ],

output_folder: "reports",
custom_commands_path: [
	"lib/command/action",
	"lib/command/assert",
	"lib/command/util",
	"lib/command/api-requests"
],
custom_assertions_path: [
	"lib/assertion"
],
page_objects_path: [
	"lib/pages/desktop",
	"lib/pages/mobile",
	"lib/pages/disco",
	"lib/elements/desktop",
	"lib/elements/mobile"
],

globals_path: "./config/globalsModule.js",

//reporting
test_runner:{
	type: "mocha",
	options: {
		ui: "bdd",
		reporter: "mochawesome",
		reporterOptions: {
			reportDir: "reports",
			reportTitle: "Automated Tests Report",
			reportFilename: "customReportFilename"
		}
	}
},

selenium : {
	"start_process" : false,
	"host" : "hub-cloud.browserstack.com",
	"port" : 80,
},

common_capabilities: {
	'browserstack.user': <userDetails>,
	'browserstack.key': <key>,
	'browserstack.tunnel': true,
	'browserstack.localIdentifier': 'test',
	'browserstack.local': true,
	'name': 'test',
	acceptInsecureCerts: true,
	javascriptEnabled: true,
	acceptSslCerts: true,
},

test_settings: {
	default: {},
	chrome: {
		desiredCapabilities: {
			start_process : false,
			selenium_host: "hub-cloud.browserstack.com",
			selenium_port: "80",
			browser: "chrome",
			browser_version: "latest",
			os: "OS X",
			os_version: "Mojave",
			resolution: "1920x1080",
			chromeOptions: {
				args: [
					"start-fullscreen"
				]
			}
		}
	},
	firefox: {
		desiredCapabilities: {
			browser: "firefox",
			browser_version: "latest",
			os: "OS X",
			os_version: "Mojave",
			resolution: "1920x1080",
		}
	},
	iOS14: {
		desiredCapabilities: {
			browser: "iOS14",
			os_version: "13",
			device: "iPhone 11",
			realMobile: "true",
			'browserstack.appium_version': "1.18.0",
			'browserstack.idleTimeout': "180",
			autoAcceptAlerts: true,
			nativeWebTap: true
		}
	},
}

};

// Code to support common capabilites
for(var i in nightwatch_config.test_settings){
var config = nightwatch_config.test_settings[i];
config['selenium_host'] = nightwatch_config.selenium.host;
config['selenium_port'] = nightwatch_config.selenium.port;
config['desiredCapabilities'] = config['desiredCapabilities'] || {};
for(var j in nightwatch_config.common_capabilities){
config['desiredCapabilities'][j] = config['desiredCapabilities'][j] || nightwatch_config.common_capabilities[j];
}
}

module.exports = nightwatch_config;

{
  "your": { "config": "here" }
}

Your Environment

Executable	Version
`nightwatch --version`	1.5.1, 1.5.0, 1.4.3
`npm --version`	6.14.8
`yarn --version`	VERSION
`node --version`	14.15.1

Browser driver	Version
NAME	VERSION

OS	Version
NAME	VERSION

pawlakmaly · 2020-11-27T12:57:43Z

pawlakmaly
Nov 27, 2020

There an issue with your code or documentation.
On result of getWindowsSize() there no property 'value':

		browser.url('https://nightwatchjs.org/');

		browser.waitForElementVisible('.btn-download', 10000);

		//taken from https://nightwatchjs.org/api/getWindowSize.html
        const value = await browser.getWindowSize();
        console.log('value', value);
		console.log('value', value.value);

Output:

Running:  Dummy

√ Element <.btn-download> was visible after 63 milliseconds.
value { height: 1020, width: 945 }
value undefined

0 replies

MancLad89 · 2020-11-27T18:58:28Z

MancLad89
Nov 27, 2020
Author

Apologies should be the below, edited the original too.

describe('mocha test', async function() {
	it('async/await test', async function (browser) {
		browser.url('https://nightwatchjs.org/');

		browser.waitForElementVisible('.btn-download', 10000);

		//taken from https://nightwatchjs.org/api/getWindowSize.html
		const value = await browser.getWindowSize();
		console.log('value:', value);
	});
});

Output
value: undefined

0 replies

Pieras2 · 2020-11-27T19:00:58Z

Pieras2
Nov 27, 2020

Give console log in callback (if get window size defines) pt., 27 lis 2020, 19:58 użytkownik MancLad89 <[email protected]> napisał:

…

Apologies should be the below, edited the original too. describe('mocha test', async function() { it('async/await test', async function (browser) { browser.url('https://nightwatchjs.org/'); browser.waitForElementVisible('.btn-download', 10000); //taken from https://nightwatchjs.org/api/getWindowSize.html const value = await browser.getWindowSize(); console.log('value:', value); }); }); Output value: undefined — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/nightwatchjs/nightwatch/issues/2549#issuecomment-734953972>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMUVMH53R7REY3A5D2PMHRDSR7ZGVANCNFSM4UECNMXA> .

0 replies

MancLad89 · 2020-11-27T19:04:29Z

MancLad89
Nov 27, 2020
Author

Apologies not sure what you mean by this?

0 replies

Pieras2 · 2020-11-27T19:12:59Z

Pieras2
Nov 27, 2020

Just to check ...getWindowSize(function(result) { Console.log(result.value) } I don't use micha runner but I wonder if it helps pt., 27 lis 2020, 19:58 użytkownik MancLad89 <[email protected]> napisał:

…

Apologies should be the below, edited the original too. describe('mocha test', async function() { it('async/await test', async function (browser) { browser.url('https://nightwatchjs.org/'); browser.waitForElementVisible('.btn-download', 10000); //taken from https://nightwatchjs.org/api/getWindowSize.html const value = await browser.getWindowSize(); console.log('value:', value); }); }); Output value: undefined — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/nightwatchjs/nightwatch/issues/2549#issuecomment-734953972>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMUVMH53R7REY3A5D2PMHRDSR7ZGVANCNFSM4UECNMXA> .

0 replies

MancLad89 · 2020-11-27T19:22:20Z

MancLad89
Nov 27, 2020
Author

The below works but trying to using async/await and avoid callbacks.

browser.getWindowSize(function(value) {
			console.log(value);
		});

Output:

{
  width: 1920,
  hCode: 30720,
  class: 'org.openqa.selenium.Dimension',
  height: 1080
}

0 replies

Pieras2 · 2020-11-27T19:28:06Z

Pieras2
Nov 27, 2020

Please try await console.log() pt., 27 lis 2020, 20:22 użytkownik MancLad89 <[email protected]> napisał:

…

The below works but trying to using async/await and avoid callbacks. browser.getWindowSize(function(value) { console.log(value); }); Output: { width: 1920, hCode: 30720, class: 'org.openqa.selenium.Dimension', height: 1080 } — You are receiving this because you commented. Reply to this email directly, view it on GitHub <https://github.com/nightwatchjs/nightwatch/issues/2549#issuecomment-734959753>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMUVMH6GH7FBF3C2DIAT3HLSR737TANCNFSM4UECNMXA> .

0 replies

Pieras2 · 2020-11-27T19:31:30Z

Pieras2
Nov 27, 2020

Before the test you can set variable visible in scope of the test file and callback would set it so that it was defined at console.log I guess. Unless async/awaits dont work with mocha pt., 27 lis 2020, 19:58 użytkownik MancLad89 <[email protected]> napisał:

…

Apologies should be the below, edited the original too. describe('mocha test', async function() { it('async/await test', async function (browser) { browser.url('https://nightwatchjs.org/'); browser.waitForElementVisible('.btn-download', 10000); //taken from https://nightwatchjs.org/api/getWindowSize.html const value = await browser.getWindowSize(); console.log('value:', value); }); }); Output value: undefined — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/nightwatchjs/nightwatch/issues/2549#issuecomment-734953972>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMUVMH53R7REY3A5D2PMHRDSR7ZGVANCNFSM4UECNMXA> .

0 replies

MancLad89 · 2020-11-27T19:48:57Z

MancLad89
Nov 27, 2020
Author

@Pieras2 I have provided a simple async/await example but have much more complex cases and doing what you suggest it would be easier to write in callback fashion. Which is not something I am looking to do/can't do it some cases.

The purpose of this bug report is I believe to point out async/await does not work with a mocha test runner.

0 replies

pawlakmaly · 2020-11-30T13:41:44Z

pawlakmaly
Nov 30, 2020

Exactly the same code works ok with default runner. Must be mocka runner issue.

0 replies

MancLad89 · 2020-11-30T13:49:21Z

MancLad89
Nov 30, 2020
Author

@pawlakmaly, agreed works with default runner. Issue looks specific to mocha test runner.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unable to use async/await with mocha runner #2549

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 11 comments

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Unable to use async/await with mocha runner #2549

MancLad89 Nov 26, 2020

Describe the bug

Sample test

Verbose output

Configuration

Your Environment

Replies: 11 comments

pawlakmaly Nov 27, 2020

MancLad89 Nov 27, 2020 Author

Pieras2 Nov 27, 2020

MancLad89 Nov 27, 2020 Author

Pieras2 Nov 27, 2020

MancLad89 Nov 27, 2020 Author

Pieras2 Nov 27, 2020

Pieras2 Nov 27, 2020

MancLad89 Nov 27, 2020 Author

pawlakmaly Nov 30, 2020

MancLad89 Nov 30, 2020 Author

MancLad89
Nov 26, 2020

pawlakmaly
Nov 27, 2020

MancLad89
Nov 27, 2020
Author

Pieras2
Nov 27, 2020

MancLad89
Nov 27, 2020
Author

Pieras2
Nov 27, 2020

MancLad89
Nov 27, 2020
Author

Pieras2
Nov 27, 2020

Pieras2
Nov 27, 2020

MancLad89
Nov 27, 2020
Author

pawlakmaly
Nov 30, 2020

MancLad89
Nov 30, 2020
Author