org.alfresco.bm.manager.api.v1

Class TestRestAPI

java.lang.Object

org.alfresco.bm.manager.api.AbstractRestResource

org.alfresco.bm.manager.api.v1.TestRestAPI

@RestController
 @RequestMapping(path="api/v1/tests")
public class TestRestAPI
extends AbstractRestResource

REST API V1

The URL pattern:

• <API URL>/v1/tests

Delegate the request to service layer and responds with JSON.

Since:

2.0

Author:

Michael Suzuki, Derek Hulley, Frank Becker

Field Summary

Fields inherited from class org.alfresco.bm.manager.api.AbstractRestResource

gson, logger

Constructor Summary

Constructors

Constructor and Description
TestRestAPI(MongoTestDAO testDAO, TestService testService, LogService logService, TestRunServicesCache testRunServices)

Method Summary

Modifier and Type	Method and Description
String	createTest(TestDetails testDetails)
String	createTestRun(String test, TestRunDetails testRunDetails)
void	deleteTest(String test, boolean clean) Delete a test and optionally clean up all related test data
void	deleteTestRun(String test, String run, boolean clean) Delete a test run and optionally clean up all related test data
String	exportProps(String test, String run)
String	exportTestProps(String test)
String	getTest(String test)
String	getTestDrivers(String test, boolean activeOnly)
String	getTestProperty(String test, String property)
String	getTestRun(String test, String run)
String	getTestRunProperty(String test, String run, String property)
String	getTestRuns(String test, int skip, int count, String stateStr)
String	getTestRunState(String test, String run)
String	getTestRunSummary(String test, String run)
String	getTests(String release, Integer schema, int skip, int count)
String	importProps(String test, String run, PropSetBean propBean)
String	importTestProps(String test, PropSetBean propBean)
String	scheduleTestRun(String test, String run, TestRunSchedule schedule)
String	setTestProperty(String test, String property, PropSetBean propBean)
String	setTestRunProperty(String test, String run, String property, PropSetBean propBean)
String	terminateTestRun(String test, String run)
String	unsetTestProperty(String test, String property, PropSetBean propBean)
String	updateTest(TestDetails testDetails)
String	updateTestRun(String test, TestRunDetails testRunDetails)

Methods inherited from class org.alfresco.bm.manager.api.AbstractRestResource

copyDBObject, maskValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestRestAPI

public TestRestAPI(MongoTestDAO testDAO,
                   TestService testService,
                   LogService logService,
                   TestRunServicesCache testRunServices)

Parameters:

testDAO - low-level data service for tests

testService - test service for retrieving calculated data

logService - service to log basic crud for end user record

testRunServices - factory providing access to test run services

Method Detail

getTests

@GetMapping(produces="application/json")
public String getTests(@RequestParam(value="release",required=false)
                                                                String release,
                                                                @RequestParam(value="schema",required=false)
                                                                Integer schema,
                                                                @RequestParam(value="skip",defaultValue="0")
                                                                int skip,
                                                                @RequestParam(value="count",defaultValue="50")
                                                                int count)

createTest

@PostMapping(consumes="application/json",
             produces="application/json")
public String createTest(@RequestBody
                                                                                                             TestDetails testDetails)

getTest

@GetMapping(path="/{test}",
            produces="application/json")
public String getTest(@PathVariable(value="test")
                                                                                           String test)

updateTest

@PutMapping(produces="application/json",
            consumes="application/json")
public String updateTest(@RequestBody
                                                                                                           TestDetails testDetails)

deleteTest

@DeleteMapping(value="/{test}")
public void deleteTest(@PathVariable(value="test")
                                                       String test,
                                                       @RequestParam(value="clean",defaultValue="true")
                                                       boolean clean)

Delete a test and optionally clean up all related test data

Parameters:

test - the name of the test

clean - true to remove all related test runs as well

getTestDrivers

@GetMapping(path="/{test}/drivers",
            produces="application/json")
public String getTestDrivers(@PathVariable(value="test")
                                                                                                          String test,
                                                                                                          @RequestParam(value="activeOnly",defaultValue="true")
                                                                                                          boolean activeOnly)

getTestProperty

@GetMapping(path="/{test}/props/{property:.+}",
            produces="application/json")
public String getTestProperty(@PathVariable(value="test")
                                                                                                                       String test,
                                                                                                                       @PathVariable(value="property")
                                                                                                                       String property)

setTestProperty

@PutMapping(path="/{test}/props/{property:.+}",
            produces="application/json",
            consumes="application/json")
public String setTestProperty(@PathVariable(value="test")
                                                                                                                                                                String test,
                                                                                                                                                                @PathVariable(value="property")
                                                                                                                                                                String property,
                                                                                                                                                                @RequestBody
                                                                                                                                                                PropSetBean propBean)

unsetTestProperty

@DeleteMapping(path="/{test}/props/{property:.+}",
               produces="application/json",
               consumes="application/json")
public String unsetTestProperty(@PathVariable(value="test")
                                                                                                                                                                           String test,
                                                                                                                                                                           @PathVariable(value="property")
                                                                                                                                                                           String property,
                                                                                                                                                                           @RequestBody
                                                                                                                                                                           PropSetBean propBean)

