Package org.openstack4j.api

Class AbstractTest

java.lang.Object

org.openstack4j.api.AbstractTest

Direct Known Subclasses:

ActionServiceTest, ActionTests, AlarmTests, AlarmTests, AvailabilityZoneTests, BuildInfoServiceTest, CapabilitiesTest, CapabilitiesV3Test, ClusterPolicyServiceTest, ClusterServiceTest, ClusterTests, ContainerTests, CustomEndpointURLResolverTest, CustomEndpointURLResolverTest, DBDatabaseServiceImplTest, DBDatastoreServiceImplTest, DBFlavorServiceImplTest, DBInstanceServiceImplTest, DBUserServiceImplTest, DeploymentTests, DesignateRecordsetServiceTest, DesignateZoneServiceTest, EnvironmentTests, EventServiceTest, EventTests, ExtensionTests, ExternalPolicyServiceTest, ExternalSegmentServiceTest, FirewallPolicyTests, FirewallRuleTests, FirewallTests, FlavorTests, FloatingIPTests, GroupServiceTest, HealthMonitorTests, HealthMonitorV2Tests, HealthMonitorV2Tests, HostAggregateTests, ImageTests, ImageV1Tests, ImageV2Tests, InstanceActionsTests, KeystoneAuthenticationTests, KeystoneCredentialServiceTests, KeystoneDomainServiceTests, KeystoneGroupServiceTests, KeystonePolicyServiceTest, KeystoneProjectServiceTests, KeystoneRegionServiceTest, KeystoneRoleServiceTests, KeystoneServiceEndpointServiceTest, KeystoneTests, KeystoneTokenlessTest, KeystoneUserServiceTests, L2policyServiceTest, L3policyServiceTest, LbPoolTests, LbPoolV2Tests, LbPoolV2Tests, ListenerV2Tests, ListenerV2Tests, LoadBalancerV2Tests, LoadBalancerV2Tests, MagnumTests, MemberTests, MemberV2Tests, MemberV2Tests, MeterSampleTests, MicroVersionedServiceTest, MigrationTests, NatPoolServiceTest, NetFloatingIPServiceTests, NetQosBandwidthLimitRuleTests, NetQosPolicyTests, NetQuotaTest, NetworkIPAvailabilityTest, NetworkPolicyServiceTest, NetworkTests, NeutronTagTests, NodeServiceTest, NovaHostTests, ObjectStorageTests, PolicyActionServiceTest, PolicyClassifierServiceTest, PolicyRuleServiceTest, PolicyRuleSetServiceTest, PolicyServiceTest, PolicyTargetServiceTest, PolicyTypeServiceTest, PortForwardingTests, PortTests, ProfileServiceTest, ProfileTypeServiceTest, QuotaSetTests, QuotaSetTests, ReceiverServiceTest, ResourcesTests, ResourceTest, ResourceV3Test, SampleTests, SampleV3Tests, SchedulerStatsGetPoolTests, SchedulerStatsTests, SecretTests, SecurityGroupTests, SecurityServiceTests, ServerTagTests, ServerTests, ServicechainServiceTest, ServiceFunctionChainTests, ServiceProfileServiceTest, ServicesTests, ServiceTests, ServiceTests, ServiceVersionTests, SessionTests, ShareInstanceTests, ShareNetworkTests, ShareServerTests, ShareSnapshotTests, SharesTests, ShareTests, ShareTypeTests, StackServiceTests, SubnetTests, TackerVimTests, TackerVnfdTests, TackerVnfTests, ToscaTemplatesArtifactTests, TrunkTests, VersionServiceTest, VipTests, VolumeBackupTests, VolumeSnapshotTests, VolumeTests, VolumeTypeQuotaTests, VolumeTypeTests, WebHookServiceTest, WorkflowBaseTest

public abstract class AbstractTest
extends Object

Base Test class which handles Mocking a Webserver to fullfill and test against JSON response objects from an OpenStack deployment

Author:

Jeremy Unruh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractTest.Service

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	JSON_ACCESS
protected static String	JSON_TOKEN
protected OSClient.OSClientV2	osv2
protected OSClient.OSClientV3	osv3
protected okhttp3.mockwebserver.MockWebServer	server
protected static String	TOKEN_ID

Constructor Summary

Constructors

Constructor	Description
AbstractTest()

