@applitools/screenshoter 3.3.4 → 3.3.5

package/CHANGELOG.md

@@ -4,6 +4,11 @@
 ## Unreleased
 
 
+## 3.3.5 - 2022/2/8
+
+- add "files" field to the package.json to avoid unnecessary files to be published
+- updated to @applitools/utils@1.2.11 (from 1.2.5)
+
 ## 3.3.4 - 2021/12/23
 
 - updated to @applitools/snippets@2.1.12 (from 2.1.11)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/screenshoter",
-  "version": "3.3.4",
+  "version": "3.3.5",
   "description": "Applitools universal screenshoter for web and native applications",
   "keywords": [
     "applitools",
@@ -26,19 +26,25 @@
     "email": "team@applitools.com"
   },
   "main": "./index.js",
-  "directories": {
-    "lib": "./lib",
-    "test": "./test"
-  },
+  "files": [
+    "src",
+    "index.js"
+  ],
   "scripts": {
     "lint": "eslint . --ext .js",
-    "test": "yarn test:it && yarn test:e2e",
-    "test:it": "mocha --no-timeouts './test/it/*.spec.js'",
-    "test:e2e": "mocha --no-timeouts './test/e2e/*.spec.js'",
+    "test": "yarn test:it && yarn test:e2e:ios",
+    "test:it": "mocha ./test/it/*.spec.js --no-timeouts",
+    "test:e2e": "mocha ./test/e2e/**/*.spec.js --no-timeouts --parallel --jobs ${MOCHA_JOBS:-1}",
+    "test:e2e:android": "mocha ./test/e2e/android/*.spec.js --no-timeouts --parallel --jobs ${MOCHA_JOBS:-1}",
+    "test:e2e:ios": "mocha ./test/e2e/ios/*.spec.js --no-timeouts --parallel --jobs ${MOCHA_JOBS:-1}",
+    "setup": "mkdir -p ./logs && yarn ios:setup && yarn appium:setup",
+    "android:setup": "node ./scripts/android-emulator.js",
+    "ios:setup": "node ./scripts/ios-simulator.js",
+    "appium:setup": "appium --address 127.0.0.1 --port 4723 --base-path /wd/hub --log-level error:info --log ./logs/appium.log &",
     "docker:setup": "node ../scripts/scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
-    "setup": "yarn docker:setup",
     "deps": "bongo deps",
+    "gh:publish": "gh workflow run publish.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages=screenshoter",
     "preversion": "bongo preversion",
     "version": "bongo version",
     "postversion": "bongo postversion --skip-release-notification"
@@ -50,21 +56,22 @@
   },
   "dependencies": {
     "@applitools/snippets": "2.1.12",
-    "@applitools/utils": "1.2.5",
+    "@applitools/utils": "1.2.11",
     "png-async": "0.9.4"
   },
   "devDependencies": {
-    "@applitools/driver": "1.4.7",
-    "@applitools/sdk-release-kit": "0.13.4",
-    "@applitools/spec-driver-webdriverio": "1.2.5",
-    "@applitools/test-utils": "1.0.10",
+    "@applitools/driver": "1.4.10",
+    "@applitools/sdk-release-kit": "0.13.11",
+    "@applitools/spec-driver-webdriverio": "1.2.6",
+    "@applitools/test-utils": "1.0.11",
+    "appium": "^1.22.2",
     "chromedriver": "^95.0.0",
     "eslint": "^7.9.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.1.4",
     "husky": "^4.3.8",
-    "mocha": "^8.2.1",
+    "mocha": "^9.2.0",
     "pixelmatch": "^5.2.1",
     "prettier": "1.19.0",
     "webdriverio": "^7.16.7"

package/.bongo/dry-run/package-lock.json

@@ -1,73 +0,0 @@
-{
-  "name": "dry-run",
-  "lockfileVersion": 2,
-  "requires": true,
-  "packages": {
-    "": {
-      "dependencies": {
-        "@applitools/screenshoter": "file:../dry-run.tgz"
-      }
-    },
-    "node_modules/@applitools/screenshoter": {
-      "version": "3.3.3",
-      "resolved": "file:../dry-run.tgz",
-      "integrity": "sha512-Z9adhafLkHH0o9oRHyA8QeKWTBNejGVnwX3MzkRI0K6pCS+tdoxwpxzsoJRIhj8WiZn4AWpOgafRh7Uu+QXB1g==",
-      "license": "SEE LICENSE IN LICENSE",
-      "dependencies": {
-        "@applitools/snippets": "2.1.12",
-        "@applitools/utils": "1.2.5",
-        "png-async": "0.9.4"
-      },
-      "engines": {
-        "node": ">= 8.9.0"
-      }
-    },
-    "node_modules/@applitools/snippets": {
-      "version": "2.1.12",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.12.tgz",
-      "integrity": "sha512-XFj9ZMJ8VNNzAuCdGqgmC+SEZY61jRahAiZ/W1dgyJJrEIWmkEm/8USq/3n1mJbbyDV8VhT6+aSikqoanzPETQ==",
-      "engines": {
-        "node": ">=8.9.0"
-      }
-    },
-    "node_modules/@applitools/utils": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.5.tgz",
-      "integrity": "sha512-nETSgqGeCk5yqjFaQ7x1KURf+t5IxsY2RoeFB5w1+6lHprmHdEithMcN0tiJWeqi14QBJdUkXCzCJrMW5RcDFg==",
-      "engines": {
-        "node": ">= 8.9.0"
-      }
-    },
-    "node_modules/png-async": {
-      "version": "0.9.4",
-      "resolved": "https://registry.npmjs.org/png-async/-/png-async-0.9.4.tgz",
-      "integrity": "sha512-B//AXX9TkneKfgtOpT1mdUnnhk2BImGD+a98vImsMU8uo1dBeHyW/kM2erWZ/CsYteTPU/xKG+t6T62heHkC3A=="
-    }
-  },
-  "dependencies": {
-    "@applitools/screenshoter": {
-      "version": "file:../dry-run.tgz",
-      "integrity": "sha512-Z9adhafLkHH0o9oRHyA8QeKWTBNejGVnwX3MzkRI0K6pCS+tdoxwpxzsoJRIhj8WiZn4AWpOgafRh7Uu+QXB1g==",
-      "requires": {
-        "@applitools/snippets": "2.1.12",
-        "@applitools/utils": "1.2.5",
-        "png-async": "0.9.4"
-      }
-    },
-    "@applitools/snippets": {
-      "version": "2.1.12",
-      "resolved": "https://registry.npmjs.org/@applitools/snippets/-/snippets-2.1.12.tgz",
-      "integrity": "sha512-XFj9ZMJ8VNNzAuCdGqgmC+SEZY61jRahAiZ/W1dgyJJrEIWmkEm/8USq/3n1mJbbyDV8VhT6+aSikqoanzPETQ=="
-    },
-    "@applitools/utils": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/@applitools/utils/-/utils-1.2.5.tgz",
-      "integrity": "sha512-nETSgqGeCk5yqjFaQ7x1KURf+t5IxsY2RoeFB5w1+6lHprmHdEithMcN0tiJWeqi14QBJdUkXCzCJrMW5RcDFg=="
-    },
-    "png-async": {
-      "version": "0.9.4",
-      "resolved": "https://registry.npmjs.org/png-async/-/png-async-0.9.4.tgz",
-      "integrity": "sha512-B//AXX9TkneKfgtOpT1mdUnnhk2BImGD+a98vImsMU8uo1dBeHyW/kM2erWZ/CsYteTPU/xKG+t6T62heHkC3A=="
-    }
-  }
-}

