Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use getSummaryByCode method in Appium Base Driver

Best JavaScript code snippet using appium-base-driver

proxy.js

Source:proxy.js

...259        let message = resBodyObj.value;260        if (_.has(message, 'message')) {261          message = message.message;262        }263        throw errorFromMJSONWPStatusCode(status, _.isEmpty(message) ? getSummaryByCode(status) : message);264      }265    } else if (protocol === W3C) {266      // Got response in W3C format267      if (response.statusCode < 300) {268        return resBodyObj.value;269      }270      if (_.isPlainObject(resBodyObj.value) && resBodyObj.value.error) {271        throw errorFromW3CJsonCode(resBodyObj.value.error, resBodyObj.value.message, resBodyObj.value.stacktrace);272      }273    } else if (response.statusCode === 200) {274      // Unknown protocol. Keeping it because of the backward compatibility275      return resBodyObj;276    }277    throw new errors.UnknownError(`Did not know what to do with response code '${response.statusCode}' ` +...

responses.js

Source:responses.js

...39  } else if (typeof statusObj === "undefined") {40    message = "undefined status object";41  } else if (typeof statusObj === "number") {42    code = statusObj;43    message = status.getSummaryByCode(code);44  } else if (typeof statusObj.code !== "undefined") {45    code = statusObj.code;46    message = statusObj.summary;47  } else if (typeof statusObj.message !== "undefined") {48    message = statusObj.message;49  }50  if (typeof newValue === "object") {51    if (newValue !== null && _.has(value, "message")) {52      // make sure this doesn't get obliterated53      value.origValue = value.message;54      message += " (Original error: " + value.message + ")";55    }56    newValue = _.extend({message: message}, value);57  } else {...

status.js

Source:status.js

1import _ from 'lodash';2const codes = {3  Success: {4    code: 0,5    summary: 'The command executed successfully.'6  },7  NoSuchDriver: {8    code: 6,9    summary: 'A session is either terminated or not started'10  },11  NoSuchElement: {12    code: 7,13    summary: 'An element could not be located on the page using the given search parameters.'14  },15  NoSuchFrame: {16    code: 8,17    summary: 'A request to switch to a frame could not be satisfied because the frame could not be found.'18  },19  UnknownCommand: {20    code: 9,21    summary: 'The requested resource could not be found, or a request was received using an HTTP method that is not supported by the mapped resource.'22  },23  StaleElementReference: {24    code: 10,25    summary: 'An element command failed because the referenced element is no longer attached to the DOM.'26  },27  ElementNotVisible: {28    code: 11,29    summary: 'An element command could not be completed because the element is not visible on the page.'30  },31  InvalidElementState: {32    code: 12,33    summary: 'An element command could not be completed because the element is in an invalid state (e.g. attempting to click a disabled element).'34  },35  UnknownError: {36    code: 13,37    summary: 'An unknown server-side error occurred while processing the command.'38  },39  ElementIsNotSelectable: {40    code: 15,41    summary: 'An attempt was made to select an element that cannot be selected.'42  },43  JavaScriptError: {44    code: 17,45    summary: 'An error occurred while executing user supplied JavaScript.'46  },47  XPathLookupError: {48    code: 19,49    summary: 'An error occurred while searching for an element by XPath.'50  },51  Timeout: {52    code: 21,53    summary: 'An operation did not complete before its timeout expired.'54  },55  NoSuchWindow: {56    code: 23,57    summary: 'A request to switch to a different window could not be satisfied because the window could not be found.'58  },59  InvalidCookieDomain: {60    code: 24,61    summary: 'An illegal attempt was made to set a cookie under a different domain than the current page.'62  },63  UnableToSetCookie: {64    code: 25,65    summary: 'A request to set a cookie\'s value could not be satisfied.'66  },67  UnexpectedAlertOpen: {68    code: 26,69    summary: 'A modal dialog was open, blocking this operation'70  },71  NoAlertOpenError: {72    code: 27,73    summary: 'An attempt was made to operate on a modal dialog when one was not open.'74  },75  ScriptTimeout: {76    code: 28,77    summary: 'A script did not complete before its timeout expired.'78  },79  InvalidElementCoordinates: {80    code: 29,81    summary: 'The coordinates provided to an interactions operation are invalid.'82  },83  IMENotAvailable: {84    code: 30,85    summary: 'IME was not available.'86  },87  IMEEngineActivationFailed: {88    code: 31,89    summary: 'An IME engine could not be started.'90  },91  InvalidSelector: {92    code: 32,93    summary: 'Argument was an invalid selector (e.g. XPath/CSS).'94  },95  SessionNotCreatedException: {96    code: 33,97    summary: 'A new session could not be created.'98  },99  MoveTargetOutOfBounds: {100    code: 34,101    summary: 'Target provided for a move action is out of bounds.'102  },103  NoSuchContext: {104    code: 35,105    summary: 'No such context found.'106  }107};108function getSummaryByCode (code) {109  code = parseInt(code, 10);110  for (let obj of _.values(codes)) {111    if (!_.isUndefined(obj.code) && obj.code === code) {112      return obj.summary;113    }114  }115  return 'An error occurred';116}117export default codes;...

index.js

Source:index.js

1// transpile:main2// BaseDriver exports3import * as driver from './lib/basedriver/driver';4import * as image from './lib/basedriver/image-element';5import * as deviceSettings from './lib/basedriver/device-settings';6const { BaseDriver } = driver;7const { ImageElement } = image;8const { DeviceSettings, BASEDRIVER_HANDLED_SETTINGS } = deviceSettings;9export { BaseDriver, DeviceSettings, ImageElement, BASEDRIVER_HANDLED_SETTINGS };10export default BaseDriver;11// MJSONWP exports12import * as protocol from './lib/protocol';13const {14  Protocol, routeConfiguringFunction, errors, isErrorType,15  errorFromMJSONWPStatusCode, errorFromW3CJsonCode, ALL_COMMANDS, METHOD_MAP,16  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,17} = protocol;18export {19  Protocol, routeConfiguringFunction, errors, isErrorType,20  errorFromMJSONWPStatusCode, errorFromW3CJsonCode,21  errorFromMJSONWPStatusCode as errorFromCode, ALL_COMMANDS, METHOD_MAP,22  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand };23// Express exports24import * as staticIndex from './lib/express/static';25const { STATIC_DIR } = staticIndex;26export { STATIC_DIR };27import * as serverIndex from './lib/express/server';28const { server } = serverIndex;29export { server };30// jsonwp-proxy exports31import * as proxyIndex from './lib/jsonwp-proxy/proxy';32const { JWProxy } = proxyIndex;33export { JWProxy };34// jsonwp-status exports35import * as statusIndex from './lib/jsonwp-status/status';36const { codes: statusCodes, getSummaryByCode } = statusIndex;37export { statusCodes, getSummaryByCode };38// W3C capabilities parser39import * as caps from './lib/basedriver/capabilities';40const { processCapabilities, isStandardCap } = caps;41export { processCapabilities, isStandardCap };42// Web socket helpers43import * as ws from './lib/express/websocket';44const { DEFAULT_WS_PATHNAME_PREFIX } = ws;...

status-specs.js

Source:status-specs.js

...16    });17  });18  describe('getSummaryByCode', function () {19    it('should get the summary for a code', function () {20      getSummaryByCode(0).should.equal('The command executed successfully.');21    });22    it('should convert codes to ints', function () {23      getSummaryByCode('0').should.equal('The command executed successfully.');24    });25    it('should return an error string for unknown code', function () {26      getSummaryByCode(1000).should.equal('An error occurred');27    });28  });...

