arjuna.tpi.constant module

class arjuna.tpi.constant.ArjunaOption(value)

Bases: enum.Enum

Represents all built-in configuration options for Arjuna.

Any option name which is does not correspond to ArjunaOption enum constant is treated as a user defined option.

ALLOW_INSECURE_SSL_CERT = 80

If True, insecure SSL certificates are allowd. Default is True

APPIUM_AUTO_LAUNCH = 101

Instructs Arjuna to launch Appium programmatically. Default is True. Currently not processed.

APPIUM_SERVICE_URL = 100

Appium Service URL. Currently not processed.

APP_URL = 58

Base URL for a Web App. Used by launch() method if url is not specified for GuiApp.

ARJUNA_EXTERNAL_IMPORTS_DIR = 2

Directory of third party libs directly included in Arjuna.

ARJUNA_ROOT_DIR = 1

Root Directory of Arjuna Installed/Imported in a session

BROWSER_BIN_PATH = 77

Path of the Browser binary on test system.

BROWSER_DIM_HEIGHT = 75

Browser Height for GUI Automation. If not set, Arjuna does not change the height of browser.

BROWSER_DIM_WIDTH = 76

Browser Width for GUI Automation. If not set, Arjuna does not change the width of browser.

BROWSER_HEADLESS = 72

Sets headless mode for browser for GUI Automation. Default is False.

BROWSER_MAXIMIZE = 74

Browser is maximized in GUI Automation after launch. Default is False.

BROWSER_NAME = 71

Browser Name for Gui Automation. Chrome/Firefox. Default is Chrome

BROWSER_NETWORK_RECORDER_AUTOMATIC = 79

If True, when a browser is launched, Arjuna automatically starts capturing all traffic. Default is False

BROWSER_NETWORK_RECORDER_ENABLED = 78

If True, Arjuna uses BrowserMob proxy, if available in test project, to capture Network requests made by browser. Default is False.

BROWSER_VERSION = 73

Browser Version for GUI Automation.

CONF_DATA_FILE = 40

File that contains all data configurations.

CONF_DATA_LOCAL_FILE = 41

Local File that contains all data configurations.

CONF_DIR = 39

Test Project configuration directory

CONF_ENVS_FILE = 42

File that contains all environment configurations.

CONF_ENVS_LOCAL_FILE = 43

Local File that contains all environment configurations.

CONF_GROUPS_FILE = 48

File that contains all test group definitions.

CONF_GROUPS_LOCAL_FILE = 49

Local File that contains all test group definitions.

CONF_PROJECT_FILE = 15

Project conf file path.

CONF_PROJECT_LOCAL_FILE = 16

Local Project conf file path.

CONF_SESSIONS_FILE = 44

File that contains all test session definitions.

CONF_SESSIONS_LOCAL_FILE = 45

Local File that contains all test session definitions.

CONF_STAGES_FILE = 46

File that contains all test stage definitions.

CONF_STAGES_LOCAL_FILE = 47

Local File that contains all test stage definitions.

CONF_WITHX_FILE = 50

withx.yaml file used for writing custom locators for Gui Automation.

CONF_WITHX_LOCAL_FILE = 51

Local withx.yaml file used for writing custom locators for Gui Automation.

DATA_DIR = 52

Directory containing data files in test project.

DATA_FILE_DIR = 57

Directory containing files used as file data.

DATA_REF_CONTEXTUAL_DIR = 55

Directory containing contextual data reference files in test project.

DATA_REF_DIR = 54

Directory containing contextual data reference files in test project.

DATA_REF_INDEXED_DIR = 56

Directory containing indexed data reference files in test project.

DATA_SRC_DIR = 53

Directory containing data source files in test project.

DBAUTO_DIR = 36

Directory containing Database interaction automation related input files.

DBAUTO_SQL_DIR = 37

Directory containing SQL files for Database interaction automation.

DEPS_DIR = 35

Directory containing external tool binaries in Arjuna test project.

EMAILAUTO_IMAP_HOST = 65

IP address/Name of EmailBox for IMAP Protocol. Default is localhost.

EMAILAUTO_IMAP_PORT = 66

Network Port of EmailBox for IMAP Protocol. Default is 993 in SSL Mode and 143 in non-SSL Mode.

EMAILAUTO_IMAP_USESSL = 67

Enables/Disables usage of SSL for connecting to EmailBox via IMAP. Default is True.

EMAILAUTO_MAX_WAIT = 70

Maximum time for selecting a mailbox or reading/parsing emails. Uses Dynamic Wait. Expressed in seconds. Default is 120 seconds.

