#242 Warning now logged for uri-rewriter without rest-api in it

Author: rjrudin

src/main/java/com/marklogic/appdeployer/command/appservers/UpdateRestApiServersCommand.java

@@ -5,7 +5,9 @@
 import com.marklogic.appdeployer.command.AbstractCommand;
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.SortOrderConstants;
+import com.marklogic.mgmt.PayloadParser;
 import com.marklogic.mgmt.SaveReceipt;
+import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.appservers.ServerManager;
 
 import java.io.File;
@@ -49,6 +51,22 @@ public void execute(CommandContext context) {
 		}
 	}
 
+	@Override
+	protected String adjustPayloadBeforeSavingResource(ResourceManager mgr, CommandContext context, File f, String payload) {
+		payload = super.adjustPayloadBeforeSavingResource(mgr, context, f, payload);
+		if (payload != null) {
+			String urlRewriter = new PayloadParser().getPayloadFieldValue(payload, "url-rewriter", false);
+			if (urlRewriter != null && !urlRewriter.contains("rest-api")) {
+				logger.warn("The REST server is being updated with a url-rewriter that does not contain the string 'rest-api' in its URI. " +
+					"This may result in a 'Port is in use' exception if the command for creating a REST server is run. " +
+					"This is because the command to create a REST server first sends a GET to /v1/rest-apis, and that endpoint " +
+					"only returns servers that have the string 'rest-api' in the URI of the url-rewriter. It is recommended to " +
+					"include the string 'rest-api' in the URI of a url-rewriter for a REST server to avoid this problem.");
+			}
+		}
+		return payload;
+	}
+
 	protected File findRestApiConfigFile(CommandContext context) {
 		if (restApiFilename != null) {
 			File f = null;

src/main/java/com/marklogic/mgmt/resource/restapis/RestApiManager.java

@@ -9,6 +9,7 @@
 import com.marklogic.rest.util.Fragment;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.client.HttpClientErrorException;
 
 /**
  * For /v1/rest-apis. Currently only supports JSON files.
@@ -33,9 +34,25 @@ public ResponseEntity<String> createRestApi(String name, String json) {
 			return null;
 		} else {
 			logger.info("Creating REST API: " + json);
-			ResponseEntity<String> re = client.postJson("/v1/rest-apis", json);
-			logger.info("Created REST API");
-			return re;
+			try {
+				ResponseEntity<String> re = client.postJson("/v1/rest-apis", json);
+				logger.info("Created REST API");
+				return re;
+			} catch (HttpClientErrorException ex) {
+				logWarningIfErrorIsDueToPortInUse(ex);
+				throw ex;
+			}
+		}
+	}
+
+	protected void logWarningIfErrorIsDueToPortInUse(HttpClientErrorException ex) {
+		String body = ex.getResponseBodyAsString();
+		if (body != null && body.contains("Invalid parameter") && body.contains("is in use")) {
+			logger.warn("Caught exception due to a port being in use; this may because the REST server already exists " +
+				"but is using a rewriter that the /v1/rest-apis endpoint does not recognize as a REST rewriter, and thus " +
+				"the /v1/rest-apis endpoint does not think that the REST server has been created yet. The error is then " +
+				"because an attempt is made to create the REST server but it fails because the port is already in use. " +
+				"To fix this, try modifying the URI of the rewriter module so it contains the string 'rest-api'.");
 		}
 	}
 

src/test/java/com/marklogic/appdeployer/command/restapis/CreateRestApiWithCustomRewriterTest.java

@@ -0,0 +1,34 @@
+package com.marklogic.appdeployer.command.restapis;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.appdeployer.ConfigDir;
+import com.marklogic.appdeployer.command.appservers.UpdateRestApiServersCommand;
+import org.junit.After;
+import org.junit.Test;
+import org.springframework.web.client.HttpClientErrorException;
+
+import java.io.File;
+
+public class CreateRestApiWithCustomRewriterTest extends AbstractAppDeployerTest {
+
+	@After
+	public void teardown() {
+		undeploySampleApp();
+	}
+
+	/**
+	 * This test is used to manually inspect the log statements that are written.
+	 */
+	@Test
+	public void test() {
+		appConfig.setConfigDir(new ConfigDir(new File("src/test/resources/sample-app/rest-api-different-rewriter")));
+
+		initializeAppDeployer(new DeployRestApiServersCommand(), new UpdateRestApiServersCommand());
+
+		try {
+			deploySampleApp();
+		} catch (HttpClientErrorException ex) {
+			logger.info("Caught expected exception because the REST server has a url-rewriter without 'rest-api' in it: " + ex.getMessage());
+		}
+	}
+}

src/test/resources/sample-app/rest-api-different-rewriter/rest-api.json

@@ -0,0 +1,12 @@
+{
+  "rest-api": {
+    "name": "%%NAME%%",
+    "group": "%%GROUP%%",
+    "database": "%%DATABASE%%",
+    "modules-database": "%%MODULES_DATABASE%%",
+    "port": "%%PORT%%",
+    "xdbc-enabled": true,
+    "forests-per-host": 1,
+    "error-format": "json"
+  }
+}

src/test/resources/sample-app/rest-api-different-rewriter/servers/rest-api-server.json

@@ -0,0 +1,4 @@
+{
+  "server-name": "%%NAME%%",
+  "url-rewriter": "/should/log/a-warning.xml"
+}