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

Added additional tests for Well Known Resources as well as Web API Standard Names requirements. Bumped generic.resoscript

This commit is contained in:
Joshua Darnell 2020-03-15 13:12:01 -07:00
parent 1c17926d91
commit a3bfa89576
4 changed files with 111 additions and 47 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.

35
generic.resoscript
View File

@ -66,7 +66,7 @@
############################################################--> ############################################################-->
<!-- The current version of this RESOScript --> <!-- The current version of this RESOScript -->
<RESOScriptVersion>1.0.5</RESOScriptVersion> <RESOScriptVersion>1.0.6</RESOScriptVersion>
<!-- <!--
@ -89,12 +89,13 @@
* https://www.oauth.com/oauth2-servers/access-tokens/authorization-code-request/ * https://www.oauth.com/oauth2-servers/access-tokens/authorization-code-request/
* https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ * https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
--> -->
<AuthenticationType>authorization_code</AuthenticationType>
<!-- Grant Type: authorization_code--> <!-- Grant Type: authorization_code -->
<AuthenticationType>authorization_code</AuthenticationType>
<BearerToken><!-- REQUIRED: Your BearerToken goes here if using Access Tokens --></BearerToken> <BearerToken><!-- REQUIRED: Your BearerToken goes here if using Access Tokens --></BearerToken>
<!-- Grant Type: client_credentials --> <!-- Grant Type: client_credentials -->
<!-- <AuthenticationType>client_credentials</AuthenticationType>-->
<ClientIdentification><!-- REQUIRED: Your client_id value if using Client Credentials--></ClientIdentification> <ClientIdentification><!-- REQUIRED: Your client_id value if using Client Credentials--></ClientIdentification>
<ClientSecret><!-- REQUIRED: Your client_secret value if using Client Credentials--></ClientSecret> <ClientSecret><!-- REQUIRED: Your client_secret value if using Client Credentials--></ClientSecret>
<TokenURI><!-- REQUIRED: Your token endpoint URI--></TokenURI> <TokenURI><!-- REQUIRED: Your token endpoint URI--></TokenURI>
@ -110,7 +111,9 @@
############################################################ ############################################################
Parameters Section - add your testing variables here Parameters Section - add your testing variables here
############################################################--> ############################################################-->
<Parameters> <Parameters>
<!-- <!--
############################################################ ############################################################
Service Configuration Service Configuration
@ -178,6 +181,7 @@
<Parameter Name="ConcatFieldTwoValue" Value="YOUR TwoValue GOES HERE" /> <Parameter Name="ConcatFieldTwoValue" Value="YOUR TwoValue GOES HERE" />
<Parameter Name="ConcatFieldBothValue" Value="Your 'OneValue: TwoValue' GOES HERE" /> <!-- format 'OneValue: TwoValue' --> <Parameter Name="ConcatFieldBothValue" Value="Your 'OneValue: TwoValue' GOES HERE" /> <!-- format 'OneValue: TwoValue' -->
<!-- <!--
############################################################ ############################################################
Sample Field Values Sample Field Values
@ -220,6 +224,7 @@
<Parameter Name="GeoSpatialDistanceValue" Value="1000" /> <Parameter Name="GeoSpatialDistanceValue" Value="1000" />
<Parameter Name="SRID" Value="0" /> <Parameter Name="SRID" Value="0" />
<!-- <!--
############################################################ ############################################################
HTTP Code Testing HTTP Code Testing
@ -240,6 +245,7 @@
<!-- REQUIRED: 501 Not Implemented - Set this to an OData query that hasn't been implemented on your server --> <!-- REQUIRED: 501 Not Implemented - Set this to an OData query that hasn't been implemented on your server -->
<Parameter Name="501NotImplemented" Value="*Parameter_EndpointResource*?$search=red OR blue" /> <Parameter Name="501NotImplemented" Value="*Parameter_EndpointResource*?$search=red OR blue" />
<!-- <!--
############################################################ ############################################################
Constants and Computed Values - Do Not Change Constants and Computed Values - Do Not Change
@ -252,11 +258,23 @@
<!-- New Values for WS103 Testing --> <!-- New Values for WS103 Testing -->
<Parameter Name="CastFieldType" Value="Edm.String" /> <Parameter Name="CastFieldType" Value="Edm.String" />
<!-- Computed OData $select list --> <!-- Required resource lists for Standard Resource Names requirement -->
<Parameter Name="WebAPI102_RequiredResourceList" Value="Property,Member,Office,Media" />
<!-- Allowed Resources - Update to 1.8 once it's approved -->
<Parameter Name="DD17_WellKnownResourceList" Value="Property,Member,Office,Contacts,ContactListings,HistoryTransactional,InternetTracking,Media,OpenHouse,OUID,Prospecting,Queue,Rules,SavedSearch,Showing,Teams" />
<!-- Gold Select List -->
<Parameter Name="GoldSelectList"
Value="*Parameter_KeyOrKeyNumericField*,*Parameter_FilterIntegerField*,*Parameter_FilterHasField*,*Parameter_DateField*,*Parameter_TimestampField*,*Parameter_GeoSpatialField*,*Parameter_StringField" />
<!-- Platinum Select List -->
<Parameter Name="PlatinumSelectList"
Value="*Parameter_KeyOrKeyNumericField*,*Parameter_FilterIntegerField*,*Parameter_FilterHasField*,*Parameter_DateField*,*Parameter_TimestampField*,*Parameter_GeoSpatialField*,*Parameter_StringField" />
<!-- Computed OData $select list --> <!-- Computed OData $select list -->
<Parameter Name="SelectList" <Parameter Name="SelectList"
Value="*Parameter_KeyOrKeyNumericField*,*Parameter_FilterIntegerField*,*Parameter_FilterHasField*,*Parameter_DateField*,*Parameter_TimestampField*,*Parameter_GeoSpatialField*,*Parameter_StringField" /> Value="*Parameter_PlatinumSelectList*" />
<!-- Computed Enumeration Values - do not change --> <!-- Computed Enumeration Values - do not change -->
<Parameter Name="SingleValueLookupValue" Value="*Parameter_SingleValueLookupNamespace*'*Parameter_SingleLookupValue*'" /> <Parameter Name="SingleValueLookupValue" Value="*Parameter_SingleValueLookupNamespace*'*Parameter_SingleLookupValue*'" />
@ -266,6 +284,7 @@
<Parameter Name="OptionalMetadataFormatParameter" Value="?$format=application/xml" /> <Parameter Name="OptionalMetadataFormatParameter" Value="?$format=application/xml" />
<!-- <!--
############################################################ ############################################################
Optional Parameters. You should not need these Optional Parameters. You should not need these
@ -277,6 +296,12 @@
</Parameters> </Parameters>
<!--
############################################################
Requests Section - Queries used during testing,
DO NOT CHANGE
############################################################-->
<Requests> <Requests>
<Request <Request

