From c8a8a9fb7a655f4c5f38716e6b3449d788349214 Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Wed, 8 Nov 2023 20:51:32 -0800 Subject: [PATCH 01/14] add appium packages --- package.serve.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/package.serve.json b/package.serve.json index 6315b6a46..1456eadad 100644 --- a/package.serve.json +++ b/package.serve.json @@ -50,7 +50,14 @@ "url-loader": "^4.1.1", "webpack": "^5.0.1", "webpack-cli": "^5.0.1", - "prettier": "3.0.3" + "prettier": "3.0.3", + "@wdio/appium-service": "^8.22.1", + "@wdio/cli": "^8.22.1", + "@wdio/local-runner": "^8.22.1", + "@wdio/mocha-framework": "^8.22.0", + "@wdio/spec-reporter": "^8.21.0", + "appium": "^2.2.1", + "appium-xcuitest-driver": "^5.8.2" }, "dependencies": { "@react-navigation/native": "^6.1.7", From b0faa75c12fef73644810f5965273edeb42bcdbe Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Wed, 8 Nov 2023 20:52:38 -0800 Subject: [PATCH 02/14] add webdriverIO setting for local e2e test --- e2e-tests/config/wdio.conf.js | 282 ++++++++++++++++++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 e2e-tests/config/wdio.conf.js diff --git a/e2e-tests/config/wdio.conf.js b/e2e-tests/config/wdio.conf.js new file mode 100644 index 000000000..6fc3ed220 --- /dev/null +++ b/e2e-tests/config/wdio.conf.js @@ -0,0 +1,282 @@ +exports.config = { + // + // ==================== + // Runner Configuration + // ==================== + // WebdriverIO supports running e2e tests as well as unit and component tests. + runner: 'local', + port: 4723, + // + // ================== + // Specify Test Files + // ================== + // Define which test specs should run. The pattern is relative to the directory + // of the configuration file being run. + // + // The specs are defined as an array of spec files (optionally using wildcards + // that will be expanded). The test for each spec file will be run in a separate + // worker process. In order to have a group of spec files run in the same worker + // process simply enclose them in an array within the specs array. + // + // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script), + // then the current working directory is where your `package.json` resides, so `wdio` + // will be called from there. + // + specs: [ + '../specs/*.js' + ], + // Patterns to exclude. + exclude: [ + // 'path/to/excluded/files' + ], + // + // ============ + // Capabilities + // ============ + // Define your capabilities here. WebdriverIO can run multiple capabilities at the same + // time. Depending on the number of capabilities, WebdriverIO launches several test + // sessions. Within your capabilities you can overwrite the spec and exclude options in + // order to group specific specs to a specific capability. + // + // First, you can define how many instances should be started at the same time. Let's + // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have + // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec + // files and you set maxInstances to 10, all spec files will get tested at the same time + // and 30 processes will get spawned. The property handles how many capabilities + // from the same test should run tests. + // + maxInstances: 10, + // + // If you have trouble getting all important capabilities together, check out the + // Sauce Labs platform configurator - a great tool to configure your capabilities: + // https://saucelabs.com/platform/platform-configurator + // + capabilities: [], + + // + // =================== + // Test Configurations + // =================== + // Define all options that are relevant for the WebdriverIO instance here + // + // Level of logging verbosity: trace | debug | info | warn | error | silent + logLevel: 'info', + // + // Set specific log levels per logger + // loggers: + // - webdriver, webdriverio + // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service + // - @wdio/mocha-framework, @wdio/jasmine-framework + // - @wdio/local-runner + // - @wdio/sumologic-reporter + // - @wdio/cli, @wdio/config, @wdio/utils + // Level of logging verbosity: trace | debug | info | warn | error | silent + // logLevels: { + // webdriver: 'info', + // '@wdio/appium-service': 'info' + // }, + // + // If you only want to run your tests until a specific amount of tests have failed use + // bail (default is 0 - don't bail, run all tests). + bail: 0, + // + // Set a base URL in order to shorten url command calls. If your `url` parameter starts + // with `/`, the base url gets prepended, not including the path portion of your baseUrl. + // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url + // gets prepended directly. + baseUrl: 'http://localhost', + // + // Default timeout for all waitFor* commands. + waitforTimeout: 10000, + // + // Default timeout in milliseconds for request + // if browser driver or grid doesn't send response + connectionRetryTimeout: 120000, + // + // Default request retries count + connectionRetryCount: 3, + // + // Test runner services + // Services take over a specific job you don't want to take care of. They enhance + // your test setup with almost no effort. Unlike plugins, they don't add new + // commands. Instead, they hook themselves up into the test process. + services: ['appium'], + + // Framework you want to run your specs with. + // The following are supported: Mocha, Jasmine, and Cucumber + // see also: https://webdriver.io/docs/frameworks + // + // Make sure you have the wdio adapter package for the specific framework installed + // before running any tests. + framework: 'mocha', + + // + // The number of times to retry the entire specfile when it fails as a whole + // specFileRetries: 1, + // + // Delay in seconds between the spec file retry attempts + // specFileRetriesDelay: 0, + // + // Whether or not retried spec files should be retried immediately or deferred to the end of the queue + // specFileRetriesDeferred: false, + // + // Test reporter for stdout. + // The only one supported by default is 'dot' + // see also: https://webdriver.io/docs/dot-reporter + reporters: ['spec'], + + // Options to be passed to Mocha. + // See the full list at http://mochajs.org/ + mochaOpts: { + ui: 'bdd', + timeout: 60000 + }, + + // + // ===== + // Hooks + // ===== + // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance + // it and to build services around it. You can either apply a single function or an array of + // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got + // resolved to continue. + /** + * Gets executed once before all workers get launched. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + */ + // onPrepare: function (config, capabilities) { + // }, + /** + * Gets executed before a worker process is spawned and can be used to initialise specific service + * for that worker as well as modify runtime environments in an async fashion. + * @param {string} cid capability id (e.g 0-0) + * @param {object} caps object containing capabilities for session that will be spawn in the worker + * @param {object} specs specs to be run in the worker process + * @param {object} args object that will be merged with the main configuration once worker is initialized + * @param {object} execArgv list of string arguments passed to the worker process + */ + // onWorkerStart: function (cid, caps, specs, args, execArgv) { + // }, + /** + * Gets executed just after a worker process has exited. + * @param {string} cid capability id (e.g 0-0) + * @param {number} exitCode 0 - success, 1 - fail + * @param {object} specs specs to be run in the worker process + * @param {number} retries number of retries used + */ + // onWorkerEnd: function (cid, exitCode, specs, retries) { + // }, + /** + * Gets executed just before initialising the webdriver session and test framework. It allows you + * to manipulate configurations depending on the capability or spec. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that are to be run + * @param {string} cid worker id (e.g. 0-0) + */ + // beforeSession: function (config, capabilities, specs, cid) { + // }, + /** + * Gets executed before test execution begins. At this point you can access to all global + * variables like `browser`. It is the perfect place to define custom commands. + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that are to be run + * @param {object} browser instance of created browser/device session + */ + // before: function (capabilities, specs) { + // }, + /** + * Runs before a WebdriverIO command gets executed. + * @param {string} commandName hook command name + * @param {Array} args arguments that command would receive + */ + // beforeCommand: function (commandName, args) { + // }, + /** + * Hook that gets executed before the suite starts + * @param {object} suite suite details + */ + // beforeSuite: function (suite) { + // }, + /** + * Function to be executed before a test (in Mocha/Jasmine) starts. + */ + // beforeTest: function (test, context) { + // }, + /** + * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling + * beforeEach in Mocha) + */ + // beforeHook: function (test, context, hookName) { + // }, + /** + * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling + * afterEach in Mocha) + */ + // afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) { + // }, + /** + * Function to be executed after a test (in Mocha/Jasmine only) + * @param {object} test test object + * @param {object} context scope object the test was executed with + * @param {Error} result.error error object in case the test fails, otherwise `undefined` + * @param {*} result.result return object of test function + * @param {number} result.duration duration of test + * @param {boolean} result.passed true if test has passed, otherwise false + * @param {object} result.retries information about spec related retries, e.g. `{ attempts: 0, limit: 0 }` + */ + // afterTest: function(test, context, { error, result, duration, passed, retries }) { + // }, + + + /** + * Hook that gets executed after the suite has ended + * @param {object} suite suite details + */ + // afterSuite: function (suite) { + // }, + /** + * Runs after a WebdriverIO command gets executed + * @param {string} commandName hook command name + * @param {Array} args arguments that command would receive + * @param {number} result 0 - command success, 1 - command error + * @param {object} error error object if any + */ + // afterCommand: function (commandName, args, result, error) { + // }, + /** + * Gets executed after all tests are done. You still have access to all global variables from + * the test. + * @param {number} result 0 - test pass, 1 - test fail + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that ran + */ + // after: function (result, capabilities, specs) { + // }, + /** + * Gets executed right after terminating the webdriver session. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that ran + */ + // afterSession: function (config, capabilities, specs) { + // }, + /** + * Gets executed after all workers got shut down and the process is about to exit. An error + * thrown in the onComplete hook will result in the test run failing. + * @param {object} exitCode 0 - success, 1 - fail + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {} results object containing test results + */ + // onComplete: function(exitCode, config, capabilities, results) { + // }, + /** + * Gets executed when a refresh happens. + * @param {string} oldSessionId session ID of the old session + * @param {string} newSessionId session ID of the new session + */ + // onReload: function(oldSessionId, newSessionId) { + // } +} From 6a64e6d0110ba72e2d01faf649cfba09db3fe547 Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Wed, 8 Nov 2023 20:53:07 -0800 Subject: [PATCH 03/14] add appium capabilities config for IOS --- e2e-tests/config/ios.config.js | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 e2e-tests/config/ios.config.js diff --git a/e2e-tests/config/ios.config.js b/e2e-tests/config/ios.config.js new file mode 100644 index 000000000..eb8dea5f3 --- /dev/null +++ b/e2e-tests/config/ios.config.js @@ -0,0 +1,19 @@ +const { config } = require('./wdio.conf'); + +// Appium capabilities +config.capabilities = [ + { + // The defaults you need to have in your config + platformName: 'iOS', + maxInstances: 1, + // For W3C the appium capabilities need to have an extension prefix + // This is `appium:` for all Appium Capabilities which can be found here + // http://appium.io/docs/en/writing-running-appium/caps/ + 'appium:deviceName': 'iPhone 13', + 'appium:platformVersion': '15.0', + 'appium:automationName': 'XCUITest', + 'appium:app': 'edu.berkeley.eecs.emission.devapp', + }, +]; + +exports.config = config; From 22ea874576cadc5c85d488b5548ab4ffabea679c Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Thu, 9 Nov 2023 11:04:13 -0800 Subject: [PATCH 04/14] add sample test file --- e2e-tests/specs/sample.js | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 e2e-tests/specs/sample.js diff --git a/e2e-tests/specs/sample.js b/e2e-tests/specs/sample.js new file mode 100644 index 000000000..eb44facb3 --- /dev/null +++ b/e2e-tests/specs/sample.js @@ -0,0 +1,14 @@ +const { expect, browser, $ } = require('@wdio/globals'); + +describe('My Login application', () => { + it('should login with valid credentials', async () => { + await browser.url(`https://the-internet.herokuapp.com/login`); + + await $('#username').setValue('tomsmith'); + await $('#password').setValue('SuperSecretPassword!'); + await $('button[type="submit"]').click(); + + await expect($('#flash')).toBeExisting(); + await expect($('#flash')).toHaveTextContaining('You logged into a secure area!'); + }); +}); From 6c70b16b770d4846d2beeb770e9df6bed517796b Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Thu, 9 Nov 2023 12:05:55 -0800 Subject: [PATCH 05/14] Change sample test to check if wdio successfully connects to simulator --- e2e-tests/specs/sample.js | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/e2e-tests/specs/sample.js b/e2e-tests/specs/sample.js index eb44facb3..e1f9f6211 100644 --- a/e2e-tests/specs/sample.js +++ b/e2e-tests/specs/sample.js @@ -1,14 +1,9 @@ -const { expect, browser, $ } = require('@wdio/globals'); +const { expect, $ } = require('@wdio/globals'); -describe('My Login application', () => { - it('should login with valid credentials', async () => { - await browser.url(`https://the-internet.herokuapp.com/login`); - - await $('#username').setValue('tomsmith'); - await $('#password').setValue('SuperSecretPassword!'); - await $('button[type="submit"]').click(); - - await expect($('#flash')).toBeExisting(); - await expect($('#flash')).toHaveTextContaining('You logged into a secure area!'); +describe('Connect test', () => { + it('should call app successfully', async () => { + // todo : add selectorAndroid + const selectorIOS = await $('UIATarget.localTarget().frontMostApp().mainWindow()'); + expect(selectorIOS).toBeDisplayed(); }); }); From c141f8ac1bbcef525fe4f34dd46a0a067958dfba Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Thu, 9 Nov 2023 22:42:15 -0800 Subject: [PATCH 06/14] Add android test setting --- e2e-tests/config/android.config.js | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 e2e-tests/config/android.config.js diff --git a/e2e-tests/config/android.config.js b/e2e-tests/config/android.config.js new file mode 100644 index 000000000..7c4daeb3b --- /dev/null +++ b/e2e-tests/config/android.config.js @@ -0,0 +1,16 @@ +const { config } = require('./wdio.conf'); +const { join } = require('path'); + +config.capabilities = [ + { + // The defaults you need to have in your config + platformName: 'Android', + maxInstances: 1, + 'appium:deviceName': 'Pixel 3a API 33', + 'appium:platformVersion': '13', + 'appium:automationName': 'UiAutomator2', + 'appium:app': join(process.cwd(), './apps/em-devapp-3.2.5.apk'), + }, +]; + +exports.config = config; From bfa1bd3622b0ce613876751d22c3323f1d7be8f9 Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Thu, 9 Nov 2023 22:43:54 -0800 Subject: [PATCH 07/14] add Android selector and detect if device is android or ios --- e2e-tests/specs/sample.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/e2e-tests/specs/sample.js b/e2e-tests/specs/sample.js index e1f9f6211..996289d4e 100644 --- a/e2e-tests/specs/sample.js +++ b/e2e-tests/specs/sample.js @@ -2,8 +2,9 @@ const { expect, $ } = require('@wdio/globals'); describe('Connect test', () => { it('should call app successfully', async () => { - // todo : add selectorAndroid const selectorIOS = await $('UIATarget.localTarget().frontMostApp().mainWindow()'); - expect(selectorIOS).toBeDisplayed(); + const selectorAndroid = await $('android=new UiSelector().className("android.widget.FrameLayout")'); + const selector = driver.isAndroid ? selectorAndroid : selectorIOS + expect(selector).toBeDisplayed(); }); }); From 725257dd0e5b4b8180728a0d3afdf2931133a713 Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Fri, 10 Nov 2023 12:36:23 -0800 Subject: [PATCH 08/14] change config we can set deviceName and platformVersion dynamically --- e2e-tests/config/android.config.js | 8 ++++++-- e2e-tests/config/common.js | 24 ++++++++++++++++++++++++ e2e-tests/config/ios.config.js | 5 +++-- 3 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 e2e-tests/config/common.js diff --git a/e2e-tests/config/android.config.js b/e2e-tests/config/android.config.js index 7c4daeb3b..d01992667 100644 --- a/e2e-tests/config/android.config.js +++ b/e2e-tests/config/android.config.js @@ -1,3 +1,4 @@ +const { getDeviceName, getPlatformVersion } = require('./common'); const { config } = require('./wdio.conf'); const { join } = require('path'); @@ -6,8 +7,11 @@ config.capabilities = [ // The defaults you need to have in your config platformName: 'Android', maxInstances: 1, - 'appium:deviceName': 'Pixel 3a API 33', - 'appium:platformVersion': '13', + // For W3C the appium capabilities need to have an extension prefix + // This is `appium:` for all Appium Capabilities which can be found here + // http://appium.io/docs/en/writing-running-appium/caps/ + 'appium:deviceName': getDeviceName('Android'), + 'appium:platformVersion': getPlatformVersion('Android'), 'appium:automationName': 'UiAutomator2', 'appium:app': join(process.cwd(), './apps/em-devapp-3.2.5.apk'), }, diff --git a/e2e-tests/config/common.js b/e2e-tests/config/common.js new file mode 100644 index 000000000..f2e61713e --- /dev/null +++ b/e2e-tests/config/common.js @@ -0,0 +1,24 @@ +/** + * get Device Name from script + * @param platform iOS or Android + */ +const getDeviceName = (platform) => { + const deviceNameIndex = process.argv.indexOf('--deviceName'); + const deviceName = deviceNameIndex !== -1 ? process.argv[deviceNameIndex + 1] : null; + const defaultDeviceName = platform === 'iOS' ? 'iPhone13' : 'Pixel 3a API 33'; + return deviceName ?? defaultDeviceName; +}; + +/** + * get Platform Version from script + * @param platform iOS or Android + */ +const getPlatformVersion = (platform) => { + const platformVersionIndex = process.argv.inydexOf('--platformVersion'); + const platformVersion = + platformVersionIndex !== -1 ? process.argv[platformVersionIndex + 1] : null; + const defaultPlatformVersion = platform === 'iOS' ? '15.0' : '13'; + return platformVersion ?? defaultPlatformVersion; +}; + +module.exports = { getDeviceName, getPlatformVersion }; diff --git a/e2e-tests/config/ios.config.js b/e2e-tests/config/ios.config.js index eb8dea5f3..7118d6d0f 100644 --- a/e2e-tests/config/ios.config.js +++ b/e2e-tests/config/ios.config.js @@ -1,3 +1,4 @@ +const { getDeviceName, getPlatformVersion } = require('./common'); const { config } = require('./wdio.conf'); // Appium capabilities @@ -9,8 +10,8 @@ config.capabilities = [ // For W3C the appium capabilities need to have an extension prefix // This is `appium:` for all Appium Capabilities which can be found here // http://appium.io/docs/en/writing-running-appium/caps/ - 'appium:deviceName': 'iPhone 13', - 'appium:platformVersion': '15.0', + 'appium:deviceName': getDeviceName('iOS'), + 'appium:platformVersion': getPlatformVersion('iOS'), 'appium:automationName': 'XCUITest', 'appium:app': 'edu.berkeley.eecs.emission.devapp', }, From 95ffe34a1502e2497a311bf4efe021c3350e7ce1 Mon Sep 17 00:00:00 2001 From: Jijeong Lee Date: Fri, 10 Nov 2023 12:36:50 -0800 Subject: [PATCH 09/14] Apply prettier to e2e-tests directory --- .prettierignore | 3 +- e2e-tests/config/wdio.conf.js | 547 +++++++++++++++++----------------- e2e-tests/specs/sample.js | 6 +- 3 files changed, 278 insertions(+), 278 deletions(-) diff --git a/.prettierignore b/.prettierignore index 988aead62..819dfcced 100644 --- a/.prettierignore +++ b/.prettierignore @@ -9,5 +9,6 @@ www/json # This is the pattern to check only www directory # Ignore all /* -# but don't ignore all the files in www directory +# but don't ignore all the files in www and e2e-tests directory !/www +!/e2e-tests diff --git a/e2e-tests/config/wdio.conf.js b/e2e-tests/config/wdio.conf.js index 6fc3ed220..74aa77928 100644 --- a/e2e-tests/config/wdio.conf.js +++ b/e2e-tests/config/wdio.conf.js @@ -1,282 +1,279 @@ exports.config = { - // - // ==================== - // Runner Configuration - // ==================== - // WebdriverIO supports running e2e tests as well as unit and component tests. - runner: 'local', - port: 4723, - // - // ================== - // Specify Test Files - // ================== - // Define which test specs should run. The pattern is relative to the directory - // of the configuration file being run. - // - // The specs are defined as an array of spec files (optionally using wildcards - // that will be expanded). The test for each spec file will be run in a separate - // worker process. In order to have a group of spec files run in the same worker - // process simply enclose them in an array within the specs array. - // - // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script), - // then the current working directory is where your `package.json` resides, so `wdio` - // will be called from there. - // - specs: [ - '../specs/*.js' - ], - // Patterns to exclude. - exclude: [ - // 'path/to/excluded/files' - ], - // - // ============ - // Capabilities - // ============ - // Define your capabilities here. WebdriverIO can run multiple capabilities at the same - // time. Depending on the number of capabilities, WebdriverIO launches several test - // sessions. Within your capabilities you can overwrite the spec and exclude options in - // order to group specific specs to a specific capability. - // - // First, you can define how many instances should be started at the same time. Let's - // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have - // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec - // files and you set maxInstances to 10, all spec files will get tested at the same time - // and 30 processes will get spawned. The property handles how many capabilities - // from the same test should run tests. - // - maxInstances: 10, - // - // If you have trouble getting all important capabilities together, check out the - // Sauce Labs platform configurator - a great tool to configure your capabilities: - // https://saucelabs.com/platform/platform-configurator - // - capabilities: [], + // + // ==================== + // Runner Configuration + // ==================== + // WebdriverIO supports running e2e tests as well as unit and component tests. + runner: 'local', + port: 4723, + // + // ================== + // Specify Test Files + // ================== + // Define which test specs should run. The pattern is relative to the directory + // of the configuration file being run. + // + // The specs are defined as an array of spec files (optionally using wildcards + // that will be expanded). The test for each spec file will be run in a separate + // worker process. In order to have a group of spec files run in the same worker + // process simply enclose them in an array within the specs array. + // + // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script), + // then the current working directory is where your `package.json` resides, so `wdio` + // will be called from there. + // + specs: ['../specs/*.js'], + // Patterns to exclude. + exclude: [ + // 'path/to/excluded/files' + ], + // + // ============ + // Capabilities + // ============ + // Define your capabilities here. WebdriverIO can run multiple capabilities at the same + // time. Depending on the number of capabilities, WebdriverIO launches several test + // sessions. Within your capabilities you can overwrite the spec and exclude options in + // order to group specific specs to a specific capability. + // + // First, you can define how many instances should be started at the same time. Let's + // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have + // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec + // files and you set maxInstances to 10, all spec files will get tested at the same time + // and 30 processes will get spawned. The property handles how many capabilities + // from the same test should run tests. + // + maxInstances: 10, + // + // If you have trouble getting all important capabilities together, check out the + // Sauce Labs platform configurator - a great tool to configure your capabilities: + // https://saucelabs.com/platform/platform-configurator + // + capabilities: [], - // - // =================== - // Test Configurations - // =================== - // Define all options that are relevant for the WebdriverIO instance here - // - // Level of logging verbosity: trace | debug | info | warn | error | silent - logLevel: 'info', - // - // Set specific log levels per logger - // loggers: - // - webdriver, webdriverio - // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service - // - @wdio/mocha-framework, @wdio/jasmine-framework - // - @wdio/local-runner - // - @wdio/sumologic-reporter - // - @wdio/cli, @wdio/config, @wdio/utils - // Level of logging verbosity: trace | debug | info | warn | error | silent - // logLevels: { - // webdriver: 'info', - // '@wdio/appium-service': 'info' - // }, - // - // If you only want to run your tests until a specific amount of tests have failed use - // bail (default is 0 - don't bail, run all tests). - bail: 0, - // - // Set a base URL in order to shorten url command calls. If your `url` parameter starts - // with `/`, the base url gets prepended, not including the path portion of your baseUrl. - // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url - // gets prepended directly. - baseUrl: 'http://localhost', - // - // Default timeout for all waitFor* commands. - waitforTimeout: 10000, - // - // Default timeout in milliseconds for request - // if browser driver or grid doesn't send response - connectionRetryTimeout: 120000, - // - // Default request retries count - connectionRetryCount: 3, - // - // Test runner services - // Services take over a specific job you don't want to take care of. They enhance - // your test setup with almost no effort. Unlike plugins, they don't add new - // commands. Instead, they hook themselves up into the test process. - services: ['appium'], + // + // =================== + // Test Configurations + // =================== + // Define all options that are relevant for the WebdriverIO instance here + // + // Level of logging verbosity: trace | debug | info | warn | error | silent + logLevel: 'info', + // + // Set specific log levels per logger + // loggers: + // - webdriver, webdriverio + // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service + // - @wdio/mocha-framework, @wdio/jasmine-framework + // - @wdio/local-runner + // - @wdio/sumologic-reporter + // - @wdio/cli, @wdio/config, @wdio/utils + // Level of logging verbosity: trace | debug | info | warn | error | silent + // logLevels: { + // webdriver: 'info', + // '@wdio/appium-service': 'info' + // }, + // + // If you only want to run your tests until a specific amount of tests have failed use + // bail (default is 0 - don't bail, run all tests). + bail: 0, + // + // Set a base URL in order to shorten url command calls. If your `url` parameter starts + // with `/`, the base url gets prepended, not including the path portion of your baseUrl. + // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url + // gets prepended directly. + baseUrl: 'http://localhost', + // + // Default timeout for all waitFor* commands. + waitforTimeout: 10000, + // + // Default timeout in milliseconds for request + // if browser driver or grid doesn't send response + connectionRetryTimeout: 120000, + // + // Default request retries count + connectionRetryCount: 3, + // + // Test runner services + // Services take over a specific job you don't want to take care of. They enhance + // your test setup with almost no effort. Unlike plugins, they don't add new + // commands. Instead, they hook themselves up into the test process. + services: ['appium'], - // Framework you want to run your specs with. - // The following are supported: Mocha, Jasmine, and Cucumber - // see also: https://webdriver.io/docs/frameworks - // - // Make sure you have the wdio adapter package for the specific framework installed - // before running any tests. - framework: 'mocha', - - // - // The number of times to retry the entire specfile when it fails as a whole - // specFileRetries: 1, - // - // Delay in seconds between the spec file retry attempts - // specFileRetriesDelay: 0, - // - // Whether or not retried spec files should be retried immediately or deferred to the end of the queue - // specFileRetriesDeferred: false, - // - // Test reporter for stdout. - // The only one supported by default is 'dot' - // see also: https://webdriver.io/docs/dot-reporter - reporters: ['spec'], + // Framework you want to run your specs with. + // The following are supported: Mocha, Jasmine, and Cucumber + // see also: https://webdriver.io/docs/frameworks + // + // Make sure you have the wdio adapter package for the specific framework installed + // before running any tests. + framework: 'mocha', - // Options to be passed to Mocha. - // See the full list at http://mochajs.org/ - mochaOpts: { - ui: 'bdd', - timeout: 60000 - }, + // + // The number of times to retry the entire specfile when it fails as a whole + // specFileRetries: 1, + // + // Delay in seconds between the spec file retry attempts + // specFileRetriesDelay: 0, + // + // Whether or not retried spec files should be retried immediately or deferred to the end of the queue + // specFileRetriesDeferred: false, + // + // Test reporter for stdout. + // The only one supported by default is 'dot' + // see also: https://webdriver.io/docs/dot-reporter + reporters: ['spec'], - // - // ===== - // Hooks - // ===== - // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance - // it and to build services around it. You can either apply a single function or an array of - // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got - // resolved to continue. - /** - * Gets executed once before all workers get launched. - * @param {object} config wdio configuration object - * @param {Array.} capabilities list of capabilities details - */ - // onPrepare: function (config, capabilities) { - // }, - /** - * Gets executed before a worker process is spawned and can be used to initialise specific service - * for that worker as well as modify runtime environments in an async fashion. - * @param {string} cid capability id (e.g 0-0) - * @param {object} caps object containing capabilities for session that will be spawn in the worker - * @param {object} specs specs to be run in the worker process - * @param {object} args object that will be merged with the main configuration once worker is initialized - * @param {object} execArgv list of string arguments passed to the worker process - */ - // onWorkerStart: function (cid, caps, specs, args, execArgv) { - // }, - /** - * Gets executed just after a worker process has exited. - * @param {string} cid capability id (e.g 0-0) - * @param {number} exitCode 0 - success, 1 - fail - * @param {object} specs specs to be run in the worker process - * @param {number} retries number of retries used - */ - // onWorkerEnd: function (cid, exitCode, specs, retries) { - // }, - /** - * Gets executed just before initialising the webdriver session and test framework. It allows you - * to manipulate configurations depending on the capability or spec. - * @param {object} config wdio configuration object - * @param {Array.} capabilities list of capabilities details - * @param {Array.} specs List of spec file paths that are to be run - * @param {string} cid worker id (e.g. 0-0) - */ - // beforeSession: function (config, capabilities, specs, cid) { - // }, - /** - * Gets executed before test execution begins. At this point you can access to all global - * variables like `browser`. It is the perfect place to define custom commands. - * @param {Array.} capabilities list of capabilities details - * @param {Array.} specs List of spec file paths that are to be run - * @param {object} browser instance of created browser/device session - */ - // before: function (capabilities, specs) { - // }, - /** - * Runs before a WebdriverIO command gets executed. - * @param {string} commandName hook command name - * @param {Array} args arguments that command would receive - */ - // beforeCommand: function (commandName, args) { - // }, - /** - * Hook that gets executed before the suite starts - * @param {object} suite suite details - */ - // beforeSuite: function (suite) { - // }, - /** - * Function to be executed before a test (in Mocha/Jasmine) starts. - */ - // beforeTest: function (test, context) { - // }, - /** - * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling - * beforeEach in Mocha) - */ - // beforeHook: function (test, context, hookName) { - // }, - /** - * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling - * afterEach in Mocha) - */ - // afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) { - // }, - /** - * Function to be executed after a test (in Mocha/Jasmine only) - * @param {object} test test object - * @param {object} context scope object the test was executed with - * @param {Error} result.error error object in case the test fails, otherwise `undefined` - * @param {*} result.result return object of test function - * @param {number} result.duration duration of test - * @param {boolean} result.passed true if test has passed, otherwise false - * @param {object} result.retries information about spec related retries, e.g. `{ attempts: 0, limit: 0 }` - */ - // afterTest: function(test, context, { error, result, duration, passed, retries }) { - // }, + // Options to be passed to Mocha. + // See the full list at http://mochajs.org/ + mochaOpts: { + ui: 'bdd', + timeout: 60000, + }, + // + // ===== + // Hooks + // ===== + // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance + // it and to build services around it. You can either apply a single function or an array of + // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got + // resolved to continue. + /** + * Gets executed once before all workers get launched. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + */ + // onPrepare: function (config, capabilities) { + // }, + /** + * Gets executed before a worker process is spawned and can be used to initialise specific service + * for that worker as well as modify runtime environments in an async fashion. + * @param {string} cid capability id (e.g 0-0) + * @param {object} caps object containing capabilities for session that will be spawn in the worker + * @param {object} specs specs to be run in the worker process + * @param {object} args object that will be merged with the main configuration once worker is initialized + * @param {object} execArgv list of string arguments passed to the worker process + */ + // onWorkerStart: function (cid, caps, specs, args, execArgv) { + // }, + /** + * Gets executed just after a worker process has exited. + * @param {string} cid capability id (e.g 0-0) + * @param {number} exitCode 0 - success, 1 - fail + * @param {object} specs specs to be run in the worker process + * @param {number} retries number of retries used + */ + // onWorkerEnd: function (cid, exitCode, specs, retries) { + // }, + /** + * Gets executed just before initialising the webdriver session and test framework. It allows you + * to manipulate configurations depending on the capability or spec. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that are to be run + * @param {string} cid worker id (e.g. 0-0) + */ + // beforeSession: function (config, capabilities, specs, cid) { + // }, + /** + * Gets executed before test execution begins. At this point you can access to all global + * variables like `browser`. It is the perfect place to define custom commands. + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that are to be run + * @param {object} browser instance of created browser/device session + */ + // before: function (capabilities, specs) { + // }, + /** + * Runs before a WebdriverIO command gets executed. + * @param {string} commandName hook command name + * @param {Array} args arguments that command would receive + */ + // beforeCommand: function (commandName, args) { + // }, + /** + * Hook that gets executed before the suite starts + * @param {object} suite suite details + */ + // beforeSuite: function (suite) { + // }, + /** + * Function to be executed before a test (in Mocha/Jasmine) starts. + */ + // beforeTest: function (test, context) { + // }, + /** + * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling + * beforeEach in Mocha) + */ + // beforeHook: function (test, context, hookName) { + // }, + /** + * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling + * afterEach in Mocha) + */ + // afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) { + // }, + /** + * Function to be executed after a test (in Mocha/Jasmine only) + * @param {object} test test object + * @param {object} context scope object the test was executed with + * @param {Error} result.error error object in case the test fails, otherwise `undefined` + * @param {*} result.result return object of test function + * @param {number} result.duration duration of test + * @param {boolean} result.passed true if test has passed, otherwise false + * @param {object} result.retries information about spec related retries, e.g. `{ attempts: 0, limit: 0 }` + */ + // afterTest: function(test, context, { error, result, duration, passed, retries }) { + // }, - /** - * Hook that gets executed after the suite has ended - * @param {object} suite suite details - */ - // afterSuite: function (suite) { - // }, - /** - * Runs after a WebdriverIO command gets executed - * @param {string} commandName hook command name - * @param {Array} args arguments that command would receive - * @param {number} result 0 - command success, 1 - command error - * @param {object} error error object if any - */ - // afterCommand: function (commandName, args, result, error) { - // }, - /** - * Gets executed after all tests are done. You still have access to all global variables from - * the test. - * @param {number} result 0 - test pass, 1 - test fail - * @param {Array.} capabilities list of capabilities details - * @param {Array.} specs List of spec file paths that ran - */ - // after: function (result, capabilities, specs) { - // }, - /** - * Gets executed right after terminating the webdriver session. - * @param {object} config wdio configuration object - * @param {Array.} capabilities list of capabilities details - * @param {Array.} specs List of spec file paths that ran - */ - // afterSession: function (config, capabilities, specs) { - // }, - /** - * Gets executed after all workers got shut down and the process is about to exit. An error - * thrown in the onComplete hook will result in the test run failing. - * @param {object} exitCode 0 - success, 1 - fail - * @param {object} config wdio configuration object - * @param {Array.} capabilities list of capabilities details - * @param {} results object containing test results - */ - // onComplete: function(exitCode, config, capabilities, results) { - // }, - /** - * Gets executed when a refresh happens. - * @param {string} oldSessionId session ID of the old session - * @param {string} newSessionId session ID of the new session - */ - // onReload: function(oldSessionId, newSessionId) { - // } -} + /** + * Hook that gets executed after the suite has ended + * @param {object} suite suite details + */ + // afterSuite: function (suite) { + // }, + /** + * Runs after a WebdriverIO command gets executed + * @param {string} commandName hook command name + * @param {Array} args arguments that command would receive + * @param {number} result 0 - command success, 1 - command error + * @param {object} error error object if any + */ + // afterCommand: function (commandName, args, result, error) { + // }, + /** + * Gets executed after all tests are done. You still have access to all global variables from + * the test. + * @param {number} result 0 - test pass, 1 - test fail + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that ran + */ + // after: function (result, capabilities, specs) { + // }, + /** + * Gets executed right after terminating the webdriver session. + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {Array.} specs List of spec file paths that ran + */ + // afterSession: function (config, capabilities, specs) { + // }, + /** + * Gets executed after all workers got shut down and the process is about to exit. An error + * thrown in the onComplete hook will result in the test run failing. + * @param {object} exitCode 0 - success, 1 - fail + * @param {object} config wdio configuration object + * @param {Array.} capabilities list of capabilities details + * @param {} results object containing test results + */ + // onComplete: function(exitCode, config, capabilities, results) { + // }, + /** + * Gets executed when a refresh happens. + * @param {string} oldSessionId session ID of the old session + * @param {string} newSessionId session ID of the new session + */ + // onReload: function(oldSessionId, newSessionId) { + // } +}; diff --git a/e2e-tests/specs/sample.js b/e2e-tests/specs/sample.js index 996289d4e..077a3d314 100644 --- a/e2e-tests/specs/sample.js +++ b/e2e-tests/specs/sample.js @@ -3,8 +3,10 @@ const { expect, $ } = require('@wdio/globals'); describe('Connect test', () => { it('should call app successfully', async () => { const selectorIOS = await $('UIATarget.localTarget().frontMostApp().mainWindow()'); - const selectorAndroid = await $('android=new UiSelector().className("android.widget.FrameLayout")'); - const selector = driver.isAndroid ? selectorAndroid : selectorIOS + const selectorAndroid = await $( + 'android=new UiSelector().className("android.widget.FrameLayout")', + ); + const selector = driver.isAndroid ? selectorAndroid : selectorIOS; expect(selector).toBeDisplayed(); }); }); From 6e338998298b8e3e3fb7e065057bf0755035f12d Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Fri, 10 Nov 2023 15:07:21 -0800 Subject: [PATCH 10/14] sample test error fix --- e2e-tests/config/common.js | 4 ++-- e2e-tests/specs/sample.js | 8 +++----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/e2e-tests/config/common.js b/e2e-tests/config/common.js index f2e61713e..e0e625926 100644 --- a/e2e-tests/config/common.js +++ b/e2e-tests/config/common.js @@ -5,7 +5,7 @@ const getDeviceName = (platform) => { const deviceNameIndex = process.argv.indexOf('--deviceName'); const deviceName = deviceNameIndex !== -1 ? process.argv[deviceNameIndex + 1] : null; - const defaultDeviceName = platform === 'iOS' ? 'iPhone13' : 'Pixel 3a API 33'; + const defaultDeviceName = platform === 'iOS' ? 'iPhone 13' : 'Pixel 3a API 33'; return deviceName ?? defaultDeviceName; }; @@ -14,7 +14,7 @@ const getDeviceName = (platform) => { * @param platform iOS or Android */ const getPlatformVersion = (platform) => { - const platformVersionIndex = process.argv.inydexOf('--platformVersion'); + const platformVersionIndex = process.argv.indexOf('--platformVersion'); const platformVersion = platformVersionIndex !== -1 ? process.argv[platformVersionIndex + 1] : null; const defaultPlatformVersion = platform === 'iOS' ? '15.0' : '13'; diff --git a/e2e-tests/specs/sample.js b/e2e-tests/specs/sample.js index 077a3d314..8608f0423 100644 --- a/e2e-tests/specs/sample.js +++ b/e2e-tests/specs/sample.js @@ -2,11 +2,9 @@ const { expect, $ } = require('@wdio/globals'); describe('Connect test', () => { it('should call app successfully', async () => { - const selectorIOS = await $('UIATarget.localTarget().frontMostApp().mainWindow()'); - const selectorAndroid = await $( - 'android=new UiSelector().className("android.widget.FrameLayout")', - ); - const selector = driver.isAndroid ? selectorAndroid : selectorIOS; + const selector = driver.isAndroid + ? await $('android=new UiSelector().className("android.widget.FrameLayout")') + : await $('UIATarget.localTarget().frontMostApp().mainWindow()'); expect(selector).toBeDisplayed(); }); }); From 4656813b3a565082a56382e4a185f016da906e6e Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Fri, 10 Nov 2023 15:11:50 -0800 Subject: [PATCH 11/14] Add appium driver package for Android --- package.serve.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.serve.json b/package.serve.json index 1456eadad..6b1be7046 100644 --- a/package.serve.json +++ b/package.serve.json @@ -57,7 +57,8 @@ "@wdio/mocha-framework": "^8.22.0", "@wdio/spec-reporter": "^8.21.0", "appium": "^2.2.1", - "appium-xcuitest-driver": "^5.8.2" + "appium-xcuitest-driver": "^5.8.2", + "appium-uiautomator2-driver": "^2.34.1" }, "dependencies": { "@react-navigation/native": "^6.1.7", From ee9a58f9064a2615350ac8dd85f4fe771ff9dad4 Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Mon, 13 Nov 2023 13:49:41 -0800 Subject: [PATCH 12/14] Change get deviceName and platformVersion logic Current logic handles spaces in deviceName (ex) iPhone 13 --- e2e-tests/config/common.js | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/e2e-tests/config/common.js b/e2e-tests/config/common.js index e0e625926..832e09a78 100644 --- a/e2e-tests/config/common.js +++ b/e2e-tests/config/common.js @@ -3,10 +3,9 @@ * @param platform iOS or Android */ const getDeviceName = (platform) => { - const deviceNameIndex = process.argv.indexOf('--deviceName'); - const deviceName = deviceNameIndex !== -1 ? process.argv[deviceNameIndex + 1] : null; + const deviceName = process.argv.find((arg) => arg.includes('--deviceName')); const defaultDeviceName = platform === 'iOS' ? 'iPhone 13' : 'Pixel 3a API 33'; - return deviceName ?? defaultDeviceName; + return deviceName ? deviceName.split('=')[1] : defaultDeviceName; }; /** @@ -14,11 +13,9 @@ const getDeviceName = (platform) => { * @param platform iOS or Android */ const getPlatformVersion = (platform) => { - const platformVersionIndex = process.argv.indexOf('--platformVersion'); - const platformVersion = - platformVersionIndex !== -1 ? process.argv[platformVersionIndex + 1] : null; + const platformVersion = process.argv.find((arg) => arg.includes('--platformVersion')); const defaultPlatformVersion = platform === 'iOS' ? '15.0' : '13'; - return platformVersion ?? defaultPlatformVersion; + return platformVersion ? platformVersion.split('=')[1] : defaultPlatformVersion; }; module.exports = { getDeviceName, getPlatformVersion }; From 0f0930be17919cd07ea4d13215bab7c8f25b1e5b Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Mon, 13 Nov 2023 13:49:54 -0800 Subject: [PATCH 13/14] Add appium test script --- package.serve.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/package.serve.json b/package.serve.json index 6b1be7046..a71679111 100644 --- a/package.serve.json +++ b/package.serve.json @@ -12,7 +12,9 @@ "serve": "webpack --config webpack.dev.js && concurrently -k \"phonegap --verbose serve\" \"webpack --config webpack.dev.js --watch\"", "serve-prod": "webpack --config webpack.prod.js && concurrently -k \"phonegap --verbose serve\" \"webpack --config webpack.prod.js --watch\"", "serve-only": "phonegap --verbose serve", - "test": "npx jest" + "test": "npx jest", + "appium-ios": "npx wdio ./e2e-tests/config/ios.config.js --", + "appium-android": "npx wdio ./e2e-tests/config/android.config.js --" }, "devDependencies": { "@babel/core": "^7.21.3", From 161bbbdc96658d4d10f3e14bcf86845a18b7a953 Mon Sep 17 00:00:00 2001 From: Jiji14 Date: Fri, 17 Nov 2023 15:43:41 -0800 Subject: [PATCH 14/14] change IOS testing setup to download devapp when starting tests --- e2e-tests/config/ios.config.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/e2e-tests/config/ios.config.js b/e2e-tests/config/ios.config.js index 7118d6d0f..a0cda4cfc 100644 --- a/e2e-tests/config/ios.config.js +++ b/e2e-tests/config/ios.config.js @@ -1,5 +1,6 @@ const { getDeviceName, getPlatformVersion } = require('./common'); const { config } = require('./wdio.conf'); +const { join } = require('path'); // Appium capabilities config.capabilities = [ @@ -13,8 +14,8 @@ config.capabilities = [ 'appium:deviceName': getDeviceName('iOS'), 'appium:platformVersion': getPlatformVersion('iOS'), 'appium:automationName': 'XCUITest', - 'appium:app': 'edu.berkeley.eecs.emission.devapp', + // it may change once we finalize our target app + 'appium:app': join(process.cwd(), './apps/em-devapp.app'), }, ]; - exports.config = config;