This document describes Q7 Runner of version 1.3.x. If you are using older version, please refer to Q7 Runner 1.2.x.
Q7 Runner is headless cross-platform eclipse application. Just download it from http://q7.xored.com/download and unpack anywhere.
Usage and command-line options
The base command line for Q7 runner looks like this:
Basic command-line options
The table below summarizes information about arguments, arguments are more or less sorted by decreasing importance
|clientId||Account or organization name at http://q7.xored.com.||myusername||Yes||1.3|
Randomly generated secret string from http://q7.xored.com/settings/balance
|organization||Optional organization name to charge execution from. A specified clientId must be a member of given organization||xored||No||1.3.5|
|licenseUrl||Local Q7 license server address for Q7 Enterprise users. Either clientId/clientSecret (for OnDemand users) or licenseUrl must be set||http://localhost:8080||Yes||1.3.3|
Platform-specific path to application under test
Semicolon-separated list of project folders with Q7 tests or resources to link. Q7 Runner will perform a recursive search of Q7 projects in each of given folders.
File prefix for application-under-test's workspace. The workspace prefix given will be suffixed with incrementing restart index to make sure
File path to save JUnit report with test exec results
File path to save HTML report with test exec results
File prefix for application-under-test process output. It will be appended with incrementing restart index for the same reason as
Semicolon-separated list of Q7 Runtime options (see description below)
List of arguments for application-under-test separated by semicolon.
List of arguments for application-under-test's JVM separated by semicolon.
|suites||List of Test suite names separated by semicolon. If this argument is set, Q7 runner executes only test cases from given suites (otherwise it executes all tests from given projects).||WindowsOnlyTests||No||1.2.0|
|Semicolon-separated list of tags. Test cases containing any of listed tags are not be executed. The default value is 'skipExecution'.||skipExecution||No||1.1|
Java VM to use with application-under-test. By default it is set to the same Java VM which is used for Q7 Runner launching
Overall execution timeout in seconds, default value is 18000 (5 hours)
application-under-test connection timeout in seconds, default value is 300 (5 mins). Very unlikely requires to be increased
|report||Generate report with custom reporting renderer. "id;path" format should be used to specify report renderer id and path to export.||No||1.2.1|
|noSecurityOverride||If specified, -eclipse.keyring parameter will not be specified. Also -testOptions could contain "overrideSecurityStorage=false" for same effect.||No||1.2.1|
|memoryUsage||If specified, AUT's memory usage information will be printed to the console.||No||1.3.5|
|tests||Semicolon-separated list of test name glob patterns (* - any chars, ? - exactly one char). If this argument is set Q7 runner executes listed test cases only.|
-tests myTest.test or -test myTest*
Injection mechanism allows to install some extra features into application-under-test before test execution. This might be useful in two cases:
- The project being tested is distributed via update site, so there's no default all-in-one application-under-test. In this case Eclipse SDK (or other eclipse package) can be used as application-under-test and plugins being tested will be installed into it.
- (rarely) Application-under-test contains some extra plugins which are required for testing, but not needed in product for end user
Injecting from Update Site
This option is similar to installing something into Eclipse application via UI – by specifying update site URL and list of features to be installed.
In command line it is specified as argument with name
injection.site where value is update site URL optionally followed by list of features separated by semicolon. If list of features is omitted, then all features from given site will be installed
It is possible to specify this argument several times to inject features from more than one update site. Note that Q7 does not resolve dependencies automatically, therefore all dependencies of features to install are required to be either explicitly specified, or presented in AUT.
Injection from directory
This way is similar to dropping some plugins into
It is possible to specify this argument several times to inject plugins from more than one directory
Q7 Runtime options
This table summarizes Q7 runtime options which are rarely need to be modified and can be specified in
testOptions argument. In Q7 IDE these options can be set by going to Preferences -> Q7 -> Advanced Options.
|passedTestDetails||false||When true, include output of 'take-screenshot' and 'trace' commands into a report|
|testExecTimeout||300||Timeout for a single test execution in seconds|
Context applying timeout.
If there are any jobs started after context applying, wait for their completion during this time (in milliseconds).
Timeout in milliseconds for jobs scheduled from eclipse Debug plugin.
If job reschedules itself more than times specified by this parameter, Q7 stops setting delay to 0 (see jobScheduleDelayedMaxtime parameter).
When job is in sleeping mode (see jobTreatAsSleeingTimeout option), execute commands with given delay (in milliseconds) between commands.
Wait timeout in milliseconds for stepping jobs (see jobTreatAsSleepingTimeout and jobSleepingStepTime)
If job executes more than this time (in milliseconds) and sleeps (i.e. executing Thread.sleep() or Object.wait()), then Q7 considers that this job is waiting for some user actions and continues to the next command.
Whether to capture screenshot from AUT on every ECL command
If Display.timerExec is scheduled for the delay less than this value (in milliseconds), set delay to 0.
How many seconds Q7 should wait for application startup.
Job hang skip timeout in milliseconds. If job is running longer than this time, Q7 Runtime considers that it is hung and moves to the next command.
Max job scheduled delay to be waited for in milliseconds. If job is scheduled with delay less than this value, Q7 sets delay to 0 and waits for job completion (also see jobNullifyRescheduleMaxValue). Otherwise Q7 Runtime does not wait for job completion if it is scheduled with a delay greater than this value.
Kill AUT on connect error. Whether Q7 should kill application-under-test if it cannot connect to it.
Wait for a given milliseconds between each ECL command. This can be useful when things go wrong at some point and it is hard to determine when by looking at execution. Setting this value to, say, 500, allows to inspect Q7 actions in more details.
Forces garbage collection on workspace cleanup.
Use following EMF features for part identity
Non EMF object identity method
EMF object identity by 'name feature' support
Use text content for part identity
These options can be set in command line like this:
When Q7 runner executed on a machine behind a proxy server, it is possible to specify proxy settings via Java's system properties (see http://docs.oracle.com/javase/6/docs/technotes/guides/net/proxies.html):
Sample Windows launch script
A script like this can be used as a starting point for creating a cmd-script for launching Q7 runner on Windows
Sample Mac OS X/linux command
Below is a typical command line for executing a single project with Q7 tests with saving JUnit and HTML reports. We assume the following:
- Q7 Runner is downloaded and unpacked into
- Application-under-test is downloaded and unpacked into
- Q7 Project with tests is stored in
Note that on Windows the caret symbol (
^) should be used instead of backslash for line continuation