GitLocker: The Coding Marketplace

Description:

nrobo 2024.43.0

nRoBo (An Automated Testing Framework )
For Web Developers, QAs and Testers

Project Status
Active

Online Tutorials
VISIT and SUBSCRIBE to nRoBo YouTube Channel

Pre-requisites
Following pre-requisites needs to be installed in order to run *nRoBo* framework.

Install Python (3.11 or higher)

Check install guide for Python

Notes on Python Installation on Windows:

Go to “Control Panel > Add Or Remove Programs” and make sure that there are not multiple versions of Python are installed.
While installing Python, make sure following options to check as mentioned in the screenshots:

python --version
# or
python --version

Install Java (11 or higher)

Check install guide for Java
Run the following command to check if java is installed

java --version

Install allure command line tool.

Check Install guide
Run the following command to check if allure cli is installed

allure --version

Install Target Browsers on testing systems

Chrome
Edge
IE
Safari
Firefox

Installation
On Windows machine, Run Command Prompt and/or Python IDE of your choice should be run in Administrator mode and execute the following commands.
(To run in administrator mode, Right click on the tool and select ‘Run As Administrator’ option)

Make a directory for automation project

mkdir <project-name>

Example:
If you want to develop autotests for the project, Dream.
You can create directory and change directory to dream as following:

mkdir dream
cd dream

Install virtualenv package

pip install virtualenv

Create virtual environment - .venv

virtualenv .venv

Activate virtual environment

Unix/Mac/Linux

source .venv/bin/activate

Windows

.\\.venv\\Scripts\\activate

Install nrobo

pip install nrobo --require-virtualenv

Install & run framework in single command

nrobo --instances 10

Note
If there are any errors, run the upgrade command, pip install –upgrade nrobo

Run tests

Minimal switches

nrobo --browser chrome_headless --report allure

Typical usage

nrobo --app <app-name> --url <test-url> --username <username> --password <password> --instances <number-of-parallel-tests> --reruns <number-of-retries-to-rerun-failed-tests> --browser chrome_headless --report allure

Example:

nrobo --app Lotus --url https://www.google.com --username shiv --password tandav --instances 10 --reruns 2 --browser chrome_headless --report allure

Above command instructs nrobo to do the following actions:

Launch the tests of Lotus application from the default test directory, <project-root-dir>, and its subdirectories and generate both, html (plain) and allure (rich) reports for displaying test results with following additional test parameters:

Test url (–url switch)
Credential: (username, password)=(shiv, tandav)
Run bunch of 10 tests at once (–instances switch)
Rerun addition 2 times the tests which got failed (–reruns switch)
Target browser = Headless Chrome (–browser switch)

Notes for running -b=anti_bot_chrome:

When running from a datacenter (even smaller ones), chances are large you will not pass! Also, if your ip reputation at home is low, you won’t pass!
anti_bot_chrome will not work with –grid switch!

Command Line Switches
This section enlists list of nRoBo-command-line-switches (nCLI) that it supports.
nCLI shadows every PyTest-command-line-switches (PyTestCLI) for backward compatibility with pytest.

Thus, nCLI switches are being categorized into three types:

Pure-nCLI-switches

Only nCLI specific switches. Non-PyTest CLI switches.

nCLI shadowing switches

These are PyTest switches overriden by nCLI with a new long or short name. These are at core, pure PyTest switches.

Pure-PyTest-CLI-switches

As the name suggests, it is self explanatory that these switches are pure PyTest switches and maintained by them.

Below is a list of switches including all the three types categorically.

Pure nCLI Switches

-i, --install
Install nRoBo requirements and framework on host system

--app
Name of application under test.
Name should not include special chars and it should only having alphanumeric values.

--url
Application url under test.

--username
Username for login.

--password
Password for login.

-n, --instances
Number of parallel tests to reduce test-run-time.
Default value is 1. Meaning single test at a time in sequence.

--report
Defines type of test report. Two types are supported, Simple HTML or Rich Allure report.
Options are <html> or <allure>. Default is <html>

-b, --browser
Target browser. Default is chrome.
Following is a list of browser options support in nRoBo.
chrome, chrome_headless, anti_bot_chrome, edge, edge_headless,
safari, firefox, firefox_headless, ie

--browser-config
Path of browser-config-file containing additional options that is/are needed to be applied
before browser instantiation. Each line in file should contain one option only.
For example: You want to apply, –start-maximized, chrome switch for chrome browser.
and if the browser-config-file is names as ‘chrome_config.txt’, then
the content of file would be as following:

–start-maximized

There will be no conversion taking place by nRoBo!
The browser switches will be applied to the browser instance.

--grid
Remote Grid server url.
Tests will be running on the machine when Grid server is running pointed by Grid url.

nCLI Shadowing Switches

-k, --key
Only run tests that match the given substring
expression. An expression is a python resolvable
expression where all names are substring-matched
against test names and their parent classes.

