#128 Stubbing out schemas database file when generating model artifacts

Author: rjrudin

.gitignore

@@ -10,7 +10,4 @@ src/test/resources/user.properties
 setenv.bat
 src/test/resources/scaffold-test/
 .DS_Store
-src/test/resources/entity-services-project/src/main/ml-modules
-src/test/resources/entity-services-project/src/main/ml-schemas
-src/test/resources/entity-services-project/src/main/ml-config/databases/content-database-GENERATED.json
-
+src/test/resources/entity-services-project/src

src/main/java/com/marklogic/appdeployer/command/es/GenerateModelArtifactsCommand.java

@@ -4,11 +4,11 @@
 import com.marklogic.appdeployer.command.AbstractCommand;
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.SortOrderConstants;
+import com.marklogic.appdeployer.command.databases.DeploySchemasDatabaseCommand;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.es.CodeGenerationRequest;
 import com.marklogic.client.es.EntityServicesManager;
 import com.marklogic.client.es.GeneratedCode;
-import com.sun.org.apache.bcel.internal.classfile.Code;
 import org.springframework.util.FileCopyUtils;
 
 import java.io.File;
@@ -97,13 +97,15 @@ protected void generateInstanceConverter(AppConfig appConfig, GeneratedCode code
 			File esDir = new File(modulesDir, appConfig.getInstanceConverterPath());
 			esDir.mkdirs();
 			File out = new File(esDir, code.getTitle() + "-" + code.getVersion() + ".xqy");
+			String logMessage = "Wrote instance converter to: ";
 			if (out.exists()) {
 				out = new File(esDir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.xqy");
+				logMessage = "Instance converter file already exists; writing new generated copy to: ";
 			}
 			try {
 				FileCopyUtils.copy(instanceConverter.getBytes(), out);
 				if (logger.isInfoEnabled()) {
-					logger.info("Wrote instance converter to: " + out.getAbsolutePath());
+					logger.info(logMessage + out.getAbsolutePath());
 				}
 			} catch (IOException e) {
 				throw new RuntimeException("Unable to write instance converter to: " + out.getAbsolutePath(), e);
@@ -117,33 +119,55 @@ protected void generateSearchOptions(GeneratedCode code, File modulesDir) {
 			File optionsDir = new File(modulesDir, optionsPath);
 			optionsDir.mkdirs();
 			File out = new File(optionsDir, code.getTitle() + ".xml");
+			String logMessage = "Wrote search options to: ";
 			if (out.exists()) {
 				out = new File(optionsDir, code.getTitle() + "-GENERATED.xml");
+				logMessage = "Search options file already exists; writing new generated copy to: ";
 			}
 			try {
 				FileCopyUtils.copy(searchOptions.getBytes(), out);
 				if (logger.isInfoEnabled()) {
-					logger.info("Wrote search options to: " + out.getAbsolutePath());
+					logger.info(logMessage + out.getAbsolutePath());
 				}
 			} catch (IOException e) {
 				throw new RuntimeException("Unable to write search options to file: " + out.getAbsolutePath(), e);
 			}
 		}
 	}
 
+	/**
+	 * The content-database.json file generated by Entity Services has a reference to a schemas database. So if a config
+	 * file for a schemas database doesn't exist, one is generated so that the next deployment succeeds.
+	 *
+	 * @param appConfig
+	 * @param code
+	 */
 	protected void generateDatabaseProperties(AppConfig appConfig, GeneratedCode code) {
 		String props = code.getDatabaseProperties();
 		if (props != null) {
-			File dir = appConfig.getConfigDir().getDatabasesDir();
-			dir.mkdirs();
-			File out = new File(dir, "content-database.json");
+			File dbDir = appConfig.getConfigDir().getDatabasesDir();
+			dbDir.mkdirs();
+			File out = new File(dbDir, "content-database.json");
+			String logMessage = "Wrote database properties to: ";
 			if (out.exists()) {
-				out = new File(dir, "content-database-GENERATED.json");
+				out = new File(dbDir, "content-database-GENERATED.json");
+				logMessage = "Database properties file already exists; writing new generated copy to: ";
 			}
 			try {
 				FileCopyUtils.copy(props.getBytes(), out);
 				if (logger.isInfoEnabled()) {
-					logger.info("Wrote database properties to: " + out.getAbsolutePath());
+					logger.info(logMessage + out.getAbsolutePath());
+				}
+
+				// Makes some assumptions about the schemas file
+				File schemasFile = new File(dbDir, DeploySchemasDatabaseCommand.DATABASE_FILENAME);
+				if (!schemasFile.exists()) {
+					String payload = "{\"database-name\": \"%%SCHEMAS_DATABASE%%\"}";
+					try {
+						FileCopyUtils.copy(payload.getBytes(), schemasFile);
+					} catch (IOException ex) {
+						logger.warn("Unable to write schemas database payload to file: " + schemasFile.getAbsolutePath(), ex);
+					}
 				}
 			} catch (IOException e) {
 				throw new RuntimeException("Unable to write database properties to file: " + out.getAbsolutePath(), e);
@@ -157,13 +181,15 @@ protected void generateSchema(AppConfig appConfig, GeneratedCode code) {
 			File dir = new File(appConfig.getSchemasPath());
 			dir.mkdirs();
 			File out = new File(dir, code.getTitle() + "-" + code.getVersion() + ".xsd");
+			String logMessage = "Wrote schema to: ";
 			if (out.exists()) {
 				out = new File(dir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.xsd");
+				logMessage = "Schema file already exists; writing new generated copy to: ";
 			}
 			try {
 				FileCopyUtils.copy(schema.getBytes(), out);
 				if (logger.isInfoEnabled()) {
-					logger.info("Wrote schema to: " + out.getAbsolutePath());
+					logger.info(logMessage + out.getAbsolutePath());
 				}
 			} catch (IOException e) {
 				throw new RuntimeException("Unable to write schema to file: " + out.getAbsolutePath(), e);
@@ -177,13 +203,15 @@ protected void generateExtractionTemplate(AppConfig appConfig, GeneratedCode cod
 			File dir = new File(appConfig.getSchemasPath());
 			dir.mkdirs();
 			File out = new File(dir, code.getTitle() + "-" + code.getVersion() + ".tdex");
+			String logMessage = "Wrote extraction template to: ";
 			if (out.exists()) {
 				out = new File(dir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.tdex");
+				logMessage = "Extraction template already exists; writing new generated copy to: ";
 			}
 			try {
 				FileCopyUtils.copy(template.getBytes(), out);
 				if (logger.isInfoEnabled()) {
-					logger.info("Wrote extraction template to: " + out.getAbsolutePath());
+					logger.info(logMessage + out.getAbsolutePath());
 				}
 			} catch (IOException e) {
 				throw new RuntimeException("Unable to write extraction template to file: " + out.getAbsolutePath(), e);

src/test/java/com/marklogic/appdeployer/command/es/GenerateModelArtifactsTest.java

@@ -24,6 +24,10 @@ public void tearDown() {
 	@Test
 	public void test() {
 		String projectPath = "src/test/resources/entity-services-project";
+		File srcDir = new File(projectPath, "src");
+		if (srcDir.exists()) {
+			srcDir.delete();
+		}
 		appConfig.setConfigDir(new ConfigDir(new File(projectPath + "/src/main/ml-config")));
 		appConfig.setModelsPath(projectPath + "/data/entity-services");
 		appConfig.getModulePaths().clear();
@@ -38,8 +42,9 @@ public void test() {
 		assertTrue(new File(projectPath, "src/main/ml-modules/options/Race.xml").exists());
 		assertTrue(new File(projectPath, "src/main/ml-schemas/Race-0.0.1.xsd").exists());
 		assertTrue(new File(projectPath, "src/main/ml-schemas/Race-0.0.1.tdex").exists());
-		// We already have a content-database.json file
-		assertTrue(new File(projectPath, "src/main/ml-config/databases/content-database-GENERATED.json").exists());
+		assertTrue(new File(projectPath, "src/main/ml-config/databases/content-database.json").exists());
+		assertTrue("A schemas db file needs to be created since the ES content-database.json file refers to one",
+			new File(projectPath, "src/main/ml-config/databases/schemas-database.json").exists());
 
 		deploySampleApp();
 
@@ -50,7 +55,8 @@ public void test() {
 		assertTrue(new File(projectPath, "src/main/ml-schemas/Race-0.0.1-GENERATED.tdex").exists());
 
 		// Make sure none of these files break when they're deployed
-		initializeAppDeployer(new DeployContentDatabasesCommand(), new LoadSchemasCommand(), new LoadModulesCommand());
+		initializeAppDeployer(new DeployContentDatabasesCommand(), new DeploySchemasDatabaseCommand(),
+			new LoadSchemasCommand(), new LoadModulesCommand());
 		deploySampleApp();
 	}
 }