TestPlanService (WSO2 TestGrid Project

java.lang.Object
- org.wso2.testgrid.web.api.TestPlanService

@Path(value="/test-plans")
 @Produces(value="application/json")
public class TestPlanService
extends Object

REST service implementation of TestPlan.

Constructor Summary

Constructors
Constructor and Description

TestPlanService()

Constructors
Constructor and Description
`TestPlanService()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`createTestPlan(TestPlanRequest testPlanRequest)` This has the implementation of the REST API for creating a new Test plan.
`javax.ws.rs.core.Response`	`getGrafanaURL(String id)` Returns the product performance dashboard url for the given test plan id
`javax.ws.rs.core.Response`	`getLogContent(String id, boolean truncate)` Returns the log content related to the given test plan.
`javax.ws.rs.core.Response`	`getScenarioResult(String testPlanId, String scenarioDir)` Deprecated. all scenario results are zipped together and given to download in testplan level Returns the result (archive file) to the given scenario of a test plan.
`javax.ws.rs.core.Response`	`getTestPlan(String id, boolean requireTestScenarioInfo)` This has the implementation of the REST API for fetching a specific TestPlan by id.
`javax.ws.rs.core.Response`	`getTestPlanHistory(String testPlanId)` Returns the testplan history of same infrastructure combination and deployment pattern as the queried testplan.
`javax.ws.rs.core.Response`	`getTestPlanResults(String testPlanId)` Returns the result (archive file) of a given test plan.
`javax.ws.rs.core.Response`	`getTestplans(String productId)` This method returns the latest `TestPlan`s for a given product that contains the build details for distinct infrastructure combinations.
`javax.ws.rs.core.Response`	`getTestPlansForDeploymentPatternAndDate(String deploymentPatternId, String date, boolean requireTestScenarioInfo)` This has the implementation of the REST API for fetching all the TestPlans for a given deployment-pattern and created before date.
`javax.ws.rs.core.Response`	`getTestSummary(String id)` Returns the test execution summary related to the given test plan.
`javax.ws.rs.core.Response`	`isLogContentExist(String id, boolean truncate)` Verify if the log content of the given test plan exists.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TestPlanService
```
public TestPlanService()
```

Method Detail

getTestPlansForDeploymentPatternAndDate

@GET
public javax.ws.rs.core.Response getTestPlansForDeploymentPatternAndDate(@QueryParam(value="deployment-pattern-id")
                                                                              String deploymentPatternId,
                                                                              @QueryParam(value="date")
                                                                              String date,
                                                                              @QueryParam(value="require-test-scenario-info")
                                                                              boolean requireTestScenarioInfo)

This has the implementation of the REST API for fetching all the TestPlans for a given deployment-pattern and created before date.

Returns:: A list of available TestPlans.

getTestPlan

@GET
 @Path(value="/{id}")
public javax.ws.rs.core.Response getTestPlan(@PathParam(value="id")
                                                                        String id,
                                                                        @QueryParam(value="require-test-scenario-info")
                                                                        boolean requireTestScenarioInfo)

This has the implementation of the REST API for fetching a specific TestPlan by id.

Returns:: The requested Test-Plan.

getLogContent

@GET
 @Path(value="/log/{id}")
public javax.ws.rs.core.Response getLogContent(@PathParam(value="id")
                                                                              String id,
                                                                              @QueryParam(value="truncate")
                                                                              boolean truncate)

Returns the log content related to the given test plan.

Parameters:: id - test plan id to get the specific log; truncate - whether the log file should be truncated or not
Returns:: The requested Test-Plan

isLogContentExist

@HEAD
 @Path(value="/log/{id}")
public javax.ws.rs.core.Response isLogContentExist(@PathParam(value="id")
                                                                                   String id,
                                                                                   @QueryParam(value="truncate")
                                                                                   boolean truncate)

Verify if the log content of the given test plan exists.

Parameters:: id - test plan id to get the specific log
Returns:: The requested Test-Plan

getTestSummary

@GET
 @Path(value="/test-summary/{id}")
public javax.ws.rs.core.Response getTestSummary(@PathParam(value="id")
                                                                                        String id)

Returns the test execution summary related to the given test plan.

Parameters:: id - test plan id
Returns:: The requested Test-Plan

getGrafanaURL

@GET
 @Path(value="/perf-url/{id}")
public javax.ws.rs.core.Response getGrafanaURL(@PathParam(value="id")
                                                                                   String id)

Returns the product performance dashboard url for the given test plan id

Parameters:: id - test plan id
Returns:: The requested roduct performance dashboard url for the test plan

getTestplans

@GET
 @Path(value="/product/{productId}")
public javax.ws.rs.core.Response getTestplans(@PathParam(value="productId")
                                                                                        String productId)

This method returns the latest TestPlans for a given product that contains the build details for distinct infrastructure combinations.

Parameters:: productId - the productId attribute for the product being queried
Returns:: list of TestPlanStatus as a JSON response.

createTestPlan
```
@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createTestPlan(TestPlanRequest testPlanRequest)
```
This has the implementation of the REST API for creating a new Test plan.

Parameters:

testPlanRequest - TestPlanRequest that includes the repository and other necessary detials to create new test plan.

Returns:

A list of available TestPlans.

getTestPlanHistory

@GET
 @Path(value="/history/{testPlanId}")
public javax.ws.rs.core.Response getTestPlanHistory(@PathParam(value="testPlanId")
                                                                                               String testPlanId)

Returns the testplan history of same infrastructure combination and deployment pattern as the queried testplan.

Parameters:: testPlanId - id of test plan being queried
Returns:: a list of testplans representing the history.

getScenarioResult

@GET
 @Path(value="/result/{test-plan-id}/{scenario-directory}")
 @Deprecated
public javax.ws.rs.core.Response getScenarioResult(@PathParam(value="test-plan-id")
                                                                                                                                 String testPlanId,
                                                                                                                                 @PathParam(value="scenario-directory")
                                                                                                                                 String scenarioDir)

Deprecated. all scenario results are zipped together and given to download in testplan level Returns the result (archive file) to the given scenario of a test plan.

Parameters:: testPlanId - test plan id; scenarioDir - scenario directory name
Returns:: archived file of the results

getTestPlanResults

@GET
 @Path(value="/result/{test-plan-id}")
public javax.ws.rs.core.Response getTestPlanResults(@PathParam(value="test-plan-id")
                                                                                                String testPlanId)

Returns the result (archive file) of a given test plan.

Parameters:: testPlanId - test plan id
Returns:: archived file of the results

Class TestPlanService

Constructor Summary