Example:
-k ‘test_method or test_other’ matches all test.yaml functions and
classes whose name contains ‘test_method’ or ‘test_other’,
while -k ‘not test_method’ matches those
that don’t contain ‘test_method’ in their names. -k ‘not test_method
and not test_other’ will eliminate the matches.
Additionally keywords are matched to classes
and functions containing extra names in their ‘extra_keyword_matches’ set,
as well as functions which have names assigned directly to them.
The matching is case-insensitive.

Note: –key switch is shadowing -k switch of PyTest for the sake of readability.

-m, --marker
Only run tests matching given mark expression.
For example:
-m ‘mark1 and not mark2’

Pure PyTest CLI Switches

--reruns
Retries to rerun the failed tests n times specified by –reruns switch.

--reruns-delay
Delay time in second(s) before a rerun for a failed test. Default is 1 second.

--markers
Show markers (builtin, plugin and per-project ones).

--junit-xml
–junit-xml=path. create junit-xml style report file at given path.

--rootdir
–rootdir=ROOTDIR. Define root directory for tests.
Can be relative path: ‘root_dir’, ‘./root_dir’,’root_dir/another_dir/’; absolute path:’/home/user/root_dir’; path with variables: ‘$HOME/root_dir’.

--co, --collect-only
only collect tests, don’t execute them.

Note:

Full list of PyTest switches are enlisted and explained at the following web address: Pure PyTest CLI Switches
Full list of all switches can be seen by running the following nrobo cli:

nrobo -h
#or
nrobo --help

nRoBo shadows all the PyTest switches, so no need to worry about. We can use each of them within the nRoBo framework. Isn’t it great!

Personalization

Note
This section will be updated soon!

Reports
Support for two kinds of test reports:

Lightweight HTML Report (Best for sharing test results)

Go to <results> dir and Double click on <report.html> file to view the simple html report.

Rich Allure Pytest Report (Best for visualization)

Make sure *allure-pytest command line tool is installed!*

To check, run the command:

allure --version

If not installed, please go through Pre-requisites section above.

Run the following command:

allure serve results/allure

Videos

Note
This section will be updated soon!

Features

@ @

Easy and standard install - By nRoBo
Easy to learn and use - By nRoBo
Simple and Well Defined Automation Directory Structure - By nRoBo
Report Customization - By nRoBo
Rich Command Line Support that helps integration with CI/CD pipeline or any DevOps tech. - By nRoBo
Shipped with rich set of examples along with install. Thus, speedup learning. - By nRoBo
VISIT and SUBSCRIBE to Dedicated nRoBo YouTube channel with a collection of video tutorials. Thus, speedup learning. - By nRoBo
Ready to use framework loaded with power of PyTest, Selenium Webdriver 4, HTML Report, Rich Allure Report and other tools. By nRoBo
Ability to organize tests in Groups. Inbuilt groups are sanity, ui, regression, nogui, api at present. - By PyTest and nRoBo
Rich Browser Support (Chrome, Headless Chrome, Anti Bot Chrome, Edge, Safari, Firefox, FireFox Headless, IE) - By SeleniumWebdriver
Rich Platform Support (Unix, Linux, Mac, Windows) - By PyTest, SeleniumWebdriver and nRoBo
nRoBo selenium wrapper classes and methods that saves lot of key presses. Thus, leveraging benefits of compact, readable and manageable of code. - By nRoBo
Well-structured thread-safe inbuilt setup and tear down processes. Thus, You can keep focus on testing! Not on maintaining framework. - By nRoBo
Test Parallelization - Inherited from PyTest
Distributed testing over Grid infrastructure - Inherited from SeleniumWebdriver
Test parameterization - Inherited from PyTest
Screenshot-capture at the end of each test - Inherited from SeleniumWebdriver
Capture webdriver logs, console logs and screenshots in reports - Inherited from PyTest
Inbuilt integration with NxGen Rich Allure Report (Backed by Allure Reports and pytest-html-reports)

Download Statistics

Country
Percent
Download Count

US
40.20%
27,877

CN
12.19%
8,454

DE
7.10%
4,925

SG
5.05%
3,505

RU
4.92%
3,410

HK
4.38%
3,040

JP
3.03%
2,102

FR
3.02%
2,091

KR
2.73%
1,895

CA
2.35%
1,627

NO
2.10%
1,457

GB
1.67%
1,161

AU
1.57%
1,086

IN
1.52%
1,055

SE
1.38%
954

TH
0.70%
482

HR
0.69%
476

DK
0.64%
443

IE
0.60%
414

NL
0.59%
411

ES
0.55%
380

TW
0.52%
363

IL
0.49%
341

CH
0.38%
265

ZA
0.37%
255

AE
0.30%
209

CZ
0.21%
144

FI
0.16%
113

BR
0.11%
78

PL
0.09%
61

TR
0.07%
46

CW
0.06%
44

IS
0.06%
42

OM
0.06%
42

RO
0.03%
24

GF
0.02%
16

BE
0.02%
14

UA
0.01%
8

CY
0.01%
8

CL
0.01%
6

DZ
0.01%
4

BG
0.01%
4

EE
0.00%
3

AR
0.00%
3

SK
0.00%
2

MX
0.00%
1

PT
0.00%
1

VN
0.00%
1

SI
0.00%
1

RS
0.00%
1

Total
100.00%
69,345