Creating StringPayloadOf class for tests

Author: Boris Kuzmic

src/test/java/com/amihaiemil/docker/RtPluginTestCase.java

@@ -29,17 +29,14 @@
 import com.amihaiemil.docker.mock.AssertRequest;
 import com.amihaiemil.docker.mock.Condition;
 import com.amihaiemil.docker.mock.Response;
-import java.io.IOException;
+import com.amihaiemil.docker.mock.StringPayloadOf;
 import java.net.URI;
 import java.util.HashMap;
 import java.util.Map;
 import javax.json.Json;
 import javax.json.JsonArray;
 import javax.json.JsonObject;
-import org.apache.http.HttpEntityEnclosingRequest;
-import org.apache.http.HttpRequest;
 import org.apache.http.HttpStatus;
-import org.apache.http.util.EntityUtils;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.collection.IsCollectionWithSize;
 import org.hamcrest.core.IsEqual;
@@ -52,8 +49,6 @@
  *
  * @author Boris Kuzmic ([email protected])
  * @since 0.0.8
- * @todo #266:30min Extract method stringPayloadOf to class to reuse in
- *  other test cases (like in RtPluginsTestCase.createOk() method)
  * @checkstyle MethodName (500 lines)
  */
 public final class RtPluginTestCase {
@@ -482,7 +477,9 @@ public void configureOk() throws Exception {
                 ),
                 new Condition(
                     "configure() must send String Array as request body",
-                    req -> "[\"DEBUG=1\"]".equals(this.stringPayloadOf(req))
+                    req -> "[\"DEBUG=1\"]".equals(
+                        new StringPayloadOf(req).value()
+                    )
                 )
             ),
             URI.create("http://localhost/plugins/sshfs"),
@@ -520,27 +517,4 @@ public void configureFailsPluginNotInstalled() throws Exception {
         );
         plugin.configure(new HashMap<>());
     }
-
-    /**
-     * Extracts request payload as String.
-     * @param request Http Request.
-     * @return Payload as String.
-     */
-    private String stringPayloadOf(final HttpRequest request) {
-        try {
-            final String payload;
-            if (request instanceof HttpEntityEnclosingRequest) {
-                payload = EntityUtils.toString(
-                    ((HttpEntityEnclosingRequest) request).getEntity()
-                );
-            } else {
-                payload = "";
-            }
-            return payload;
-        } catch (final IOException ex) {
-            throw new IllegalStateException(
-                "Cannot read request payload", ex
-            );
-        }
-    }
 }

src/test/java/com/amihaiemil/docker/RtPluginsTestCase.java

@@ -29,16 +29,13 @@
 import com.amihaiemil.docker.mock.AssertRequest;
 import com.amihaiemil.docker.mock.Condition;
 import com.amihaiemil.docker.mock.Response;
-import java.io.IOException;
+import com.amihaiemil.docker.mock.StringPayloadOf;
 import java.net.URI;
 import java.util.Iterator;
 import javax.json.Json;
 import javax.json.JsonArray;
 import javax.json.JsonObject;
-import org.apache.http.HttpEntityEnclosingRequest;
-import org.apache.http.HttpRequest;
 import org.apache.http.HttpStatus;
-import org.apache.http.util.EntityUtils;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.core.IsEqual;
 import org.junit.Test;
@@ -80,7 +77,9 @@ public void createOk() throws Exception {
                 ),
                 new Condition(
                     "create() must send String body request",
-                    req -> "/home/pluginDir".equals(this.stringPayloadOf(req))
+                    req -> "/home/pluginDir".equals(
+                        new StringPayloadOf(req).value()
+                    )
                 )
             ),
             URI.create("http://localhost/plugins"),
@@ -210,27 +209,4 @@ public void iteratePluginPrivileges() throws Exception {
         );
     }
 
-    /**
-     * Extracts request payload as String.
-     * @param request Http Request.
-     * @return Payload as String.
-     */
-    private String stringPayloadOf(final HttpRequest request) {
-        try {
-            final String payload;
-            if (request instanceof HttpEntityEnclosingRequest) {
-                payload = EntityUtils.toString(
-                    ((HttpEntityEnclosingRequest) request).getEntity()
-                );
-            } else {
-                payload = "";
-            }
-            return payload;
-        } catch (final IOException ex) {
-            throw new IllegalStateException(
-                "Cannot read request payload", ex
-            );
-        }
-    }
-
 }

src/test/java/com/amihaiemil/docker/mock/StringPayloadOf.java

@@ -0,0 +1,75 @@
+/**
+ * Copyright (c) 2018-2019, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of docker-java-api nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.amihaiemil.docker.mock;
+
+import java.io.IOException;
+import org.apache.http.HttpEntityEnclosingRequest;
+import org.apache.http.HttpRequest;
+import org.apache.http.util.EntityUtils;
+
+/**
+ * String payload of an HttpRequest.
+ *
+ * @author Boris Kuzmic ([email protected])
+ * @since 0.0.8
+ */
+public final class StringPayloadOf {
+
+    /**
+     * Payload as String.
+     */
+    private final String stringPayload;
+
+    /**
+     * Ctor.
+     *
+     * @param request The http request
+     * @throws IllegalStateException if the request's payload cannot be read
+     */
+    public StringPayloadOf(final HttpRequest request) {
+        try {
+            if (request instanceof HttpEntityEnclosingRequest) {
+                this.stringPayload = EntityUtils.toString(
+                    ((HttpEntityEnclosingRequest) request).getEntity()
+                );
+            } else {
+                this.stringPayload = "";
+            }
+        } catch (final IOException ex) {
+            throw new IllegalStateException(
+                "Cannot read request payload", ex
+            );
+        }
+    }
+
+    /**
+     * Returns payload value as String.
+     * @return Payload as String.
+     */
+    public String value() {
+        return this.stringPayload;
+    }
+}