#442 Logging warning when database resource directory isn't valid

rjrudin · rjrudin · commit 53b83e9f9c5b · 2021-09-03T11:35:03.000-04:00
"Isn't valid" = an existing ML database cannot be associated. Now logging a warning as throwing an exception proved to be too punitive for users.
diff --git a/src/main/java/com/marklogic/appdeployer/command/AbstractCommand.java b/src/main/java/com/marklogic/appdeployer/command/AbstractCommand.java
@@ -509,7 +509,10 @@ protected void setIncrementalMode(boolean incrementalMode) {
 	 * within the directory should be associated with. But starting in 3.16.0, if the name of the directory doesn't
 	 * match that of an existing database, then a check is made to see if there's a database file in the given ConfigDir
 	 * that has the same name, minus its extension, as the database directory name. If so, then the database-name is
-	 * extracted from that file and used as the database name. If not, an exception is thrown.
+	 * extracted from that file and used as the database name. If not, a warning is logged and null is returned.
+	 * Previously, an exception was thrown if the database-name could not be determined, but this raised problems for
+	 * users that had directory names like ".svn" that they could not easily remove (and we can't eagerly ignore certain
+	 * names since something like ".svn" is a valid ML database name).
 	 *
 	 * @param context
 	 * @param configDir
@@ -538,8 +541,10 @@ protected String determineDatabaseNameForDatabaseResourceDirectory(CommandContex
 			}
 		}
 