package/.bongo/dry-run/package.json

@@ -1,5 +0,0 @@
-{
-  "dependencies": {
-    "@applitools/screenshoter": "file:../dry-run.tgz"
-  }
-}

package/.eslintrc

@@ -1,39 +0,0 @@
-{
-  "env": {
-    "commonjs": true,
-    "es6": true,
-    "node": true,
-    "mocha": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "extends": ["plugin:node/recommended"],
-  "plugins": ["prettier", "mocha-no-only", "node"],
-  "ignorePatterns": [
-    "node_modules/",
-    "dist/",
-    "screenshots/",
-    "applitools.config.js",
-    "logs",
-    "tmp/",
-    "**/test/coverage/generic/"
-  ],
-  "rules": {
-    "prettier/prettier": ["error", {"allowParens": "avoid", "printWidth": 120}],
-    "no-process-exit": "off",
-    "no-const-assign": "error",
-    "no-this-before-super": "error",
-    "no-undef": "warn",
-    "no-unreachable": "warn",
-    "no-unused-vars": [
-      1,
-      {"varsIgnorePattern": "^_", "args": "all", "argsIgnorePattern": "^_"}
-    ],
-    "constructor-super": "warn",
-    "valid-typeof": "warn",
-    "mocha-no-only/mocha-no-only": "error",
-    "node/no-unpublished-require": ["off"]
-  }
-}

package/test/e2e/android.spec.js

@@ -1,334 +0,0 @@
-const assert = require('assert')
-const pixelmatch = require('pixelmatch')
-const {Driver} = require('@applitools/driver')
-const spec = require('@applitools/spec-driver-webdriverio')
-const makeImage = require('../../src/image')
-const takeScreenshot = require('../../index')
-
-const env = {
-  android: {
-    url: 'https://ondemand.saucelabs.com/wd/hub',
-    capabilities: {
-      name: 'Android Screenshoter Test',
-      browserName: '',
-      platformName: 'Android',
-      platformVersion: '7.0',
-      appiumVersion: '1.20.2',
-      deviceName: 'Samsung Galaxy S8 FHD GoogleAPI Emulator',
-      automationName: 'uiautomator2',
-      app: 'https://applitools.jfrog.io/artifactory/Examples/android/1.3/app-debug.apk',
-      username: process.env.SAUCE_USERNAME,
-      accessKey: process.env.SAUCE_ACCESS_KEY,
-    },
-
-    // url: 'http://0.0.0.0:4723/wd/hub',
-    // capabilities: {
-    //   deviceName: 'Google Pixel 3a XL',
-    //   platformName: 'Android',
-    //   platformVersion: '10.0',
-    //   automationName: 'uiautomator2',
-    //   nativeWebScreenshot: true,
-    //   avd: 'Pixel_3a_XL',
-    //   app: 'https://applitools.jfrog.io/artifactory/Examples/android/1.3/app-debug.apk',
-    // },
-  },
-  androidx: {
-    url: 'https://ondemand.saucelabs.com/wd/hub',
-    capabilities: {
-      name: 'AndroidX Screenshoter Test',
-      browserName: '',
-      platformName: 'Android',
-      platformVersion: '10.0',
-      appiumVersion: '1.20.2',
-      deviceName: 'Google Pixel 3a XL GoogleAPI Emulator',
-      automationName: 'uiautomator2',
-      app: 'https://applitools.jfrog.io/artifactory/Examples/androidx/1.3.1/app_androidx.apk',
-      username: process.env.SAUCE_USERNAME,
-      accessKey: process.env.SAUCE_ACCESS_KEY,
-    },
-
-    // url: 'http://0.0.0.0:4723/wd/hub',
-    // capabilities: {
-    //   deviceName: 'Google Pixel 3a XL',
-    //   platformName: 'Android',
-    //   platformVersion: '10.0',
-    //   automationName: 'uiautomator2',
-    //   avd: 'Pixel_3a_XL',
-    //   app: 'https://applitools.jfrog.io/artifactory/Examples/androidx/1.3.3/app_androidx.apk',
-    // },
-  },
-}
-
-describe('screenshoter', () => {
-  const logger = {log: () => {}, warn: () => {}, error: () => {}, verbose: () => {}}
-  let driver, browser, destroyBrowser
-
-  async function sanitizeStatusBar(image) {
-    const patchImage = makeImage({
-      width: 85,
-      height: 18,
-      data: Buffer.alloc(85 * 18 * 4, Buffer.from([0, 0xed, 0xed, 0xff])),
-    })
-    await image.copy(patchImage, {x: 270, y: 4})
-  }
-
-  describe('android app', () => {
-    before(async () => {
-      ;[browser, destroyBrowser] = await spec.build(env.android)
-    })
-
-    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 (recycler view)', () => {
-      return fullApp({type: 'recycler'})
-    })
-
-    it('take full app screenshot (non-scrollable)', () => {
-      return fullApp({type: 'non-scrollable'})
-    })
-
-    it.skip('take webview screenshot', () => {
-      return webview()
-    })
-
-    it('take region screenshot', () => {
-      return region()
-    })
-
-    it.skip('take full region screenshot', () => {
-      return fullRegion()
-    })
-
-    it('take element screenshot', () => {
-      return element()
-    })
-  })
-
-  describe('androidx app', () => {
-    before(async () => {
-      ;[browser, destroyBrowser] = await spec.build(env.androidx)
-    })
-
-    after(async () => {
-      await destroyBrowser()
-    })
-
-    beforeEach(async () => {
-      await browser.closeApp()
-      await browser.launchApp()
-      driver = await new Driver({driver: browser, spec, logger}).init()
-    })
-
-    it('take full app screenshot (recycler view)', () => {
-      return fullApp({type: 'recycler', x: true})
-    })
-
-    it('take full app screenshot (collapsing layout)', () => {
-      return fullApp({type: 'collapsing', x: true})
-    })
-
-    it.skip('take full app screenshot (pager)', () => {
-      return fullApp({type: 'pager', x: true})
-    })
-
-    it.skip('take full app screenshot (overlapped status bar)', () => {
-      return fullApp({type: 'overlapped', x: true})
-    })
-
-    it('take full element screenshot', () => {
-      return fullElement()
-    })
-  })
-
-  async function app(options = {}) {
-    const expectedPath = `./test/fixtures/android/app${options.withStatusBar ? '-statusbar' : ''}.png`
-
-    const screenshot = await takeScreenshot({logger, driver, wait: 1500, ...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, x, ...options} = {}) {
-    let buttonSelector, expectedPath, scrollingElementSelector
-    if (type === 'pager') {
-      buttonSelector = {type: 'id', selector: 'btn_view_pager_2_activity'}
-      expectedPath = `./test/fixtures/android/x-app-fully-pager${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'overlapped') {
-      buttonSelector = {type: 'id', selector: 'btn_recycler_view_under_status_bar_activity'}
-      expectedPath = `./test/fixtures/android/x-app-fully-overlapped${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'collapsing') {
-      buttonSelector = {type: 'id', selector: 'btn_recycler_view_nested_collapsing'}
-      scrollingElementSelector = {type: 'id', selector: 'recyclerView'}
-      expectedPath = `./test/fixtures/android/x-app-fully-collapsing${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else if (type === 'recycler') {
-      if (x) {
-        buttonSelector = {type: 'id', selector: 'btn_recycler_view_activity'}
-        expectedPath = `./test/fixtures/android/x-app-fully-recycler${options.withStatusBar ? '-statusbar' : ''}.png`
-      } else {
-        buttonSelector = {type: 'id', selector: 'btn_recycler_view'}
-        expectedPath = `./test/fixtures/android/app-fully-recycler${options.withStatusBar ? '-statusbar' : ''}.png`
-      }
-    } else if (type === 'non-scrollable') {
-      buttonSelector = {type: 'id', selector: 'btn_activity_as_dialog'}
-      expectedPath = `./test/fixtures/android/app-fully-non-scrollable${options.withStatusBar ? '-statusbar' : ''}.png`
-    } else {
-      buttonSelector = {type: 'id', selector: 'btn_scroll_view_footer_header'}
-      expectedPath = `./test/fixtures/android/app-fully-scroll${options.withStatusBar ? '-statusbar' : ''}.png`
-    }
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-
-    await driver.init()
-
-    if (scrollingElementSelector) {
-      await driver.currentContext.setScrollingElement(scrollingElementSelector)
-    }
-
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      fully: true,
-      framed: true,
-      scrollingMode: 'scroll',
-      wait: 1500,
-      ...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/android/webview.png`
-    const buttonSelector = {type: 'id', selector: 'btn_web_view'}
-
-    const button = await driver.element(buttonSelector)
-    await button.click()
-    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
-    }
-  }
-  async function region(options) {
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {x: 30, y: 500, height: 100, width: 200},
-      scrollingMode: 'scroll',
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/android/region.png').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', suffix: Date.now()})
-      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/android/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', suffix: Date.now()})
-      throw err
-    }
-  }
-  async function element(options) {
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {type: 'id', selector: 'btn_recycler_view'},
-      scrollingMode: 'scroll',
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/android/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', suffix: Date.now()})
-      throw err
-    }
-  }
-  async function fullElement(options) {
-    const button = await driver.element({
-      type: 'id',
-      selector: 'btn_recycler_view_in_scroll_view_activity',
-    })
-    await button.click()
-
-    const screenshot = await takeScreenshot({
-      logger,
-      driver,
-      region: {type: 'id', selector: 'recyclerView'},
-      fully: true,
-      scrollingMode: 'scroll',
-      wait: 1500,
-      ...options,
-    })
-    try {
-      const actual = await screenshot.image.toObject()
-      const expected = await makeImage('./test/fixtures/android/x-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', suffix: Date.now()})
-      throw err
-    }
-  }
-})