Merge pull request #28 from mmarkelov/Add-ability-to-support-device-from-env

Add ability to support device from env

Author: mmarkelov

package-lock.json

@@ -1,7 +1,9 @@
 import NodeEnvironment from 'jest-environment-node'
 import {
   checkBrowserEnv,
+  checkDeviceEnv,
   getBrowserType,
+  getDeviceType,
   getPlaywrightInstance,
   readConfig,
 } from './utils'
@@ -63,20 +65,16 @@ class PlaywrightEnvironment extends NodeEnvironment {
     const config = await readConfig()
     const browserType = getBrowserType(config)
     checkBrowserEnv(browserType)
-    const { device, context } = config
+    const { context } = config
+    const device = getDeviceType(config)
     const playwrightInstance = await getPlaywrightInstance(browserType)
     let contextOptions = context
 
     const availableDevices = Object.keys(playwrightInstance.devices)
     if (device) {
-      if (!availableDevices.includes(device)) {
-        throw new Error(
-          `Wrong device. Should be one of [${availableDevices}], but got ${device}`,
-        )
-      } else {
-        const { viewport, userAgent } = playwrightInstance.devices[device]
-        contextOptions = { ...contextOptions, viewport, userAgent }
-      }
+      checkDeviceEnv(device, availableDevices)
+      const { viewport, userAgent } = playwrightInstance.devices[device]
+      contextOptions = { ...contextOptions, viewport, userAgent }
     }
     this.global.browser = await getBrowserPerProcess(playwrightInstance, config)
     this.global.context = await this.global.browser.newContext(contextOptions)

src/PlaywrightEnvironment.js

@@ -22,6 +22,22 @@ export function checkBrowserEnv(param) {
   }
 }
 
+export function checkDeviceEnv(device, availableDevices) {
+  if (!availableDevices.includes(device)) {
+    throw new Error(
+      `Wrong device. Should be one of [${availableDevices}], but got ${device}`,
+    )
+  }
+}
+
+export function getDeviceType(config) {
+  const processDevice = process.env.DEVICE
+  if (processDevice) {
+    return processDevice
+  }
+  return config.device
+}
+
 export function getBrowserType(config) {
   const processBrowser = process.env.BROWSER
   if (processBrowser) {

src/utils.js

@@ -1,8 +1,13 @@
-import { checkBrowserEnv, readPackage } from './utils'
-
 const fs = require('fs')
 const path = require('path')
-const { readConfig, getBrowserType } = require('./utils')
+const {
+  readConfig,
+  getBrowserType,
+  getDeviceType,
+  checkBrowserEnv,
+  checkDeviceEnv,
+  readPackage,
+} = require('./utils')
 const { DEFAULT_CONFIG, CHROMIUM } = require('./constants')
 
 jest.spyOn(fs, 'exists')
@@ -100,6 +105,20 @@ describe('getBrowserType', () => {
   })
 })
 
+describe('getDeviceType', () => {
+  it('should return "undefined" when there is no device', async () => {
+    const config = await readConfig()
+    const device = getDeviceType(config)
+    expect(device).toBe(undefined)
+  })
+  it('should return BROWSER if defined', async () => {
+    process.env.DEVICE = 'iPhone 11'
+    const device = getDeviceType()
+    expect(device).toBe(process.env.DEVICE)
+    delete process.env.DEVICE
+  })
+})
+
 describe('checkBrowserEnv', () => {
   it('should throw Error with unknown type', async () => {
     fs.exists.mockImplementationOnce((_, cb) => cb(true))
@@ -116,6 +135,14 @@ describe('checkBrowserEnv', () => {
   })
 })
 
+describe('checkDeviceEnv', () => {
+  it('should throw Error with unknown type', async () => {
+    const device = 'unknown'
+    const devices = ['iPhone 11', 'Pixel 2', 'Nexus 4']
+    expect(() => checkDeviceEnv(device, devices)).toThrow()
+  })
+})
+
 describe('readPackage', () => {
   it('should return null when dependencies does not passed', async () => {
     fs.exists.mockImplementationOnce((_, cb) => cb(true))