EMAILAUTO_PASSWORD = 69

Default Email password to be used in Arjuna.

EMAILAUTO_USER = 68

Default Email Address to be used in Arjuna.

GUIAUTO_CONTEXT = 85

Gui Automation Context. Currently not processed.

GUIAUTO_DEF_MULTICONTEXT = 84

Sets multi context mode for GNS files. Currently not processed.

GUIAUTO_DIR = 82

Root directory of all Gui automation relation directories and files

GUIAUTO_MAX_WAIT = 87

Maximum time for a Gui element locating or waitable interaction to occur. Uses Dynamic Wait. Expressed in seconds. Default is 60.

GUIAUTO_NAME = 81

Engine name. Currently set to Selenium which is the only supported engine.

GUIAUTO_NAMESPACE_DIR = 83

Root directory of all Gui Namespace (GNS) files.

GUIAUTO_SLOMO_INTERVAL = 89

Time Interval between successive Gui Automation actions when Slow Motion mode is ON. Expressed in seconds. Default is 2

GUIAUTO_SLOMO_ON = 88

Sets slow motion mode for Gui Automation. Default is False.

HOOKS_CONFIG_PACKAGE = 19

Arjuna Config Hooks Package Import Path.

HOOKS_ENTITY_PACKAGE = 20

Arjuna Data Entity Hooks Package Import Path.

HOOKS_PACKAGE = 18

Arjuna Hooks Package Import Path.

HOOKS_RESOURCE_PACKAGE = 21

Arjuna Resource Package Import Path.

HTTPAUTO_DIR = 63

Root directory of all HTTP automation relation directories and files

HTTPAUTO_MESSAGE_DIR = 64

Root directory of all HTTP message YAML files.

HTTP_PROXY_ENABLED = 60

Is a proxy enabled for HTTP requests (GUIAuto as well as HttpAuto)

HTTP_PROXY_HOST = 61

IP address/Name of HTTP proxy host. Default is localhost.

HTTP_PROXY_PORT = 62

Network Port of HTTP proxy. Default is 8080.

IMG_COMP_MIN_SCORE = 102

A fraction that represents minimum image comparison score to decide on an image match. Default is 0.7. Currently not processed.

L10N_DIR = 12

Directory containing Localization files.

L10N_LOCALE = 10

Default Locale type to be used for Localization call. Values as per arjuna.tpi.constant.Locale

L10N_STRICT = 11

Sets Localization mode to strict. Default is False.

LOG_ALLOWED_CONTEXTS = 9

Allowed context strings for logging (file as well as display). Messages without contexts always get logged.

LOG_CONSOLE_LEVEL = 8

Minimum level for a message to be displayed on console

LOG_DIR = 31

Directory containing arjuna.log for current test run.

LOG_FILE_LEVEL = 7

Minimum level for a message to be logged to log file.

LOG_NAME = 3

Name of Arjuna’s log file

MOBILE_APP_FILE_PATH = 94

Mobile App path on test system. No default set.

MOBILE_DEVICE_NAME = 92

Mobile Device name. No default set.

MOBILE_DEVICE_UDID = 93

Mobile Device UDID. No default set.

MOBILE_OS_NAME = 90

Mobile OS Name. iOs/Android. Default is Android.

MOBILE_OS_VERSION = 91

Mobile OS Version. No default set.

PROJECT_NAME = 13

Test Project Name

PROJECT_ROOT_DIR = 14

Test Project Root Directory

REPORTS_DIR = 22

Root directory for test reports.

REPORT_DIR = 24

Reporting directory for current test run under REPORTS_DIR. Name is generated with RUN_ID and Current Timestamp. With –static-rid CLI switch, timestamp is not appended.

REPORT_FORMATS = 23

Formats for Report Generation. XML/HTML

REPORT_GROUP_RENAME = 27

If True, for run-group command, reports are created without session and stage prefixes.

REPORT_HTML_DIR = 26

Directory containing report.html for current test run.

REPORT_NETWORK_ALWAYS = 29

If True, Network packets are always show in Report, else they are not shown for passed tests. Default is False.

REPORT_NETWORK_FILTER = 30

If True, in reporting, the request/response for static resources like image files, css etc will be excluded. Only HTML/JSON/XML content is included. Default is True

REPORT_SCREENSHOTS_ALWAYS = 28

If True, Screenshots are always show in Report, else they are not shown for passed tests. Default is False.

REPORT_XML_DIR = 25