-		throw new RuntimeException("Could not determine database to associate with database resource directory: " +
-			databaseResourceDir);
+		logger.warn("Could not determine database to associate with database resource directory: " +
+			databaseResourceDir + "; will not process any resource files in that directory");
+
+		return null;
 	}
 
 	public void setPayloadTokenReplacer(PayloadTokenReplacer payloadTokenReplacer) {
diff --git a/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertActionsCommand.java b/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertActionsCommand.java
@@ -35,7 +35,9 @@ public void execute(CommandContext context) {
 			deployActions(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployActions(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployActions(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertConfigsCommand.java b/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertConfigsCommand.java
@@ -26,7 +26,9 @@ public void execute(CommandContext context) {
 			deployAlertConfigs(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployAlertConfigs(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployAlertConfigs(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertRulesCommand.java b/src/main/java/com/marklogic/appdeployer/command/alert/DeployAlertRulesCommand.java
@@ -28,7 +28,9 @@ public void execute(CommandContext context) {
 			deployRules(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployRules(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployRules(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployConfigsCommand.java b/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployConfigsCommand.java
@@ -33,7 +33,9 @@ public void execute(CommandContext context) {
 			deployConfigs(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployConfigs(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployConfigs(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployPullsCommand.java b/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployPullsCommand.java
@@ -35,7 +35,9 @@ public void execute(CommandContext context) {
 			deployFlexRepPulls(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployFlexRepPulls(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployFlexRepPulls(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployTargetsCommand.java b/src/main/java/com/marklogic/appdeployer/command/flexrep/DeployTargetsCommand.java
@@ -37,7 +37,9 @@ public void execute(CommandContext context) {
 			deployTargets(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployTargets(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployTargets(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/rebalancer/DeployPartitionQueriesCommand.java b/src/main/java/com/marklogic/appdeployer/command/rebalancer/DeployPartitionQueriesCommand.java
@@ -27,7 +27,9 @@ public void execute(CommandContext context) {
 		for (ConfigDir configDir : appConfig.getConfigDirs()) {
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployPartitionQueries(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployPartitionQueries(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/rebalancer/DeployPartitionsCommand.java b/src/main/java/com/marklogic/appdeployer/command/rebalancer/DeployPartitionsCommand.java
@@ -27,7 +27,9 @@ public void execute(CommandContext context) {
 		for (ConfigDir configDir : appConfig.getConfigDirs()) {
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployPartitions(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployPartitions(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalAxesCommand.java b/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalAxesCommand.java
@@ -28,7 +28,9 @@ public void execute(CommandContext context) {
 			deployTemporalAxes(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployTemporalAxes(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployTemporalAxes(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalCollectionsCommand.java b/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalCollectionsCommand.java
@@ -29,7 +29,9 @@ public void execute(CommandContext context) {
 			deployTemporalCollections(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployTemporalCollections(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployTemporalCollections(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalCollectionsLSQTCommand.java b/src/main/java/com/marklogic/appdeployer/command/temporal/DeployTemporalCollectionsLSQTCommand.java
@@ -20,7 +20,9 @@ public void execute(CommandContext context) {
 			deployTemporalCollectionsLsqt(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployTemporalCollectionsLsqt(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployTemporalCollectionsLsqt(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/triggers/DeployTriggersCommand.java b/src/main/java/com/marklogic/appdeployer/command/triggers/DeployTriggersCommand.java
@@ -37,7 +37,9 @@ public void execute(CommandContext context) {
 			deployTriggers(context, configDir, initialTriggersDatabaseName);
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployTriggers(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployTriggers(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/main/java/com/marklogic/appdeployer/command/viewschemas/DeployViewSchemasCommand.java b/src/main/java/com/marklogic/appdeployer/command/viewschemas/DeployViewSchemasCommand.java
@@ -41,7 +41,9 @@ public void execute(CommandContext context) {
 			deployViewSchemas(context, configDir, appConfig.getContentDatabaseName());
 			for (File dir : configDir.getDatabaseResourceDirectories()) {
 				String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);
-				deployViewSchemas(context, new ConfigDir(dir), databaseName);
+				if (databaseName != null) {
+					deployViewSchemas(context, new ConfigDir(dir), databaseName);
+				}
 			}
 		}
 	}
diff --git a/src/test/java/com/marklogic/appdeployer/command/alert/ManageAlertConfigsTest.java b/src/test/java/com/marklogic/appdeployer/command/alert/ManageAlertConfigsTest.java
@@ -8,6 +8,11 @@
 
 import java.io.File;
 
+/**
+ * This test is also expected to verify the fix for #442, which is that when a database resource directory - in this
+ * case, sample-app/alert-configs/databases/unknown-database - cannot be associated with an existing ML database, an
+ * exception is NOT thrown but rather a warning is logged. The fact that the test succeeds is evidence of this.
+ */
 public class ManageAlertConfigsTest extends AbstractManageResourceTest {
 
 	@Override
diff --git a/src/test/resources/sample-app/alert-config/databases/unknown-database/alert/configs/should-be-ignored-alert-config.json b/src/test/resources/sample-app/alert-config/databases/unknown-database/alert/configs/should-be-ignored-alert-config.json
@@ -0,0 +1,9 @@
+{
+  "uri": "should-be-ignored-alert-config",
+  "name": "Should Be Ignored Alerting App",
+  "description": "This should be ignored since the parent directory of 'unknown-database' doesn't match an existing ML database",
+  "trigger": [],
+  "domain": [],
+  "action": [],
+  "option": []
+}

Original file line number	Diff line number	Diff line change
`@@ -509,7 +509,10 @@ protected void setIncrementalMode(boolean incrementalMode) {`
`509`	`509`	`* within the directory should be associated with. But starting in 3.16.0, if the name of the directory doesn't`
`510`	`510`	`* match that of an existing database, then a check is made to see if there's a database file in the given ConfigDir`
`511`	`511`	`* that has the same name, minus its extension, as the database directory name. If so, then the database-name is`
`512`		`- * extracted from that file and used as the database name. If not, an exception is thrown.`
	`512`	`+ * extracted from that file and used as the database name. If not, a warning is logged and null is returned.`
	`513`	`+ * Previously, an exception was thrown if the database-name could not be determined, but this raised problems for`
	`514`	`+ * users that had directory names like ".svn" that they could not easily remove (and we can't eagerly ignore certain`
	`515`	`+ * names since something like ".svn" is a valid ML database name).`
`513`	`516`	`*`
`514`	`517`	`* @param context`
`515`	`518`	`* @param configDir`
`@@ -538,8 +541,10 @@ protected String determineDatabaseNameForDatabaseResourceDirectory(CommandContex`
`538`	`541`	`}`
`539`	`542`	`}`
`540`	`543`
`541`		`- throw new RuntimeException("Could not determine database to associate with database resource directory: " +`
`542`		`- databaseResourceDir);`
	`544`	`+ logger.warn("Could not determine database to associate with database resource directory: " +`
	`545`	`+ databaseResourceDir + "; will not process any resource files in that directory");`
	`546`	`+`
	`547`	`+ return null;`
`543`	`548`	`}`
`544`	`549`
`545`	`550`	`public void setPayloadTokenReplacer(PayloadTokenReplacer payloadTokenReplacer) {`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,9 @@ public void execute(CommandContext context) {`
`35`	`35`	`deployActions(context, configDir, appConfig.getContentDatabaseName());`
`36`	`36`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`37`	`37`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`38`		`- deployActions(context, new ConfigDir(dir), databaseName);`
	`38`	`+ if (databaseName != null) {`
	`39`	`+ deployActions(context, new ConfigDir(dir), databaseName);`
	`40`	`+ }`
`39`	`41`	`}`
`40`	`42`	`}`
`41`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,9 @@ public void execute(CommandContext context) {`
`26`	`26`	`deployAlertConfigs(context, configDir, appConfig.getContentDatabaseName());`
`27`	`27`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`28`	`28`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`29`		`- deployAlertConfigs(context, new ConfigDir(dir), databaseName);`
	`29`	`+ if (databaseName != null) {`
	`30`	`+ deployAlertConfigs(context, new ConfigDir(dir), databaseName);`
	`31`	`+ }`
`30`	`32`	`}`
`31`	`33`	`}`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@ public void execute(CommandContext context) {`
`28`	`28`	`deployRules(context, configDir, appConfig.getContentDatabaseName());`
`29`	`29`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`30`	`30`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`31`		`- deployRules(context, new ConfigDir(dir), databaseName);`
	`31`	`+ if (databaseName != null) {`
	`32`	`+ deployRules(context, new ConfigDir(dir), databaseName);`
	`33`	`+ }`
`32`	`34`	`}`
`33`	`35`	`}`
`34`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ public void execute(CommandContext context) {`
`33`	`33`	`deployConfigs(context, configDir, appConfig.getContentDatabaseName());`
`34`	`34`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`35`	`35`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`36`		`- deployConfigs(context, new ConfigDir(dir), databaseName);`
	`36`	`+ if (databaseName != null) {`
	`37`	`+ deployConfigs(context, new ConfigDir(dir), databaseName);`
	`38`	`+ }`
`37`	`39`	`}`
`38`	`40`	`}`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,9 @@ public void execute(CommandContext context) {`
`37`	`37`	`deployTargets(context, configDir, appConfig.getContentDatabaseName());`
`38`	`38`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`39`	`39`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`40`		`- deployTargets(context, new ConfigDir(dir), databaseName);`
	`40`	`+ if (databaseName != null) {`
	`41`	`+ deployTargets(context, new ConfigDir(dir), databaseName);`
	`42`	`+ }`
`41`	`43`	`}`
`42`	`44`	`}`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,9 @@ public void execute(CommandContext context) {`
`27`	`27`	`for (ConfigDir configDir : appConfig.getConfigDirs()) {`
`28`	`28`	`for (File dir : configDir.getDatabaseResourceDirectories()) {`
`29`	`29`	`String databaseName = determineDatabaseNameForDatabaseResourceDirectory(context, configDir, dir);`
`30`		`- deployPartitionQueries(context, new ConfigDir(dir), databaseName);`
	`30`	`+ if (databaseName != null) {`
	`31`	`+ deployPartitionQueries(context, new ConfigDir(dir), databaseName);`
	`32`	`+ }`
`31`	`33`	`}`
`32`	`34`	`}`
`33`	`35`	`}`