Skip to main content

SeeTestAutomation- Updating External Tool Entities - API

info

Please note that this tool is classified as a Legacy tool. We recommend transitioning to our updated solutions to maintain optimal performance and security in your workflows. For more information on this matter, please reach out to technical support .

Updating Entities during test Automation session

During test automation, client code can generate a PDF report and attach it to a certain entity. In order to do that, the client should first perform a setReporter call with "pdf" as reporter argument. Later, the client should call generateReport(boolean ReleaseClient, String ExternalToolPropFilePath) with an absolute path to a java .properties file.

The file can contain the following properties:

info
  • Mandatory property
  • Mandatory if tool.connection.URL property is specified

tool.name 

 -  specifies the tool to use for the operation (for instance: "JIRA" or "ALM").

tool.connection.URL -  specifies the URL of the tool service. If not specified, SeeTest will try to use the tool already defined from UI.

tool.connection.user 

 & tool.connection.pass

 -  specifies the username and password for the connection. Required if tool.connection.url is specified.

operation 

-  specifies the operation to perform with the tool. Each tool can specify a verity of operations.

include.report - use "false" to avoid attaching a report to the entity.

include.devices.screenshot & include.devices.log -  a list of device names to attach logs or screenshot to the entity.

Specific properties for HP ALM​

run.id 

 -  specified the run id number to update.

operation

 -  currently only "update_test_run" is supported.

field.<field_name> - field names can be specified for update. Any field id used in HP ALM REST API can be specified. for instance "field.status=Passed" or "field.comments=Test performed relatively fast".

tool.connection.domain & tool.connection.project** - specifies the used domain and project.

Specific properties for Atlassian JIRA​

operation

 -  currently only "create_issue" is supported.

project

 & issuetype

 -  must be specified.

field.<field_id> - field IDs can be specified for the new issue. Any field id used in Atlassian JIRA REST API can be specified. for instance "field.summary=A minor issue".

field.name.<field_name> - a convenient way to specify field according to their name in JIRA web UI instead of the field ID in REST API. For instance "field.name.Sprint=23". In this example 23 is the ID of the selected sprint.

info
  • If a property represents a list of values, it can be written using JSON String array notation, or be separated by semicolon (with /; as escape string for semicolon). For instance:
  • include.devices.screenshot=adb:Nexus 7;ios_app:IPhone 6+ - A semicolon separated string array.
  • field.fixVersions=['7.3','7.4','8'] - A JSON string array.

Java Example

public class Test {
    private String host = "localhost";
    private int port = 8890;
    protected Client client = null;

    @Before
    public void setUp(){
        client = new Client(host, port, true);
        client.setReporter("pdf", "reports", "jira_test");
    }

    @Test
    public void clickTest(){
        client.setDevice("adb:asus Nexus 7");
        client.sendText("{HOME}");
		client.click("NATIVE", "//*[@text='Applications']", 0, 1);
    }

    @After
	public void tearDown() throws IOException {
	    Properties p = new Properties();
    	p.setProperty("tool.name", "JIRA");
    	p.setProperty("operation", "create_issue");
    	p.setProperty("project", "PRJ");
    	p.setProperty("issuetype", "Improvement");
    	p.setProperty("field.summary", "Testing reporting an issue to JIRA.");
    	p.setProperty("field.description", "A short description.");
    	p.setProperty("field.components", "Automation");
    	p.setProperty("field.versions", "1.1;1.2");
    	p.setProperty("field.fixVersions", "2.0.1");
    	p.setProperty("field.name.Assignee", "George.M");
    	p.setProperty("field.attachment", "['C:/Users/QA/Test.png']");
    	p.setProperty("field.name.Labels", "Experitest");
    	p.setProperty("field.name.Sprint", "47");
    	p.setProperty("tool.connection.url", "http://192.168.6.88:8080/");
    	p.setProperty("tool.connection.user", "QA");
    	p.setProperty("tool.connection.pass", "JohnDoePass");
    	p.setProperty("include.report", "true");
    	p.setProperty("include.devices.screenshot", "adb:asus Nexus 7;adb:samsung SM-G920F");
    	p.setProperty("include.devices.log", "adb:asus Nexus 7");
           
    	File propFlie = File.createTempFile("jira", ".properties");
    	propFlie.deleteOnExit();
    	p.store(new FileOutputStream(propFlie), null);

    	String jiraIssueID = client.generateReport(false, propFlie.getAbsolutePath());
	}
}

Example of a .properties file:​

Its path can be inserted directly to the generateReport command 

properties file Expand source

tool.name=JIRA
tool.connection.url=your_jira_domain
tool.connection.user=some_user
tool.connection.pass=some_pass
operation=create_issue
project=your_project
issuetype=Bug
field.summary=Testing reporting an issue to JIRA.
field.name.Description=A short description.
field.components=your_components
field.name.fixVersions=number_of_version
field.versions=number_of_version
field.name.Assignee=your_assignee

How to find the available issue types in JIRA:​

Navigate to the following URL (possibly from your browser) to get the project and issue type data:

<JIRA_SERVER>/rest/api/2/issue/createmeta

info
Request:​

http://kelpie9:8081/rest/api/2/issue/createmeta

Response:​

 Expand source

{
    "expand": "projects",
    "projects": [
        {
            "self": "http://kelpie9:8081/rest/api/2/project/XSS",
            "id": "10020",
            "key": "XSS",
            "name": "<iframe src=\"http://www.google.com\"></iframe>",
            "avatarUrls": {
                "16x16": "http://kelpie9:8081/secure/projectavatar?size=small&pid=10020&avatarId=10011",
                "48x48": "http://kelpie9:8081/secure/projectavatar?pid=10020&avatarId=10011"
            },
            "issuetypes": [
                {
                    "self": "http://kelpie9:8081/rest/api/2/issuetype/1",
                    "id": 1,
                    "name": "Bug",
                    "iconUrl": "http://kelpie9:8081/images/icons/bug.gif"
                },
                {
                    "self": "http://kelpie9:8081/rest/api/2/issuetype/2",
                    "id": 2,
                    "name": "New Feature",
                    "iconUrl": "http://kelpie9:8081/images/icons/newfeature.gif"
                },
.
.
.                {
                    "self": "http://kelpie9:8081/rest/api/2/issuetype/5",
                    "id": 5,
                    "name": "Sub-task",
                    "iconUrl": "http://kelpie9:8081/images/icons/issue_subtask.gif"
                }
            ]
        },
        {
            "self": "http://kelpie9:8081/rest/api/2/project/BULK",
            "id": "10000",
            "key": "BULK",
            "name": "Bulk Move 1",
            "avatarUrls": {
                "16x16": "http://kelpie9:8081/secure/projectavatar?size=small&pid=10000&avatarId=10020",
                "48x48": "http://kelpie9:8081/secure/projectavatar?pid=10000&avatarId=10020"
            },
            "issuetypes": [
                {
                    "self": "http://kelpie9:8081/rest/api/2/issuetype/1",
                    "id": 1,
                    "name": "Bug",
                    "iconUrl": "http://kelpie9:8081/images/icons/bug.gif"
                },
.
.
.
                {
                    "self": "http://kelpie9:8081/rest/api/2/issuetype/5",
                    "id": 5,
                    "name": "Sub-task",
                    "iconUrl": "http://kelpie9:8081/images/icons/issue_subtask.gif"
                }
            ]
        },
        {
            "self": "http://kelpie9:8081/rest/api/2/project/BLUK",
            "id": "10001",
            "key": "BLUK",
            "name": "Bulk Move 2",
            "avatarUrls": {
.
.
.
.
        }
    ]
}
Last updated on