getTestRuns

@GetMapping(path="/{test}/runs",
            produces="application/json")
public String getTestRuns(@PathVariable(value="test")
                                                                                                    String test,
                                                                                                    @RequestParam(value="skip",defaultValue="0")
                                                                                                    int skip,
                                                                                                    @RequestParam(value="count",defaultValue="50")
                                                                                                    int count,
                                                                                                    @RequestParam(value="state",defaultValue="")
                                                                                                    String stateStr)

createTestRun

@PostMapping(path="/{test}/runs",
             produces="application/json",
             consumes="application/json")
public String createTestRun(@PathVariable(value="test")
                                                                                                                                                  String test,
                                                                                                                                                  @RequestBody
                                                                                                                                                  TestRunDetails testRunDetails)

getTestRun

@GetMapping(path="/{test}/runs/{run}",
            produces="application/json")
public String getTestRun(@PathVariable(value="test")
                                                                                                         String test,
                                                                                                         @PathVariable(value="run")
                                                                                                         String run)

updateTestRun

@PutMapping(path="/{test}/runs",
            consumes="application/json",
            produces="application/json")
public String updateTestRun(@PathVariable(value="test")
                                                                                                                                               String test,
                                                                                                                                               @RequestBody
                                                                                                                                               TestRunDetails testRunDetails)

deleteTestRun

@DeleteMapping(path="/{test}/runs/{run}")
public void deleteTestRun(@PathVariable(value="test")
                                                                    String test,
                                                                    @PathVariable(value="run")
                                                                    String run,
                                                                    @RequestParam(value="clean",defaultValue="true")
                                                                    boolean clean)

Delete a test run and optionally clean up all related test data

Parameters:

test - the name of the test

run - the name of the test run

clean - true to remove all related test run data as well

getTestRunProperty

@GetMapping(path="/{test}/runs/{run}/props/{property:.+}",
            produces="application/json")
public String getTestRunProperty(@PathVariable(value="test")
                                                                                                                                     String test,
                                                                                                                                     @PathVariable(value="run")
                                                                                                                                     String run,
                                                                                                                                     @PathVariable(value="property")
                                                                                                                                     String property)

setTestRunProperty

@PutMapping(path="/{test}/runs/{run}/props/{property:.+}",
            produces="application/json",
            consumes="application/json")
public String setTestRunProperty(@PathVariable(value="test")
                                                                                                                                                                              String test,
                                                                                                                                                                              @PathVariable(value="run")
                                                                                                                                                                              String run,
                                                                                                                                                                              @PathVariable(value="property")
                                                                                                                                                                              String property,
                                                                                                                                                                              @RequestBody
                                                                                                                                                                              PropSetBean propBean)

getTestRunSummary

@GetMapping(path="/{test}/runs/{run}/summary",
            produces="application/json")
public String getTestRunSummary(@PathVariable(value="test")
                                                                                                                        String test,
                                                                                                                        @PathVariable(value="run")
                                                                                                                        String run)

getTestRunState

@GetMapping(path="/{test}/runs/{run}/state",
            produces="application/json")
public String getTestRunState(@PathVariable(value="test")
                                                                                                                    String test,
                                                                                                                    @PathVariable(value="run")
                                                                                                                    String run)

scheduleTestRun

@PostMapping(path="/{test}/runs/{run}/schedule",
             produces="application/json",
             consumes="application/json")
public String scheduleTestRun(@PathVariable(value="test")
                                                                                                                                                                   String test,
                                                                                                                                                                   @PathVariable(value="run")
                                                                                                                                                                   String run,
                                                                                                                                                                   @RequestBody
                                                                                                                                                                   TestRunSchedule schedule)

terminateTestRun

@PostMapping(path="/{test}/runs/{run}/terminate",
             produces="application/json",
             consumes="application/json")
public String terminateTestRun(@PathVariable(value="test")
                                                                                                                                                                     String test,
                                                                                                                                                                     @PathVariable(value="run")
                                                                                                                                                                     String run)

exportProps

@GetMapping(path="/{test}/runs/{run}/exportProps",
            produces="application/json")
public String exportProps(@PathVariable(value="test")
                                                                                                                      String test,
                                                                                                                      @PathVariable(value="run")
                                                                                                                      String run)

importProps

@PostMapping(path="/{test}/runs/{run}/importProps",
             produces="application/json",
             consumes="application/json")
public String importProps(@PathVariable(value="test")
                                                                                                                                                                  String test,
                                                                                                                                                                  @PathVariable(value="run")
                                                                                                                                                                  String run,
                                                                                                                                                                  @RequestBody
                                                                                                                                                                  PropSetBean propBean)

exportTestProps

@GetMapping(path="/{test}/exportProps",
            produces="application/json")
public String exportTestProps(@PathVariable(value="test")
                                                                                                               String test)

importTestProps

@PostMapping(path="/{test}/importProps",
             produces="application/json",
             consumes="application/json")
public String importTestProps(@PathVariable(value="test")
                                                                                                                                                           String test,
                                                                                                                                                           @RequestBody
                                                                                                                                                           PropSetBean propBean)