@applitools/screenshoter 3.2.6 → 3.3.0

package/test/e2e/web-ios.spec.js

@@ -1,18 +1,31 @@
 const assert = require('assert')
 const pixelmatch = require('pixelmatch')
 const {Driver} = require('@applitools/driver')
-const spec = require('../util/spec-driver')
-const screenshoter = require('../../index')
+const spec = require('@applitools/spec-driver-webdriverio')
+const takeScreenshot = require('../../index')
 const makeImage = require('../../src/image')
 
-// TODO add tests for page without viewport meta tag
+const env = {
+  url: 'https://ondemand.saucelabs.com/wd/hub',
+  capabilities: {
+    name: 'iOS Web Screenshoter Test',
+    deviceName: 'iPhone 11 Pro Simulator',
+    browserName: 'safari',
+    platformName: 'iOS',
+    platformVersion: '14.5',
+    appiumVersion: '1.20.1',
+    automationName: 'XCUITest',
+    username: process.env.SAUCE_USERNAME,
+    accessKey: process.env.SAUCE_ACCESS_KEY,
+  },
+}
 
 describe('screenshoter web ios', () => {
   const logger = {log: () => {}, warn: () => {}, error: () => {}, verbose: () => {}}
   let driver, browser, destroyBrowser
 
   before(async () => {
-    ;[browser, destroyBrowser] = await spec.build({type: 'web-ios'})
+    ;[browser, destroyBrowser] = await spec.build(env)
   })
 
   after(async () => {
@@ -34,7 +47,7 @@ describe('screenshoter web ios', () => {
   })
 
   async function viewport(options) {
-    const screenshot = await screenshoter({logger, driver, ...options})
+    const screenshot = await takeScreenshot({logger, driver, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web-ios/page.png').toObject()
@@ -46,7 +59,7 @@ describe('screenshoter web ios', () => {
   }
 
   async function fullPage(options) {
-    const screenshot = await screenshoter({logger, driver, fully: true, ...options})
+    const screenshot = await takeScreenshot({logger, driver, fully: true, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web-ios/page-fully.png').toObject()

package/test/e2e/web.spec.js

@@ -1,10 +1,17 @@
 const assert = require('assert')
 const pixelmatch = require('pixelmatch')
 const {Driver} = require('@applitools/driver')
-const spec = require('../util/spec-driver')
-const screenshoter = require('../../index')
+const spec = require('@applitools/spec-driver-webdriverio')
+const takeScreenshot = require('../../index')
 const makeImage = require('../../src/image')
 
+const env = {
+  url: 'http://localhost:4444/wd/hub',
+  capabilities: {
+    browserName: 'chrome',
+  },
+}
+
 // TODO add overflowed regions tests
 
 describe('screenshoter web', () => {
@@ -12,7 +19,7 @@ describe('screenshoter web', () => {
   let driver, browser, destroyBrowser
 
   before(async () => {
-    ;[browser, destroyBrowser] = await spec.build({type: 'web'})
+    ;[browser, destroyBrowser] = await spec.build(env)
   })
 
   after(async () => {
@@ -37,10 +44,10 @@ describe('screenshoter web', () => {
   })
 
   it('take frame screenshot with "scroll" scrolling', () => {
-    frame({scrollingMode: 'scroll'})
+    return frame({scrollingMode: 'scroll'})
   })
   it('take frame screenshot with "css" scrolling', () => {
-    frame({scrollingMode: 'css'})
+    return frame({scrollingMode: 'css'})
   })
 
   it('take full frame screenshot with "scroll" scrolling', () => {
@@ -51,10 +58,10 @@ describe('screenshoter web', () => {
   })
 
   it('take region screenshot with "scroll" scrolling', () => {
-    region({scrollingMode: 'scroll'})
+    return region({scrollingMode: 'scroll'})
   })
   it('take region screenshot with "css" scrolling', () => {
-    region({scrollingMode: 'css'})
+    return region({scrollingMode: 'css'})
   })
 
   it('take full region screenshot with "scroll" scrolling', () => {
@@ -121,7 +128,7 @@ describe('screenshoter web', () => {
   })
 
   async function viewport(options) {
-    const screenshot = await screenshoter({logger, driver, ...options})
+    const screenshot = await takeScreenshot({logger, driver, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/page.png').toObject()
@@ -132,7 +139,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullPage(options) {
-    const screenshot = await screenshoter({logger, driver, fully: true, ...options})
+    const screenshot = await takeScreenshot({logger, driver, fully: true, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/page-fully.png').toObject()
@@ -143,7 +150,12 @@ describe('screenshoter web', () => {
     }
   }
   async function frame(options) {
-    const screenshot = await screenshoter({logger, driver, frames: [{reference: 'iframe[name="frame1"]'}], ...options})
+    const screenshot = await takeScreenshot({
+      logger,
+      driver,
+      frames: [{reference: 'iframe[name="frame1"]'}],
+      ...options,
+    })
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/frame.png').toObject()
@@ -154,7 +166,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}],
@@ -172,7 +184,7 @@ describe('screenshoter web', () => {
   }
   async function region(options) {
     const region = {x: 30, y: 500, height: 100, width: 200}
-    const screenshot = await screenshoter({logger, driver, region, ...options})
+    const screenshot = await takeScreenshot({logger, driver, region, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/region.png').toObject()
@@ -184,7 +196,7 @@ describe('screenshoter web', () => {
   }
   async function fullRegion(options) {
     const region = {x: 30, y: 500, height: 700, width: 200}
-    const screenshot = await screenshoter({logger, driver, region, fully: true, ...options})
+    const screenshot = await takeScreenshot({logger, driver, region, fully: true, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/region-fully.png').toObject()
@@ -195,7 +207,7 @@ describe('screenshoter web', () => {
     }
   }
   async function element(options) {
-    const screenshot = await screenshoter({logger, driver, region: '#overflowing-div-image', ...options})
+    const screenshot = await takeScreenshot({logger, driver, region: '#overflowing-div-image', ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/element.png').toObject()
@@ -206,7 +218,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullElement(options) {
-    const screenshot = await screenshoter({logger, driver, region: '#overflowing-div-image', fully: true, ...options})
+    const screenshot = await takeScreenshot({logger, driver, region: '#overflowing-div-image', fully: true, ...options})
     try {
       const actual = await screenshot.image.toObject()
       const expected = await makeImage('./test/fixtures/web/element-fully.png').toObject()
@@ -217,7 +229,7 @@ describe('screenshoter web', () => {
     }
   }
   async function regionInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}],
@@ -234,7 +246,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullRegionInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}],
@@ -252,7 +264,7 @@ describe('screenshoter web', () => {
     }
   }
   async function elementInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}],
@@ -269,7 +281,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullElementInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}],
@@ -287,7 +299,7 @@ describe('screenshoter web', () => {
     }
   }
   async function frameInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}, {reference: 'iframe[name="frame1-1"]'}],
@@ -303,7 +315,7 @@ describe('screenshoter web', () => {
     }
   }
   async function fullFrameInFrame(options) {
-    const screenshot = await screenshoter({
+    const screenshot = await takeScreenshot({
       logger,
       driver,
       frames: [{reference: 'iframe[name="frame1"]'}, {reference: 'iframe[name="frame1-1"]'}],

package/test/it/find-pattern.spec.js

@@ -4,23 +4,28 @@ const findPattern = require('../../src/find-image-pattern')
 
 describe('pattern', () => {
   const fixtures = [
-    {name: 'iPhone_5S_landscape', position: {x: 0, y: 100}, pixelRatio: 2},
-    {name: 'iPhone_X_perfecto_portrait', position: {x: 0, y: 297}, pixelRatio: 3},
-    {name: 'iPhone_XR_perfecto_landscape', position: {x: 88, y: 100}, pixelRatio: 2},
-    {name: 'iPhone_XS_Max_perfecto_landscape', position: {x: 132, y: 150}, pixelRatio: 3},
-    {name: 'iPhone_XS_landscape', position: {x: 132, y: 150}, pixelRatio: 3},
-    {name: 'iPhone_XS_portrait', position: {x: 0, y: 282}, pixelRatio: 3},
-    {name: 'iPad_Air_portrait', position: {x: 0, y: 140}, pixelRatio: 2},
+    {name: 'iPhone_SE_portrait', position: {x: 0, y: 140}, offset: 0, pixelRatio: 2},
+    {name: 'iPhone_SE_landscape', position: {x: 0, y: 100}, offset: 0, pixelRatio: 2},
+    {name: 'iPhone_11_portrait', position: {x: 0, y: 282}, offset: 0, pixelRatio: 3},
+    {name: 'iPhone_11_landscape', position: {x: 132, y: 150}, offset: 0, pixelRatio: 3},
+    {name: 'iPhone_13_portrait', position: {x: 0, y: 141}, offset: 0, pixelRatio: 3},
+    {name: 'iPhone_13_landscape', position: {x: 141, y: 144}, offset: 0, pixelRatio: 3},
+    {name: 'iPad_5th_portrait', position: {x: 0, y: 140}, offset: 0, pixelRatio: 2},
+    {name: 'iPad_5th_landscape', position: {x: 0, y: 140}, offset: 0, pixelRatio: 2},
+    {name: 'iPad_9th_portrait', position: {x: 0, y: 136}, offset: 0, pixelRatio: 2},
+    {name: 'iPad_9th_landscape', position: {x: 641, y: 137}, offset: 1, pixelRatio: 2},
+    {name: 'iPhone_XS_portrait_noviewport', position: {x: 0, y: 282}, offset: 0, pixelRatio: 3},
     {name: 'iPhone_XS_portrait_nomarker', position: null, pixelRatio: 3},
   ]
 
-  fixtures.forEach(({name, position, pixelRatio}) => {
+  fixtures.forEach(({name, position, offset, pixelRatio}) => {
     it(name, async () => {
       const image = await makeImage(`./test/fixtures/pattern/${name}.png`)
       const result = findPattern(await image.toObject(), {
-        offset: 1 * pixelRatio,
-        size: 3 * pixelRatio,
-        mask: [0, 1, 0],
+        pixelRatio,
+        mask: [1, 0, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1, 1, 0, 1, 0, 0, 1, 1, 1],
+        offset,
+        size: 1,
       })
       assert.deepStrictEqual(result, position)
     })

package/test/it/image.spec.js

@@ -78,42 +78,69 @@ describe('image', () => {
     assert.strictEqual(actual.height, 50000)
   })
 
-  it('should replace region in image with a higher and wider image', async () => {
+  it('should frame image in a higher and wider region', async () => {
     const image = makeImage('./test/fixtures/image/house.png')
     const srcImage = makeImage({
       width: 200,
       height: 200,
       data: Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0, 0xff])),
     })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 100, height: 100})
+    const combinedImage = await srcImage.frame(image, image, {x: 200, y: 200, width: 100, height: 100})
     const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-higher-wider.png').toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-higher-wider.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 
-  it('should replace region in image with a higher image', async () => {
+  it('should frame image in a higher region', async () => {
     const image = await makeImage('./test/fixtures/image/house.png')
     const srcImage = makeImage({
       width: 200,
       height: 200,
       data: Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0xff, 0, 0xff])),
     })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 200, height: 100})
+    const combinedImage = await srcImage.frame(image, image, {x: 200, y: 200, width: 200, height: 100})
     const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-higher.png').toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-higher.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 
-  it('should replace region in image with a higher image', async () => {
+  it('should frame image in a wider region', async () => {
     const image = await makeImage('./test/fixtures/image/house.png')
-    const srcImage = makeImage({
-      width: 200,
-      height: 200,
-      data: Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0, 0xff, 0xff])),
-    })
-    const combinedImage = await srcImage.combine(image, image, {x: 200, y: 200, width: 100, height: 200})
-    const actual = await combinedImage.toObject()
-    const expected = await makeImage('./test/fixtures/image/house.combined-wider.png').toObject()
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 200, y: 200, width: 100, height: 200})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-wider.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a shorter and thinner region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 250, height: 250})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a shorter region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 200, height: 250})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
+    assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
+  })
+
+  it('should frame image in a thinner region', async () => {
+    const image = await makeImage('./test/fixtures/image/house.png')
+    const data = Buffer.alloc(200 * 200 * 4, Buffer.from([0xff, 0, 0xff, 0xff]))
+    const actual = await makeImage({width: 200, height: 200, data})
+      .frame(image, image, {x: 100, y: 100, width: 250, height: 200})
+      .toObject()
+    const expected = await makeImage('./test/fixtures/image/house.framed-shorter-thinner.png').toObject()
     assert.ok(pixelmatch(actual.data, expected.data, null, expected.width, expected.height) === 0)
   })
 })

package/src/calculate-screenshot-regions.js

@@ -1,31 +0,0 @@
-const utils = require('@applitools/utils')
-
-async function calculateScreenshotRegions({context, screenshotRegion, regions}) {
-  const screenshotRegions = []
-  for (const region of regions) {
-    screenshotRegions.push(await transformRegion(region))
-  }
-
-  return screenshotRegions
-
-  async function transformRegion(region) {
-    if (utils.types.has(region, ['x', 'y', 'width', 'height'])) {
-      // if someday different coordinate systems will be supported (context or app based), the conversion will happen here
-      return [regions]
-    }
-    const elements = await context.elements(region)
-    return elements.reduce(async (regions, element) => {
-      regions = await regions
-      const region = await element.getRegion()
-      regions.push({
-        x: Math.max(0, region.x - screenshotRegion.x),
-        y: Math.max(0, region.y - screenshotRegion.y),
-        width: region.width,
-        height: region.height,
-      })
-      return regions
-    }, [])
-  }
-}
-
-module.exports = calculateScreenshotRegions