br.eti.kinoshita.testlinkjavaapi.TestCaseService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of testlink-java-api Show documentation
Show all versions of testlink-java-api Show documentation
TestLink Java API to interface with TestLink PHP XML-RPC API.
The newest version!
/*
* The MIT License
*
* Copyright (c) 2010 Bruno P. Kinoshita http://www.kinoshita.eti.br
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package br.eti.kinoshita.testlinkjavaapi;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.stream.Collectors;
import java.util.Set;
import org.apache.xmlrpc.XmlRpcException;
import org.apache.xmlrpc.client.XmlRpcClient;
import br.eti.kinoshita.testlinkjavaapi.constants.ActionOnDuplicate;
import br.eti.kinoshita.testlinkjavaapi.constants.ExecutionStatus;
import br.eti.kinoshita.testlinkjavaapi.constants.ExecutionType;
import br.eti.kinoshita.testlinkjavaapi.constants.ResponseDetails;
import br.eti.kinoshita.testlinkjavaapi.constants.TestCaseDetails;
import br.eti.kinoshita.testlinkjavaapi.constants.TestCaseStatus;
import br.eti.kinoshita.testlinkjavaapi.constants.TestCaseStepAction;
import br.eti.kinoshita.testlinkjavaapi.constants.TestImportance;
import br.eti.kinoshita.testlinkjavaapi.constants.TestLinkMethods;
import br.eti.kinoshita.testlinkjavaapi.constants.TestLinkParams;
import br.eti.kinoshita.testlinkjavaapi.constants.TestLinkResponseParams;
import br.eti.kinoshita.testlinkjavaapi.constants.TestLinkTables;
import br.eti.kinoshita.testlinkjavaapi.model.Attachment;
import br.eti.kinoshita.testlinkjavaapi.model.CustomField;
import br.eti.kinoshita.testlinkjavaapi.model.ReportTCResultResponse;
import br.eti.kinoshita.testlinkjavaapi.model.TestCase;
import br.eti.kinoshita.testlinkjavaapi.model.TestCaseStep;
import br.eti.kinoshita.testlinkjavaapi.model.TestCaseStepResult;
import br.eti.kinoshita.testlinkjavaapi.util.TestLinkAPIException;
import br.eti.kinoshita.testlinkjavaapi.util.Util;
/**
* Class responsible for Test Case services.
*
* @author Bruno P. Kinoshita - http://www.kinoshita.eti.br
* @since 1.9.0-1
*/
@SuppressWarnings("unchecked")
class TestCaseService extends BaseService {
/**
* @param xmlRpcClient XML RPC Client.
* @param devKey TestLink User DevKey.
*/
TestCaseService(XmlRpcClient xmlRpcClient, String devKey) {
super(xmlRpcClient, devKey);
}
/**
* Creates a Test Case.
*
* @param testCaseName
* @param testSuiteId
* @param testProjectId
* @param authorLogin
* @param summary
* @param steps
* @param preconditions
* @param status
* @param importance
* @param execution
* @param order
* @param internalId
* @param checkDuplicatedName
* @param actionOnDuplicatedName
* @return Test Case.
* @throws TestLinkAPIException
*/
protected TestCase createTestCase(String testCaseName, Integer testSuiteId, Integer testProjectId,
String authorLogin, String summary, List steps, String preconditions, TestCaseStatus status,
TestImportance importance, ExecutionType execution, Integer order, Integer internalId,
Boolean checkDuplicatedName, ActionOnDuplicate actionOnDuplicatedName) throws TestLinkAPIException {
TestCase testCase;
Integer id = null;
testCase = new TestCase(id, testCaseName, testSuiteId, testProjectId, authorLogin, summary, steps,
preconditions, status, importance, execution, null, order, internalId, null, null, checkDuplicatedName,
actionOnDuplicatedName, null, null, null, null, null, null, null);
try {
Map executionData = Util.getTestCaseMap(testCase);
Object response = this.executeXmlRpcCall(TestLinkMethods.CREATE_TEST_CASE.toString(), executionData);
Object[] responseArray = Util.castToArray(response);
Map responseMap = (Map) responseArray[0];
Integer version = (Integer) ((HashMap) responseMap.get("additionalInfo"))
.get("version_number");
id = Util.getInteger(responseMap, TestLinkResponseParams.ID.toString());
testCase.setId(id);
testCase.setVersion(version);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error creating test plan: " + xmlrpcex.getMessage(), xmlrpcex);
}
return testCase;
}
protected Map updateTestCase(TestCase tc) throws TestLinkAPIException {
try {
Map responseMap = null;
Map executionData = Util.getTestCaseMap(tc);
Object response = this.executeXmlRpcCall(TestLinkMethods.UPDATE_TEST_CASE.toString(), executionData);
if (response instanceof Object[]) {
Object[] arr = (Object[]) response;
if (arr.length > 0 && arr[0] instanceof Map) {
responseMap = (Map) arr[0];
}
} else {
responseMap = (Map) response;
}
return responseMap;
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error updating test case: " + xmlrpcex.getMessage(), xmlrpcex);
}
}
protected Map createTestCaseSteps(Integer testCaseId, String testCaseExternalId, Integer version,
TestCaseStepAction action, List testCaseSteps) throws TestLinkAPIException {
Map responseMap = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), version);
executionData.put(TestLinkParams.ACTION.toString(), action.toString());
List> steps = Util.getTestCaseStepsMap(testCaseSteps);
executionData.put(TestLinkParams.STEPS.toString(), steps);
Object response = this.executeXmlRpcCall(TestLinkMethods.CREATE_TEST_CASE_STEPS.toString(), executionData);
if (response instanceof Object[]) {
Object[] arr = (Object[]) response;
if (arr.length > 0 && arr[0] instanceof Map) {
responseMap = (Map) arr[0];
}
} else {
responseMap = (Map) response;
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error adding steps to test case: " + xmlrpcex.getMessage(), xmlrpcex);
}
return responseMap;
}
protected Map deleteTestCaseSteps(String testCaseExternalId, Integer version,
List testCaseSteps) throws TestLinkAPIException {
Map responseMap;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), version);
List steps = Util.getTestCaseStepsIdList(testCaseSteps);
executionData.put(TestLinkParams.STEPS.toString(), steps);
Object response = this.executeXmlRpcCall(TestLinkMethods.DELETE_TEST_CASE_STEPS.toString(), executionData);
responseMap = (Map) response;
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error deleting steps from test case: " + xmlrpcex.getMessage(), xmlrpcex);
}
return responseMap;
}
protected Integer addTestCaseToTestPlan(Integer testProjectId, Integer testPlanId, Integer testCaseId,
Integer version, Integer platformId, Integer order, Integer urgency) throws TestLinkAPIException {
Integer featureId;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.VERSION.toString(), version);
executionData.put(TestLinkParams.PLATFORM_ID.toString(), platformId);
executionData.put(TestLinkParams.ORDER.toString(), order);
executionData.put(TestLinkParams.URGENCY.toString(), urgency);
Object response = this.executeXmlRpcCall(TestLinkMethods.ADD_TEST_CASE_TO_TEST_PLAN.toString(),
executionData);
Map responseMap = Util.castToMap(response);
featureId = Util.getInteger(responseMap, TestLinkResponseParams.FEATURE_ID.toString());
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error adding test case to test plan: " + xmlrpcex.getMessage(), xmlrpcex);
}
return featureId;
}
/**
* @param testSuiteId
* @param deep
* @return
*/
protected TestCase[] getTestCasesForTestSuite(Integer testSuiteId, Boolean deep, TestCaseDetails detail)
throws TestLinkAPIException {
TestCase[] testCases;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_SUITE_ID.toString(), testSuiteId);
executionData.put(TestLinkParams.DEEP.toString(), deep);
executionData.put(TestLinkParams.DETAILS.toString(), Util.getStringValueOrNull(detail));
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASES_FOR_TEST_SUITE.toString(),
executionData);
Object[] responseArray = Util.castToArray(response);
testCases = new TestCase[responseArray.length];
for (int i = 0; i < responseArray.length; i++) {
Map responseMap = (Map) responseArray[i];
testCases[i] = Util.getTestCase(responseMap);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test cases for test suite: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return testCases;
}
/**
* @param testPlanId
* @param testCasesIds
* @param buildId
* @param keywordsIds
* @param keywords
* @param executed
* @param assignedTo
* @param executeStatus
* @param executionType
* @param getStepInfo
* @return
* @throws TestLinkAPIException
*/
protected TestCase[] getTestCasesForTestPlan(Integer testPlanId, List testCasesIds, Integer buildId,
List keywordsIds, String keywords, Boolean executed, List assignedTo,
String[] executeStatus, ExecutionType executionType, Boolean getStepInfo, TestCaseDetails detail)
throws TestLinkAPIException {
TestCase[] testCases;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCasesIds);
executionData.put(TestLinkParams.BUILD_ID.toString(), buildId);
executionData.put(TestLinkParams.KEYWORD_ID.toString(), keywordsIds);
executionData.put(TestLinkParams.KEYWORDS.toString(), keywords);
executionData.put(TestLinkParams.EXECUTED.toString(), executed);
executionData.put(TestLinkParams.ASSIGNED_TO.toString(), assignedTo);
executionData.put(TestLinkParams.EXECUTE_STATUS.toString(), executeStatus);
executionData.put(TestLinkParams.EXECUTION_TYPE.toString(), Util.getStringValueOrNull(executionType));
executionData.put(TestLinkParams.GET_STEP_INFO.toString(), getStepInfo);
executionData.put(TestLinkParams.DETAILS.toString(), Util.getStringValueOrNull(detail));
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASES_FOR_TEST_PLAN.toString(),
executionData);
/*
* // The Util.castToMap method will return an empty Map if ( response instanceof String ) { throw new
* TestLinkAPIException( "The test plan you requested does not contain Test Cases." ); }
*/
Map responseMap = Util.castToMap(response);
List testCasesList = new ArrayList<>();
for (Entry entry : responseMap.entrySet()) {
String key = entry.getKey();
Map testCaseMap;
if (entry.getValue() instanceof Object[]) {
Object[] responseArray = (Object[]) entry.getValue();
testCaseMap = (Map) responseArray[0];
testCaseMap.put(TestLinkResponseParams.ID.toString(), key);
testCasesList.add(Util.getTestCase(testCaseMap));
} else if (entry.getValue() instanceof Map) {
testCaseMap = (Map) entry.getValue();
if (testCaseMap.size() > 0) {
for (Entry o : testCaseMap.entrySet()) {
if (o instanceof Map) {
Map testCaseMapTmp = (Map) o;
testCaseMapTmp.put(TestLinkResponseParams.ID.toString(), key);
testCasesList.add(Util.getTestCase(testCaseMapTmp));
}
}
} else {
testCaseMap.put(TestLinkResponseParams.ID.toString(), key);
testCasesList.add(Util.getTestCase(testCaseMap));
}
}
}
testCases = testCasesList.toArray(new TestCase[0]);
return testCases;
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test cases for test plan: " + xmlrpcex.getMessage(),
xmlrpcex);
}
}
/**
*
* @param testCaseId
* @param testCaseExternalId
* @param version
* @return
* @throws TestLinkAPIException
*/
protected TestCase getTestCase(Integer testCaseId, Integer testCaseExternalId, Integer version)
throws TestLinkAPIException {
TestCase testCase;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), version);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE.toString(), executionData);
Object[] responseArray = Util.castToArray(response);
Map responseMap = (Map) responseArray[0];
testCase = Util.getTestCase(responseMap);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error getting test case info : " + xmlrpcex.getMessage(), xmlrpcex);
}
return testCase;
}
/**
*
* @param fullTestCaseExternalId Full external id: prefix-externalId
* @param version
* @return
* @throws TestLinkAPIException
*/
protected TestCase getTestCaseByExternalId(String fullTestCaseExternalId, Integer version)
throws TestLinkAPIException {
TestCase testCase;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), fullTestCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), version);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE.toString(), executionData);
Object[] responseArray = Util.castToArray(response);
Map responseMap = (Map) responseArray[0];
testCase = Util.getTestCase(responseMap);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error getting test case info : " + xmlrpcex.getMessage(), xmlrpcex);
}
return testCase;
}
/**
* @param testCaseName
* @param testSuiteName
* @param testProjectName
* @param testCasePathName
* @return Integer
* @throws TestLinkAPIException
*/
protected Integer getTestCaseIDByName(String testCaseName, String testSuiteName, String testProjectName,
String testCasePathName) throws TestLinkAPIException {
Integer testCaseID;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_NAME.toString(), testCaseName);
executionData.put(TestLinkParams.TEST_SUITE_NAME.toString(), testSuiteName);
executionData.put(TestLinkParams.TEST_PROJECT_NAME.toString(), testProjectName);
executionData.put(TestLinkParams.TEST_CASE_PATH_NAME.toString(), testCasePathName);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE_ID_BY_NAME.toString(),
executionData);
Map responseMap;
if (response instanceof HashMap) {
Map hm = (HashMap) response;
responseMap = (Map) hm.get(hm.keySet().toArray()[0]);
} else {
Object[] responseArray = Util.castToArray(response);
responseMap = (Map) responseArray[0];
}
testCaseID = Util.getInteger(responseMap, TestLinkResponseParams.ID.toString());
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error getting test case ID : " + xmlrpcex.getMessage(), xmlrpcex);
}
return testCaseID;
}
/**
* @param testCaseId
* @param title
* @param description
* @param fileName
* @param fileType
* @param content
* @return
*/
protected Attachment uploadTestCaseAttachment(Integer testCaseId, String title, String description, String fileName,
String fileType, String content) throws TestLinkAPIException {
Attachment attachment;
Integer id = 0;
attachment = new Attachment(id, testCaseId, TestLinkTables.NODES_HIERARCHY.toString(), title, description,
fileName, null, fileType, content);
try {
Map executionData = Util.getTestCaseAttachmentMap(attachment);
Object response = this.executeXmlRpcCall(TestLinkMethods.UPLOAD_TEST_CASE_ATTACHMENT.toString(),
executionData);
Map responseMap = Util.castToMap(response);
id = Util.getInteger(responseMap, TestLinkResponseParams.ID.toString());
attachment.setId(id);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error uploading attachment for test case: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return attachment;
}
/**
* @param testCaseId
* @param testCaseExternalId
* @param testCaseVersion
* @return
* @throws TestLinkAPIException
*/
protected Attachment[] getTestCaseAttachments(Integer testCaseId, Integer testCaseVersion, Integer testCaseExternalId)
throws TestLinkAPIException {
Attachment[] attachments;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.VERSION.toString(), testCaseVersion);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE_ATTACHMENTS.toString(),
executionData);
if (response instanceof Map) {
Map responseMap = Util.castToMap(response);
Set> entrySet = responseMap.entrySet();
attachments = new Attachment[entrySet.size()];
int index = 0;
for (Entry entry : entrySet) {
String key = entry.getKey();
Map attachmentMap = (Map) entry.getValue();
attachmentMap.put(TestLinkResponseParams.ID.toString(), key);
attachments[index] = Util.getAttachment(attachmentMap);
index += 1;
}
} else {
attachments = new Attachment[0];
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test case's attachments: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return attachments;
}
protected Attachment uploadExecutionAttachment(Integer executionId, String title, String description,
String fileName, String fileType, String content) throws TestLinkAPIException {
Attachment attachment;
Integer id = 0;
attachment = new Attachment(id, executionId, TestLinkTables.EXECUTIONS.toString(), title, description, fileName,
null, fileType, content);
try {
Map executionData = Util.getExecutionAttachmentMap(attachment);
Object response = this.executeXmlRpcCall(TestLinkMethods.UPLOAD_EXECUTION_ATTACHMENT.toString(),
executionData);
Map responseMap = Util.castToMap(response);
id = Util.getInteger(responseMap, TestLinkResponseParams.ID.toString());
attachment.setId(id);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error uploading attachment for execution: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return attachment;
}
/**
* @param executionId
* @return
* @te
*/
protected void deleteExecution(Integer executionId) throws TestLinkAPIException {
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.EXECUTION_ID.toString(), executionId);
this.executeXmlRpcCall(TestLinkMethods.DELETE_EXECUTION.toString(), executionData);
// the error verification routine is called inside
// super.executeXml...
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error deleting execution: " + xmlrpcex.getMessage(), xmlrpcex);
}
}
/**
* @param testCaseId
* @param testCaseExternalId
* @param testPlanId
* @param status
* @param steps
* @param buildId
* @param buildName
* @param notes
* @param executionDuration
* @param guess
* @param bugId
* @param platformId
* @param platformName
* @param customFields
* @param overwrite
* @param user if present checks if user is a valid login
* @param timestamp format YYYY-MM-DD HH:MM:SS (e.g. 2015-05-22 12:15:45)
* @return Response object of reportTCResult method
* @throws TestLinkAPIException
*/
protected ReportTCResultResponse reportTCResult(Integer testCaseId, Integer testCaseExternalId, Integer testPlanId,
ExecutionStatus status, List steps, Integer buildId, String buildName,
String notes, Integer executionDuration, Boolean guess, String bugId,
Integer platformId, String platformName, Map customFields, Boolean overwrite,
String user, String timestamp)
throws TestLinkAPIException {
// TODO: Map customFields =>
// change for a list of custom fields. After implementing method
// getTestCaseCustomFieldDesignValue this
// entities properties will become much more clear
ReportTCResultResponse reportTCResultResponse = null;
List> stepsMap = Util.getTestCaseStepResultMap(steps);
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.STATUS.toString(), status.toString());
executionData.put(TestLinkParams.STEPS.toString(), stepsMap);
executionData.put(TestLinkParams.BUILD_ID.toString(), buildId);
executionData.put(TestLinkParams.BUILD_NAME.toString(), buildName);
executionData.put(TestLinkParams.NOTES.toString(), notes);
executionData.put(TestLinkParams.EXECUTION_DURATION.toString(), executionDuration);
executionData.put(TestLinkParams.GUESS.toString(), guess);
executionData.put(TestLinkParams.BUG_ID.toString(), bugId);
executionData.put(TestLinkParams.PLATFORM_ID.toString(), platformId);
executionData.put(TestLinkParams.PLATFORM_NAME.toString(), platformName);
executionData.put(TestLinkParams.CUSTOM_FIELDS.toString(), customFields);
executionData.put(TestLinkParams.OVERWRITE.toString(), overwrite);
executionData.put(TestLinkParams.USER.toString(), user);
executionData.put(TestLinkParams.TIMESTAMP.toString(), timestamp);
Object response = this.executeXmlRpcCall(TestLinkMethods.REPORT_TC_RESULT.toString(), executionData);
// the error verification routine is called inside
// super.executeXml...
if (response instanceof Object[]) {
Object[] responseArray = Util.castToArray(response);
Map responseMap = (Map) responseArray[0];
reportTCResultResponse = Util.getReportTCResultResponse(responseMap);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error reporting TC result: " + xmlrpcex.getMessage(), xmlrpcex);
}
return reportTCResultResponse;
}
/**
* @param testCaseId
* @param testCaseExternalId
* @param versionNumber
* @param testProjectId
* @param customFieldName
* @param details
* @return Custom Field.
* @throws TestLinkAPIException
*/
protected CustomField getTestCaseCustomFieldDesignValue(Integer testCaseId, Integer testCaseExternalId,
Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)
throws TestLinkAPIException {
CustomField customField = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), versionNumber);
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.CUSTOM_FIELD_NAME.toString(), customFieldName);
executionData.put(TestLinkParams.DETAILS.toString(), Util.getStringValueOrNull(details));
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE_CUSTOM_FIELD_DESIGN_VALUE.toString(),
executionData);
if (response instanceof String) {
customField = new CustomField();
customField.setValue(response.toString());
} else if (response instanceof Map) {
Map responseMap = Util.castToMap(response);
customField = Util.getCustomField(responseMap);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test case custom field value: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return customField;
}
/**
* @param testCaseId
* @param testCaseExternalId
* @param versionNumber
* @param testProjectId
* @param customFieldName
* @param details
* @return
* @throws TestLinkAPIException
*/
protected CustomField getTestCaseCustomFieldTestPlanDesignValue(Integer testCaseId, Integer testCaseExternalId,
Integer versionNumber, Integer testProjectId, String customFieldName, ResponseDetails details)
throws TestLinkAPIException {
CustomField customField = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), versionNumber);
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.CUSTOM_FIELD_NAME.toString(), customFieldName);
executionData.put(TestLinkParams.DETAILS.toString(), Util.getStringValueOrNull(details));
Object response = this.executeXmlRpcCall(
TestLinkMethods.GET_TEST_CASE_CUSTOM_FIELD_TEST_PLAN_DESIGN_VALUE.toString(), executionData);
if (response instanceof String) {
customField = new CustomField();
customField.setValue(response.toString());
} else if (response instanceof Map) {
Map responseMap = Util.castToMap(response);
customField = Util.getCustomField(responseMap);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test case custom field value: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return customField;
}
/**
* @param testCaseId
* @param testCaseExternalId
* @param versionNumber
* @param testPlanId
* @param testProjectId
* @param customFieldName
* @param details
* @return
* @throws TestLinkAPIException
*/
protected CustomField getTestCaseCustomFieldExecutionValue(Integer testCaseId, Integer testCaseExternalId,
Integer versionNumber, Integer executionId, Integer testPlanId, Integer testProjectId, String customFieldName,
ResponseDetails details) throws TestLinkAPIException {
CustomField customField = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.VERSION.toString(), versionNumber);
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.CUSTOM_FIELD_NAME.toString(), customFieldName);
executionData.put(TestLinkParams.DETAILS.toString(), Util.getStringValueOrNull(details));
executionData.put(TestLinkParams.EXECUTION_ID.toString(), executionId);
Object response = this.executeXmlRpcCall(
TestLinkMethods.GET_TEST_CASE_CUSTOM_FIELD_EXECUTION_VALUE.toString(), executionData);
if (response instanceof String) {
customField = new CustomField();
customField.setValue(response.toString());
} else if (response instanceof Map) {
Map responseMap = Util.castToMap(response);
customField = Util.getCustomField(responseMap);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test case custom field value: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return customField;
}
/**
* Gets list of keywords for a given Test case
*
* @param testProjectId
* @param testCaseId
* @return
* @throws TestLinkAPIException
*/
protected List getTestCaseKeywords(Integer testProjectId, Integer testCaseId) throws TestLinkAPIException {
List keywords = new ArrayList<>();
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE_KEYWORDS.toString(), executionData);
Object[] responseArray = (Object[]) response;
for (Object keywordObject : responseArray) {
Map keywordMap = (Map) keywordObject;
keywords.add(keywordMap.get("keyword"));
}
// testCase = Util.getTestCase(responseMap);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error getting test case info : " + xmlrpcex.getMessage(), xmlrpcex);
}
return keywords;
}
/**
* @param testProjectId
* @param testCaseExternalId
* @param versionNumber
* @param executionType
* @return
*/
protected Map setTestCaseExecutionType(Integer testProjectId, Integer testCaseId,
Integer testCaseExternalId, Integer versionNumber, ExecutionType executionType) {
Map responseMap;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.VERSION.toString(), versionNumber);
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.EXECUTION_TYPE.toString(), Util.getStringValueOrNull(executionType));
Object response = this.executeXmlRpcCall(TestLinkMethods.SET_TEST_CASE_EXECUTION_TYPE.toString(),
executionData);
if (response instanceof Map) {
responseMap = Util.castToMap(response);
} else {
responseMap = Util.castToMap(((Object[]) response)[0]);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error retrieving test case custom field value: " + xmlrpcex.getMessage(),
xmlrpcex);
}
return responseMap;
}
/**
*
* @param testCaseId
* @param versionNumber
* @param testProjectId
* @param customFieldName
* @param customFieldValue
*/
protected Map updateTestCaseCustomFieldDesignValue(Integer testCaseId, Integer versionNumber,
Integer testProjectId, String customFieldName, String customFieldValue) {
Map responseMap = null;
try {
Map executionData = new HashMap<>();
Map cf = new HashMap<>();
cf.put(customFieldName, customFieldValue);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.VERSION.toString(), versionNumber);
executionData.put(TestLinkParams.TEST_PROJECT_ID.toString(), testProjectId);
executionData.put(TestLinkParams.CUSTOM_FIELDS.toString(), cf);
Object response = this.executeXmlRpcCall(TestLinkMethods.UPDATE_TEST_CASE_CUSTOM_FIELD_VALUE.toString(),
executionData);
if (response instanceof Map) {
responseMap = Util.castToMap(response);
} else if (!(response instanceof String)) {
responseMap = Util.castToMap(((Object[]) response)[0]);
}
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error updating test case custom field value. " + xmlrpcex.getMessage(),
xmlrpcex);
}
return responseMap;
}
/**
*
* @param testPlanId
* @param testCaseExternalId
* @param user
* @param buildName
* @throws TestLinkAPIException
*/
protected void assignTestCaseExecutionTask(Integer testPlanId, String testCaseExternalId, String user,
String buildName) throws TestLinkAPIException {
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.USER.toString(), user);
executionData.put(TestLinkParams.BUILD_NAME.toString(), buildName);
this.executeXmlRpcCall(TestLinkMethods.ASSIGN_TEST_CASE_EXECUTION_TASK.toString(), executionData);
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error deleting execution: " + xmlrpcex.getMessage(), xmlrpcex);
}
}
/**
* @param testcaseKeywordsMap key - testcase externalId, value - list of keywords
*
* @return
* @throws TestLinkAPIException
*/
protected Map addTestCaseKeyWords(Map> testcaseKeywordsMap)
throws TestLinkAPIException {
Map responseMap = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.KEYWORDS.toString(), testcaseKeywordsMap);
Object response = this.executeXmlRpcCall(TestLinkMethods.ADD_TEST_CASE_KEY_WORDS.toString(), executionData);
if (response instanceof Map) {
responseMap = Util.castToMap(response);
} else if (!(response instanceof String)) {
responseMap = Util.castToMap(((Object[]) response)[0]);
}
return responseMap;
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error adding test case keywords: " + xmlrpcex.getMessage(), xmlrpcex);
}
}
/**
* @param testPlanId
* @param testCaseId
* @param testCaseExternalId
* @param platformId
* @param platformName
* @param buildId
* @param buildName
* @return
*/
protected List getTestCaseBugs(Integer testPlanId, Integer testCaseId, Integer testCaseExternalId,
Integer platformId, String platformName, Integer buildId, String buildName) {
Map responseMap = null;
try {
Map executionData = new HashMap<>();
executionData.put(TestLinkParams.TEST_PLAN_ID.toString(), testPlanId);
executionData.put(TestLinkParams.TEST_CASE_ID.toString(), testCaseId);
executionData.put(TestLinkParams.TEST_CASE_EXTERNAL_ID.toString(), testCaseExternalId);
executionData.put(TestLinkParams.PLATFORM_ID.toString(), platformId);
executionData.put(TestLinkParams.PLATFORM_NAME.toString(), platformName);
executionData.put(TestLinkParams.BUILD_ID.toString(), buildId);
executionData.put(TestLinkParams.BUILD_NAME.toString(), buildName);
Object response = this.executeXmlRpcCall(TestLinkMethods.GET_TEST_CASE_BUGS.toString(), executionData);
if (response instanceof Map) {
responseMap = Util.castToMap(response);
} else if (!(response instanceof String)) {
responseMap = Util.castToMap(((Object[]) response)[0]);
}
if (responseMap != null && !responseMap.isEmpty() && responseMap.containsKey("bugs")) {
Object bugs = responseMap.get("bugs");
if (bugs != null) {
Object[] o = Util.castToArray(bugs);
return Arrays
.stream(o)
.map((Object object) -> ((Map) object).get("bug_id"))
.map((Object string) -> Integer.parseInt((String) string))
.collect(Collectors.toList());
}
}
return Collections.emptyList();
} catch (XmlRpcException xmlrpcex) {
throw new TestLinkAPIException("Error adding test case keywords: " + xmlrpcex.getMessage(), xmlrpcex);
}
}
}