feat: add Browser.takeScreenshot action

.gitignore

@@ -4,4 +4,5 @@ coverage
 dist
 node_modules
 npm-debug.log*
+screenshots
 todo.tasks

README.md

@@ -19,6 +19,8 @@ test('Star the "clebert/cybernaut" repository on GitHub', async t => {
 
   await t.assert(browser.pageTitle, it.should.contain('clebert/cybernaut'));
 
+  await t.perform(browser.takeScreenshot());
+
   const starButton = defineElement('ul.pagehead-actions > li:nth-child(2) > a:nth-child(1)');
 
   await t.perform(starButton.click());

config-schema.json

@@ -61,6 +61,10 @@
       "type": "number",
       "minimum": 0,
       "multipleOf": 1
+    },
+    "screenshotDirectory": {
+      "type": "string",
+      "minLength": 1
     }
   },
   "additionalProperties": false

example/test.e2e.js

@@ -5,6 +5,8 @@ test('Star the "clebert/cybernaut" repository on GitHub', async t => {
 
   await t.assert(browser.pageTitle, it.should.contain('clebert/cybernaut'));
 
+  await t.perform(browser.takeScreenshot());
+
   const starButton = defineElement('ul.pagehead-actions > li:nth-child(2) > a:nth-child(1)');
 
   await t.perform(starButton.click());

fixtures/config.js

@@ -5,5 +5,6 @@ module.exports = {
   exclude: ['custom-config.js'],
   include: '*.js',
   retries: 3,
-  retryDelay: 1000
+  retryDelay: 1000,
+  screenshotDirectory: '/dev/null'
 };

package.json

@@ -77,14 +77,18 @@
     "watch:tests": "ava --fail-fast --watch"
   },
   "dependencies": {
+    "@types/fs-extra": "0.0.37",
+    "@types/mz": "0.0.30",
     "@types/node": "7.0.12",
     "@types/proxyquire": "1.3.27",
     "ajv": "4.11.5",
     "deep-strict-equal": "0.2.0",
+    "fs-promise": "2.0.2",
     "glob": "7.1.1",
     "selenium-webdriver": "3.3.0",
     "tap": "10.3.1",
-    "tslib": "1.6.0"
+    "tslib": "1.6.0",
+    "uuid": "3.0.1"
   },
   "devDependencies": {
     "ava": "0.18.2",

src/__tests__/browser.test.ts

@@ -7,28 +7,42 @@ import {stub} from 'sinon';
 import {format} from '../description';
 import {Deferred} from './deferred';
 
-const sleep = stub();
+const stubs = {
+  outputFile: stub(),
+  sleep: stub(),
+  uuidV4: stub()
+};
 
 proxyquire.noPreserveCache();
 proxyquire.preserveCache();
 
-proxyquire('../browser', {'./utils': {sleep}});
+proxyquire('../browser', {
+  'fs-promise': {outputFile: stubs.outputFile},
+  'uuid/v4': stubs.uuidV4,
+  './utils': {sleep: stubs.sleep}
+});
 
 import {Browser} from '../browser';
 
 function createTestName(method: string, result: string): string {
   return `\`Browser.${method}\` should return an ${result}`;
 }
 
-test.beforeEach(t => {
-  sleep.reset();
-  sleep.resetBehavior();
+let browser: Browser;
+
+test.beforeEach(() => {
+  browser = new Browser('screenshotDirectory');
+
+  for (const key of Object.keys(stubs)) {
+    (stubs as any)[key].reset();
+    (stubs as any)[key].resetBehavior();
+  }
 });
 
 test(createTestName('pageTitle', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().pageTitle;
+  const accessor = browser.pageTitle;
 
   t.is(format(accessor.description), 'page title');
 
@@ -42,7 +56,7 @@ test(createTestName('pageTitle', 'accessor'), async t => {
 test(createTestName('pageUrl', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().pageUrl;
+  const accessor = browser.pageUrl;
 
   t.is(format(accessor.description), 'page url');
 
@@ -56,7 +70,7 @@ test(createTestName('pageUrl', 'accessor'), async t => {
 test(createTestName('windowX', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().windowX;
+  const accessor = browser.windowX;
 
   t.is(format(accessor.description), 'window x-position');
 
@@ -72,7 +86,7 @@ test(createTestName('windowX', 'accessor'), async t => {
 test(createTestName('windowY', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().windowY;
+  const accessor = browser.windowY;
 
   t.is(format(accessor.description), 'window y-position');
 
@@ -88,7 +102,7 @@ test(createTestName('windowY', 'accessor'), async t => {
 test(createTestName('windowWidth', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().windowWidth;
+  const accessor = browser.windowWidth;
 
   t.is(format(accessor.description), 'window width');
 
@@ -104,7 +118,7 @@ test(createTestName('windowWidth', 'accessor'), async t => {
 test(createTestName('windowHeight', 'accessor'), async t => {
   t.plan(3);
 
-  const accessor = new Browser().windowHeight;
+  const accessor = browser.windowHeight;
 
   t.is(format(accessor.description), 'window height');
 
@@ -121,7 +135,7 @@ test(createTestName('scriptResult', 'accessor'), async t => {
   t.plan(4);
 
   const script = () => undefined;
-  const accessor = new Browser().scriptResult('scriptName', script);
+  const accessor = browser.scriptResult('scriptName', script);
 
   t.is(format(accessor.description), 'result of script \'scriptName\'');
 
@@ -137,7 +151,7 @@ test(createTestName('executeScript', 'action'), async t => {
   t.plan(4);
 
   const script = () => undefined;
-  const action = new Browser().executeScript('scriptName', script);
+  const action = browser.executeScript('scriptName', script);
 
   t.is(format(action.description), 'execute script \'scriptName\'');
 
@@ -155,7 +169,7 @@ test(createTestName('executeScript', 'action'), async t => {
 test(createTestName('loadPage', 'action'), async t => {
   t.plan(4);
 
-  const action = new Browser().loadPage('pageUrl');
+  const action = browser.loadPage('pageUrl');
 
   t.is(format(action.description), 'load page \'pageUrl\'');
 
@@ -173,7 +187,7 @@ test(createTestName('loadPage', 'action'), async t => {
 test(createTestName('maximizeWindow', 'action'), async t => {
   t.plan(3);
 
-  const action = new Browser().maximizeWindow();
+  const action = browser.maximizeWindow();
 
   t.is(format(action.description), 'maximize window');
 
@@ -190,7 +204,7 @@ test(createTestName('maximizeWindow', 'action'), async t => {
 test(createTestName('navigateBack', 'action'), async t => {
   t.plan(3);
 
-  const action = new Browser().navigateBack();
+  const action = browser.navigateBack();
 
   t.is(format(action.description), 'navigate back');
 
@@ -207,7 +221,7 @@ test(createTestName('navigateBack', 'action'), async t => {
 test(createTestName('navigateForward', 'action'), async t => {
   t.plan(3);
 
-  const action = new Browser().navigateForward();
+  const action = browser.navigateForward();
 
   t.is(format(action.description), 'navigate forward');
 
@@ -224,7 +238,7 @@ test(createTestName('navigateForward', 'action'), async t => {
 test(createTestName('reloadPage', 'action'), async t => {
   t.plan(3);
 
-  const action = new Browser().reloadPage();
+  const action = browser.reloadPage();
 
   t.is(format(action.description), 'reload page');
 
@@ -241,7 +255,7 @@ test(createTestName('reloadPage', 'action'), async t => {
 test(createTestName('setWindowPosition', 'action'), async t => {
   t.plan(5);
 
-  const action = new Browser().setWindowPosition(123, 456);
+  const action = browser.setWindowPosition(123, 456);
 
   t.is(format(action.description), 'set window position to 123,456');
 
@@ -262,7 +276,7 @@ test(createTestName('setWindowPosition', 'action'), async t => {
 test(createTestName('setWindowSize', 'action'), async t => {
   t.plan(5);
 
-  const action = new Browser().setWindowSize(123, 456);
+  const action = browser.setWindowSize(123, 456);
 
   t.is(format(action.description), 'set window size to 123x456');
 
@@ -281,18 +295,45 @@ test(createTestName('setWindowSize', 'action'), async t => {
 test(createTestName('sleep', 'action'), async t => {
   t.plan(4);
 
-  const action = new Browser().sleep(50);
+  const action = browser.sleep(50);
 
   t.is(format(action.description), `sleep for 50 ms`);
 
   const deferred = new Deferred();
 
-  sleep.resolves(deferred);
+  stubs.sleep.resolves(deferred);
 
   await action.perform({} as any);
 
   t.true(deferred.done);
 
-  t.is(sleep.callCount, 1);
-  t.is(sleep.args[0][0], 50);
+  t.is(stubs.sleep.callCount, 1);
+  t.is(stubs.sleep.args[0][0], 50);
+});
+
+test(createTestName('takeScreenshot', 'action'), async t => {
+  t.plan(6);
+
+  stubs.uuidV4.returns('uuid');
+
+  const action = browser.takeScreenshot();
+
+  t.is(
+    format(action.description),
+    'take screenshot \'screenshotDirectory/uuid.png\''
+  );
+
+  const takeScreenshot = stub().resolves('screenshot');
+  const deferred = new Deferred();
+
+  stubs.outputFile.resolves(deferred);
+
+  await action.perform({takeScreenshot} as any);
+
+  t.true(deferred.done);
+
+  t.is(stubs.outputFile.callCount, 1);
+  t.is(stubs.outputFile.args[0][0], 'screenshotDirectory/uuid.png');
+  t.is(stubs.outputFile.args[0][1], 'screenshot');
+  t.deepEqual(stubs.outputFile.args[0][2], {encoding: 'base64'});
 });