Using AI Code Generation

1const BaseDriver = require('appium-base-driver');2const driver = new BaseDriver();3driver.getSummaryByCode(0);4const AndroidDriver = require('appium-android-driver');5const driver = new AndroidDriver();6driver.getSummaryByCode(0);7const IosDriver = require('appium-ios-driver');8const driver = new IosDriver();9driver.getSummaryByCode(0);10const WindowsDriver = require('appium-windows-driver');11const driver = new WindowsDriver();12driver.getSummaryByCode(0);13const MacDriver = require('appium-mac-driver');14const driver = new MacDriver();15driver.getSummaryByCode(0);16const YouiEngineDriver = require('appium-youiengine-driver');17const driver = new YouiEngineDriver();18driver.getSummaryByCode(0);19const EspressoDriver = require('appium-espresso-driver');20const driver = new EspressoDriver();21driver.getSummaryByCode(0);22const XCUITestDriver = require('appium-xcuitest-driver');23const driver = new XCUITestDriver();24driver.getSummaryByCode(0);25const WebDriver = require('appium-webdriver');26const driver = new WebDriver();27driver.getSummaryByCode(0);28const FakeDriver = require('appium-fake-driver');29const driver = new FakeDriver();30driver.getSummaryByCode(0);31const SelendroidDriver = require('appium-selendroid-driver');32const driver = new SelendroidDriver();33driver.getSummaryByCode(0);34const uiautomator2Driver = require('app

Using AI Code Generation

1const { AppiumBaseDriver } = require('appium-base-driver');2const driver = new AppiumBaseDriver();3driver.getSummaryByCode(400);4Appium version (or git revision) that exhibits the issue: 1.14.05Last Appium version that did not exhibit the issue (if applicable): N/A6Node.js version (unless using Appium.app|exe): v12.6.0

Using AI Code Generation

1const { AppiumDriver, errors } = require('appium-base-driver');2const { BaseDriver } = require('appium-base-driver');3const { BaseDriver } = require('appium-base-driver');4const { BaseDriver } = require('appium-base-driver');5const driver = new AppiumDriver();6driver.getSummaryByCode(500, 'Test Error');7const { AppiumDriver, errors } = require('appium-base-driver');8const { BaseDriver } = require('appium-base-driver');9const { BaseDriver } = require('appium-base-driver');10const { BaseDriver } = require('appium-base-driver');11const driver = new AppiumDriver();12driver.setSummaryByCode(500, 'Test Error');13const { AppiumDriver, errors } = require('appium-base-driver');14const { BaseDriver } = require('appium-base-driver');15const { BaseDriver } = require('appium-base-driver');16const { BaseDriver } = require('appium-base-driver');17const driver = new AppiumDriver();18driver.getSummaryByHTTPStatus(500, 'Test Error');19const { AppiumDriver, errors } = require('appium-base-driver');20const { BaseDriver } = require('appium-base-driver');21const { BaseDriver } = require('appium-base-driver');22const { BaseDriver } = require('appium-base-driver');23const driver = new AppiumDriver();24driver.setSummaryByHTTPStatus(500, 'Test Error');

Using AI Code Generation

1driver.getSummaryByCode(1, 2, 3, 4);2driver.getSummaryByCode(1, 2, 3, 4);3driver.getSummaryByCode(1, 2, 3, 4);4driver.getSummaryByCode(1, 2, 3, 4);5driver.getSummaryByCode(1, 2, 3, 4);6driver.getSummaryByCode(1, 2, 3, 4);7driver.getSummaryByCode(1, 2, 3, 4);8driver.getSummaryByCode(1, 2, 3, 4);9driver.getSummaryByCode(1, 2, 3, 4);10driver.getSummaryByCode(1, 2, 3, 4);11driver.getSummaryByCode(1, 2, 3, 4);12driver.getSummaryByCode(1, 2, 3, 4);13driver.getSummaryByCode(1,

Using AI Code Generation

1describe('getSummaryByCode', function () {2    it('should return a summary of the current session', async function () {3      let summary = await driver.getSummaryByCode();4      console.log(summary);5    });6  });7{ "status": 0, "value": { "message": "OK", "code": 0, "summary": { "sessionId": "d8b8e6c0-6e1f-4d8d-8f2b-1e2a7a9d0d8e", "capabilities": { "deviceName": "emulator-5554", "platformName": "Android", "platformVersion": "8.0.0", "app": "/Users/username/Downloads/ApiDemos-debug.apk", "automationName": "UiAutomator2", "noReset": true, "fullReset": false, "newCommandTimeout": 60, "appPackage": "io.appium.android.apis", "appActivity": "io.appium.android.apis.ApiDemos", "udid": "emulator-5554" } } } }8{ "status": 0, "value": { "message": "OK", "code": 0, "summary": { "sessionId": "d8b8e6c0-6e1f-4d8d-8f2b-1e2a7a9d0d8e", "capabilities": { "deviceName": "emulator-5554", "platformName": "Android", "platformVersion": "8.0.0", "app": "/Users/username/Downloads/ApiDemos-debug.apk", "automationName": "UiAutomator2",

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.