Package com.exasol.extensionmanager.itest

Class ExtensionManagerClient

java.lang.Object

com.exasol.extensionmanager.itest.ExtensionManagerClient

public class ExtensionManagerClient
extends Object

This class wraps the extension manager REST API and simplifies calling its endpoint methods:

• Adds authentication header value and passes database connection parameters required by most requests.
• Adds extension ID parameter for the extension under test to requests when required.
• Optionally adds the current version of the extension under test to requests when required.

The class also provides a convenient method assertRequestFails(Executable, Matcher, Matcher) for verifying that an API fails with expected error message and HTTP status code.

Method Summary

Modifier and Type	Method	Description
void	assertRequestFails(org.junit.jupiter.api.function.Executable executable, String expectedMessage, int expectedStatus)	Verify that the given executable throws an ApiException with a given error message and HTTP status code.
void	assertRequestFails(org.junit.jupiter.api.function.Executable executable, org.hamcrest.Matcher<String> messageMatcher, org.hamcrest.Matcher<Integer> statusMatcher)	Verify that the given executable throws an ApiException with a given error message and HTTP status code.
String	createInstance(String extensionId, String extensionVersion, List<ParameterValue> parameterValues)	Calls InstanceApi.createInstance(CreateInstanceRequest, String, Integer, String, String).
String	createInstance(List<ParameterValue> parameterValues)	Calls InstanceApi.createInstance(CreateInstanceRequest, String, Integer, String, String).
void	deleteInstance(String instanceId)	Calls InstanceApi.deleteInstance(String, String, String, String, Integer).
void	deleteInstance(String version, String instanceId)	Calls InstanceApi.deleteInstance(String, String, String, String, Integer).
ExtensionDetailsResponse	getExtensionDetails(String extensionVersion)	Calls ExtensionApi.getExtensionDetails(String, String, String, Integer).
List<ExtensionsResponseExtension>	getExtensions()	Calls ExtensionApi.listAvailableExtensions(String, Integer).
List<InstallationsResponseInstallation>	getInstallations()	Calls InstallationApi.listInstalledExtensions(String, Integer).
void	install()	Calls ExtensionApi.installExtension(InstallExtensionRequest, String, Integer, String, String).
void	install(String version)	Calls ExtensionApi.installExtension(InstallExtensionRequest, String, Integer, String, String).
List<Instance>	listInstances()	Calls InstanceApi.listInstances(String, String, String, Integer).
List<Instance>	listInstances(String version)	Calls InstanceApi.listInstances(String, String, String, Integer).
void	uninstall()	Calls InstallationApi.uninstallExtension(String, String, String, Integer) with the current version.
void	uninstall(String extensionVersion)	Calls InstallationApi.uninstallExtension(String, String, String, Integer).
UpgradeExtensionResponse	upgrade()	Calls InstallationApi.upgradeExtension(String, String, Integer).
UpgradeExtensionResponse	upgrade(String extensionId)	Calls InstallationApi.upgradeExtension(String, String, Integer).

Methods inherited from class java.lang.Object

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

Method Detail

getExtensions

public List<ExtensionsResponseExtension> getExtensions()

Calls ExtensionApi.listAvailableExtensions(String, Integer).

Returns:

list of available extensions

getInstallations

public List<InstallationsResponseInstallation> getInstallations()

Calls InstallationApi.listInstalledExtensions(String, Integer).

Returns:

list of installed extensions

getExtensionDetails

public ExtensionDetailsResponse getExtensionDetails(String extensionVersion)

Calls ExtensionApi.getExtensionDetails(String, String, String, Integer).

Parameters:

extensionVersion - extension version

Returns:

extension details

install

public void install(String version)

Calls ExtensionApi.installExtension(InstallExtensionRequest, String, Integer, String, String).

Parameters:

version - extension version

install

public void install()

Calls ExtensionApi.installExtension(InstallExtensionRequest, String, Integer, String, String).

uninstall

public void uninstall(String extensionVersion)

Calls InstallationApi.uninstallExtension(String, String, String, Integer).

Parameters:

extensionVersion - the extension version

uninstall

public void uninstall()

Calls InstallationApi.uninstallExtension(String, String, String, Integer) with the current version.

upgrade

public UpgradeExtensionResponse upgrade()

Calls InstallationApi.upgradeExtension(String, String, Integer).

Returns:

upgrade response

upgrade

public UpgradeExtensionResponse upgrade(String extensionId)

Calls InstallationApi.upgradeExtension(String, String, Integer).

Parameters:

extensionId - extension id

Returns:

upgrade response

createInstance

public String createInstance(List<ParameterValue> parameterValues)

Calls InstanceApi.createInstance(CreateInstanceRequest, String, Integer, String, String).

Parameters:

parameterValues - parameter values for creating the instance

Returns:

name of the new instance

createInstance

public String createInstance(String extensionId,
                             String extensionVersion,
                             List<ParameterValue> parameterValues)

Calls InstanceApi.createInstance(CreateInstanceRequest, String, Integer, String, String).

Parameters:

extensionId - extension id

extensionVersion - extension version

parameterValues - parameter name

Returns:

name of the new instance

listInstances

public List<Instance> listInstances()

Calls InstanceApi.listInstances(String, String, String, Integer).

Returns:

list of available instances

listInstances

public List<Instance> listInstances(String version)

Calls InstanceApi.listInstances(String, String, String, Integer).

Parameters:

version - extension version

Returns:

list of available instances

deleteInstance

public void deleteInstance(String version,
                           String instanceId)

Calls InstanceApi.deleteInstance(String, String, String, String, Integer).

Parameters:

version - extension version

instanceId - instance id to delete

deleteInstance

public void deleteInstance(String instanceId)

Calls InstanceApi.deleteInstance(String, String, String, String, Integer).

Parameters:

instanceId - instance id to delete

assertRequestFails

public void assertRequestFails(org.junit.jupiter.api.function.Executable executable,
                               org.hamcrest.Matcher<String> messageMatcher,
                               org.hamcrest.Matcher<Integer> statusMatcher)

Verify that the given executable throws an ApiException with a given error message and HTTP status code.

Parameters:

executable - executable to run

messageMatcher - Matcher for the error message field of the response

statusMatcher - Matcher for the HTTP status code of the response

assertRequestFails

public void assertRequestFails(org.junit.jupiter.api.function.Executable executable,
                               String expectedMessage,
                               int expectedStatus)

Verify that the given executable throws an ApiException with a given error message and HTTP status code.

Parameters:

executable - executable to run

expectedMessage - expected response error message

expectedStatus - expected response status code