4
src/main/java/org/reso/certification/features/web-api/web-api-server-1.0.2.feature
View File

@ -6,8 +6,6 @@ Feature: Web API Server 1.0.2 Certification
And Client Settings and Parameters were read from the file And Client Settings and Parameters were read from the file
And an OData client was successfully created from the given RESOScript And an OData client was successfully created from the given RESOScript
####################################### #######################################
# Core Tests # Core Tests
####################################### #######################################
@ -21,6 +19,8 @@ Feature: Web API Server 1.0.2 Certification
And a default entity container exists for the service root in "ClientSettings_WebAPIURI" And a default entity container exists for the service root in "ClientSettings_WebAPIURI"
And the Edm metadata returned by the server are valid And the Edm metadata returned by the server are valid
And the metadata contains the "Parameter_EndpointResource" resource And the metadata contains the "Parameter_EndpointResource" resource
And the given "Parameter_EndpointResource" resource exists within "Parameter_DD17_WellKnownResourceList"
And the metadata contains at least one resource from "Parameter_WebAPI102_RequiredResourceList"
And resource metadata for "Parameter_EndpointResource" contains the fields in "Parameter_SelectList" And resource metadata for "Parameter_EndpointResource" contains the fields in "Parameter_SelectList"
@REQ-WA103-END2 @core @2.4.1 @core-endorsement @datasystem @REQ-WA103-END2 @core @2.4.1 @core-endorsement @datasystem

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

