@applitools/screenshoter 3.3.3 → 3.3.7

package/test/e2e/ios.spec.js

@@ -1,339 +0,0 @@
-const assert = require('assert')
-const pixelmatch = require('pixelmatch')
-const utils = require('@applitools/utils')
-const {Driver} = require('@applitools/driver')
-const spec = require('@applitools/spec-driver-webdriverio')
-const makeImage = require('../../src/image')
-const takeScreenshot = require('../../index')
-
-const env = {
-  url: 'https://ondemand.saucelabs.com/wd/hub',
-  capabilities: {
-    name: 'iOS Screenshoter Test',
-    deviceName: 'iPhone 11 Pro Simulator',
-    platformName: 'iOS',
-    platformVersion: '14.5',
-    appiumVersion: '1.21.0',
-    automationName: 'XCUITest',
-    app: 'https://applitools.jfrog.io/artifactory/Examples/IOSTestApp/1.9/app/IOSTestApp.zip',
-    username: process.env.SAUCE_USERNAME,
-    accessKey: process.env.SAUCE_ACCESS_KEY,
-  },
-
-  // url: 'http://0.0.0.0:4723/wd/hub',
-  // capabilities: {
-  //   deviceName: 'iPhone 11 Pro',
-  //   platformName: 'iOS',
-  //   platformVersion: '14.5',
-  //   automationName: 'XCUITest',
-  //   app: 'https://applitools.jfrog.io/artifactory/Examples/IOSTestApp/1.9/app/IOSTestApp.zip',
-  // },
-}
-
-describe('screenshoter ios', () => {
-  const logger = {log: () => {}, warn: () => {}, error: () => {}, verbose: () => {}}
-  let driver, browser, destroyBrowser
-
-  async function sanitizeStatusBar(image) {
-    const leftPatchImage = makeImage({
-      width: 50,
-      height: 16,
-      data: Buffer.alloc(50 * 16 * 4, Buffer.from([0, 0xed, 0xed, 0xff])),
-    })
-    await image.copy(leftPatchImage, {x: 18, y: 15})
-    const rightPatchImage = makeImage({
-      width: 75,
-      height: 16,
-      data: Buffer.alloc(75 * 16 * 4, Buffer.from([0, 0xed, 0xed, 0xff])),
-    })
-    await image.copy(rightPatchImage, {x: 290, y: 15})
-  }
-
-  before(async () => {
-    ;[browser, destroyBrowser] = await spec.build(env)
-  })
-
-  after(async () => {
-    await destroyBrowser()
-  })
-
-  beforeEach(async () => {
-    await browser.closeApp()
-    await browser.launchApp()
-    driver = await new Driver({driver: browser, spec, logger}).init()
-  })
-
-  it('take viewport screenshot', () => {
-    return app()
-  })
-
-  it('take viewport screenshot with status bar', () => {
-    return app({withStatusBar: true})
-  })
-
-  it('take full app screenshot (scroll view)', () => {
-    return fullApp({type: 'scroll'})
-  })
-
-  it('take full app screenshot with status bar (scroll view)', () => {
-    return fullApp({type: 'scroll', withStatusBar: true})
-  })
-
-  it('take full app screenshot (table view)', () => {
-    return fullApp({type: 'table'})
-  })
-
-  it('take full app screenshot (collection view)', () => {
-    return fullApp({type: 'collection'})
-  })
-
-  it('take full app screenshot (table view with collapsing header)', () => {
-    return fullApp({type: 'collapsing'})
-  })
-
-  it('take full app screenshot (collection view with overlapped status bar)', () => {
-    return fullApp({type: 'overlapped'})
-  })
-
-  it('take full app screenshot with status bar (collection view with overlapped status bar)', () => {
-    return fullApp({type: 'overlapped', withStatusBar: true})
-  })
-
-  it('take full app screenshot (collection view with superview)', () => {
-    return fullApp({type: 'superview'})
-  })
-
-  it('take webview screenshot', () => {
-    return webview()
-  })
-
-  it('take full webview screenshot', () => {
-    return fullWebview()
-  })
-
-  it('take region screenshot', () => {
-    return region()
-  })
-
-  it.skip('take full region screenshot', () => {
-    return fullRegion()
-  })
-
-  it('take element screenshot', () => {
-    return element()
-  })
-
-  it('take full element screenshot', () => {
-    return fullElement()
-  })
-
-  async function app(options = {}) {
-    const expectedPath = `./test/fixtures/ios/app${options.withStatusBar ? '-statusbar' : ''}.png`
-    const buttonSelector = {type: 'accessibility id', selector: 'Empty table view'}
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-
-    const screenshot = await takeScreenshot({logger, driver, ...options})
-    try {
-      if (options.withStatusBar) await sanitizeStatusBar(screenshot.image)
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'viewport_failed', suffix: Date.now()})
-      throw err
-    }
-  }
-  async function fullApp({type, ...options} = {}) {
-    let buttonSelector, expectedPath, overlap
-    if (type === 'superview') {
-      overlap = {top: 200}
-      buttonSelector = {type: 'accessibility id', selector: 'Bottom to superview'}
-      expectedPath = `./test/fixtures/ios/app-fully-superview${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'overlapped') {
-      overlap = {top: 200}
-      buttonSelector = {type: 'accessibility id', selector: 'Bottom to safe area'}
-      expectedPath = `./test/fixtures/ios/app-fully-overlapped${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'collapsing') {
-      buttonSelector = {type: 'accessibility id', selector: 'Table view with stretchable header'}
-      expectedPath = `./test/fixtures/ios/app-fully-collapsing${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'collection') {
-      buttonSelector = {type: 'accessibility id', selector: 'Collection view'}
-      expectedPath = `./test/fixtures/ios/app-fully-collection${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'table') {
-      buttonSelector = {type: 'accessibility id', selector: 'Table view'}
-      expectedPath = `./test/fixtures/ios/app-fully-table${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else {
-      buttonSelector = {type: 'accessibility id', selector: 'Scroll view'}
-      expectedPath = `./test/fixtures/ios/app-fully-scroll${options.withStatusBar ? '-statusbar' : ''}.png`
-    }
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-
-    await driver.init()
-
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      fully: true,
-      framed: true,
-      scrollingMode: 'scroll',
-      wait: 1500,
-      overlap: {top: 10, bottom: 50, ...overlap},
-      ...options,
-    })
-    try {
-      if (options.withStatusBar) await sanitizeStatusBar(screenshot.image)
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'full_app_failed', suffix: Date.now()})
-      throw err
-    }
-  }
-  async function webview(options) {
-    const expectedPath = `./test/fixtures/ios/webview.png`
-    const buttonSelector = {type: 'accessibility id', selector: 'Web view'}
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-    await driver.target.getContexts()
-    await utils.general.sleep(500)
-    const [, webview] = await driver.target.getContexts()
-    console.log(webview)
-    await driver.target.switchContext(webview)
-
-    await driver.init()
-
-    const screenshot = await takeScreenshot({logger, driver, wait: 1500, ...options})
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'webview_failed', suffix: Date.now()})
-      throw err
-    } finally {
-      await driver.target.switchContext('NATIVE_APP')
-    }
-  }
-  async function fullWebview(options) {
-    const expectedPath = `./test/fixtures/ios/webview-fully.png`
-    const buttonSelector = {type: 'accessibility id', selector: 'Web view'}
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-    await driver.target.getContexts()
-    await utils.general.sleep(500)
-    const [, webview] = await driver.target.getContexts()
-    await driver.target.switchContext(webview)
-
-    await driver.init()
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      wait: 1500,
-      fully: true,
-      scrollingMode: 'scroll',
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'full_webview_failed', suffix: Date.now()})
-      throw err
-    } finally {
-      await driver.target.switchContext('NATIVE_APP')
-    }
-  }
-  async function region(options) {
-    const expectedPath = `./test/fixtures/ios/region.png`
-    const buttonSelector = {type: 'accessibility id', selector: 'Empty table view'}
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-
-    await driver.init()
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {x: 30, y: 500, height: 100, width: 200},
-      scrollingMode: 'scroll',
-      wait: 1500,
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'region_failed'})
-      throw err
-    }
-  }
-  async function fullRegion(options) {
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {x: 30, y: 10, height: 700, width: 200},
-      fully: true,
-      scrollingMode: 'scroll',
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/ios/region-fully.png').toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'full_region_failed'})
-      throw err
-    }
-  }
-  async function element(options) {
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {type: 'accessibility id', selector: 'Table view'},
-      scrollingMode: 'scroll',
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/ios/element.png').toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'element_failed'})
-      throw err
-    }
-  }
-  async function fullElement(options) {
-    const button = await driver.element({
-      type: 'accessibility id',
-      selector: 'Scroll view with nested table',
-    })
-    await button.click()
-
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {type: 'xpath', selector: '//XCUIElementTypeTable[1]'},
-      fully: true,
-      scrollingMode: 'scroll',
-      wait: 1500,
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/ios/element-fully.png').toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'full_element_failed'})
-      throw err
-    }
-  }
-})

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

@@ -1,107 +0,0 @@
-const assert = require('assert')
-const pixelmatch = require('pixelmatch')
-const {Driver} = require('@applitools/driver')
-const spec = require('@applitools/spec-driver-webdriverio')
-const takeScreenshot = require('../../index')
-const makeImage = require('../../src/image')
-
-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,
-  },
-
-  // url: 'http://0.0.0.0:4723/wd/hub',
-  // capabilities: {
-  //   name: 'iOS Web Screenshoter Test',
-  //   deviceName: 'iPhone 11 Pro',
-  //   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(env)
-  })
-
-  after(async () => {
-    await destroyBrowser()
-  })
-
-  beforeEach(async () => {
-    driver = await new Driver({driver: browser, spec, logger}).init()
-    await driver.visit('https://applitools.github.io/demo/TestPages/PageWithBurgerMenu/')
-    await driver.setViewportSize({width: 700, height: 460})
-  })
-
-  it('take viewport screenshot', () => {
-    return viewport({orientation: 'portrait'})
-  })
-
-  it('take viewport screenshot with landscape orientation', () => {
-    return viewport({orientation: 'landscape'})
-  })
-
-  it('take full page screenshot', () => {
-    return fullPage({orientation: 'portrait'})
-  })
-
-  it('take full page screenshot with landscape orientation', () => {
-    return fullPage({orientation: 'landscape'})
-  })
-
-  async function viewport({orientation = 'portrait', ...options} = {}) {
-    const expectedPath = `./test/fixtures/web-ios/page${orientation === 'landscape' ? '-landscape' : ''}.png`
-
-    await driver.target.setOrientation(orientation.toUpperCase())
-    await driver.visit(await driver.getUrl())
-
-    await driver.init()
-
-    const screenshot = await takeScreenshot({logger, driver, ...options})
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'ios_viewport_failed'})
-      throw err
-    }
-  }
-
-  async function fullPage({orientation = 'portrait', ...options} = {}) {
-    const expectedPath = `./test/fixtures/web-ios/page-fully${orientation === 'landscape' ? '-landscape' : ''}.png`
-
-    await driver.target.setOrientation(orientation.toUpperCase())
-    await driver.visit(await driver.getUrl())
-
-    await driver.init()
-
-    const screenshot = await takeScreenshot({logger, driver, fully: true, ...options})
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage(expectedPath).toObject()
-      assert.strictEqual(pixelmatch(actual.data, expected.data, null, expected.width, expected.height), 0)
-    } catch (err) {
-      await screenshot.image.debug({path: './logs', name: 'ios_full_page_failed'})
-      throw err
-    }
-  }
-})