Directory containing report.xml for current test run.

RUN_HOST_OS = 6

Windows/Mac/Linux.

Type

Host Operating System type

RUN_ID = 4

An alnum string representing current test run. Default is mrun

RUN_SESSION_NAME = 5

Current session name.

SCREENSHOTS_DIR = 32

Directory containing screenshots for current test run.

SCROLL_PIXELS = 86

Number of pixels for each scroll call in Gui Automation. Default is 100.

SELENIUM_DRIVERS_DIR = 96

Root Directory containing OS specific browser drivers for Selenium. Has an impact only if SELENIUM_DRIVER_DOWNLOAD is set to False.

SELENIUM_DRIVER_DOWNLOAD = 98

Instructs Arjuna to automatically download Selenium browser driver for chosen browser. Default is True.

SELENIUM_DRIVER_PATH = 97

Absolute path of Selenium browser driver. Automatically set to WebDriverManager’s downloaded driver if SELENIUM_DRIVER_DOWNLOAD is True, else automatically set as per the test project structure, OS and browser.

SELENIUM_DRIVER_PROP = 95

Selenium Environment variable for browser driver as per chosen browser. Automatically set as per chosen browser. Default is webdriver.chrome.driver

SELENIUM_SERVICE_URL = 99

Selenium’s Service URL. If set, Arjuna does not launch the browser service and uses this URL as the service URL.

SOCKET_TIMEOUT = 59

Timeout for socket connections. Default is 60 seconds.

TEMP_DIR = 38

Temporary directory for this session.

TESTS_DIR = 17

Directory containing test modules.

TOOLS_BMPROXY_DIR = 34

Directory containing BrowerMob Proxy binaries.

TOOLS_DIR = 33

Directory containing external tool binaries in Arjuna test project.

class arjuna.tpi.constant.BrowserName(value)

Bases: enum.Enum

Allowed browser names for Gui Automation.

CHROME = 1

FIREFOX = 2

class arjuna.tpi.constant.DomDirection(value)

Bases: enum.Enum

Directions in DOM movement.

DOWN = 2

LEFT = 3

RIGHT = 4

UP = 1

class arjuna.tpi.constant.DomNodeType(value)

Bases: enum.Enum

Directions in DOM movement.

BNODE = 2

FNODE = 3

NODE = 1

class arjuna.tpi.constant.Locale(value)

Bases: enum.Enum

Allowed locale names in Arjuna.

A3 = 0

A3_AZ = 1

AA_DJ = 2

AA_ER = 3

AA_ET = 4

AF = 5

AF_ZA = 6

AGR_PE = 7

AK_GH = 8

AM = 9

AMERICAN = 11

AM_ET = 10

ANP_IN = 13

AN_ES = 12

AR = 14

ARABIC = 35

AR_AA = 15

AR_AE = 16

AR_BH = 17

AR_DZ = 18

AR_EG = 19

AR_IN = 20

AR_IQ = 21

AR_JO = 22

AR_KW = 23

AR_LB = 24

AR_LY = 25

AR_MA = 26

AR_OM = 27

AR_QA = 28

AR_SA = 29

AR_SD = 30

AR_SS = 31

AR_SY = 32

AR_TN = 33

AR_YE = 34

AS = 36

AST_ES = 38

AS_IN = 37

AYC_PE = 39

AZ = 40

AZ_AZ = 41

AZ_IR = 42

BE = 43

BEM_ZM = 45

BER_DZ = 46

BER_MA = 47

BE_BY = 44

BG = 48

BG_BG = 49

BHO_IN = 50

BHO_NP = 51

BI_VU = 52

BN_BD = 53

BN_IN = 54

BOKMAL = 57

BOKMÅL = 58

BO_CN = 55

BO_IN = 56

BR = 59

BRX_IN = 61

BR_FR = 60

BS = 62

BS_BA = 63

BULGARIAN = 64

BYN_ER = 65

C = 66

CA = 68

CATALAN = 73

CA_AD = 69

CA_ES = 70

CA_FR = 71

CA_IT = 72

CEXTEND = 75

CE_RU = 74

CHR_US = 76

CKB_IQ = 77

CMN_TW = 78

CRH_UA = 79

CROATIAN = 80

CS = 81

CSB_PL = 84

CS_CS = 82

CS_CZ = 83

CV_RU = 85

CY = 86

CY_GB = 87

CZ = 88

CZECH = 90

CZ_CZ = 89

C_C = 67

DA = 91

DANISH = 93

DANSK = 94

DA_DK = 92