@ -46,6 +46,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 Settings settings; private static Settings settings;
//container to hold retrieved metadata for later comparisons //container to hold retrieved metadata for later comparisons
@ -145,10 +147,10 @@ public class WebAPIServer_1_0_2 implements En {
responseCode.set(HttpStatus.SC_NOT_IMPLEMENTED); responseCode.set(HttpStatus.SC_NOT_IMPLEMENTED);
return null; return null;
} }
fail(sex.toString()); fail("ERROR: unhandled ODataServerErrorException in executeGetRequest()!\n" + sex.toString());
throw sex; throw sex;
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.toString()); fail("ERROR: unhandled Exception in executeGetRequest()!\n" + ex.toString());
throw ex; throw ex;
} }
return null; return null;
@ -227,9 +229,9 @@ public class WebAPIServer_1_0_2 implements En {
try { try {
boolean isValid = commander.get().validateMetadata(edm.get()); boolean isValid = commander.get().validateMetadata(edm.get());
LOG.info("Edm Metadata is " + (isValid ? "valid" : "invalid") + "!"); LOG.info("Edm Metadata is " + (isValid ? "valid" : "invalid") + "!");
assertTrue(isValid); assertTrue("Edm Metadata at the given service root is not valid! " + serviceRoot, isValid);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail("ERROR: could not validate Edm Metadata!\n" + ex.getMessage());
} }
}); });
@ -246,9 +248,9 @@ public class WebAPIServer_1_0_2 implements En {
boolean isValid = commander.get().validateMetadata(xmlMetadata.get()); boolean isValid = commander.get().validateMetadata(xmlMetadata.get());
LOG.info("XML Metadata is " + (isValid ? "valid" : "invalid") + "!"); LOG.info("XML Metadata is " + (isValid ? "valid" : "invalid") + "!");
assertTrue(isValid); assertTrue("ERROR: XML Metadata at the given service root is not valid! " + serviceRoot, isValid);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail("ERROR: could not validate XML Metadata!\n" + ex.getMessage());
} }
}); });
@ -273,27 +275,24 @@ public class WebAPIServer_1_0_2 implements En {
LOG.info("Resolved value is: " + resolvedValue); LOG.info("Resolved value is: " + resolvedValue);
if (resolvedValue.getClass().isInstance(Integer.class)) { if (resolvedValue.getClass().isInstance(Integer.class)) {
assertEquals(Integer.parseInt(expectedValueAsString), resolvedValue); assertEquals("ERROR: the given Integer value is not equal to the value found on the server!", Integer.parseInt(expectedValueAsString), resolvedValue);
} else { } else {
assertEquals(expectedValueAsString, resolvedValue.toString()); assertEquals("ERROR: the given String value is not equal to the value found on the server!", expectedValueAsString, resolvedValue.toString());
} }
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
}); });
/* /*
* REQ-WA103-QR3 - $select * REQ-WA103-QR3 - $select
*/ */
And("^data are present in fields contained within \"([^\"]*)\"$", (String parameterSelectList) -> { And("^data are present in fields contained within \"([^\"]*)\"$", (String parameterSelectList) -> {
try { try {
AtomicInteger numFieldsWithData = new AtomicInteger(); AtomicInteger numFieldsWithData = new AtomicInteger();
List<String> fieldList = new ArrayList<>(Arrays.asList(Settings.resolveParametersString(parameterSelectList, settings).split(","))); List<String> fieldList = new ArrayList<>(Arrays.asList(Settings.resolveParametersString(parameterSelectList, settings).split(FIELD_SEPARATOR)));
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(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).forEach(item -> {
if (item != null) { if (item != null) {
@ -314,7 +313,7 @@ public class WebAPIServer_1_0_2 implements En {
} else { } else {
LOG.info("Percent Fill: 0% - no fields with data found!"); LOG.info("Percent Fill: 0% - no fields with data found!");
} }
assertTrue(numFieldsWithData.get() > 0); assertTrue("ERROR: no fields with data could be found from the given $select list!",numFieldsWithData.get() > 0);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -333,7 +332,8 @@ public class WebAPIServer_1_0_2 implements En {
int topCount = Integer.parseInt(Settings.resolveParametersString(parameterTopCount, settings)); int topCount = Integer.parseInt(Settings.resolveParametersString(parameterTopCount, settings));
LOG.info("Number of values returned: " + numResults.get() + ", top count is: " + topCount); LOG.info("Number of values returned: " + numResults.get() + ", top count is: " + topCount);
assertTrue(numResults.get() > 0 && numResults.get() <= topCount); assertTrue("ERROR: results count must be greater than zero and less than " + parameterTopCount + "!",
numResults.get() > 0 && numResults.get() <= topCount);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -354,7 +354,6 @@ public class WebAPIServer_1_0_2 implements En {
//TODO: convert to OData filter factory //TODO: convert to OData filter factory
requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequests().get(requirementId), settings).getUrl() + "&$skip=" + skipCount)); requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequests().get(requirementId), settings).getUrl() + "&$skip=" + skipCount));
executeGetRequest.apply(requestUri.get()); executeGetRequest.apply(requestUri.get());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
@ -369,17 +368,13 @@ public class WebAPIServer_1_0_2 implements En {
Set<POJONode> combined = new LinkedHashSet<>(l1); Set<POJONode> combined = new LinkedHashSet<>(l1);
new POJONode(l1); new POJONode(l1);
if (showResponses) { if (showResponses) LOG.info("Response Page 1: " + l1);
LOG.info("Response Page 1: " + l1);
}
combined.addAll(l2); combined.addAll(l2);
new POJONode(l2); new POJONode(l2);
if (showResponses) { if (showResponses) LOG.info("Response Page 2: " + l2);
LOG.info("Response Page 2: " + l2);
}
assertEquals(combinedCount, combined.size()); assertEquals("ERROR: repeated data found, expected unique data on each page!", combinedCount, combined.size());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -397,7 +392,7 @@ public class WebAPIServer_1_0_2 implements En {
//reset local state each time a get request is run //reset local state each time a get request is run
resetRequestState.run(); resetRequestState.run();
LOG.info("Running test with RequirementId: " + requirementId); LOG.info("RequirementId: " + requirementId);
requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequests().get(requirementId), settings).getUrl())); requestUri.set(Commander.prepareURI(Settings.resolveParameters(settings.getRequests().get(requirementId), settings).getUrl()));
executeGetRequest.apply(requestUri.get()); executeGetRequest.apply(requestUri.get());
} catch (Exception ex) { } catch (Exception ex) {
@ -412,7 +407,9 @@ public class WebAPIServer_1_0_2 implements En {
try { try {
LOG.info("Asserted Response Code: " + assertedResponseCode + ", Server Response Code: " + responseCode); LOG.info("Asserted Response Code: " + assertedResponseCode + ", Server Response Code: " + responseCode);
assertTrue(responseCode.get() > 0 && assertedResponseCode > 0); assertTrue(responseCode.get() > 0 && assertedResponseCode > 0);
assertEquals(assertedResponseCode.intValue(), responseCode.get().intValue());
assertEquals("ERROR: asserted response code does not match the one returned from the server!",
assertedResponseCode.intValue(), responseCode.get().intValue());
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -423,7 +420,7 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the response is valid XML$", () -> { And("^the response is valid XML$", () -> {
try { try {
assertTrue(Commander.validateXML(responseData.get())); assertTrue("ERROR: invalid XML response!", Commander.validateXML(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());
@ -435,12 +432,10 @@ public class WebAPIServer_1_0_2 implements En {
*/ */
And("^the response is valid JSON$", () -> { And("^the response is valid JSON$", () -> {
try { try {
assertTrue(TestUtils.isValidJson(responseData.get())); assertTrue("ERROR: invalid JSON response!", TestUtils.isValidJson(responseData.get()));
LOG.info("Response is valid JSON!"); LOG.info("Response is valid JSON!");
if (showResponses) { if (showResponses) LOG.info("Response: " + new ObjectMapper().readTree(responseData.get()).toPrettyString());
LOG.info("Response: " + new ObjectMapper().readTree(responseData.get()).toPrettyString());
}
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -460,10 +455,11 @@ public class WebAPIServer_1_0_2 implements En {
if (versionsMatch) { if (versionsMatch) {
LOG.info("Asserted Response Code: " + assertedHttpResponseCode + ", Response code: " + responseCode.get()); LOG.info("Asserted Response Code: " + assertedHttpResponseCode + ", Response code: " + responseCode.get());
assertTrue(responseCodesMatch); assertTrue("ERROR: asserted response code does not match the one returned from the server!", responseCodesMatch);
} }
} catch (Exception ex) { } catch (Exception ex) {
//DEBUG only in this case as we are expecting an error and don't want to throw or print it //Don't fail tests like in other cases because get requests may generate exceptions that we want to
//continue past and test. Log exceptions to DEBUG instead.
LOG.debug(ex.toString()); LOG.debug(ex.toString());
} }
}); });
@ -503,7 +499,7 @@ public class WebAPIServer_1_0_2 implements En {
try { try {
int count = from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size(); int count = from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size();
LOG.info("Results count is: " + count); LOG.info("Results count is: " + count);
assertTrue(count > 0); assertTrue("ERROR: no results returned from the server!", count > 0);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -518,7 +514,7 @@ public class WebAPIServer_1_0_2 implements En {
boolean isPresent = from(responseData.get()).get() != null; boolean isPresent = from(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(isPresent); assertTrue("ERROR: singleton results not found for '" + value + "'!", isPresent);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -532,7 +528,7 @@ public class WebAPIServer_1_0_2 implements En {
int count = from(responseData.get()).getList(JSON_VALUE_PATH, HashMap.class).size(), int count = from(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(count <= limit); assertTrue("ERROR: number of results exceeds that specified in '" + limitField + "'!", count <= limit);
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.getMessage()); fail(ex.getMessage());
} }
@ -600,7 +596,6 @@ public class WebAPIServer_1_0_2 implements En {
assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get())); assertTrue(TestUtils.compare(fieldValue.get(), op, assertedValue.get()));
} catch (Exception ex) { } catch (Exception ex) {
fail(ex.toString()); fail(ex.toString());
} }
}); });
} catch (Exception ex) { } catch (Exception ex) {
@ -745,6 +740,9 @@ public class WebAPIServer_1_0_2 implements En {
} }
}); });
/*
* Date Field comparisons
*/
And("^\"([^\"]*)\" data in Date Field \"([^\"]*)\" \"([^\"]*)\" \"([^\"]*)\"$", (String stringDatePart, String parameterFieldName, String op, String parameterAssertedValue) -> { And("^\"([^\"]*)\" data in Date Field \"([^\"]*)\" \"([^\"]*)\" \"([^\"]*)\"$", (String stringDatePart, String parameterFieldName, String op, String parameterAssertedValue) -> {
String fieldName = Settings.resolveParametersString(parameterFieldName, settings); String fieldName = Settings.resolveParametersString(parameterFieldName, settings);
AtomicReference<Integer> fieldValue = new AtomicReference<>(); AtomicReference<Integer> fieldValue = new AtomicReference<>();
@ -819,7 +817,6 @@ public class WebAPIServer_1_0_2 implements En {
}); });
//===============================\\ //===============================\\
// Metadata validation methods \\ // Metadata validation methods \\
//===============================\\ //===============================\\
@ -845,10 +842,10 @@ public class WebAPIServer_1_0_2 implements En {
}); });
/* /*
* * Ensures that the server metadata for the given resource in parameterResourceName contains
* all of the fields in the given parameterSelectList.
*/ */
And("^resource metadata for \"([^\"]*)\" contains the fields in \"([^\"]*)\"$", (String parameterResourceName, String parameterSelectList) -> { And("^resource metadata for \"([^\"]*)\" contains the fields in \"([^\"]*)\"$", (String parameterResourceName, String parameterSelectList) -> {
final String FIELD_SEPARATOR = ",";
final String selectList = Settings.resolveParametersString(parameterSelectList, settings); final String selectList = Settings.resolveParametersString(parameterSelectList, settings);
try { try {
@ -871,6 +868,10 @@ public class WebAPIServer_1_0_2 implements En {
} }
}); });
/*
* Finds default Edm entity container at the given Service Root.
* Note that this assumes the server can process the Accept application/xml header!
*/
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, commander.get().getServiceRoot());
@ -890,6 +891,9 @@ public class WebAPIServer_1_0_2 implements En {
} }
}); });
/*
* XML Metadata getter
*/
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, commander.get().getServiceRoot());
@ -906,7 +910,6 @@ public class WebAPIServer_1_0_2 implements En {
} }
}); });
/* /*
* Tests whether a navigation property can be found in the given resource name. * Tests whether a navigation property can be found in the given resource name.
*/ */
@ -951,7 +954,6 @@ public class WebAPIServer_1_0_2 implements En {
assertNotNull("ERROR: data type could not be found for " + clientProperty.getName(), clientProperty.getValue().getTypeName()); assertNotNull("ERROR: data type could not be found for " + clientProperty.getName(), clientProperty.getValue().getTypeName());
}); });
}); });
}); });
/* /*
@ -962,5 +964,42 @@ public class WebAPIServer_1_0_2 implements En {
//TODO: this depends on either finding the appropriate navigation property for a given relationship, or having the Expanded resource name //TODO: this depends on either finding the appropriate navigation property for a given relationship, or having the Expanded resource name
}); });
/*
* Checks the Standard Resources requirement from Section 2.6 of the Web API specification
*/
And("^the metadata contains at least one resource from \"([^\"]*)\"$", (String parameterRequiredResourceList) -> {
String requiredResourceString = Settings.resolveParametersString(parameterRequiredResourceList, settings).replace(" ", "");
List<String> requiredResources = Arrays.asList(requiredResourceString.split(","));
LOG.info("Searching the default entity container for one of the following Standard Resources: " + requiredResourceString.replace(FIELD_SEPARATOR, PRETTY_FIELD_SEPARATOR));
AtomicBoolean found = new AtomicBoolean(false);
requiredResources.forEach(requiredResource -> {
if (!found.get()) found.set(found.get() || edm.get().getEntityContainer().getEntitySet(requiredResource) != null);
});
assertTrue("ERROR: could not find one of the following Standard Resource Names in the default entity container: " + requiredResourceString.replace(FIELD_SEPARATOR, PRETTY_FIELD_SEPARATOR),
found.get());
LOG.info("Standard Resource Names requirement met!");
});
/*
* Checks that the resource in Parameter_EndpointResource is within the allowed resources for the
* latest version of the Data Dictionary, currently 1.7.
*/
And("^the given \"([^\"]*)\" resource exists within \"([^\"]*)\"$", (String parameterResourceName, String parameterResourceList) -> {
String resourceName = Settings.resolveParametersString(parameterResourceName, settings),
allowedResourceString = Settings.resolveParametersString(parameterResourceList, settings).replace(" ", "");
List<String> allowedResources = new ArrayList<>(Arrays.asList(allowedResourceString.split(FIELD_SEPARATOR)));
LOG.info("Resource Name: " + resourceName);
LOG.info("Allowed Resources: " + allowedResourceString.replace(FIELD_SEPARATOR, PRETTY_FIELD_SEPARATOR));
assertTrue("ERROR: the given resource name '" + resourceName + "' does not exist in the known resources within '" + parameterResourceList + "'. ",
allowedResources.contains(resourceName));
});
} }
} }