Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! 
How to use validateCaps method in Appium Base Driver
Best JavaScript code snippet using appium-base-driver
driver.js
Source:driver.js 
...192 if (!this.shouldValidateCaps) {193 return true;194 }195 try {196 validateCaps(caps, this._constraints);197 } catch (e) {198 log.errorAndThrow(new errors.SessionNotCreatedError(`The desiredCapabilities object was not valid for the ` +199 `following reason(s): ${e.message}`));200 }201 this.logExtraCaps(caps);202 return true;203 }204 isMjsonwpProtocol () {205 return this.protocol === PROTOCOLS.MJSONWP;206 }207 isW3CProtocol () {208 return this.protocol === PROTOCOLS.W3C;209 }210 setProtocolMJSONWP () {...
capabilities-specs.js
Source:capabilities-specs.js
...9 // Tests based on: https://www.w3.org/TR/webdriver/#dfn-validate-caps10 describe('#validateCaps', function () {11 it('returns invalid argument error if "capability" is not a JSON object (1)', function () {12 for (let arg of [undefined, null, 1, true, 'string']) {13 (function () { validateCaps(arg); }).should.throw(/must be a JSON object/);14 }15 });16 it('returns result {} by default if caps is empty object and no constraints provided (2)', function () {17 validateCaps({}).should.deep.equal({});18 });19 describe('throws errors if constraints are not met', function () {20 it('returns invalid argument error if "present" constraint not met on property', function () {21 (() => validateCaps({}, {foo: {presence: true}})).should.throw(/'foo' can't be blank/);22 });23 it('returns the capability that was passed in if "skipPresenceConstraint" is false', function () {24 validateCaps({}, {foo: {presence: true}}, {skipPresenceConstraint: true}).should.deep.equal({});25 });26 it('returns invalid argument error if "isString" constraint not met on property', function () {27 (() => validateCaps({foo: 1}, {foo: {isString: true}})).should.throw(/'foo' must be of type string/);28 });29 it('returns invalid argument error if "isNumber" constraint not met on property', function () {30 (() => validateCaps({foo: 'bar'}, {foo: {isNumber: true}})).should.throw(/'foo' must be of type number/);31 });32 it('returns invalid argument error if "isBoolean" constraint not met on property', function () {33 (() => validateCaps({foo: 'bar'}, {foo: {isBoolean: true}})).should.throw(/'foo' must be of type boolean/);34 });35 it('returns invalid argument error if "inclusion" constraint not met on property', function () {36 (() => validateCaps({foo: '3'}, {foo: {inclusionCaseInsensitive: ['1', '2']}})).should.throw(/'foo' 3 not part of 1,2/);37 });38 it('returns invalid argument error if "inclusionCaseInsensitive" constraint not met on property', function () {39 (() => validateCaps({foo: 'a'}, {foo: {inclusion: ['A', 'B', 'C']}})).should.throw(/'foo' a is not included in the list/);40 });41 });42 it('should not throw errors if constraints are met', function () {43 let caps = {44 number: 1,45 string: 'string',46 present: 'present',47 extra: 'extra',48 };49 let constraints = {50 number: {isNumber: true},51 string: {isString: true},52 present: {presence: true},53 notPresent: {presence: false},54 };55 validateCaps(caps, constraints).should.deep.equal(caps);56 });57 });58 // Tests based on: https://www.w3.org/TR/webdriver/#dfn-merging-caps59 describe('#mergeCaps', function () {60 it('returns a result that is {} by default (1)', function () {61 mergeCaps().should.deep.equal({});62 });63 it('returns a result that matches primary by default (2, 3)', function () {64 mergeCaps({hello: 'world'}).should.deep.equal({hello: 'world'});65 });66 it('returns invalid argument error if primary and secondary have matching properties (4)', function () {67 (() => mergeCaps({hello: 'world'}, {hello: 'whirl'})).should.throw(/property 'hello' should not exist on both primary [\w\W]* and secondary [\w\W]*/);68 });69 it('returns a result with keys from primary and secondary together', function () {...
capabilities.js
Source:capabilities.js
...124 stripAppiumPrefixes(firstMatchCaps);125 }126 // Validate the requiredCaps. But don't validate 'presence' because if that constraint fails on 'alwaysMatch' it could still pass on one of the 'firstMatch' keys127 if (shouldValidateCaps) {128 requiredCaps = validateCaps(requiredCaps, constraints, {skipPresenceConstraint: true});129 }130 // Remove the 'presence' constraint for any keys that are already present in 'requiredCaps'131 // since we know that this constraint has already passed132 let filteredConstraints = {...constraints};133 let requiredCapsKeys = _.keys(requiredCaps);134 for (let key of _.keys(filteredConstraints)) {135 if (requiredCapsKeys.includes(key)) {136 delete filteredConstraints[key];137 }138 }139 // Validate all of the first match capabilities and return an array with only the valid caps (see spec #5)140 let validationErrors = [];141 let validatedFirstMatchCaps = allFirstMatchCaps.map((firstMatchCaps) => {142 try {143 // Validate firstMatch caps144 return shouldValidateCaps ? validateCaps(firstMatchCaps, filteredConstraints) : firstMatchCaps;145 } catch (e) {146 validationErrors.push(e.message);147 return null;148 }149 }).filter((caps) => !_.isNull(caps));150 // Try to merge requiredCaps with first match capabilities, break once it finds its first match (see spec #6)151 let matchedCaps = null;152 for (let firstMatchCaps of validatedFirstMatchCaps) {153 try {154 matchedCaps = mergeCaps(requiredCaps, firstMatchCaps);155 if (matchedCaps) {156 break;157 }158 } catch (err) {...
registerSlice.js
Source:registerSlice.js
1import {createAsyncThunk, createSlice} from "@reduxjs/toolkit";2import {baseApi} from '../../app/App';3export const submitRegistration = createAsyncThunk(4 'registerSlice/submitRegistration', 5 async (obj) => {6 const {username, password, confirmPassword} = obj; 7 if(password === confirmPassword){8 const validateCaps = /[A-Z]/9 const validateNum = /\d/10 if(password.match(validateCaps) && password.match(validateNum)){11 const basic = `${username}:${password}:${confirmPassword}`;12 const basicEncoded = Buffer.from(basic).toString("base64");13 const data = await fetch(`${baseApi}/auth/register`, {14 method: 'POST',15 credentials: 'include',16 headers: {17 'Accept': 'application/json',18 'Authorization': `Basic ${basicEncoded}`19 }20 });21 const {status} = data;22 const json = await data.json()23 json['status'] = status;24 return json;25 } else {26 return {"message": 'Password must contain at least one capital letter and one number.', "status": 0}27 }28 } else {29 return {"message": 'Passwords do not match, please try again.', "status": 0}30 }31 }32)33const registerSlice = createSlice({34 name:'registerSlice',35 initialState:{36 isLoading: false,37 hasError: false,38 sessionActive: false,39 redirectRequired:false,40 errorMessage: ''41 },42 extraReducers: {43 [submitRegistration.pending]: (state, action) => {44 state.isLoading = true;45 state.hasError = false;46 },47 [submitRegistration.fulfilled]: (state, action) => {48 state.isLoading = false;49 if(action.payload.status === 200){50 state.hasError = false;51 } else {52 state.hasError = true;53 state.errorMessage = action.payload.message;54 }55 },56 [submitRegistration.rejected]: (state, action) => {57 state.isLoading = false;58 state.hasError = true 59 }60 }61})62export const errorMessage = state => state.registerSlice.errorMessage;63export const errored = state => state.registerSlice.hasError;...
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';13import {14 DEFAULT_BASE_PATH, PROTOCOLS15} from './lib/constants';16const {17 Protocol, routeConfiguringFunction, errors, isErrorType,18 errorFromMJSONWPStatusCode, errorFromW3CJsonCode, ALL_COMMANDS, METHOD_MAP,19 routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,20 normalizeBasePath, determineProtocol21} = protocol;22export {23 Protocol, routeConfiguringFunction, errors, isErrorType, PROTOCOLS,24 errorFromMJSONWPStatusCode, errorFromW3CJsonCode, determineProtocol,25 errorFromMJSONWPStatusCode as errorFromCode, ALL_COMMANDS, METHOD_MAP,26 routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,27 DEFAULT_BASE_PATH, normalizeBasePath28};29// Express exports30import * as staticIndex from './lib/express/static';31const { STATIC_DIR } = staticIndex;32export { STATIC_DIR };33import * as serverIndex from './lib/express/server';34const { server } = serverIndex;35export { server };36// jsonwp-proxy exports37import * as proxyIndex from './lib/jsonwp-proxy/proxy';38const { JWProxy } = proxyIndex;39export { JWProxy };40// jsonwp-status exports41import * as statusIndex from './lib/jsonwp-status/status';42const { codes: statusCodes, getSummaryByCode } = statusIndex;43export { statusCodes, getSummaryByCode };44// W3C capabilities parser45import * as caps from './lib/basedriver/capabilities';46const { processCapabilities, isStandardCap, validateCaps } = caps;47export { processCapabilities, isStandardCap, validateCaps };48// Web socket helpers49import * as ws from './lib/express/websocket';50const { DEFAULT_WS_PATHNAME_PREFIX } = ws;...
loginSlice.js
Source:loginSlice.js
1import { createAsyncThunk, createSlice } from "@reduxjs/toolkit";2import { baseApi } from "../../app/App";3export const submitLogin = createAsyncThunk(4 'loginSlice/submitLogin', 5 async (obj) => {6 const {username, password} = obj;7 const validateCaps = /[A-Z]/8 const validateNum = /\d/9 if(password.match(validateCaps) && password.match(validateNum)){10 const basic = `${username}:${password}`;11 const basicEncoded = Buffer.from(basic).toString("base64");12 const data = await fetch(`${baseApi}/auth/login`, {13 method: 'POST',14 credentials: 'include', 15 headers: {16 'Accept': 'application/json',17 'Authorization': `Basic ${basicEncoded}` 18 }19 });20 const {status} = data;21 const json = await data.json();22 json['status'] = status;23 return json;24 } else {25 return {"message": 'Password must contain at least one capital letter and one number.', "status": 0} 26 }27 }28)29const loginSlice = createSlice({30 name:'loginSlice',31 initialState:{32 isLoading: false,33 hasError: false,34 errorMessage: ''35 },36 extraReducers: {37 [submitLogin.pending]: (state, action) => {38 state.isLoading = true;39 },40 [submitLogin.fulfilled]: (state, action) => {41 state.isLoading = false;42 if(action.payload.status === 200){43 state.hasError = false;44 } else {45 state.hasError = true;46 state.errorMessage = action.payload.message;47 }48 },49 [submitLogin.rejected]: (state, action) => {50 state.isLoading = false;51 state.hasError = true;52 }53 }54});55export const errorMessage = state => state.loginSlice.errorMessage;56export const errored = state => state.loginSlice.hasError;...
Using AI Code Generation
1let AppiumBaseDriver = require('appium-base-driver');2let driver = new AppiumBaseDriver();3let caps = {4};5let errors = driver.validateCaps(caps);6if (errors) {7 console.log(errors);8}9let AppiumBaseDriver = require('appium-base-driver');10let driver = new AppiumBaseDriver();11let caps = {12};13let errors = driver.validateDesiredCaps(caps);14if (errors) {15 console.log(errors);16}17let AppiumBaseDriver = require('appium-base-driver');18let driver = new AppiumBaseDriver();19let caps = {20};21let errors = driver.validateApp(caps);22if (errors) {23 console.log(errors);24}25let AppiumBaseDriver = require('appium-base-driver');26let driver = new AppiumBaseDriver();27let caps = {28};29let errors = driver.validateApp(caps);30if (errors) {31 console.log(errors);32}33let AppiumBaseDriver = require('appium-base-driver');34let driver = new AppiumBaseDriver();35let caps = {36};37let errors = driver.validateAutomationName(caps);38if (
Using AI Code Generation
1var appium = require('appium-base-driver');2var validateCaps = appium.validateCaps;3var desiredCaps = {4};5var validatedCaps = validateCaps(desiredCaps);6console.log(validatedCaps);7var appium = require('appium-android-driver');8var validateCaps = appium.validateCaps;9var desiredCaps = {10};11var validatedCaps = validateCaps(desiredCaps);12console.log(validatedCaps);
Using AI Code Generation
1const validateCaps = require('appium-base-driver').validateCaps;2const caps = {3};4validateCaps(caps);5const validateCaps = require('appium-xcuitest-driver').validateCaps;6const caps = {7};8validateCaps(caps);9const validateCaps = require('appium-android-driver').validateCaps;10const caps = {11};12validateCaps(caps);13const validateCaps = require('appium-windows-driver').validateCaps;14const caps = {15};16validateCaps(caps);17const validateCaps = require('appium-mac-driver').validateCaps;18const caps = {19};20validateCaps(caps);21const validateCaps = require('appium-youiengine-driver').validateCaps;22const caps = {23};24validateCaps(caps);25const validateCaps = require('appium-espresso-driver').validateCaps;26const caps = {
Using AI Code Generation
1var validateCaps = require('appium-base-driver').validateCaps;2validateCaps(caps);3var validateCaps = require('appium-base-driver').validateCaps;4validateCaps(caps);5var validateCaps = require('appium-base-driver').validateCaps;6validateCaps(caps);7var validateCaps = require('appium-base-driver').validateCaps;8validateCaps(caps);9var validateCaps = require('appium-base-driver').validateCaps;10validateCaps(caps);11var validateCaps = require('appium-base-driver').validateCaps;12validateCaps(caps);13var validateCaps = require('appium-base-driver').validateCaps;14validateCaps(caps);15var validateCaps = require('appium-base-driver').validateCaps;16validateCaps(caps);17var validateCaps = require('appium-base-driver').validateCaps;18validateCaps(caps);19var validateCaps = require('appium-base-driver').validateCaps;20validateCaps(caps);21var validateCaps = require('appium-base-driver').validateCaps;22validateCaps(caps);23var validateCaps = require('appium-base-driver').validateCaps;24validateCaps(caps);
Using AI Code Generation
1const { BaseDriver } = require('appium-base-driver');2const { util } = require('appium-support');3const { validateCaps } = util;4const desiredCaps = {5};6const opts = {7 appiumCaps: {8 platformName: {9 },10 deviceName: {11 },12 app: {13 },14 automationName: {15 },16 appPackage: {17 },18 appActivity: {19 }20 },21 derivedCaps: {22 platformVersion: {23 },24 deviceUDID: {25 },26 showChromedriverLog: {27 },28 chromedriverExecutable: {29 }30 }31};32validateCaps(desiredCaps, opts);33console.log('desiredCaps are validated');34const { BaseDriver } = require('appium-base-driver');35const { util } = require('appium-support');36const { validateCaps } = util;37const desiredCaps = {38};39const opts = {40 appiumCaps: {41 platformName: {42 },43 deviceName: {44 },45 app: {46 },47 automationName: {48 },49 appPackage: {50 },51 appActivity: {
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.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Appium Base Driver automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