DE = 95

DEUTSCH = 102

DE_AT = 96

DE_BE = 97

DE_CH = 98

DE_DE = 99

DE_IT = 100

DE_LU = 101

DOI_IN = 103

DUTCH = 104

DV_MV = 105

DZ_BT = 106

EE = 107

EESTI = 109

EE_EE = 108

EL = 110

EL_CY = 111

EL_GR = 112

EN = 113

ENGLISH = 135

ENGLISH_UK = 136

ENGLISH_US = 137

ENG_GB = 134

EN_AG = 114

EN_AU = 115

EN_BE = 116

EN_BW = 117

EN_CA = 118

EN_DK = 119

EN_GB = 120

EN_HK = 121

EN_IE = 122

EN_IL = 123

EN_IN = 124

EN_NG = 125

EN_NZ = 126

EN_PH = 127

EN_SG = 128

EN_UK = 129

EN_US = 130

EN_ZA = 131

EN_ZM = 132

EN_ZW = 133

EO = 138

EO_EO = 139

EO_XX = 140

ES = 141

ESTONIAN = 163

ES_AR = 142

ES_BO = 143

ES_CL = 144

ES_CO = 145

ES_CR = 146

ES_CU = 147

ES_DO = 148

ES_EC = 149

ES_ES = 150

ES_GT = 151

ES_HN = 152

ES_MX = 153

ES_NI = 154

ES_PA = 155

ES_PE = 156

ES_PR = 157

ES_PY = 158

ES_SV = 159

ES_US = 160

ES_UY = 161

ES_VE = 162

ET = 164

ET_EE = 165

EU = 166

EU_ES = 167

EU_FR = 168

FA = 169

FA_IR = 170

FF_SN = 171

FI = 172

FIL_PH = 174

FINNISH = 175

FI_FI = 173

FO = 176

FO_FO = 177

FR = 178

FRANÇAIS = 184

FRENCH = 186

FRENCH_FRANCE = 187

FRE_FR = 185

FR_BE = 179

FR_CA = 180

FR_CH = 181

FR_FR = 182

FR_LU = 183

FUR_IT = 188

FY_DE = 189

FY_NL = 190

GA = 191

GALEGO = 193

GALICIAN = 194

GA_IE = 192

GD = 195

GD_GB = 196

GERMAN = 198

GERMAN_GERMANY = 199

GER_DE = 197

GEZ_ER = 200

GEZ_ET = 201

GL = 202

GL_ES = 203

GREEK = 204

GU_IN = 205

GV = 206

GV_GB = 207

HAK_TW = 209

HA_NG = 208

HE = 210

HEBREW = 212

HE_IL = 211

HI = 213

HIF_FJ = 215

HI_IN = 214

HNE = 216

HNE_IN = 217

HR = 218

HRVATSKI = 220

HR_HR = 219

HSB_DE = 221

HT_HT = 222

HU = 223

HUNGARIAN = 225

HU_HU = 224

HY_AM = 226

IA = 227

IA_FR = 228

ICELANDIC = 229

ID = 230

ID_ID = 231

IG_NG = 232

IK_CA = 233

IN = 234

IN_ID = 235

IS = 236

ISO_8859_1 = 238

ISO_8859_15 = 239

IS_IS = 237

IT = 240

ITALIAN = 243

IT_CH = 241

IT_IT = 242

IU = 244

IU_CA = 245

IW = 246

IW_IL = 247

JA = 248

JAPAN = 250

JAPANESE = 251

JA_JP = 249

JP_JP = 252

KA = 253

KAB_DZ = 255

KA_GE = 254

KK_KZ = 256

KL = 257

KL_GL = 258

KM_KH = 259

KN = 260

KN_IN = 261

KO = 262

KOK_IN = 264

KOREAN = 265

KO_KR = 263

KS = 266

KS_IN = 267

KU_TR = 268

KW = 269

KW_GB = 270

KY = 271

KY_KG = 272

LB_LU = 273

LG_UG = 274

LIJ_IT = 277

LITHUANIAN = 278

LI_BE = 275

LI_NL = 276

LN_CD = 279

LO = 280

LO_LA = 281

LT = 282

LT_LT = 283

LV = 284

LV_LV = 285

LZH_TW = 286

MAG_IN = 287

MAI = 288

MAI_IN = 289

MAI_NP = 290

MFE_MU = 291

MG_MG = 292

MHR_RU = 293

MI = 294

MIQ_NI = 296

MI_NZ = 295

MJW_IN = 297

MK = 298

