USRealEstate
/
web-api-commander
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

created a test wrapper for the commander, converted tests to use test wrapper, rename commander.log to commander.debug.log, and change state mutators to helper functions in TestUtils

This commit is contained in:
Joshua Darnell 2020-03-23 23:34:25 -07:00
parent fec45b94ac
commit fbfa3c0d15
5 changed files with 221 additions and 223 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
build/libs/web-api-commander.jar
View File

Binary file not shown.

262
src/main/java/org/reso/certification/stepdefs/WebAPIServer_1_0_2.java
View File

@ -12,10 +12,6 @@ import org.apache.http.HttpStatus;
import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.Logger;
import org.apache.olingo.client.api.communication.ODataClientErrorException; import org.apache.olingo.client.api.communication.ODataClientErrorException;
import org.apache.olingo.client.api.communication.ODataServerErrorException;
import org.apache.olingo.client.api.communication.request.retrieve.ODataEntitySetRequest;
import org.apache.olingo.client.api.communication.request.retrieve.ODataRawRequest;
import org.apache.olingo.client.api.communication.response.ODataRawResponse;
import org.apache.olingo.client.api.communication.response.ODataRetrieveResponse; import org.apache.olingo.client.api.communication.response.ODataRetrieveResponse;
import org.apache.olingo.client.api.data.ResWrap; import org.apache.olingo.client.api.data.ResWrap;
import org.apache.olingo.client.api.domain.ClientEntitySet; import org.apache.olingo.client.api.domain.ClientEntitySet;
@ -30,13 +26,11 @@ import org.apache.olingo.commons.api.format.ContentType;
import org.reso.commander.Commander; import org.reso.commander.Commander;
import org.reso.commander.TestUtils; import org.reso.commander.TestUtils;
import org.reso.models.ClientSettings; import org.reso.models.ClientSettings;
import org.reso.models.Request;
import org.reso.models.Settings; import org.reso.models.Settings;
import java.io.ByteArrayInputStream; import java.io.ByteArrayInputStream;
import java.io.File; import java.io.File;
import java.io.InputStream; import java.io.InputStream;
import java.net.URI;
import java.sql.Time; import java.sql.Time;
import java.sql.Timestamp; import java.sql.Timestamp;
import java.time.Instant; import java.time.Instant;
@ -44,7 +38,6 @@ import java.util.*;
import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Function;
import static io.restassured.path.json.JsonPath.from; import static io.restassured.path.json.JsonPath.from;
import static org.junit.Assert.*; import static org.junit.Assert.*;
@ -54,6 +47,8 @@ import static org.reso.commander.TestUtils.Operators.*;
public class WebAPIServer_1_0_2 implements En { public class WebAPIServer_1_0_2 implements En {
private static final Logger LOG = LogManager.getLogger(WebAPIServer_1_0_2.class); private static final Logger LOG = LogManager.getLogger(WebAPIServer_1_0_2.class);
private static final String FIELD_SEPARATOR = ",", PRETTY_FIELD_SEPARATOR = FIELD_SEPARATOR + " "; private static final String FIELD_SEPARATOR = ",", PRETTY_FIELD_SEPARATOR = FIELD_SEPARATOR + " ";
private static final String SHOW_RESPONSES = "showResponses";
private static final boolean showResponses = Boolean.parseBoolean(System.getProperty(SHOW_RESPONSES));
private static Settings settings; private static Settings settings;
@ -64,119 +59,16 @@ public class WebAPIServer_1_0_2 implements En {
private String serviceRoot, bearerToken, clientId, clientSecret, authorizationUri, tokenUri, redirectUri, scope; private String serviceRoot, bearerToken, clientId, clientSecret, authorizationUri, tokenUri, redirectUri, scope;
private String pathToRESOScript; private String pathToRESOScript;
/** /*
* Accessors used for running one-off tests that have dependent metadata tests * Used to store a static instance of the CommanderWrapper class
* @param commander the commander instance to make the request with.
* @return the XMLMetadata for the given request.
*/ */
private static XMLMetadata getXMLMetadata(Commander commander) { private static AtomicReference<CommanderWrapper> wrapper = new AtomicReference<>(new TestUtils.CommanderWrapper());
if (xmlMetadata.get() == null) {
xmlMetadata.set(commander.getXMLMetadata());
}
return xmlMetadata.get();
}
/** /**
* Accessors used for running one-off tests that have dependent metadata tests * Entry point to the Web API Server tests
* @param commander the commander instance to make the request with.
* @return the Edm for the given request.
*/ */
private static Edm getEdmMetadata(Commander commander) {
if (edm.get() == null) {
edm.set(commander.getEdm());
}
return edm.get();
}
public WebAPIServer_1_0_2() { public WebAPIServer_1_0_2() {
//TODO: split into separate test files and parallelize to remove the need for Atomic "globals"
AtomicReference<Commander> commander = new AtomicReference<>();
AtomicReference<ODataRawResponse> oDataRawResponse = new AtomicReference<>();
AtomicReference<Request> request = new AtomicReference<>();
AtomicReference<URI> requestUri = new AtomicReference<>();
AtomicReference<Integer> responseCode = new AtomicReference<>();
AtomicReference<String> responseData = new AtomicReference<>();
AtomicReference<String> initialResponseData = new AtomicReference<>(); //used if two result sets need to be compared
AtomicReference<ODataRawRequest> rawRequest = new AtomicReference<>();
AtomicReference<ODataClientErrorException> oDataClientErrorException = new AtomicReference<>();
AtomicReference<String> serverODataHeaderVersion = new AtomicReference<>();
AtomicReference<Boolean> testAppliesToServerODataHeaderVersion = new AtomicReference<>();
AtomicReference<ODataEntitySetRequest<ClientEntitySet>> clientEntitySetRequest = new AtomicReference<>();
AtomicReference<ODataRetrieveResponse<ClientEntitySet>> clientEntitySetResponse = new AtomicReference<>();
AtomicReference<ClientEntitySet> clientEntitySet = new AtomicReference<>();
final boolean showResponses = Boolean.parseBoolean(System.getProperty("showResponses"));
/*
* Instance Utility Methods - must precede usage
*/
/*
* Resets the local instance state used during test time.
* NOTE: you should add any local variables you need reset between tests here.
*
* TODO: refactor into collection of AtomicReference<T>
*/
Runnable resetRequestState = () -> {
oDataRawResponse.set(null);
request.set(null);
responseCode.set(null);
responseData.set(null);
initialResponseData.set(null);
rawRequest.set(null);
oDataClientErrorException.set(null);
serverODataHeaderVersion.set(null);
testAppliesToServerODataHeaderVersion.set(false);
};
/*
* This is used to prepare the URI coming from the raw RESOScript file to handle special characters
* needing to be processed prior to being converted to a valid URI.
*/
Function<String, URI> prepareUri = queryString -> URI.create(
/* replace spaces with %20 */
queryString.replace(" ", "%20")
/* add other handlers here */
);
/*
* Executes HTTP GET request and sets the expected local variables.
* Handles exceptions and sets response codes.
*/
Function<URI, Void> executeGetRequest = (URI uri) -> {
LOG.info("Request URI: " + uri);
try {
rawRequest.set(commander.get().getClient().getRetrieveRequestFactory().getRawRequest(uri));
oDataRawResponse.set(rawRequest.get().execute());
responseData.set(TestUtils.convertInputStreamToString(oDataRawResponse.get().getRawResponse()));
serverODataHeaderVersion.set(oDataRawResponse.get().getHeader(HEADER_ODATA_VERSION).toString());
responseCode.set(oDataRawResponse.get().getStatusCode());
LOG.info("Request succeeded..." + responseData.get().getBytes().length + " bytes received.");
} catch (ODataClientErrorException cex) {
LOG.debug("ODataClientErrorException caught. Check tests for asserted conditions...");
oDataClientErrorException.set(cex);
serverODataHeaderVersion.set(TestUtils.getHeaderData(HEADER_ODATA_VERSION, cex.getHeaderInfo()));
responseCode.set(cex.getStatusLine().getStatusCode());
} catch (ODataServerErrorException sex) {
LOG.debug("ODataServerErrorException thrown in executeGetRequest. Check tests for asserted conditions...");
//TODO: look for better ways to do this in Olingo or open PR
if (sex.getMessage().contains(Integer.toString(HttpStatus.SC_NOT_IMPLEMENTED))) {
responseCode.set(HttpStatus.SC_NOT_IMPLEMENTED);
return null;
}
fail("ERROR: unhandled ODataServerErrorException in executeGetRequest()!\n" + sex.toString());
throw sex;
} catch (Exception ex) {
fail("ERROR: unhandled Exception in executeGetRequest()!\n" + ex.toString());
//throw ex;
}
return null;
};
/* /*
* Background * Background
*/ */
@ -212,8 +104,9 @@ public class WebAPIServer_1_0_2 implements En {
LOG.info("Service root is: " + serviceRoot); LOG.info("Service root is: " + serviceRoot);
if (wrapper.get().commander.get() == null) {
//create Commander instance //create Commander instance
commander.set(new Commander.Builder() wrapper.get().commander.set(new Commander.Builder()
.clientId(clientId) .clientId(clientId)
.clientSecret(clientSecret) .clientSecret(clientSecret)
.tokenUri(tokenUri) .tokenUri(tokenUri)
@ -222,19 +115,20 @@ public class WebAPIServer_1_0_2 implements En {
.bearerToken(bearerToken) .bearerToken(bearerToken)
.useEdmEnabledClient(true) .useEdmEnabledClient(true)
.build()); .build());
}
}); });
/* /*
* Ensures that the client either uses Authorization Codes or Client Credentials * Ensures that the client either uses Authorization Codes or Client Credentials
*/ */
And("^the OData client uses authorization_code or client_credentials for authentication$", () -> { And("^the OData client uses authorization_code or client_credentials for authentication$", () -> {
assertNotNull(commander.get()); assertNotNull(wrapper.get().commander.get());
assertTrue("ERROR: Commander must either have a valid Authorization Code or Client Credentials configuration.", assertTrue("ERROR: Commander must either have a valid Authorization Code or Client Credentials configuration.",
commander.get().isTokenClient() || (commander.get().isOAuthClient() && commander.get().hasValidAuthConfig())); wrapper.get().commander.get().isTokenClient() || (wrapper.get().commander.get().isOAuthClient() && wrapper.get().commander.get().hasValidAuthConfig()));
if (commander.get().isTokenClient()) { if (wrapper.get().commander.get().isTokenClient()) {
LOG.info("Authentication Type: authorization_code"); LOG.info("Authentication Type: authorization_code");
} else if (commander.get().isOAuthClient()) { } else if (wrapper.get().commander.get().isOAuthClient()) {
LOG.info("Authentication Type: client_credentials"); LOG.info("Authentication Type: client_credentials");
} }
}); });
@ -243,7 +137,7 @@ public class WebAPIServer_1_0_2 implements En {
* REQ-WA103-END2 - validate DataSystem endpoint, if present. * REQ-WA103-END2 - validate DataSystem endpoint, if present.
*/ */
And("^the results match the expected DataSystem JSON schema$", () -> { And("^the results match the expected DataSystem JSON schema$", () -> {
if (responseCode.get() == HttpStatus.SC_OK && responseData.get() != null) { if (wrapper.get().responseCode.get() == HttpStatus.SC_OK && wrapper.get().responseData.get() != null) {
try { try {
JsonSchemaFactory factory = JsonSchemaFactory.getInstance(); JsonSchemaFactory factory = JsonSchemaFactory.getInstance();
InputStream is = Thread.currentThread().getContextClassLoader() InputStream is = Thread.currentThread().getContextClassLoader()
@ -251,7 +145,7 @@ public class WebAPIServer_1_0_2 implements En {
JsonSchema schema = factory.getSchema(is); JsonSchema schema = factory.getSchema(is);
ObjectMapper mapper = new ObjectMapper(); ObjectMapper mapper = new ObjectMapper();
JsonNode node = mapper.readTree(responseData.get()); JsonNode node = mapper.readTree(wrapper.get().responseData.get());
if (node.findPath(JSON_VALUE_PATH).size() > 0) { if (node.findPath(JSON_VALUE_PATH).size() > 0) {
Set<ValidationMessage> errors = schema.validate(node); Set<ValidationMessage> errors = schema.validate(node);
@ -275,7 +169,7 @@ public class WebAPIServer_1_0_2 implements En {
assertNotNull("ERROR: No Entity Data Model (Edm) Exists!", edm.get()); assertNotNull("ERROR: No Entity Data Model (Edm) Exists!", edm.get());
try { try {
boolean isValid = commander.get().validateMetadata(edm.get()); boolean isValid = wrapper.get().commander.get().validateMetadata(edm.get());
LOG.info("Edm Metadata is " + (isValid ? "valid" : "invalid") + "!"); LOG.info("Edm Metadata is " + (isValid ? "valid" : "invalid") + "!");
assertTrue("Edm Metadata at the given service root is not valid! " + serviceRoot, isValid); assertTrue("Edm Metadata at the given service root is not valid! " + serviceRoot, isValid);
} catch (Exception ex) { } catch (Exception ex) {
@ -288,15 +182,15 @@ public class WebAPIServer_1_0_2 implements En {
* XMLMetadata Validator * XMLMetadata Validator
*/ */
And("^the XML metadata returned by the server are valid$", () -> { And("^the XML metadata returned by the server are valid$", () -> {
assertNotNull("ERROR: No Response Data exists to convert to XML Metadata!", responseData.get()); assertNotNull("ERROR: No Response Data exists to convert to XML Metadata!", wrapper.get().responseData.get());
try { try {
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(responseData.get().getBytes()); ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(wrapper.get().responseData.get().getBytes());
xmlMetadata.set(commander.get().getClient().getDeserializer(ContentType.APPLICATION_XML).toMetadata(byteArrayInputStream)); xmlMetadata.set(wrapper.get().commander.get().getClient().getDeserializer(ContentType.APPLICATION_XML).toMetadata(byteArrayInputStream));
LOG.info("XML Metadata is \n" + responseData.get()); if (showResponses) LOG.info("XML Metadata is \n" + wrapper.get().responseData.get());
boolean isValid = commander.get().validateMetadata(xmlMetadata.get()); boolean isValid = wrapper.get().commander.get().validateMetadata(xmlMetadata.get());
LOG.info("XML Metadata is " + (isValid ? "valid" : "invalid") + "!"); LOG.info("XML Metadata is " + (isValid ? "valid" : "invalid") + "!");
assertTrue("ERROR: XML Metadata at the given service root is not valid! " + serviceRoot, isValid); assertTrue("ERROR: XML Metadata at the given service root is not valid! " + serviceRoot, isValid);
} catch (Exception ex) { } catch (Exception ex) {
@ -311,7 +205,7 @@ public class WebAPIServer_1_0_2 implements En {
And("^the provided \"([^\"]*)\" is returned in \"([^\"]*)\"$", (String parameterUniqueIdValue, String parameterUniqueId) -> { And("^the provided \"([^\"]*)\" is returned in \"([^\"]*)\"$", (String parameterUniqueIdValue, String parameterUniqueId) -> {
try { try {
String expectedValueAsString = Settings.resolveParametersString(parameterUniqueIdValue, settings), resolvedValueAsString = null; String expectedValueAsString = Settings.resolveParametersString(parameterUniqueIdValue, settings), resolvedValueAsString = null;
Object resolvedValue = from(responseData.get()).get(Settings.resolveParametersString(parameterUniqueId, settings)); Object resolvedValue = from(wrapper.get().responseData.get()).get(Settings.resolveParametersString(parameterUniqueId, settings));
//both of the inputs should be present //both of the inputs should be present
assertNotNull(expectedValueAsString); assertNotNull(expectedValueAsString);
@ -344,7 +238,7 @@ public class WebAPIServer_1_0_2 implements En {
AtomicInteger numResults = new AtomicInteger(); AtomicInteger numResults = new AtomicInteger();
//iterate over the items and count the number of fields with data to determine whether there are data present //iterate over the items and count the number of fields with data to determine whether there are data present
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
if (item != null) { if (item != null) {
numResults.getAndIncrement(); numResults.getAndIncrement();
fieldList.forEach(field -> { fieldList.forEach(field -> {
@ -376,7 +270,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the results contain at most \"([^\"]*)\" records$", (String parameterTopCount) -> { And("^the results contain at most \"([^\"]*)\" records$", (String parameterTopCount) -> {
try { try {
List<String> items = from(responseData.get()).getList(JSON_VALUE_PATH); List<String> items = from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH);
AtomicInteger numResults = new AtomicInteger(items.size()); AtomicInteger numResults = new AtomicInteger(items.size());
int topCount = Integer.parseInt(Settings.resolveParametersString(parameterTopCount, settings)); int topCount = Integer.parseInt(Settings.resolveParametersString(parameterTopCount, settings));
@ -400,20 +294,20 @@ public class WebAPIServer_1_0_2 implements En {
LOG.info("Skip count is: " + skipCount); LOG.info("Skip count is: " + skipCount);
//preserve initial response data for later comparisons //preserve initial response data for later comparisons
initialResponseData.set(responseData.get()); wrapper.get().initialResponseData.set(wrapper.get().responseData.get());
//TODO: convert to OData filter factory //TODO: convert to OData filter factory
requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequestById(requirementId), settings).getUrl() wrapper.get().requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequestById(requirementId), settings).getUrl()
+ "&" + Commander.ODATA_QUERY_OPTIONS.SKIP +"=" + skipCount)); + "&" + Commander.ODATA_QUERY_OPTIONS.SKIP +"=" + skipCount));
executeGetRequest.apply(requestUri.get()); wrapper.set(executeGetRequest(wrapper.get().requestUri.get(), wrapper.get()));
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
}); });
And("^data in the \"([^\"]*)\" fields are different in the second request than in the first$", (String parameterUniqueId) -> { And("^data in the \"([^\"]*)\" fields are different in the second request than in the first$", (String parameterUniqueId) -> {
try { try {
List<POJONode> l1 = from(initialResponseData.get()).getJsonObject(JSON_VALUE_PATH); List<POJONode> l1 = from(wrapper.get().initialResponseData.get()).getJsonObject(JSON_VALUE_PATH);
List<POJONode> l2 = from(responseData.get()).getJsonObject(JSON_VALUE_PATH); List<POJONode> l2 = from(wrapper.get().responseData.get()).getJsonObject(JSON_VALUE_PATH);
int combinedCount = l1.size() + l2.size(); int combinedCount = l1.size() + l2.size();
Set<POJONode> combined = new LinkedHashSet<>(l1); Set<POJONode> combined = new LinkedHashSet<>(l1);
@ -441,11 +335,11 @@ public class WebAPIServer_1_0_2 implements En {
When("^a GET request is made to the resolved Url in \"([^\"]*)\"$", (String requestId) -> { When("^a GET request is made to the resolved Url in \"([^\"]*)\"$", (String requestId) -> {
try { try {
//reset local state each time a get request is run //reset local state each time a get request is run
resetRequestState.run(); buildWrapperResetRunnable(wrapper.get()).run();
LOG.info("Request ID: " + requestId); LOG.info("Request ID: " + requestId);
requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequestById(requestId), settings).getUrl())); wrapper.get().requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequestById(requestId), settings).getUrl()));
executeGetRequest.apply(requestUri.get()); wrapper.set(executeGetRequest(wrapper.get().requestUri.get(), wrapper.get()));
} catch (Exception ex) { } catch (Exception ex) {
LOG.debug("Exception was thrown in " + this.getClass() + ": " + ex.toString()); LOG.debug("Exception was thrown in " + this.getClass() + ": " + ex.toString());
} }
@ -456,11 +350,11 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
Then("^the server responds with a status code of (\\d+)$", (Integer assertedResponseCode) -> { Then("^the server responds with a status code of (\\d+)$", (Integer assertedResponseCode) -> {
try { try {
LOG.info("Asserted Response Code: " + assertedResponseCode + ", Server Response Code: " + responseCode); LOG.info("Asserted Response Code: " + assertedResponseCode + ", Server Response Code: " + wrapper.get().responseCode);
assertTrue(responseCode.get() > 0 && assertedResponseCode > 0); assertTrue(wrapper.get().responseCode.get() > 0 && assertedResponseCode > 0);
assertEquals("ERROR: asserted response code does not match the one returned from the server!", assertEquals("ERROR: asserted response code does not match the one returned from the server!",
assertedResponseCode.intValue(), responseCode.get().intValue()); assertedResponseCode.intValue(), wrapper.get().responseCode.get().intValue());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -471,7 +365,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the response is valid XML$", () -> { And("^the response is valid XML$", () -> {
try { try {
assertTrue("ERROR: invalid XML response!", Commander.validateXML(responseData.get())); assertTrue("ERROR: invalid XML response!", Commander.validateXML(wrapper.get().responseData.get()));
LOG.info("Response is valid XML!"); LOG.info("Response is valid XML!");
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
@ -483,10 +377,10 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the response is valid JSON$", () -> { And("^the response is valid JSON$", () -> {
try { try {
assertTrue("ERROR: invalid JSON response!", TestUtils.isValidJson(responseData.get())); assertTrue("ERROR: invalid JSON response!", TestUtils.isValidJson(wrapper.get().responseData.get()));
LOG.info("Response is valid JSON!"); LOG.info("Response is valid JSON!");
if (showResponses) LOG.info("Response: " + new ObjectMapper().readTree(responseData.get()).toPrettyString()); if (showResponses) LOG.info("Response: " + new ObjectMapper().readTree(wrapper.get().responseData.get()).toPrettyString());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -499,13 +393,13 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
Then("^the server responds with a status code of (\\d+) if the server headers report OData version \"([^\"]*)\"$", (Integer assertedHttpResponseCode, String assertedODataVersion) -> { Then("^the server responds with a status code of (\\d+) if the server headers report OData version \"([^\"]*)\"$", (Integer assertedHttpResponseCode, String assertedODataVersion) -> {
try { try {
boolean versionsMatch = serverODataHeaderVersion.get().equals(assertedODataVersion), boolean versionsMatch = wrapper.get().serverODataHeaderVersion.get().equals(assertedODataVersion),
responseCodesMatch = responseCode.get().intValue() == assertedHttpResponseCode.intValue(); responseCodesMatch = wrapper.get().responseCode.get().intValue() == assertedHttpResponseCode.intValue();
LOG.info("Asserted OData Version: " + assertedODataVersion + ", Server Version: " + serverODataHeaderVersion.get()); LOG.info("Asserted OData Version: " + assertedODataVersion + ", Server Version: " + wrapper.get().serverODataHeaderVersion.get());
if (versionsMatch) { if (versionsMatch) {
LOG.info("Asserted Response Code: " + assertedHttpResponseCode + ", Response code: " + responseCode.get()); LOG.info("Asserted Response Code: " + assertedHttpResponseCode + ", Response code: " + wrapper.get().responseCode.get());
assertTrue("ERROR: asserted response code does not match the one returned from the server!", responseCodesMatch); assertTrue("ERROR: asserted response code does not match the one returned from the server!", responseCodesMatch);
} }
} catch (Exception ex) { } catch (Exception ex) {
@ -532,7 +426,7 @@ public class WebAPIServer_1_0_2 implements En {
AtomicReference<Integer> fieldValue = new AtomicReference<>(); AtomicReference<Integer> fieldValue = new AtomicReference<>();
//iterate through response data and ensure that with data, the statement fieldName "op" assertValue is true //iterate through response data and ensure that with data, the statement fieldName "op" assertValue is true
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
fieldValue.set(Integer.parseInt(item.get(fieldName).toString())); fieldValue.set(Integer.parseInt(item.get(fieldName).toString()));
result.set(result.get() && TestUtils.compare(fieldValue.get(), op, assertedValue)); result.set(result.get() && TestUtils.compare(fieldValue.get(), op, assertedValue));
}); });
@ -548,7 +442,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the response has results$", () -> { And("^the response has results$", () -> {
try { try {
int count = from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size(); int count = from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size();
LOG.info("Results count is: " + count); LOG.info("Results count is: " + count);
assertTrue("ERROR: no results returned from the server!", count > 0); assertTrue("ERROR: no results returned from the server!", count > 0);
} catch (Exception ex) { } catch (Exception ex) {
@ -562,7 +456,7 @@ public class WebAPIServer_1_0_2 implements En {
And("^the response has singleton results in \"([^\"]*)\"", (String parameterFieldName) -> { And("^the response has singleton results in \"([^\"]*)\"", (String parameterFieldName) -> {
try { try {
String value = Settings.resolveParametersString(parameterFieldName, settings); String value = Settings.resolveParametersString(parameterFieldName, settings);
boolean isPresent = from(responseData.get()).get() != null; boolean isPresent = from(wrapper.get().responseData.get()).get() != null;
LOG.info("Response value is: " + value); LOG.info("Response value is: " + value);
LOG.info("IsPresent: " + isPresent); LOG.info("IsPresent: " + isPresent);
assertTrue("ERROR: singleton results not found for '" + value + "'!", isPresent); assertTrue("ERROR: singleton results not found for '" + value + "'!", isPresent);
@ -576,7 +470,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the number of results is less than or equal to \"([^\"]*)\"$", (String limitField) -> { And("^the number of results is less than or equal to \"([^\"]*)\"$", (String limitField) -> {
try { try {
int count = from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size(), int count = from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size(),
limit = Integer.parseInt(Settings.resolveParametersString(limitField, settings)); limit = Integer.parseInt(Settings.resolveParametersString(limitField, settings));
LOG.info("Results count is: " + count + ", Limit is: " + limit); LOG.info("Results count is: " + count + ", Limit is: " + limit);
assertTrue("ERROR: number of results exceeds that specified in '" + limitField + "'!", count <= limit); assertTrue("ERROR: number of results exceeds that specified in '" + limitField + "'!", count <= limit);
@ -606,7 +500,7 @@ public class WebAPIServer_1_0_2 implements En {
rhsValue = new AtomicReference<>(); rhsValue = new AtomicReference<>();
//iterate through response data and ensure that with data, the statement fieldName "op" assertValue is true //iterate through response data and ensure that with data, the statement fieldName "op" assertValue is true
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
lhsValue.set(Integer.parseInt(item.get(fieldName).toString())); lhsValue.set(Integer.parseInt(item.get(fieldName).toString()));
rhsValue.set(Integer.parseInt(item.get(fieldName).toString())); rhsValue.set(Integer.parseInt(item.get(fieldName).toString()));
@ -641,7 +535,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(TestUtils.parseDateFromEdmDateString(Settings.resolveParametersString(parameterAssertedValue, settings))); assertedValue.set(TestUtils.parseDateFromEdmDateString(Settings.resolveParametersString(parameterAssertedValue, settings)));
LOG.info("Asserted value is: " + assertedValue.get().toString()); LOG.info("Asserted value is: " + assertedValue.get().toString());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
try { try {
fieldValue.set(TestUtils.parseDateFromEdmDateTimeOffsetString(item.get(fieldName).toString())); fieldValue.set(TestUtils.parseDateFromEdmDateTimeOffsetString(item.get(fieldName).toString()));
assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get())); assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get()));
@ -666,7 +560,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(TestUtils.parseTimeOfDayFromEdmTimeOfDayString(Settings.resolveParametersString(parameterAssertedValue, settings))); assertedValue.set(TestUtils.parseTimeOfDayFromEdmTimeOfDayString(Settings.resolveParametersString(parameterAssertedValue, settings)));
LOG.info("Asserted value is: " + assertedValue.get().toString()); LOG.info("Asserted value is: " + assertedValue.get().toString());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
try { try {
fieldValue.set(TestUtils.parseTimeOfDayFromEdmDateTimeOffsetString(item.get(fieldName).toString())); fieldValue.set(TestUtils.parseTimeOfDayFromEdmDateTimeOffsetString(item.get(fieldName).toString()));
assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get())); assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get()));
@ -684,7 +578,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^DateTimeOffset data in \"([^\"]*)\" \"([^\"]*)\" \"([^\"]*)\"$", (String parameterFieldName, String op, String parameterAssertedValue) -> { And("^DateTimeOffset data in \"([^\"]*)\" \"([^\"]*)\" \"([^\"]*)\"$", (String parameterFieldName, String op, String parameterAssertedValue) -> {
try { try {
TestUtils.assertDateTimeOffset(parameterFieldName, op, parameterAssertedValue, responseData.get(), settings); TestUtils.assertDateTimeOffset(parameterFieldName, op, parameterAssertedValue, wrapper.get().responseData.get(), settings);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -695,7 +589,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^DateTimeOffset data in \"([^\"]*)\" \"([^\"]*)\" now\\(\\)$", (String parameterFieldName, String op) -> { And("^DateTimeOffset data in \"([^\"]*)\" \"([^\"]*)\" now\\(\\)$", (String parameterFieldName, String op) -> {
try { try {
TestUtils.assertDateTimeOffset(parameterFieldName, op, Timestamp.from(Instant.now()), responseData.get(), settings); TestUtils.assertDateTimeOffset(parameterFieldName, op, Timestamp.from(Instant.now()), wrapper.get().responseData.get(), settings);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -715,7 +609,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(Settings.resolveParametersString(parameterAssertedValue, settings)); assertedValue.set(Settings.resolveParametersString(parameterAssertedValue, settings));
LOG.info("Asserted value is: " + assertedValue.get()); LOG.info("Asserted value is: " + assertedValue.get());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
fieldValue.set(item.get(fieldName).toString()); fieldValue.set(item.get(fieldName).toString());
result.set(fieldValue.get().contentEquals(assertedValue.get())); result.set(fieldValue.get().contentEquals(assertedValue.get()));
LOG.info("Assert True: " + fieldValue.get() + " equals " + assertedValue.get() + " ==> " + result.get()); LOG.info("Assert True: " + fieldValue.get() + " equals " + assertedValue.get() + " ==> " + result.get());
@ -741,7 +635,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(Settings.resolveParametersString(parameterAssertedValue, settings)); assertedValue.set(Settings.resolveParametersString(parameterAssertedValue, settings));
LOG.info("Asserted value is: " + assertedValue.get()); LOG.info("Asserted value is: " + assertedValue.get());
from(responseData.get()).getList(JSON_VALUE_PATH, ObjectNode.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, ObjectNode.class).forEach(item -> {
fieldValue.set(item.get(fieldName).toString()); fieldValue.set(item.get(fieldName).toString());
result.set(fieldValue.get().contains(assertedValue.get())); result.set(fieldValue.get().contains(assertedValue.get()));
LOG.info("Assert True: " + fieldValue.get() + " has " + assertedValue.get() + " ==> " + result.get()); LOG.info("Assert True: " + fieldValue.get() + " has " + assertedValue.get() + " ==> " + result.get());
@ -768,7 +662,7 @@ public class WebAPIServer_1_0_2 implements En {
AtomicReference<Timestamp> currentValue = new AtomicReference<>(); AtomicReference<Timestamp> currentValue = new AtomicReference<>();
AtomicInteger count = new AtomicInteger(0); AtomicInteger count = new AtomicInteger(0);
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
try { try {
if (count.get() == 0) { if (count.get() == 0) {
initialValue.set(TestUtils.parseTimestampFromEdmDateTimeOffsetString(item.get(fieldName).toString())); initialValue.set(TestUtils.parseTimestampFromEdmDateTimeOffsetString(item.get(fieldName).toString()));
@ -805,7 +699,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(Integer.parseInt(Settings.resolveParametersString(parameterAssertedValue, settings))); assertedValue.set(Integer.parseInt(Settings.resolveParametersString(parameterAssertedValue, settings)));
LOG.info("Asserted value is: " + assertedValue.get()); LOG.info("Asserted value is: " + assertedValue.get());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
try { try {
fieldValue.set(TestUtils.getDatePart(datePart.get(), item.get(fieldName))); fieldValue.set(TestUtils.getDatePart(datePart.get(), item.get(fieldName)));
assertTrue(TestUtils.compare(fieldValue.get(), operator.get(), assertedValue.get())); assertTrue(TestUtils.compare(fieldValue.get(), operator.get(), assertedValue.get()));
@ -834,7 +728,7 @@ public class WebAPIServer_1_0_2 implements En {
assertedValue.set(Integer.parseInt(Settings.resolveParametersString(parameterAssertedValue, settings))); assertedValue.set(Integer.parseInt(Settings.resolveParametersString(parameterAssertedValue, settings)));
LOG.info("Asserted value is: " + assertedValue.get().toString()); LOG.info("Asserted value is: " + assertedValue.get().toString());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
try { try {
fieldValue.set(TestUtils.getTimestampPart(datePart.get(), item.get(fieldName).toString())); fieldValue.set(TestUtils.getTimestampPart(datePart.get(), item.get(fieldName).toString()));
assertTrue(TestUtils.compare(fieldValue.get(), operator.get(), assertedValue.get())); assertTrue(TestUtils.compare(fieldValue.get(), operator.get(), assertedValue.get()));
@ -859,7 +753,7 @@ public class WebAPIServer_1_0_2 implements En {
AtomicReference<String> assertedValue = new AtomicReference<>(Settings.resolveParametersString(parameterAssertedValue, settings)); AtomicReference<String> assertedValue = new AtomicReference<>(Settings.resolveParametersString(parameterAssertedValue, settings));
AtomicReference<String> operator = new AtomicReference<>(op.toLowerCase()); AtomicReference<String> operator = new AtomicReference<>(op.toLowerCase());
from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> { from(wrapper.get().responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
assertTrue(TestUtils.compare(item.get(fieldName).toString(), operator.get(), assertedValue.get())); assertTrue(TestUtils.compare(item.get(fieldName).toString(), operator.get(), assertedValue.get()));
}); });
} catch (Exception ex) { } catch (Exception ex) {
@ -925,17 +819,17 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
When("^a default entity container exists for the service root in \"([^\"]*)\"$", (String clientSettingsServiceRoot) -> { When("^a default entity container exists for the service root in \"([^\"]*)\"$", (String clientSettingsServiceRoot) -> {
final String serviceRoot = Settings.resolveParametersString(clientSettingsServiceRoot, settings); final String serviceRoot = Settings.resolveParametersString(clientSettingsServiceRoot, settings);
assertEquals("ERROR: given service root doesn't match the one configured in the Commander", serviceRoot, commander.get().getServiceRoot()); assertEquals("ERROR: given service root doesn't match the one configured in the Commander", serviceRoot, wrapper.get().commander.get().getServiceRoot());
try { try {
ODataRetrieveResponse<Edm> oDataRetrieveResponse = commander.get().getODataRetrieveEdmResponse(); ODataRetrieveResponse<Edm> oDataRetrieveResponse = wrapper.get().commander.get().getODataRetrieveEdmResponse();
responseCode.set(oDataRetrieveResponse.getStatusCode()); wrapper.get().responseCode.set(oDataRetrieveResponse.getStatusCode());
edm.set(oDataRetrieveResponse.getBody()); edm.set(oDataRetrieveResponse.getBody());
assertNotNull("ERROR: could not find default entity container for given service root: " + serviceRoot, edm.get().getEntityContainer()); assertNotNull("ERROR: could not find default entity container for given service root: " + serviceRoot, edm.get().getEntityContainer());
LOG.info("Found Default Entity Container: '" + edm.get().getEntityContainer().getNamespace() + "'"); LOG.info("Found Default Entity Container: '" + edm.get().getEntityContainer().getNamespace() + "'");
} catch (ODataClientErrorException cex) { } catch (ODataClientErrorException cex) {
responseCode.set(cex.getStatusLine().getStatusCode()); wrapper.get().responseCode.set(cex.getStatusLine().getStatusCode());
fail(cex.getMessage()); fail(cex.getMessage());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
@ -947,14 +841,14 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^XML Metadata are requested from the service root in \"([^\"]*)\"$", (String clientSettingsServiceRoot) -> { And("^XML Metadata are requested from the service root in \"([^\"]*)\"$", (String clientSettingsServiceRoot) -> {
final String serviceRoot = Settings.resolveParametersString(clientSettingsServiceRoot, settings); final String serviceRoot = Settings.resolveParametersString(clientSettingsServiceRoot, settings);
assertEquals("ERROR: given service root doesn't match the one configured in the Commander", serviceRoot, commander.get().getServiceRoot()); assertEquals("ERROR: given service root doesn't match the one configured in the Commander", serviceRoot, wrapper.get().commander.get().getServiceRoot());
try { try {
xmlMetadata.set(commander.get().getXMLMetadata()); xmlMetadata.set(wrapper.get().commander.get().getXMLMetadata());
assertNotNull("ERROR: could not find valid XML Metadata for given service root: " + serviceRoot, xmlMetadata.get()); assertNotNull("ERROR: could not find valid XML Metadata for given service root: " + serviceRoot, xmlMetadata.get());
LOG.info("XML Metadata retrieved from: " + serviceRoot); LOG.info("XML Metadata retrieved from: " + serviceRoot);
} catch (ODataClientErrorException cex) { } catch (ODataClientErrorException cex) {
responseCode.set(cex.getStatusLine().getStatusCode()); wrapper.get().responseCode.set(cex.getStatusLine().getStatusCode());
fail(cex.getMessage()); fail(cex.getMessage());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
@ -968,7 +862,7 @@ public class WebAPIServer_1_0_2 implements En {
String resourceName = Settings.resolveParametersString(parameterEndpointResource, settings); String resourceName = Settings.resolveParametersString(parameterEndpointResource, settings);
List<CsdlNavigationProperty> navigationProperties List<CsdlNavigationProperty> navigationProperties
= TestUtils.findNavigationPropertiesForEntityTypeName(getEdmMetadata(commander.get()), getXMLMetadata(commander.get()), resourceName); = TestUtils.findNavigationPropertiesForEntityTypeName(wrapper.get().commander.get().getEdm(), wrapper.get().commander.get().getXMLMetadata(), resourceName);
assertTrue("ERROR: no navigation properties found for the given '" + resourceName + "' resource!", assertTrue("ERROR: no navigation properties found for the given '" + resourceName + "' resource!",
navigationProperties.size() > 0); navigationProperties.size() > 0);
@ -988,7 +882,7 @@ public class WebAPIServer_1_0_2 implements En {
String expandField = Settings.resolveParametersString(parameterExpandField, settings); String expandField = Settings.resolveParametersString(parameterExpandField, settings);
assertFalse("ERROR: no expand field found for " + parameterExpandField, expandField.isEmpty()); assertFalse("ERROR: no expand field found for " + parameterExpandField, expandField.isEmpty());
ClientEntitySet results = commander.get().getClient().getRetrieveRequestFactory().getEntitySetRequest(requestUri.get()).execute().getBody(); ClientEntitySet results = wrapper.get().commander.get().getClient().getRetrieveRequestFactory().getEntitySetRequest(wrapper.get().requestUri.get()).execute().getBody();
LOG.info("Results count is: " + results.getEntities().size()); LOG.info("Results count is: " + results.getEntities().size());
AtomicInteger counter = new AtomicInteger(); AtomicInteger counter = new AtomicInteger();
@ -1061,18 +955,18 @@ public class WebAPIServer_1_0_2 implements En {
LOG.info("Request Id: " + parameterRequestId); LOG.info("Request Id: " + parameterRequestId);
try { try {
requestUri.set(prepareUri.apply(uriString)); wrapper.get().requestUri.set(prepareUri(uriString));
clientEntitySetRequest.set(commander.get().getClient().getRetrieveRequestFactory().getEntitySetRequest(requestUri.get())); wrapper.get().clientEntitySetRequest.set(wrapper.get().commander.get().getClient().getRetrieveRequestFactory().getEntitySetRequest(wrapper.get().requestUri.get()));
LOG.info("OData Client Request being made to: " + uriString); LOG.info("OData Client Request being made to: " + uriString);
clientEntitySetResponse.set(clientEntitySetRequest.get().execute()); wrapper.get().clientEntitySetResponse.set(wrapper.get().clientEntitySetRequest.get().execute());
responseCode.set(clientEntitySetResponse.get().getStatusCode()); wrapper.get().responseCode.set(wrapper.get().clientEntitySetResponse.get().getStatusCode());
ResWrap<EntityCollection> coll = (commander.get().getClient().getDeserializer(ContentType.JSON).toEntitySet(clientEntitySetResponse.get().getRawResponse())); ResWrap<EntityCollection> coll = (wrapper.get().commander.get().getClient().getDeserializer(ContentType.JSON).toEntitySet(wrapper.get().clientEntitySetResponse.get().getRawResponse()));
clientEntitySet.set(commander.get().getClient().getBinder().getODataEntitySet(coll)); wrapper.get().clientEntitySet.set(wrapper.get().commander.get().getClient().getBinder().getODataEntitySet(coll));
} catch (ODataClientErrorException cex) { } catch (ODataClientErrorException cex) {
oDataClientErrorException.set(cex); wrapper.get().oDataClientErrorException.set(cex);
responseCode.set(cex.getStatusLine().getStatusCode()); wrapper.get().responseCode.set(cex.getStatusLine().getStatusCode());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.toString()); fail(ex.toString());
} }
@ -1088,18 +982,18 @@ public class WebAPIServer_1_0_2 implements En {
Integer fieldValue = Integer.parseInt(Settings.resolveParametersString(parameterFieldValue, settings)); Integer fieldValue = Integer.parseInt(Settings.resolveParametersString(parameterFieldValue, settings));
assertNotNull(fieldValue); assertNotNull(fieldValue);
clientEntitySet.get().getEntities().forEach(entity -> { wrapper.get().clientEntitySet.get().getEntities().forEach(entity -> {
assertTrue(compare((Integer)entity.getProperty(fieldName).getValue().asPrimitive().toValue(), op, fieldValue)); assertTrue(compare((Integer)entity.getProperty(fieldName).getValue().asPrimitive().toValue(), op, fieldValue));
}); });
}); });
And("^the OData client response has client entity set data$", () -> { And("^the OData client response has client entity set data$", () -> {
assertNotNull("ERROR: no entity collection returned in response!", clientEntitySet.get()); assertNotNull("ERROR: no entity collection returned in response!", wrapper.get().clientEntitySet.get());
assertTrue("ERROR: no results returned!", clientEntitySet.get().getCount() > 0); assertTrue("ERROR: no results returned!", wrapper.get().clientEntitySet.get().getCount() > 0);
if (showResponses) { if (showResponses) {
clientEntitySet.get().getEntities().forEach(entity -> { wrapper.get().clientEntitySet.get().getEntities().forEach(entity -> {
LOG.info("Entity Type is: " + entity.getTypeName()); LOG.info("Entity Type is: " + entity.getTypeName());
entity.getProperties().forEach(property -> LOG.info("\tProperty: " + property.toString())); entity.getProperties().forEach(property -> LOG.info("\tProperty: " + property.toString()));
}); });

52
src/main/java/org/reso/commander/Commander.java
View File

@ -46,20 +46,20 @@ public class Commander {
public static final Integer DEFAULT_PAGE_SIZE = 10; public static final Integer DEFAULT_PAGE_SIZE = 10;
public static final Integer DEFAULT_PAGE_LIMIT = 1; public static final Integer DEFAULT_PAGE_LIMIT = 1;
private static final Logger LOG = LogManager.getLogger(Commander.class); private static final Logger LOG = LogManager.getLogger(Commander.class);
String bearerToken; private static String bearerToken;
String clientId; private static String clientId;
String clientSecret; private static String clientSecret;
String authorizationUri; private static String authorizationUri;
String tokenUri; private static String tokenUri;
String redirectUri; private static String redirectUri;
String scope; private static String scope;
boolean isTokenClient, isOAuthClient; private static boolean isTokenClient, isOAuthClient;
//one instance of client per Commander. See Builder //one instance of client per Commander. See Builder
private ODataClient client; private static ODataClient client;
private boolean useEdmEnabledClient; private static boolean useEdmEnabledClient;
private String serviceRoot; private static String serviceRoot;
private Edm edm; private static Edm edm;
private XMLMetadata xmlMetadata; private static XMLMetadata xmlMetadata;
//private constructor for internal use, use Builder to construct instances //private constructor for internal use, use Builder to construct instances
private Commander() { private Commander() {
@ -628,24 +628,24 @@ public class Commander {
public Commander build() { public Commander build() {
Commander commander = new Commander(); Commander commander = new Commander();
commander.serviceRoot = this.serviceRoot; Commander.serviceRoot = this.serviceRoot;
commander.bearerToken = this.bearerToken; Commander.bearerToken = this.bearerToken;
commander.clientId = this.clientId; Commander.clientId = this.clientId;
commander.clientSecret = this.clientSecret; Commander.clientSecret = this.clientSecret;
commander.authorizationUri = this.authorizationUri; Commander.authorizationUri = this.authorizationUri;
commander.tokenUri = this.tokenUri; Commander.tokenUri = this.tokenUri;
commander.redirectUri = this.redirectUri; Commander.redirectUri = this.redirectUri;
commander.scope = this.scope; Commander.scope = this.scope;
commander.useEdmEnabledClient = this.useEdmEnabledClient; Commander.useEdmEnabledClient = this.useEdmEnabledClient;
//items required for OAuth client //items required for OAuth client
commander.isOAuthClient = isOAuthClient =
clientId != null && clientId.length() > 0 clientId != null && clientId.length() > 0
&& clientSecret != null && clientSecret.length() > 0 && clientSecret != null && clientSecret.length() > 0
&& tokenUri != null && tokenUri.length() > 0; && tokenUri != null && tokenUri.length() > 0;
//items required for token client //items required for token client
commander.isTokenClient = bearerToken != null && bearerToken.length() > 0; isTokenClient = bearerToken != null && bearerToken.length() > 0;
LOG.debug("\nUsing EdmEnabledClient: " + useEdmEnabledClient + "..."); LOG.debug("\nUsing EdmEnabledClient: " + useEdmEnabledClient + "...");
if (useEdmEnabledClient) { if (useEdmEnabledClient) {
@ -654,9 +654,9 @@ public class Commander {
commander.setClient(ODataClientFactory.getClient()); commander.setClient(ODataClientFactory.getClient());
} }
if (commander.isOAuthClient) { if (isOAuthClient) {
commander.getClient().getConfiguration().setHttpClientFactory(new OAuth2HttpClientFactory(clientId, clientSecret, tokenUri, scope)); commander.getClient().getConfiguration().setHttpClientFactory(new OAuth2HttpClientFactory(clientId, clientSecret, tokenUri, scope));
} else if (commander.isTokenClient) { } else if (isTokenClient) {
commander.getClient().getConfiguration().setHttpClientFactory(new TokenHttpClientFactory(bearerToken)); commander.getClient().getConfiguration().setHttpClientFactory(new TokenHttpClientFactory(bearerToken));
} }
return commander; return commander;

108
src/main/java/org/reso/commander/TestUtils.java
View File

@ -2,9 +2,16 @@ package org.reso.commander;
import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.Header; import org.apache.http.Header;
import org.apache.http.HttpStatus;
import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.Logger;
import org.apache.olingo.client.api.communication.ODataClientErrorException;
import org.apache.olingo.client.api.communication.ODataServerErrorException;
import org.apache.olingo.client.api.communication.request.retrieve.ODataEntitySetRequest;
import org.apache.olingo.client.api.communication.request.retrieve.ODataRawRequest;
import org.apache.olingo.client.api.communication.response.ODataRawResponse; import org.apache.olingo.client.api.communication.response.ODataRawResponse;
import org.apache.olingo.client.api.communication.response.ODataRetrieveResponse;
import org.apache.olingo.client.api.domain.ClientEntitySet;
import org.apache.olingo.client.api.edm.xml.XMLMetadata; import org.apache.olingo.client.api.edm.xml.XMLMetadata;
import org.apache.olingo.commons.api.edm.Edm; import org.apache.olingo.commons.api.edm.Edm;
import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException; import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException;
@ -15,12 +22,14 @@ import org.apache.olingo.commons.api.edm.provider.CsdlSchema;
import org.apache.olingo.commons.core.edm.primitivetype.EdmDate; import org.apache.olingo.commons.core.edm.primitivetype.EdmDate;
import org.apache.olingo.commons.core.edm.primitivetype.EdmDateTimeOffset; import org.apache.olingo.commons.core.edm.primitivetype.EdmDateTimeOffset;
import org.apache.olingo.commons.core.edm.primitivetype.EdmTimeOfDay; import org.apache.olingo.commons.core.edm.primitivetype.EdmTimeOfDay;
import org.reso.models.Request;
import org.reso.models.Settings; import org.reso.models.Settings;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.net.URI;
import java.sql.Time; import java.sql.Time;
import java.sql.Timestamp; import java.sql.Timestamp;
import java.time.LocalDate; import java.time.LocalDate;
@ -32,14 +41,109 @@ import java.util.List;
import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.atomic.AtomicReference;
import static io.restassured.path.json.JsonPath.from; import static io.restassured.path.json.JsonPath.from;
import static org.junit.Assert.assertNotNull; import static org.junit.Assert.*;
import static org.junit.Assert.assertTrue;
public final class TestUtils { public final class TestUtils {
public static final String JSON_VALUE_PATH = "value"; public static final String JSON_VALUE_PATH = "value";
public static final String HEADER_ODATA_VERSION = "OData-Version"; public static final String HEADER_ODATA_VERSION = "OData-Version";
private static final Logger LOG = LogManager.getLogger(TestUtils.class); private static final Logger LOG = LogManager.getLogger(TestUtils.class);
/**
* Encapsulates Commander Requests and Responses during runtime
*/
public static final class CommanderWrapper {
//TODO: Wrap in Commander Request/Response object
public AtomicReference<Commander> commander = new AtomicReference<>();
public AtomicReference<ODataRawResponse> oDataRawResponse = new AtomicReference<>();
public AtomicReference<Request> request = new AtomicReference<>();
public AtomicReference<URI> requestUri = new AtomicReference<>();
public AtomicReference<Integer> responseCode = new AtomicReference<>();
public AtomicReference<String> responseData = new AtomicReference<>();
public AtomicReference<String> initialResponseData = new AtomicReference<>(); //used if two result sets need to be compared
public AtomicReference<ODataRawRequest> rawRequest = new AtomicReference<>();
public AtomicReference<ODataClientErrorException> oDataClientErrorException = new AtomicReference<>();
public AtomicReference<ODataServerErrorException> oDataServerErrorException = new AtomicReference<>();
public AtomicReference<String> serverODataHeaderVersion = new AtomicReference<>();
public AtomicReference<Boolean> testAppliesToServerODataHeaderVersion = new AtomicReference<>();
public AtomicReference<ODataEntitySetRequest<ClientEntitySet>> clientEntitySetRequest = new AtomicReference<>();
public AtomicReference<ODataRetrieveResponse<ClientEntitySet>> clientEntitySetResponse = new AtomicReference<>();
public AtomicReference<ClientEntitySet> clientEntitySet = new AtomicReference<>();
}
/**
* Creates a Runnable to reset the state of the given CommanderWrapper
* @param wrapper the CommanderWrapper to reset
* @return a Runnable that can be called
*/
public static Runnable buildWrapperResetRunnable(final CommanderWrapper wrapper){
return new Runnable() {
@Override
public void run() {
wrapper.oDataRawResponse.set(null);
wrapper.request.set(null);
wrapper.responseCode.set(null);
wrapper.responseData.set(null);
wrapper.initialResponseData.set(null);
wrapper.rawRequest.set(null);
wrapper.oDataClientErrorException.set(null);
wrapper.oDataServerErrorException.set(null);
wrapper.serverODataHeaderVersion.set(null);
wrapper.testAppliesToServerODataHeaderVersion.set(false);
}
};
}
/**
* Used to prepare URIs given that the input queryStrings can sometimes contain special characters
* that need to be ensured that they be processed.
* @param queryString the queryString to prepare
* @return the prepared URI with special characters in the queryString processed.
*/
public static URI prepareUri(final String queryString) {
/* replace spaces with %20 */
return URI.create(
queryString.replace(" ", "%20")
/* add other handlers here */
);
}
/**
* Executes HTTP GET request and sets the expected local variables in the given CommanderWrapper
* Handles exceptions and sets response codes as well.
* @param uri the URI to make requests to
* @param wrapper the CommanderWrapper to execute the requests in
* @return a CommanderWrapper containing the final state of the request.
*/
public static CommanderWrapper executeGetRequest(final URI uri, final CommanderWrapper wrapper) {
LOG.info("Request URI: " + uri);
try {
wrapper.rawRequest.set(wrapper.commander.get().getClient().getRetrieveRequestFactory().getRawRequest(uri));
wrapper.oDataRawResponse.set(wrapper.rawRequest.get().execute());
wrapper.responseData.set(TestUtils.convertInputStreamToString(wrapper.oDataRawResponse.get().getRawResponse()));
wrapper.serverODataHeaderVersion.set(wrapper.oDataRawResponse.get().getHeader(HEADER_ODATA_VERSION).toString());
wrapper.responseCode.set(wrapper.oDataRawResponse.get().getStatusCode());
LOG.info("Request succeeded..." + wrapper.responseData.get().getBytes().length + " bytes received.");
} catch (ODataClientErrorException cex) {
LOG.debug("ODataClientErrorException caught. Check tests for asserted conditions...");
wrapper.oDataClientErrorException.set(cex);
wrapper.serverODataHeaderVersion.set(TestUtils.getHeaderData(HEADER_ODATA_VERSION, cex.getHeaderInfo()));
wrapper.responseCode.set(cex.getStatusLine().getStatusCode());
} catch (ODataServerErrorException ode) {
LOG.debug("ODataServerErrorException thrown in executeGetRequest. Check tests for asserted conditions...");
//TODO: look for better ways to do this in Olingo or open PR
if (ode.getMessage().contains(Integer.toString(HttpStatus.SC_NOT_IMPLEMENTED))) {
wrapper.responseCode.set(HttpStatus.SC_NOT_IMPLEMENTED);
}
wrapper.oDataServerErrorException.set(ode);
} catch (Exception ex) {
fail("ERROR: unhandled Exception in executeGetRequest()!\n" + ex.toString());
//throw ex;
}
return wrapper;
}
/** /**
* Finds the default entity container for the given configuration. * Finds the default entity container for the given configuration.
* *

2
src/main/resources/log4j2.xml
View File

@ -3,7 +3,7 @@
<Properties> <Properties>
<Property name="PATTERN">[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%level] [%c{1}] - %msg%n</Property> <Property name="PATTERN">[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%level] [%c{1}] - %msg%n</Property>
<Property name="SIMPLE_PATTERN">%msg%n</Property> <Property name="SIMPLE_PATTERN">%msg%n</Property>
<Property name="LOGFILE_NAME">./commander.log</Property> <Property name="LOGFILE_NAME">./commander.debug.log</Property>
</Properties> </Properties>
<Appenders> <Appenders>
<Console name="Console" target="SYSTEM_OUT"> <Console name="Console" target="SYSTEM_OUT">