org.alfresco.bm.manager.api.v1

Class ResultsRestAPI

java.lang.Object

org.alfresco.bm.manager.api.AbstractRestResource

org.alfresco.bm.manager.api.v1.ResultsRestAPI

@RestController
 @RequestMapping(path="api/v1/tests/{test}/runs/{run}/results")
public class ResultsRestAPI
extends AbstractRestResource

REST API V1

The URL pattern:

• <API URL>/v1/tests/{test}/runs/{run}/results

This class presents APIs for retrieving test run results and related information.

It is a meant to be a sub-resource, hence there is no defining path annotation.

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_EVENT_NAMES states not to filter by event names when query event results

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

gson, logger

Constructor Summary

Constructors

Constructor and Description
ResultsRestAPI(TestRunServicesCache services)

Method Summary

Modifier and Type	Method and Description
String	getAllEventsFilterName()
String	getEventResultEventNames(String test, String run)
String	getEventResults(String test, String run, String filterEventName, String filterSuccess, int skipResults, int numberOfResults)
org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody	getReportCSV(String test, String run)
org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody	getReportXLSX(String test, String run)
String	getTimeSeriesResults(String test, String run, long fromTime, String timeUnit, long reportPeriod, int smoothing, boolean chartOnly) Retrieve an approximate number of results, allowing for a smoothing factor (Simple Moving Average) - the number of data results to including in the moving average.

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

Field Detail

ALL_EVENT_NAMES

public static final String ALL_EVENT_NAMES

states not to filter by event names when query event results

See Also:

Constant Field Values

Constructor Detail

ResultsRestAPI

public ResultsRestAPI(TestRunServicesCache services)

Parameters:

services - object providing access to necessary test run services

test - the name of the test

run - the name of the run

Method Detail

getReportCSV

@GetMapping(path="/csv",
            produces="text/csv")
public org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody getReportCSV(@PathVariable(value="test")
                                                                                                                                                          String test,
                                                                                                                                                          @PathVariable(value="run")
                                                                                                                                                          String run)

getReportXLSX

@GetMapping(path="/xlsx",
            produces="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
public org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody getReportXLSX(@PathVariable(value="test")
                                                                                                                                                                                                                     String test,
                                                                                                                                                                                                                     @PathVariable(value="run")
                                                                                                                                                                                                                     String run)

getEventResultEventNames

@GetMapping(path="/eventNames",
            produces="application/json")
public String getEventResultEventNames(@PathVariable(value="test")
                                                                                                                String test,
                                                                                                                @PathVariable(value="run")
                                                                                                                String run)

getAllEventsFilterName

@GetMapping(path="/allEventsFilterName",
            produces="application/json")
public String getAllEventsFilterName()

getTimeSeriesResults

@GetMapping(path="/ts",
            produces="application/json")
public String getTimeSeriesResults(@PathVariable(value="test")
                                                                                                    String test,
                                                                                                    @PathVariable(value="run")
                                                                                                    String run,
                                                                                                    @RequestParam(value="fromTime",defaultValue="O")
                                                                                                    long fromTime,
                                                                                                    @RequestParam(value="timeUnit",defaultValue="SECONDS")
                                                                                                    String timeUnit,
                                                                                                    @RequestParam(value="reportPeriod",defaultValue="1")
                                                                                                    long reportPeriod,
                                                                                                    @RequestParam(value="smoothing",defaultValue="1")
                                                                                                    int smoothing,
                                                                                                    @RequestParam(value="chartOnly",defaultValue="true")
                                                                                                    boolean chartOnly)

Retrieve an approximate number of results, allowing for a smoothing factor (Simple Moving Average) - the number of data results to including in the moving average.

Parameters:

fromTime - the approximate time to start from

timeUnit - the units of the 'reportPeriod' (default SECONDS). See TimeUnit.

reportPeriod - how often a result should be output. This is expressed as a multiple of the 'timeUnit'.

smoothing - the number of results to include in the Simple Moving Average calculations

chartOnly - true to filter out results that are not of interest in performance charts

Returns:

JSON representing the event start time (x-axis) and the smoothed average execution time along with data such as the events per second, failures per second, etc.

getEventResults

@GetMapping(path="/eventResults",
            produces="application/json")
public String getEventResults(@PathVariable(value="test")
                                                                                                         String test,
                                                                                                         @PathVariable(value="run")
                                                                                                         String run,
                                                                                                         @RequestParam(value="filterEventName",defaultValue="(All Events)")
                                                                                                         String filterEventName,
                                                                                                         @RequestParam(value="filterSuccess",defaultValue="All")
                                                                                                         String filterSuccess,
                                                                                                         @RequestParam(value="skipResults",defaultValue="0")
                                                                                                         int skipResults,
                                                                                                         @RequestParam(value="numberOfResults",defaultValue="10")
                                                                                                         int numberOfResults)