MLE-25605 Tweaking support for MarkLogic endpoints in PDC

Did some renaming based on the terminology used by the PDC API. Added some logging to assist with debugging when a MarkLogic endpoint does not exist.

Author: rjrudin

ml-app-deployer/src/main/java/com/marklogic/appdeployer/AppConfig.java

@@ -5,6 +5,7 @@
 
 import com.marklogic.appdeployer.command.forests.ForestNamingStrategy;
 import com.marklogic.appdeployer.command.forests.ReplicaBuilderStrategy;
+import com.marklogic.appdeployer.util.LogUtil;
 import com.marklogic.appdeployer.util.MapPropertiesSource;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.DatabaseClientFactory;
@@ -389,13 +390,24 @@ public void setAppServicesSimpleSslConfig(String protocol) {
 	}
 
 	/**
-	 * Convenience method for constructing a MarkLogic Java API DatabaseClient based on the the host and rest*
+	 * Convenience method for constructing a MarkLogic Java API DatabaseClient based on the host and rest*
 	 * properties defined on this class.
 	 *
 	 * @return
 	 */
 	public DatabaseClient newDatabaseClient() {
-		return configuredDatabaseClientFactory.newDatabaseClient(newRestDatabaseClientConfig(getRestPort()));
+		DatabaseClientConfig config = newRestDatabaseClientConfig(getRestPort());
+		DatabaseClient client = configuredDatabaseClientFactory.newDatabaseClient(config);
+		if (StringUtils.hasText(client.getBasePath())) {
+			LogUtil.APP_DEPLOYER_LOGGER.info("Connecting to REST API server with base path: {}", client.getBasePath());
+		} else {
+			boolean isCloudDeployment = client.getSecurityContext() instanceof DatabaseClientFactory.ProgressDataCloudAuthContext;
+			if (isCloudDeployment) {
+				LogUtil.APP_DEPLOYER_LOGGER.warn("Connecting to a REST API server in Progress Data Cloud without a base path may not work; " +
+					"if you encounter an error, you likely need to configure a base path via the 'mlRestBasePath' property.");
+			}
+		}
+		return client;
 	}
 
 	/**

ml-app-deployer/src/main/java/com/marklogic/appdeployer/command/CommandMapBuilder.java

@@ -25,7 +25,7 @@
 import com.marklogic.appdeployer.command.mimetypes.DeployMimetypesCommand;
 import com.marklogic.appdeployer.command.modules.DeleteTestModulesCommand;
 import com.marklogic.appdeployer.command.modules.LoadModulesCommand;
-import com.marklogic.appdeployer.command.pdc.DeployPdcEndpointsCommand;
+import com.marklogic.appdeployer.command.pdc.DeployMarkLogicEndpointsCommand;
 import com.marklogic.appdeployer.command.plugins.InstallPluginsCommand;
 import com.marklogic.appdeployer.command.rebalancer.DeployPartitionQueriesCommand;
 import com.marklogic.appdeployer.command.rebalancer.DeployPartitionsCommand;
@@ -142,7 +142,7 @@ private void addCommandsThatDoNotWriteToDatabases(Map<String, List<Command>> map
 		map.put("mlRestApiCommands", restApiCommands);
 
 		List<Command> pdcCommands = new ArrayList<>();
-		pdcCommands.add(new DeployPdcEndpointsCommand());
+		pdcCommands.add(new DeployMarkLogicEndpointsCommand());
 		map.put("mlPdcCommands", pdcCommands);
 
 		List<Command> securityCommands = new ArrayList<>();

ml-app-deployer/src/main/java/com/marklogic/appdeployer/command/pdc/DeployPdcEndpointsCommand.java renamed to ml-app-deployer/src/main/java/com/marklogic/appdeployer/command/pdc/DeployMarkLogicEndpointsCommand.java

@@ -23,15 +23,11 @@
 import java.util.UUID;
 import java.util.stream.Stream;
 
-/**
- * Deploys Progress Data Cloud (PDC) integration endpoints by reading JSON configuration files
- * from the src/main/pdc-config/service/endpoints directory.
- */
-public class DeployPdcEndpointsCommand extends AbstractCommand {
+public class DeployMarkLogicEndpointsCommand extends AbstractCommand {
 
 	private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
-	public DeployPdcEndpointsCommand() {
+	public DeployMarkLogicEndpointsCommand() {
 		setExecuteSortOrder(SortOrderConstants.DEPLOY_PDC_MARKLOGIC_ENDPOINTS);
 	}
 
@@ -45,10 +41,10 @@ public void execute(CommandContext context) {
 		final List<MarkLogicHttpEndpoint> endpoints = readEndpointDefinitionsFromFiles(pdcConfigPaths);
 		if (!endpoints.isEmpty()) {
 			if (!StringUtils.hasText(context.getAppConfig().getCloudApiKey())) {
-				logger.warn("Found configuration for {} PDC endpoint(s), but not deploying them because no cloud API key has been specified.", endpoints.size());
+				logger.warn("Found configuration for {} MarkLogic endpoint(s), but not deploying them because no cloud API key has been specified.", endpoints.size());
 			} else {
 				if (logger.isInfoEnabled()) {
-					logger.info("Deploying {} PDC endpoint(s)", endpoints.size());
+					logger.info("Deploying {} MarkLogic endpoint(s)", endpoints.size());
 				}
 				deployEndpoints(context, endpoints);
 			}
@@ -60,24 +56,24 @@ private List<MarkLogicHttpEndpoint> readEndpointDefinitionsFromFiles(List<String
 
 		for (String pdcConfigPath : pdcConfigPaths) {
 			File serviceDir = new File(pdcConfigPath, "service");
-			File endpointsDir = new File(serviceDir, "endpoints");
+			File endpointsDir = new File(serviceDir, "mlendpoints");
 			if (!endpointsDir.exists()) {
 				if (logger.isDebugEnabled()) {
-					logger.debug("PDC endpoints directory does not exist: {}", endpointsDir.getAbsolutePath());
+					logger.debug("MarkLogic endpoints directory does not exist: {}", endpointsDir.getAbsolutePath());
 				}
 				continue;
 			}
 
 			if (logger.isInfoEnabled()) {
-				logger.info("Reading PDC integration endpoints from: {}", endpointsDir.getAbsolutePath());
+				logger.info("Reading MarkLogic endpoints from: {}", endpointsDir.getAbsolutePath());
 			}
 
 			try (Stream<Path> paths = Files.walk(endpointsDir.toPath())) {
 				paths.filter(Files::isRegularFile)
 					.filter(path -> path.toString().endsWith(".json"))
 					.forEach(path -> endpoints.add(buildEndpointFromFile(path.toFile())));
 			} catch (IOException e) {
-				throw new RuntimeException("Failed to read PDC endpoint configuration files from: " +
+				throw new RuntimeException("Failed to read MarkLogic endpoint configuration files from: " +
 					endpointsDir.getAbsolutePath(), e);
 			}
 		}
@@ -88,14 +84,14 @@ private List<MarkLogicHttpEndpoint> readEndpointDefinitionsFromFiles(List<String
 	private MarkLogicHttpEndpoint buildEndpointFromFile(File endpointFile) {
 		try {
 			MarkLogicHttpEndpoint endpoint = OBJECT_MAPPER.readValue(endpointFile, MarkLogicHttpEndpoint.class);
-			if (logger.isInfoEnabled()) {
-				logger.info("Built PDC endpoint: name={}, displayName={}, port={}, type={}, path={}",
+			if (logger.isDebugEnabled()) {
+				logger.debug("Built MarkLogic endpoint: name={}, displayName={}, port={}, type={}, path={}",
 					endpoint.getName(), endpoint.getDisplayName(), endpoint.getPort(),
 					endpoint.getType(), endpoint.getPath());
 			}
 			return endpoint;
 		} catch (IOException e) {
-			throw new RuntimeException("Failed to parse PDC endpoint configuration file: " +
+			throw new RuntimeException("Failed to parse MarkLogic endpoint configuration file: " +
 				endpointFile.getAbsolutePath(), e);
 		}
 	}
@@ -107,7 +103,7 @@ private void deployEndpoints(CommandContext context, List<MarkLogicHttpEndpoint>
 			try {
 				new ServiceApi(pdcClient.getApiClient()).apiServiceMlendpointsIdHttpPut(markLogicServiceId, endpoints);
 			} catch (ApiException e) {
-				throw new RuntimeException("Unable to create MarkLogic HTTP endpoints in PDC; cause: %s".formatted(e.getMessage()), e);
+				throw new RuntimeException("Unable to create MarkLogic endpoints in PDC; cause: %s".formatted(e.getMessage()), e);
 			}
 		}
 	}

ml-app-deployer/src/main/java/com/marklogic/appdeployer/util/LogUtil.java

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+ */
+package com.marklogic.appdeployer.util;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public interface LogUtil {
+
+	Logger APP_DEPLOYER_LOGGER = LoggerFactory.getLogger("com.marklogic.appdeployer");
+}

ml-app-deployer/src/test/java/com/marklogic/appdeployer/command/pdc/DeployPdcEndpointsDebug.java renamed to ml-app-deployer/src/test/java/com/marklogic/appdeployer/command/pdc/DeployMarkLogicEndpointsDebug.java

@@ -15,7 +15,7 @@
 import java.util.Properties;
 
 // For manual testing of deploying integration endpoints to PDC.
-public class DeployPdcEndpointsDebug {
+public class DeployMarkLogicEndpointsDebug {
 
 	public static void main(String[] args) {
 		Properties props = new Properties();
@@ -29,13 +29,12 @@ public static void main(String[] args) {
 			new SimplePropertySource(props)
 		).newManageConfig();
 		final ManageClient manageClient = new ManageClient(manageConfig);
-
-
+		
 		DefaultAppConfigFactory factory = new DefaultAppConfigFactory(new SimplePropertySource(props));
 		factory.setProjectDir(new File("ml-app-deployer/src/test/resources/cloud-project"));
 		AppConfig appConfig = factory.newAppConfig();
 
 		CommandContext context = new CommandContext(appConfig, manageClient, null);
-		new DeployPdcEndpointsCommand().execute(context);
+		new DeployMarkLogicEndpointsCommand().execute(context);
 	}
 }

ml-app-deployer/src/test/java/com/marklogic/appdeployer/command/pdc/DeployPdcEndpointsTest.java renamed to ml-app-deployer/src/test/java/com/marklogic/appdeployer/command/pdc/DeployMarkLogicEndpointsTest.java

@@ -12,12 +12,12 @@
  * We don't yet have a PDC instance for automated tests, so this test does what it can in the absence of that.
  * For now, relying on manual testing via the DeployPdcEndpointsDebug class.
  */
-class DeployPdcEndpointsTest extends AbstractAppDeployerTest {
+class DeployMarkLogicEndpointsTest extends AbstractAppDeployerTest {
 
 	@Test
 	void dontDeployWhenCloudApiKeyIsNotSet() {
 		initializeAppConfig(new File("src/test/resources/cloud-project"));
-		initializeAppDeployer(new DeployPdcEndpointsCommand());
+		initializeAppDeployer(new DeployMarkLogicEndpointsCommand());
 
 		deploySampleApp();
 	}