|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectbr.eti.kinoshita.testlinkjavaapi.TestLinkAPI
public class TestLinkAPI
TestLink API class.
| Constructor Summary | |
|---|---|
TestLinkAPI(java.lang.String url,
java.lang.String devKey)
Constructor with parameters. |
|
| Method Summary | |
|---|---|
java.lang.String |
about()
Displays information about TL. |
java.lang.Integer |
addTestCaseToTestPlan(java.lang.Integer testProjectId,
java.lang.Integer testPlanId,
java.lang.Integer testCaseId,
java.lang.Integer version,
java.lang.Integer platformId,
java.lang.Integer order,
java.lang.Integer urgency)
Adds a Test Case to a Test Plan. |
void |
assignRequirements(java.lang.Integer testCaseId,
java.lang.Integer testProjectId,
java.util.List<Requirement> requirements)
Assign a requirements to a Test Case. |
java.lang.Boolean |
checkDevKey(java.lang.String devKey)
Checks developer key. |
Build |
createBuild(java.lang.Integer testPlanId,
java.lang.String buildName,
java.lang.String buildNotes)
Creates a Build. |
TestCase |
createTestCase(java.lang.String testCaseName,
java.lang.Integer testSuiteId,
java.lang.Integer testProjectId,
java.lang.String authorLogin,
java.lang.String summary,
java.util.List<TestCaseStep> steps,
java.lang.String preconditions,
TestImportance importance,
ExecutionType execution,
java.lang.Integer order,
java.lang.Integer internalId,
java.lang.Boolean checkDuplicatedName,
java.lang.String actionOnDuplicatedName)
Creates a Test Case. |
TestPlan |
createTestPlan(java.lang.String planName,
java.lang.String projectName,
java.lang.String notes,
java.lang.Boolean isActive,
java.lang.Boolean isPublic)
Creates a Test Plan. |
TestProject |
createTestProject(java.lang.String testProjectName,
java.lang.String testProjectPrefix,
java.lang.String notes,
java.lang.Boolean enableRequirements,
java.lang.Boolean enableTestPriority,
java.lang.Boolean enableAutomation,
java.lang.Boolean enableInventory,
java.lang.Boolean isActive,
java.lang.Boolean isPublic)
Creates a Test Project. |
TestSuite |
createTestSuite(java.lang.Integer testProjectId,
java.lang.String name,
java.lang.String details,
java.lang.Integer parentId,
java.lang.Integer order,
java.lang.Boolean checkDuplicatedName,
java.lang.String actionOnDuplicatedName)
|
void |
deleteExecution(java.lang.Integer executionId)
Deletes an execution. |
java.lang.Boolean |
doesUserExist(java.lang.String user)
Checks if the given user exists. |
Build[] |
getBuildsForTestPlan(java.lang.Integer testPlanId)
Retrieves an Array of Builds for a given Test Plan. |
java.lang.String |
getDevKey()
|
TestSuite[] |
getFirstLevelTestSuitesForTestProject(java.lang.Integer testProjectId)
Get set of test suites AT TOP LEVEL of tree on a Test Project |
java.lang.String[] |
getFullPath(java.lang.Integer nodeId)
Retrieves the full path of a node. |
Execution |
getLastExecutionResult(java.lang.Integer testPlanId,
java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId)
Retrieves last execution result of a Test Case. |
Build |
getLatestBuildForTestPlan(java.lang.Integer testPlanId)
Retrieves the latest Build for a given Test Plan. |
TestProject[] |
getProjects()
Retrieves all Test Projects from TestLink. |
TestPlan[] |
getProjectTestPlans(java.lang.Integer projectId)
Retrieves an array of Test Plans associated to a Test Project. |
TestCase |
getTestCase(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer version)
Get a test case |
Attachment[] |
getTestCaseAttachments(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId)
Return an array of attachments of a Test Case. |
CustomField |
getTestCaseCustomFieldDesignValue(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer versionNumber,
java.lang.Integer testProjectId,
java.lang.String customFieldName,
ResponseDetails details)
Retrieves list of Custom Fields for a Test Case. |
java.lang.Integer |
getTestCaseIDByName(java.lang.String testCaseName,
java.lang.String testSuiteName,
java.lang.String testProjectName,
java.lang.String testCasePathName)
Get a test case ID by a test case Name |
TestCase[] |
getTestCasesForTestPlan(java.lang.Integer testPlanId,
java.util.List<java.lang.Integer> testCasesIds,
java.lang.Integer buildId,
java.util.List<java.lang.Integer> keywordsIds,
java.lang.String keywords,
java.lang.Boolean executed,
java.util.List<java.lang.Integer> assignedTo,
java.lang.String executeStatus,
ExecutionType executionType,
java.lang.Boolean getStepInfo)
Retrieves Test Cases for Test Plans. |
TestCase[] |
getTestCasesForTestSuite(java.lang.Integer testSuiteId,
java.lang.Boolean deep,
java.lang.String details)
Retrieves Test Cases for a Test Suite. |
TestPlan |
getTestPlanByName(java.lang.String planName,
java.lang.String projectName)
Retrieves a Test Plan by its name. |
Platform[] |
getTestPlanPlatforms(java.lang.Integer planId)
Retrieves Platforms of a Test Plan. |
TestProject |
getTestProjectByName(java.lang.String projectName)
Retrieves a Test Project by its name. |
TestSuite[] |
getTestSuiteByID(java.util.List<java.lang.Integer> testSuiteIds)
Retrieves Test Suites for given Ids. |
TestSuite[] |
getTestSuitesForTestPlan(java.lang.Integer testPlanId)
|
TestSuite[] |
getTestSuitesForTestSuite(java.lang.Integer testSuiteId)
Get list of TestSuites which are DIRECT children of a given TestSuite |
java.util.Map<java.lang.String,java.lang.Object> |
getTotalsForTestPlan(java.lang.Integer testPlanId)
|
java.lang.String |
getUrl()
|
java.lang.String |
ping()
ping method is an alias for sayHello. |
java.lang.String |
repeat(java.lang.String str)
|
ReportTCResultResponse |
reportTCResult(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer testPlanId,
ExecutionStatus status,
java.lang.Integer buildId,
java.lang.String buildName,
java.lang.String notes,
java.lang.Boolean guess,
java.lang.String bugId,
java.lang.Integer platformId,
java.lang.String platformName,
java.util.Map<java.lang.String,java.lang.String> customFields,
java.lang.Boolean overwrite)
Reports a Test Case result. |
java.lang.String |
sayHello()
Says hello to the user. |
ReportTCResultResponse |
setTestCaseExecutionResult(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer testPlanId,
ExecutionStatus status,
java.lang.Integer buildId,
java.lang.String buildName,
java.lang.String notes,
java.lang.Boolean guess,
java.lang.String bugId,
java.lang.Integer platformId,
java.lang.String platformName,
java.util.Map<java.lang.String,java.lang.String> customFields,
java.lang.Boolean overwrite)
Reports a Test Case result. |
java.lang.Boolean |
setTestMode(java.lang.Boolean testMode)
|
java.lang.String |
toString()
|
Attachment |
uploadAttachment(java.lang.Integer fkId,
java.lang.String fkTable,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment linking it to a DB table. |
Attachment |
uploadRequirementAttachment(java.lang.Integer requirementId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment to a Requirement. |
Attachment |
uploadRequirementSpecificationAttachment(java.lang.Integer reqSpecId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment to a Requirement Specification. |
Attachment |
uploadTestCaseAttachment(java.lang.Integer testCaseId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment to a Test Case. |
Attachment |
uploadTestProjectAttachment(java.lang.Integer testProjectId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment to a Test Project. |
Attachment |
uploadTestSuiteAttachment(java.lang.Integer testSuiteId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
Uploads an attachment to a Test Suite. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public TestLinkAPI(java.lang.String url,
java.lang.String devKey)
throws java.net.MalformedURLException
Constructor with parameters.
Instantiates TestLink services.
url - The URL to set.devKey - The Developer Key to set.
java.net.MalformedURLException| Method Detail |
|---|
public java.lang.String getUrl()
public java.lang.String getDevKey()
public java.lang.String toString()
toString in class java.lang.Object
public java.lang.Boolean checkDevKey(java.lang.String devKey)
throws TestLinkAPIException
devKey - Developer Key.
TestLinkAPIException
public java.lang.Boolean doesUserExist(java.lang.String user)
throws TestLinkAPIException
user -
TestLinkAPIException
public java.lang.String ping()
throws TestLinkAPIException
TestLinkAPIException
public java.lang.String sayHello()
throws TestLinkAPIException
TestLinkAPIException
public java.lang.String about()
throws TestLinkAPIException
TestLinkAPIException
public java.lang.Boolean setTestMode(java.lang.Boolean testMode)
throws TestLinkAPIException
testMode -
TestLinkAPIException
public java.lang.String repeat(java.lang.String str)
throws TestLinkAPIException
str -
TestLinkAPIException
public Attachment uploadAttachment(java.lang.Integer fkId,
java.lang.String fkTable,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
fkId - fkTable - title - description - fileName - fileType - content -
TestLinkAPIException
public java.lang.String[] getFullPath(java.lang.Integer nodeId)
throws TestLinkAPIException
nodeId -
TestLinkAPIException
public Execution getLastExecutionResult(java.lang.Integer testPlanId,
java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId)
throws TestLinkAPIException
testPlanId - testCaseId - testCaseExternalId -
TestLinkAPIException
public TestProject createTestProject(java.lang.String testProjectName,
java.lang.String testProjectPrefix,
java.lang.String notes,
java.lang.Boolean enableRequirements,
java.lang.Boolean enableTestPriority,
java.lang.Boolean enableAutomation,
java.lang.Boolean enableInventory,
java.lang.Boolean isActive,
java.lang.Boolean isPublic)
throws TestLinkAPIException
testProjectName - testProjectPrefix - notes - enableRequirements - enableTestPriority - enableAutomation - enableInventory - isActive - isPublic -
TestLinkAPIException
public TestProject getTestProjectByName(java.lang.String projectName)
throws TestLinkAPIException
projectName - Test Project name.
TestLinkAPIException
public TestProject[] getProjects()
throws TestLinkAPIException
TestLinkAPIException
public TestPlan[] getProjectTestPlans(java.lang.Integer projectId)
throws TestLinkAPIException
projectId - Test Project Id.
TestLinkAPIException
public Attachment uploadTestProjectAttachment(java.lang.Integer testProjectId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
testProjectId - title - description - fileName - fileType - content -
TestLinkAPIException
public TestPlan createTestPlan(java.lang.String planName,
java.lang.String projectName,
java.lang.String notes,
java.lang.Boolean isActive,
java.lang.Boolean isPublic)
throws TestLinkAPIException
planName - Test Plan name.projectName - Test Project name.notes - Test Plan notes.isActive - isPublic -
TestLinkAPIException
public TestPlan getTestPlanByName(java.lang.String planName,
java.lang.String projectName)
throws TestLinkAPIException
planName - Test Plan name.projectName - Test Project name.
TestLinkAPIException
public Platform[] getTestPlanPlatforms(java.lang.Integer planId)
throws TestLinkAPIException
planId - Test Plan Id.
TestLinkAPIException
public java.util.Map<java.lang.String,java.lang.Object> getTotalsForTestPlan(java.lang.Integer testPlanId)
throws TestLinkAPIException
TestLinkAPIException
public Build createBuild(java.lang.Integer testPlanId,
java.lang.String buildName,
java.lang.String buildNotes)
throws TestLinkAPIException
testPlanId - buildName - buildNotes -
TestLinkAPIException
public Build[] getBuildsForTestPlan(java.lang.Integer testPlanId)
throws TestLinkAPIException
testPlanId - Test Plan ID.
TestLinkAPIException
public Build getLatestBuildForTestPlan(java.lang.Integer testPlanId)
throws TestLinkAPIException
testPlanId - Test Plan ID.
TestLinkAPIException
public TestSuite createTestSuite(java.lang.Integer testProjectId,
java.lang.String name,
java.lang.String details,
java.lang.Integer parentId,
java.lang.Integer order,
java.lang.Boolean checkDuplicatedName,
java.lang.String actionOnDuplicatedName)
throws TestLinkAPIException
TestLinkAPIException
public TestSuite[] getTestSuiteByID(java.util.List<java.lang.Integer> testSuiteIds)
throws TestLinkAPIException
testSuiteIds - List of Test Suite Ids.
TestLinkAPIException
public Attachment uploadTestSuiteAttachment(java.lang.Integer testSuiteId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
testSuiteId - title - description - fileName - fileType - content -
TestLinkAPIException
public TestSuite[] getTestSuitesForTestPlan(java.lang.Integer testPlanId)
throws TestLinkAPIException
testPlanId -
TestLinkAPIException
public TestSuite[] getTestSuitesForTestSuite(java.lang.Integer testSuiteId)
throws TestLinkAPIException
testSuiteId -
TestLinkAPIException
public TestSuite[] getFirstLevelTestSuitesForTestProject(java.lang.Integer testProjectId)
throws TestLinkAPIException
testProjectId -
TestLinkAPIException
public TestCase createTestCase(java.lang.String testCaseName,
java.lang.Integer testSuiteId,
java.lang.Integer testProjectId,
java.lang.String authorLogin,
java.lang.String summary,
java.util.List<TestCaseStep> steps,
java.lang.String preconditions,
TestImportance importance,
ExecutionType execution,
java.lang.Integer order,
java.lang.Integer internalId,
java.lang.Boolean checkDuplicatedName,
java.lang.String actionOnDuplicatedName)
throws TestLinkAPIException
testCaseName - testSuiteId - testProjectId - authorLogin - summary - steps - preconditions - importance - execution - order - internalId - checkDuplicatedName - actionOnDuplicatedName -
TestLinkAPIException
public java.lang.Integer addTestCaseToTestPlan(java.lang.Integer testProjectId,
java.lang.Integer testPlanId,
java.lang.Integer testCaseId,
java.lang.Integer version,
java.lang.Integer platformId,
java.lang.Integer order,
java.lang.Integer urgency)
throws TestLinkAPIException
testProjectId - testPlanId - testCaseId - version - platformId - order - urgency -
TestLinkAPIException
public TestCase[] getTestCasesForTestSuite(java.lang.Integer testSuiteId,
java.lang.Boolean deep,
java.lang.String details)
throws TestLinkAPIException
testSuiteId - deep - details -
TestLinkAPIException
public TestCase getTestCase(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer version)
throws TestLinkAPIException
testCaseId - testCaseExternalId - version -
TestLinkAPIException
public TestCase[] getTestCasesForTestPlan(java.lang.Integer testPlanId,
java.util.List<java.lang.Integer> testCasesIds,
java.lang.Integer buildId,
java.util.List<java.lang.Integer> keywordsIds,
java.lang.String keywords,
java.lang.Boolean executed,
java.util.List<java.lang.Integer> assignedTo,
java.lang.String executeStatus,
ExecutionType executionType,
java.lang.Boolean getStepInfo)
throws TestLinkAPIException
testPlanId - testCasesIds - buildId - keywordsIds - keywords - executed - assignedTo - executeStatus - executionType - getStepInfo -
TestLinkAPIException
public java.lang.Integer getTestCaseIDByName(java.lang.String testCaseName,
java.lang.String testSuiteName,
java.lang.String testProjectName,
java.lang.String testCasePathName)
throws TestLinkAPIException
devKey - testCaseName - testSuiteName - testProjectName - testCasePathName -
TestLinkAPIException
public Attachment uploadTestCaseAttachment(java.lang.Integer testCaseId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
testCaseId - title - description - fileName - fileType - content -
TestLinkAPIException
public Attachment[] getTestCaseAttachments(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId)
throws TestLinkAPIException
testCaseId - testCaseExternalId -
TestLinkAPIException
public void deleteExecution(java.lang.Integer executionId)
throws TestLinkAPIException
executionId - Execution Id.
TestLinkAPIException
public ReportTCResultResponse reportTCResult(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer testPlanId,
ExecutionStatus status,
java.lang.Integer buildId,
java.lang.String buildName,
java.lang.String notes,
java.lang.Boolean guess,
java.lang.String bugId,
java.lang.Integer platformId,
java.lang.String platformName,
java.util.Map<java.lang.String,java.lang.String> customFields,
java.lang.Boolean overwrite)
throws TestLinkAPIException
testCaseId - testCaseExternalId - testPlanId - status - buildId - buildName - notes - guess - bugId - platformId - platformName - customFields - overwrite -
TestLinkAPIException
public ReportTCResultResponse setTestCaseExecutionResult(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer testPlanId,
ExecutionStatus status,
java.lang.Integer buildId,
java.lang.String buildName,
java.lang.String notes,
java.lang.Boolean guess,
java.lang.String bugId,
java.lang.Integer platformId,
java.lang.String platformName,
java.util.Map<java.lang.String,java.lang.String> customFields,
java.lang.Boolean overwrite)
throws TestLinkAPIException
testCaseId - testCaseExternalId - testPlanId - status - buildId - buildName - notes - guess - bugId - platformId - platformName - customFields - overwrite -
TestLinkAPIException
public CustomField getTestCaseCustomFieldDesignValue(java.lang.Integer testCaseId,
java.lang.Integer testCaseExternalId,
java.lang.Integer versionNumber,
java.lang.Integer testProjectId,
java.lang.String customFieldName,
ResponseDetails details)
throws TestLinkAPIException
testCaseId - testCaseExternalId - versionNumber - testProjectId - customFieldName -
TestLinkAPIException
public Attachment uploadRequirementSpecificationAttachment(java.lang.Integer reqSpecId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
reqSpecId - title - description - fileName - fileType - content -
TestLinkAPIException
public Attachment uploadRequirementAttachment(java.lang.Integer requirementId,
java.lang.String title,
java.lang.String description,
java.lang.String fileName,
java.lang.String fileType,
java.lang.String content)
throws TestLinkAPIException
requirementId - title - description - fileName - fileType - content -
TestLinkAPIException
public void assignRequirements(java.lang.Integer testCaseId,
java.lang.Integer testProjectId,
java.util.List<Requirement> requirements)
throws TestLinkAPIException
testCaseId - testProjectId - requirements -
TestLinkAPIException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||