Issue 34 Web API Core Tests

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "odata-openapi"]
+	path = odata-openapi
+	url = https://github.com/oasis-tcs/odata-openapi.git

.run/Commander Acceptance Tests.run.xml

@@ -15,7 +15,6 @@
     </extension>
     <method v="2">
       <option name="Make" enabled="true" />
-      <option name="Gradle.BeforeRunTask" enabled="true" tasks="testDataDictionaryReferenceMetadata_1_7" externalProjectPath="$PROJECT_DIR$" vmOptions="" scriptParameters="" />
     </method>
   </configuration>
 </component>

README.md

@@ -22,6 +22,7 @@ To begin using the Commander, choose one of the following topics:
 * [Getting Metadata](#getting-metadata)  
 * [Validating Metadata stored in an EDMX file](#validating-metadata-stored-in-an-edmx-file)  
 * [Saving Results from a Given `uri`](#saving-results-from-a-given-uri)
+* [Displaying Queries for RESOScript Files](#displaying-queries-for-resoscript-files)
 * [Running RESOScript Files](#running-resoscript-files)
 
 
@@ -31,7 +32,7 @@ To begin using the Commander, choose one of the following topics:
 * [Converting metadata to Open API 3 format](#converting-metadata-to-open-api-3-format)  
 
 ## Java Requirements
-Your operating system probably already has a Java Runtime Environment (JRE) installed. This is all you need to run the [Commander as a Web API Client](#using-the-commander-as-a-web-api-client). 
+Your operating system probably already has a Java Runtime Environment (JRE) installed. This is all you need to run the Commander as a Web API Client. 
 
 To check your version of Java, type the following in a command line environment:
 ```
@@ -144,6 +145,43 @@ JSON Response saved to: response.json
 Otherwise, errors will be displayed showing what went wrong during the request.
 
 
+## Displaying Queries for RESOScript Files
+A RESOScript file usually contains a server's service root and one or more Requests that can either 
+be used in batch-format or can be used during testing.
+
+To resolve all parameters and display the queries to be run with your RESOScript, use the following command:
+
+```
+$ java -jar web-api-commander.jar --generateQueries --inputFile /path/to/your.resoscript
+```
+
+This should display something similar to the following:
+
+```
+==============================================================
+Web API Commander Starting... Press <ctrl+c> at any time to exit.
+==============================================================
+Displaying 44 Request(s)
+RESOScript: src/test/resources/mock.web-api-server.core.1.0.2.resoscript
+==============================================================
+
+
+===========================
+Request: #1
+===========================
+Request Id: metadata-validation
+Resolved URL: https://api.reso.org/OData/$metadata
+
+
+===========================
+Request: #2
+===========================
+Request Id: fetch-by-key
+Resolved URL: https://api.reso.org/OData/Property('12345')?$select=ListingKey
+
+...
+```
+
 ## Running RESOScript Files
 The Web API Commander is able to run files written using RESO's XML-based scripting format, also known as a RESOScript.
 
@@ -195,7 +233,7 @@ See documentation regarding running the [nodejs-based tools in odata-openapi/lib
 * [Cucumber Feature Specifications](#cucumber-feature-specifications)
 * [Testing Environment](#testing-environment) 
 * [Gradle Wrapper](#gradle-wrapper)
-* [Automated RESO Web API Core Testing](#automated-reso-web-api-core-testing-in-development)
+* [Automated RESO Web API Core Testing](#automated-reso-web-api-core-testing)
 * [Automated RESO Data Dictionary Testing](#automated-reso-data-dictionary-testing)
 
 
@@ -287,9 +325,12 @@ testDataDictionaryReferenceMetadata_1_7 - Runs Data Dictionary tests against ref
 testWebApiServer_1_0_2_Core - Runs Web API Core 1.0.2 Automated Acceptance Tests.
   Example: 
     $ ./gradlew testWebApiServer_1_0_2_Core -DpathToRESOScript=/path/to/web-api-core-1.0.2.resoscript -DshowResponses=true
+
+    Note: by default the Web API tests assume Collection(Edm.EnumType).
+      Pass -DuseCollections=false if using OData IsFlags.
 ```
 
-## Automated RESO Web API Core Testing (in-development)
+## Automated RESO Web API Core Testing
 Automated Web API Core automated testing tools are currently in development. See [Issue 34](https://github.com/RESOStandards/web-api-commander/issues/34) for progress.
 
 To use the automated RESO testing tools, you must have a [JDK installed](#java-and-the-jdk).
@@ -314,14 +355,17 @@ These tasks will also produce reports in the local `build` directory, named acco
 
 This will run the Core tests against the Web API 1.0.2 Server provided as `WebAPIURI` in your `web-api-server.core.1.0.2.resoscript` file.
 
+**Note**: by default, the Commander uses `Collection(Edm.EnumType)` for multiple enumerations testing. 
+Pass `-DuseCollections=false` if you are using `IsFlags="true"` instead.
+
 ##### MacOS or Linux
 ```
-$ ./gradlew testWebAPIServerCore_1_0_2 -DpathToRESOScript=/path/to/your.web-api-server.core.1.0.2.resoscript -DshowResponses=true
+$ ./gradlew testWebApiServer_1_0_2_Core -DpathToRESOScript=/path/to/your.web-api-server.core.1.0.2.resoscript -DshowResponses=true
 ```
 
 ##### Windows
 ```
-C:\path\to\web-api-commander> gradlew testWebAPIServerCore_1_0_2 -DpathToRESOScript=C:\path\to\your.web-api-server.core.1.0.2.resoscript -DshowResponses=true
+C:\path\to\web-api-commander> gradlew testWebApiServer_1_0_2_Core -DpathToRESOScript=C:\path\to\your.web-api-server.core.1.0.2.resoscript -DshowResponses=true
 ```
 
 *Note: the first time you run these tasks, they will take some time as the environment must be configured and code is being compiled from the contents of the source directory downloaded in the previous step. 
@@ -333,7 +377,7 @@ A sample of the runtime terminal output follows:
 ```gherkin
 > Task :testWebApiServer_1_0_2_Core
 
-@REQ-WA103-END3 @2.4.1 @metadata
+@metadata-request @2.4.1
 Scenario: REQ-WA103-END3 - Request and Validate Server Metadata                                            
 
 Using RESOScript: ./web-api-server.core.1.0.2.resoscript
@@ -578,4 +622,4 @@ Gradle may be debugged as well, and additional gradle commands such as turning o
 ## Support
 Please contact [Josh](mailto:josh@reso.org) with any questions, bug reports, or feature requests. Contributions to code or documentation are welcome. 
 
-You may also [open a ticket](https://github.com/RESOStandards/web-api-commander/issues).
+You may also [open a ticket](https://github.com/RESOStandards/web-api-commander/issues).

build.gradle

@@ -90,14 +90,17 @@ task testWebApiServer_1_0_2_Core() {
   group = 'RESO Certification'
   description = 'Runs Web API Core 1.0.2 Automated Acceptance Tests.' +
       '\n  Example: ' +
-      '\n    $ ./gradlew testWebApiServer_1_0_2_Core -DpathToRESOScript=/path/to/web-api-core-1.0.2.resoscript -DshowResponses=true\n'
+      '\n    $ ./gradlew testWebApiServer_1_0_2_Core -DpathToRESOScript=/path/to/web-api-core-1.0.2.resoscript -DshowResponses=true\n' +
+      '\n    Note: by default the Web API tests assume Collection(Edm.EnumType).' +
+      '\n      Pass -DuseCollections=false if using OData IsFlags.\n'
 
   dependsOn jar
   doLast {
     javaexec {
       main = "io.cucumber.core.cli.Main"
       classpath = configurations.cucumberRuntime + sourceSets.main.output + sourceSets.test.output
       systemProperties = System.getProperties()
+
       args = [
           '--strict',
           '--plugin',