eggPlant Integration V1

This feature is available in qTest Elite and Enterprise packages. We provide a command line tool which is capable of kicking off eggPlant scripts which reside on your local machine and reporting test results in JUnit-compatible format back to qTest. Automation Test Cases and Test Runs are automatically created in qTest so you will not need to manually do it.

In order to setup the integration, please follow the steps below:

  1. Enable Automation Integration settings for your qTest project
  2. Download our eggPlant Connector command line tool and set it up on the same machine where your eggPlant tests are executed

  IMPORTANT:

  • eggPlant Functional and the eggPlant Connector need to be installed on the same machine, in order for the eggPlant Connector to kick off eggPlant scripts
  • The integration tool works with eggPlant Functional v16.01
  • The tool works best on a Windows machine
  • JDK 7+ is required to be installed on your machine

See our instructions below:

»Enabling Automation Integration feature in qTest

»Configuring eggPlant Connector tool

»Executing eggPlant Connector tool

Enabling Automation Integration feature in qTest

In order to receive test results submitted by eggPlant Connector, you will need to activate the Automation Integration feature in your qTest project.

  1. Access your qTest project, then click on the Gear icon and select Automation Settings
  2. Switch on the Activation Status
  3. Map automation execution results with corresponding qTest values. The eggPlant Connector collects test results which have been converted to JUnit-compatible format. Execution results in JUnit format include:
    • Successs
    • Failure
    • Running
  4. Click on the Save button

qTest - Automation Settings - Automation Integration

Configuring eggPlant Connector tool

A. Download eggPlant Connector

  1. Download eggPlant Connector zip file from the qTest Resources page
    qTest - Resources - Download eggPlant
  2. Extract the download package and access the extracted directory:
    eggPlant Connector Folder Structure

B. Configure eggPlant Connector

In the extracted directory above, you can find the config.properties file, which stores all available configurations. You will need to modify the keys in the file as described in the table below.

KeyRequiredDescription
qtest.url Yes The URL to access your qTest instance
qtest.tokenstring Yes The token to login to your qTest instance. You can get the token from the qTest Resources page
qTest - Resources - eggPlant Token
qtest.project.id Yes ID of the qTest project to which you want to report test execution results to. You can get the project ID from its URL or on the Site Administration Projects page:
qTest - Project ID
qtest.testsuite No

When test results are submitted to qTest, Test Runs are automatically created in qTest if they do not already exist.

You can specify a qTest Test Suite where the submitted Test Runs will be located using its ID or PID.

If it is omitted, one Test Suite is created per execution date to contain the Test Runs. If eggPlant tests are executed multiple times in one day, all Test Runs are located in the same Test Suite of that day. The Test Suite is named as eggPlant yyyy-mm-dd, in which yyyy-mm-dd is the execution date, and it is located under the Test Execution tree's root.

rundate No

Specify an execution date in yyyy-mm-dd which will be used in the default Test Suite name.

If it is omitted, qTest will use the test log submitted date to create the Test Suite.

qtest.parent.module No

When test results are submitted to qTest, Test Cases are automatically created in qTest if they do not already exist.

All eggPlant Test Cases are located under the module eggPlant Automation located under the Test Design tree's root.

If you specify a parent module using its PID or ID, the eggPlant Automation module will be created under the parent module.

eggplant.results.directory Yes Directories in which test results are located. You can specify multiple directories, separated by | character. Use / in the directory paths

You can use wildcards to specify result directories as below:

  • ? matches one character
  • * matches zero or more characters
  • ** matches zero or more 'directories' in a path
eggplant.command No

You can specify an eggPlant command line to kick off eggPlant scripts before collecting the test logs.

If only collect the existing test logs and submit them to qTest, please leave this key empty

eachMethodAsTestCase No

If it is Yes, each <testcase> tags in JUnit XML test logs is created as one Test Case in qTest

submit.latest No If this is yes, only the latest test logs are submitted. Otherwise, all existing test logs which have not been reported to qTest will be submitted.
submit.automatedstepresults No By default the key’s value is yes
  • If its value is yes, results of each test step are submitted to qTest Manager
  • If its value is no, automated test step logs are omitted. Only the result of the overall test run’s log are submitted to qTest Manager. However, associated Test Cases’ steps are not overwritten

  IMPORTANT:

  • eggPlant Connector only collects test logs in the Result directory which is located under the test suite directory. In a future release, you will be able to specify your custom test log directories
    eggPlant - Results dir

 

Executing eggPlant Connector tool

After you have completed modifying the config.properties file, you are ready to execute the tool.

  1. Open the console and access the extracted folder of the downloaded package. Execute this command:
    java -jar eggplant-connector-1.0.0.jar
    		
  2. Submission progress is logged in the console so you can monitor it
    eggPlant - Console
  3. After the submission is completed, you can access your qTest project to verify if Test Cases and Test Runs have been created

  NOTE:

  • Run this command to view available arguments of the eggPlant Connector
    java -jar eggplant-connector-1.0.0.jar --help
    		
  • Instead of using the default config.properties files, you can specify another file which contains the configurations by using argument -conf or --configFile
  • Configurations can be defined in either the configuration file or via command line arguments. If the same configuration is defined in both places, the eggPlant Connector will use the configuration in the command line arguments
  • eggPlant Connector creates qtest.info file in the eggPlant Results directory. Please do not remove it, or duplicate test logs will be created in qTest
    eggPlant - qtest.info
  • Known Issue: Test Cases created in qTest will only have one Test Step