Version 0.1.1
A parallel executor for Robot Framework tests destined to Android devices. With APTR you can run tests on multiple devices in parallel and get report/log/screenshots correctly.
When I discovered Pabot I was very excited. But there were problems when I tried to run my android device tests simultaneously. Sometimes appium sessions were override, or reports were not created correctly. APTR is a tool that I did to simplify at maximum the parallel execution of android tests. It uses a custom pabot version to get screenshots in reports.
Click to watch.
You can get the compiled jar from release :
Or build you own jar from the project
cd /path/to/git/clone
mvn clean compile assembly:single
Then you can find the .jar into the target directory.
APTR need a custom pabot version to run correctly. So at startup APTR will looks for a folder called "pabot" which should contains pabot.py, pabotlib.py, ... "By chance" APTR do it automatically by cloning my custom pabot repository. If the repo is already cloned, you can still force cloning again (upgrade) by using --forceupdate argument.
APTR needs some files and folder to run, please consider create them in your project to begin. Create a "runner" directory into your workspace and follow this graph.
WORKSPACE_DIR
├── TestFileSuite1.robot
├── TestFileSuite2.robot
├── ....................
├── runner
│ ├── devices_conf
│ │ ├── device1.dat
│ │ ├── .........
│ │ └── nexus.dat
│ └── output
Note : the output dir is cleaned automatically when you run another test suite.
All files into devices_conf directory are variable files passed to pabot. APTR uses --argumentfileX from pabot to run tests.
So they must contain some information about devices. Minimum requirement are simple. See the example file bellow :
device1.dat
--variable udid:3bc45f49 (necessary)
--variable name:Device1_s6 (necessary)
--variable appium:4470 (necessary => indicate on which port appium server will run for this device [localhost:PORT])
--variable appiumbp:9055 (necessary => indication bootstrap port for appium)
Theses 4 variables have to be defined in .dat files.
If you need to pass other arguments to pabot/pybot, you can specify them in the .dat file.
Here you can see all possibilities.
Notice that all these variables are accessible from test suites (${udid}, ${appium}, ...)
APTR has been created to simplify at maximum the parallelization.
--directory (-d)
Specify the workspace directory (which contains .robot files and runner directory)
--file (-f)
Specify one or multiple files, you need to be on workspace before running -f (use cd)
--testname (-t)
Specify a general test name. It will be displayed into the final report/log
--forceupdate (-force)
Force pabot update by deleting current directory, and cloning again from git. By default APTR uses a custom pabot version directly from a pabot directory, at same location of .jar.
--jenkins (-j)
If you want to run test on jenkins you should indicate it. The output is formated specially for jenkins or for local execution. Please refer to jenkins section for more information.
--verbose (-v)
Specify if you want to see processes output and add some verbose output.
Once you download the jar (or compile yourself it),
Example usages (consider change "-x" with your version, so APTR-0.1.1.jar for exemple):
Run only one test
user$ cd /path/to/robot/workspace/ # please go to your robot workspace before using -f arg
user$ java -jar APTR-x.jar --file Test_Suite.robot
Run multiple test files
user$ cd /path/to/robot/workspace/ # please go to your robot workspace before using -f arg
user$ java -jar APTR-x.jar -f Test_Suite.robot Test_Suite_Forever.robot JCV.robot
Run all tests from a directory (workspace) and choose a test name
user$ java -jar APTR-x.jar -d /path/to/robot/workspace -t MyBigTest
Run all tests from a directory (workspace) and ensuring to have last custom pabot version and add verbose output
user$ java -jar APTR-x.jar -d /path/to/robot/workspace --forceupdate -v
Considering a workspace like this
Android
├── TestFileSuite1.robot
├── TestFileSuite2.robot
├── ....................
├── runner
│ ├── devices_conf
│ │ ├── device1.dat
│ │ ├── .........
│ │ └── nexus.dat
│ └── output
You have to configure jenkins like this :
There are several ways you can help in improving this tool:
- Report an issue or an improvement idea to the issue tracker
- Contribute by submitting improvements.