Add documentation on async operations in steps and hooks about gauge-js HOT 17 CLOSED

This is what I did to get webdriver.io checking the google home page title.

package.json

{
  "name": "gauge-test",
  "version": "1.0.0",
  "description": "testing out gauge with webdriver",
  "directories": {
    "test": "gauge specs/"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "chai": "^3.5.0",
    "chai-as-promised": "^5.2.0",
    "webdriverio": "^4.0.3",
    "webdriverjs-angular": "^0.1.3"
  }
}

spec file

#This spec is an example on how to use Asynch operqtions with webdriver.io

Check the title
---------------------------
* Check the title of the Google home page is "Google"

step file

'use strict'

var webdriverio = require('webdriverio');
var options = {
  desiredCapabilities: {
    browserName: 'firefox'
  }
};
var chai = require('chai');
var chaiAsPromised = require('chai-as-promised');

chai.use(chaiAsPromised);
expect = chai.expect;
chai.Should();

var assert = require("assert");

gauge.step("Check the title of the Google home page is <vowels>", function (titleGiven, done) {
  webdriverio
    .remote(options)
    .init()
    .url('http://google.com')
    .getTitle().then(function(title) {
      assert.equal(title, titleGiven);
    })
    .end()
    .call(done);
});

then run

npm test

Enjoy.

from gauge-js.

@philipbeadle This is superb! Thanks a lot!

from gauge-js.

Will definitely be giving this a shot today! Might be worth adding this to the README? What do you guys think?

from gauge-js.

@ivanbportugal There's a new release with the latest fixes. 😄 You may want to do:

$ gauge --update js

from gauge-js.

Also, the docs have been updated with information on async operations.

from gauge-js.

thanx so much, youre doing an amazing job with this plugin. I'm building a full blown demo of using gauge-js with a meteor site and webdriver.io. Ill keep you posted.

from gauge-js.

@philipbeadle That's lovely. If the demo you are building can be shared, would you mind uploading it as a repo on Github? That way, we can share it with others.

from gauge-js.

demo will be here very soon

https://github.com/philipbeadle/gauge-js-angular-webdriver-demo

from gauge-js.

😺 👍 🍻

from gauge-js.

Demo is up, basic demo showing using Gauge, gauge-js, angular and webdriver.io to do UI testing :)

https://github.com/philipbeadle/gauge-js-angular-webdriver-demo

from gauge-js.

@philipbeadle Nice! Do you mind if we add it as an example for gauge-js to the README?

from gauge-js.

Please do. I'm going to add to it over the next few weeks and show how to select elements etc and build up a library set hooks etc.

from gauge-js.

Guys,

How might we get assert errors and gauge messages to show up in the report? The following code (using @philipbeadle example) errors out on the console correctly but doesn't show up on the report. It looks like the closure is not being caught at the gauge js level:

'use strict'

var webdriverio = require('webdriverio');
var options = {
  desiredCapabilities: {
    browserName: 'chrome'
  }
};
var chai = require('chai');
var chaiAsPromised = require('chai-as-promised');

chai.use(chaiAsPromised);
var expect = chai.expect;
chai.Should();

var assert = require("assert");

gauge.step("Check the title of the Google home page is <vowels>", function (titleGiven, done) {
  webdriverio
    .remote(options)
    .init()
    .url('http://google.com')
    .getTitle().then(function(title) {
        gauge.message('just a test message'); // Does NOT show up
        expect(title).to.equal('blah'); // Shows on the console, not on the report
        assert.equal(title, 'blah'); // Shows on the console, not on the report
    })
    .end()
    .call(done);
});

from gauge-js.

More info: I get the following error in the console. Still digging...

Unable to connect to plugin Html Report 2.0.0. proto: required field "SuiteExecutionResult.SuiteResult.SpecResults.ProtoSpec.Items.Scenario.ScenarioItems.Step.StepExecutionResult.PostHookFailure.StackTrace" not set

from gauge-js.

@kaustavdm @philipbeadle More info: A workaround might be to use the gauge API to fail a test. How might this be done? gauge.error(e) or gauge.step.fail(e) or done(e) ?

gauge.step("Check the title of the Google home page is <vowels>", function (titleGiven, done) {

    webdriverio
        .remote(options)
        .init()
        .once('error', function(e) {
            gauge.message('Here is the error: ' + e);
            // Would be nice if we could say: gauge.error(e) or gauge.fail(e) ?
            // Or, maybe even done(e)
        })
        .url('http://google.com')
        .getTitle().then(function(title) {
            try{
                gauge.message('just a test message'); // Shows up
                expect(title).to.equal('blah'); // Throws AssertionError
                assert.equal(title, 'blah'); // Throws AssertionError if you comment out the above line
            } catch(e) {
                this.emit('error', e);
            }
        })
        .end()
        .call(done);
});

If you debug, after calling done(e) that param doesn't show up in the err variable here:
Snippet from test.js in your gaugejs library:

var done = function(err) {
  var self = this;
  if(self.finished || self.timedOut) {
    return;
  }
  self.duration = new Date() - self.start;
  self.finished = true;
  clearTimeout(self.timer);

  if(err) {
    self.deferred.reject({
      exception: err,
      duration: self.duration
    });
    return;
  } else{
    self.deferred.resolve({
      duration: self.duration
    });
    return;
  }
};

from gauge-js.

Sorry for the busy-ness of this, I think I found a solution. I have a fix. Let me do a PR so you can check it out.

from gauge-js.

Yes you need to set the timeout property in the js.properties file.

And lastly we need to increase the timeout from 1 second to about 30. Open the tests/env/default/js.properties file and set the timeout to 30 seconds.

Cheers
Phil

from gauge-js.