Method Summary

Modifier and Type	Method	Description
protected void	afterTest()
protected void	associateClientV2(OSClient.OSClientV2 osv2)
protected void	associateClientV3(OSClient.OSClientV3 osv3)
protected String	authURL(String path)
protected String	getResource(String resource)
protected OSClient.OSClientV2	osv2()
protected OSClient.OSClientV3	osv3()
protected void	respondWith(int statusCode)	Responds with specified status code and no body
protected void	respondWith(int statusCode, String jsonBody)	Responds with specified status code and json body
protected void	respondWith(String resource)	Responds with success status code and body from json resource file
protected void	respondWith(Map<String,String> headers, int statusCode)	Responds with specified status code, no body and optional headers
protected void	respondWith(Map<String,String> headers, int statusCode, String body)	Responds with specified status code, body and optional headers
protected void	respondWithCodeAndResource(int statusCode, String resource)
protected void	respondWithHeaderAndResource(Map<String,String> headers, int statusCode, String resource)	Responds with given header, status code, body from json resource file.
protected abstract AbstractTest.Service	service()
protected void	startServer()
protected okhttp3.mockwebserver.RecordedRequest	takeRequest()	Awaits, removes and returns the next request made to the mock server.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_ACCESS

protected static final String JSON_ACCESS

See Also:

Constant Field Values

JSON_TOKEN

protected static final String JSON_TOKEN

See Also:

Constant Field Values

TOKEN_ID

protected static final String TOKEN_ID

See Also:

Constant Field Values

osv2

protected OSClient.OSClientV2 osv2

osv3

protected OSClient.OSClientV3 osv3

server

protected okhttp3.mockwebserver.MockWebServer server

Constructor Detail

AbstractTest

public AbstractTest()

Method Detail

service

protected abstract AbstractTest.Service service()

Returns:

the service the API is using

startServer

@BeforeClass
protected void startServer()
                    throws UnknownHostException

Throws:

UnknownHostException

respondWith

protected void respondWith(String resource)
                    throws IOException

Responds with success status code and body from json resource file

Parameters:

resource - the json resource file

Throws:

IOException - Signals that an I/O exception has occurred.

respondWith

protected void respondWith(int statusCode)

Responds with specified status code and no body

Parameters:

statusCode - the status code to respond with

respondWith

protected void respondWith(Map<String,String> headers,
                           int statusCode)

Responds with specified status code, no body and optional headers

Parameters:

headers - optional headers

statusCode - the status code to respond with

respondWith

protected void respondWith(int statusCode,
                           String jsonBody)

Responds with specified status code and json body

Parameters:

statusCode - the status code to respond with

jsonBody - the json body

respondWith

protected void respondWith(Map<String,String> headers,
                           int statusCode,
                           String body)

Responds with specified status code, body and optional headers

Parameters:

headers - optional headers

statusCode - the status code to respond with

body - the response body

respondWithHeaderAndResource

protected void respondWithHeaderAndResource(Map<String,String> headers,
                                            int statusCode,
                                            String resource)
                                     throws IOException

Responds with given header, status code, body from json resource file.

Parameters:

headers - the specified header

statusCode - the status code to respond with

resource - the json resource file

Throws:

IOException - Signals that an I/O exception has occurred

respondWithCodeAndResource

protected void respondWithCodeAndResource(int statusCode,
                                          String resource)
                                   throws IOException

Throws:

IOException

takeRequest

protected okhttp3.mockwebserver.RecordedRequest takeRequest()
                                                     throws InterruptedException

Awaits, removes and returns the next request made to the mock server. Callers should use this to verify the request was sent as intended. This method will block until the request is available, possibly forever.
Be aware that this method will catch all the previous requests made to the mock server, also from other previous tests! Make sure to take all the requests made by methods in the same test class.

Returns:

the head of the request queue

Throws:

InterruptedException

authURL

protected String authURL(String path)

afterTest

@AfterClass(alwaysRun=true)
protected void afterTest()

associateClientV2

protected void associateClientV2(OSClient.OSClientV2 osv2)

associateClientV3

protected void associateClientV3(OSClient.OSClientV3 osv3)

osv2

protected OSClient.OSClientV2 osv2()

osv3

protected OSClient.OSClientV3 osv3()

getResource

protected String getResource(String resource)
                      throws IOException

Throws:

IOException