MK_MK = 299

ML = 300

ML_IN = 301

MNI_IN = 303

MN_MN = 302

MR = 304

MR_IN = 305

MS = 306

MS_MY = 307

MT = 308

MT_MT = 309

MY_MM = 310

NAN_TW = 311

NB = 312

NB_NO = 313

NDS_DE = 314

NDS_NL = 315

NE_NP = 316

NHN_MX = 317

NIU_NU = 318

NIU_NZ = 319

NL = 320

NL_AW = 321

NL_BE = 322

NL_NL = 323

NN = 324

NN_NO = 325

NO = 326

NORWEGIAN = 328

NO_NO = 327

NR = 329

NR_ZA = 330

NSO = 331

NSO_ZA = 332

NY = 333

NYNORSK = 335

NY_NO = 334

OC = 336

OC_FR = 337

OM_ET = 338

OM_KE = 339

OR = 340

OR_IN = 341

OS_RU = 342

PA = 343

PAP_AN = 346

PAP_AW = 347

PAP_CW = 348

PA_IN = 344

PA_PK = 345

PD = 349

PD_DE = 350

PD_US = 351

PH = 352

PH_PH = 353

PL = 354

PL_PL = 355

POLISH = 356

PORTUGUESE = 357

PORTUGUESE_BRAZIL = 358

POSIX = 359

PP = 360

PP_AN = 361

PS_AF = 362

PT = 363

PT_BR = 364

PT_PT = 365

QUZ_PE = 366

RAJ_IN = 367

RO = 368

ROMANIAN = 370

RO_RO = 369

RU = 371

RUMANIAN = 374

RUSSIAN = 375

RU_RU = 372

RU_UA = 373

RW = 376

RW_RW = 377

SAT_IN = 379

SA_IN = 378

SC_IT = 380

SD = 381

SD_IN = 382

SD_PK = 383

SERBOCROATIAN = 385

SE_NO = 384

SGS_LT = 386

SH = 387

SHN_MM = 391

SHS_CA = 392

SH_HR = 388

SH_SP = 389

SH_YU = 390

SI = 393

SID_ET = 395

SINHALA = 396

SI_LK = 394

SK = 397

SK_SK = 398

SL = 399

SLOVAK = 402

SLOVENE = 403

SLOVENIAN = 404

SL_CS = 400

SL_SI = 401

SM_WS = 405

SO_DJ = 406

SO_ET = 407

SO_KE = 408

SO_SO = 409

SP = 410

SPANISH = 412

SPANISH_SPAIN = 413

SP_YU = 411

SQ = 414

SQ_AL = 415

SQ_MK = 416

SR = 417

SR_CS = 418

SR_ME = 419

SR_RS = 420

SR_SP = 421

SR_YU = 422

SS = 423

SS_ZA = 424

ST = 425

ST_ZA = 426

SV = 427

SV_FI = 428

SV_SE = 429

SWEDISH = 432

SW_KE = 430

SW_TZ = 431

SZL_PL = 433

TA = 434

TA_IN = 435

TA_LK = 436

TE = 437

TE_IN = 438

TG = 439

TG_TJ = 440

TH = 441

THAI = 443

THE_NP = 444

TH_TH = 442

TIG_ER = 447

TI_ER = 445

TI_ET = 446

TK_TM = 448

TL = 449

TL_PH = 450

TN = 451

TN_ZA = 452

TO_TO = 453

TPI_PG = 454

TR = 455

TR_CY = 456

TR_TR = 457

TS = 458

TS_ZA = 459

TT = 460

TT_RU = 461

TURKISH = 462

UG_CN = 463

UK = 464

UK_UA = 465

UNIV = 466

UNIVERSAL = 467

UNM_US = 468

UR = 469

UR_IN = 470

UR_PK = 471

UZ = 472

UZ_UZ = 473

VE = 474

VE_ZA = 475

VI = 476

VI_VN = 477

WA = 478

WAE_CH = 480

WAL_ET = 481

WA_BE = 479

WO_SN = 482

XH = 483

XH_ZA = 484

YI = 485

YI_US = 486

YO_NG = 487

YUE_HK = 488

YUW_PG = 489

ZH = 490

ZH_CN = 491

ZH_HK = 492

ZH_SG = 493

ZH_TW = 494

ZU = 495

ZU_ZA = 496

class arjuna.tpi.constant.TimeUnit(value)

Bases: enum.Enum

Allowed time unit types.

MILLI_SECONDS = 1

MINUTES = 3

SECONDS = 2