Package com.loadfocus.jenkins.api

Class LoadAPI

java.lang.Object

com.loadfocus.jenkins.api.LoadAPI

public class LoadAPI
extends Object

Client for the LoadFocus public load-test API (cloud "general" tests). The API key travels only in the loadfocus-auth header and is never logged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LoadAPI.ExecuteResult	Outcome of launching a run.
static final class	LoadAPI.Response	Result of an HTTP call: status code plus raw body.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BASE_URL

Constructor Summary

Constructors

Constructor	Description
LoadAPI(String apiKey)
LoadAPI(String baseUrl, String apiKey)

Method Summary

Modifier and Type	Method	Description
void	annotateRun(String testrunname, String testrunid, String label, String url)	Labels a run (shown on its LoadFocus results and trend), e.g.
String	createShareLink(String testrunname, String testrunid)	Creates (or returns) a public share link for a finished run.
LoadAPI.ExecuteResult	execute(String testrunname)
net.sf.json.JSONObject	getAnalysis(String testrunname, String testrunid)	Whole-run analysis (overall + per-label metrics), or null while the run has no samples yet.
net.sf.json.JSONObject	getState(String testrunname, String testrunid)
List<Map<String,String>>	getTestList()	The account's cloud tests as {testrunname, testrunid} maps, or null when the key is rejected.
net.sf.json.JSONObject	getVerdict(String testrunname, String testrunid)	Server-side pass/fail verdict against the thresholds configured on loadfocus.com.
boolean	isValidApiKey()
String	latestRunId(String testrunname)	The test's latest run id ("" when the test has never run).
void	putThresholds(String testrunname, Map<String,Number> values)	Replaces the test's pass/fail thresholds on loadfocus.com (metrics left out are cleared) and enables them.
String	resultsUrl(String testrunname, String testrunid)
static String	resultsUrl(String baseUrl, String testrunname, String testrunid)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

See Also:

• Constant Field Values

Constructor Details

LoadAPI

public LoadAPI(String apiKey)

LoadAPI

public LoadAPI(String baseUrl,
 String apiKey)

Method Details

isValidApiKey

public boolean isValidApiKey()

getTestList

public List<Map<String,String>> getTestList()
                                     throws IOException,
InterruptedException,
LoadAPIException

The account's cloud tests as {testrunname, testrunid} maps, or null when the key is rejected.

Throws:

IOException

InterruptedException

LoadAPIException

latestRunId

public String latestRunId(String testrunname)
                   throws IOException,
InterruptedException,
LoadAPIException

The test's latest run id ("" when the test has never run).

Throws:

IOException

InterruptedException

LoadAPIException

execute

public LoadAPI.ExecuteResult execute(String testrunname)
                              throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getState

public net.sf.json.JSONObject getState(String testrunname,
 String testrunid)
                                throws IOException,
InterruptedException,
LoadAPIException

Throws:

IOException

InterruptedException

LoadAPIException

getAnalysis

public net.sf.json.JSONObject getAnalysis(String testrunname,
 String testrunid)
                                   throws IOException,
InterruptedException,
LoadAPIException

Whole-run analysis (overall + per-label metrics), or null while the run has no samples yet.

Throws:

IOException

InterruptedException

LoadAPIException

getVerdict

public net.sf.json.JSONObject getVerdict(String testrunname,
 String testrunid)
                                  throws IOException,
InterruptedException,
LoadAPIException

Server-side pass/fail verdict against the thresholds configured on loadfocus.com.

Throws:

IOException

InterruptedException

LoadAPIException

createShareLink

public String createShareLink(String testrunname,
 String testrunid)
                       throws IOException,
InterruptedException,
LoadAPIException

Creates (or returns) a public share link for a finished run.

Throws:

IOException

InterruptedException

LoadAPIException

putThresholds

public void putThresholds(String testrunname,
 Map<String,Number> values)
                   throws IOException,
InterruptedException,
LoadAPIException

Replaces the test's pass/fail thresholds on loadfocus.com (metrics left out are cleared) and enables them. Values: p95Ms, p99Ms, errorRatePct, minRps.

Throws:

IOException

InterruptedException

LoadAPIException

annotateRun

public void annotateRun(String testrunname,
 String testrunid,
 String label,
 String url)
                 throws IOException,
InterruptedException,
LoadAPIException

Labels a run (shown on its LoadFocus results and trend), e.g. with the Jenkins build that started it.

Throws:

IOException

InterruptedException

LoadAPIException

resultsUrl

public String resultsUrl(String testrunname,
 String testrunid)

resultsUrl

public static String resultsUrl(String baseUrl,
 String testrunname,
 String testrunid)