Merge pull request #166 from marklogic/feature/contrib-update

Added support for logging the request and response in tests

Author: rjrudin

CONTRIBUTING.md

@@ -8,6 +8,33 @@ Use the following steps to install GDS as a standalone project and run the tests
    password
 2. Run `./gradlew -i mlDeploy loadTestData test`
 
+## Inspecting logging of HTTP requests and responses
+
+If you wish to see the HTTP request/response that each test sends/receives, set the following value in your 
+`gradle-local.properties` file:
+
+    logRequestAndResponse=true
+
+Or include it on the command line when running tests:
+
+    ./gradlew -i test -PlogRequestAndResponse=true
+
+This is often helpful when running a single test so that you can see what the input and output is for a particular 
+scenario. To run a single test, such as `PointQueries`, run the following (this adds the property to the command 
+line, but you can also just add it to your `gradle-local.properties` file so you don't need to remember to add it 
+each time):
+
+    ./gradlew -i test --tests PointQueries -PlogRequestAndResponse=true
+
+To run an individual test method, add a period and the method name to the test class name:
+
+    ./gradlew -i test --tests PointQueries.testPointIntersects1 -PlogRequestAndResponse=true
+
+To force tests to be run, include `cleanTest`, which will prevent Gradle from not running a test due to it not 
+having changed:
+
+    ./gradlew -i cleanTest test --tests PointQueries.testPointIntersects1 -PlogRequestAndResponse=true
+
 # Manual testing
 
 You can perform manual testing by following the instructions in the `examples/sample-project/README.md` file for 

build.gradle

@@ -36,7 +36,8 @@ dependencies {
 }
 
 test {
-    systemProperty "sonar.projectVersion", project.version
+  systemProperty "sonar.projectVersion", project.version
+  systemProperty "logRequestAndResponse", logRequestAndResponse
 }
 
 task loadTestData(dependsOn: [

gradle.properties

@@ -27,6 +27,9 @@ mlContentDatabaseName=geo-data-services-test-content
 mlSchemasDatabaseName=geo-data-services-test-schemas
 mlContentForestsPerHost=1
 
+# Set to true for each test to log the HTTP request it sends and the HTTP response it receives.
+logRequestAndResponse=false
+
 # Sonar settings
 systemProp.sonar.login=set this in gradle-local.properties
 systemProp.sonar.host.url=set this in gradle-local.properties

src/test/java/AbstractTest.java

@@ -1,6 +1,8 @@
 import com.marklogic.gds.GeoQueryRequest;
 import io.restassured.RestAssured;
 import io.restassured.filter.log.LogDetail;
+import io.restassured.filter.log.RequestLoggingFilter;
+import io.restassured.filter.log.ResponseLoggingFilter;
 import io.restassured.http.ContentType;
 import io.restassured.path.json.JsonPath;
 import io.restassured.path.json.config.JsonPathConfig;
@@ -20,6 +22,10 @@ public void setup() {
         RestAssured.port = 8096;
         RestAssured.authentication = basic("test-geo-data-services-writer", "test-geo-data-services-writer");
 
+        if ("true".equals(System.getProperty("logRequestAndResponse"))) {
+            RestAssured.filters(new RequestLoggingFilter(), new ResponseLoggingFilter());
+        }
+
         RestAssured.enableLoggingOfRequestAndResponseIfValidationFails(LogDetail.ALL);
     }