#128 Adding diff'ing for generated files

Author: rjrudin

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

@@ -99,8 +99,14 @@ protected void generateInstanceConverter(AppConfig appConfig, GeneratedCode code
 			File out = new File(esDir, code.getTitle() + "-" + code.getVersion() + ".xqy");
 			String logMessage = "Wrote instance converter to: ";
 			if (out.exists()) {
+				if (!fileHasDifferentContent(out, instanceConverter)) {
+					if (logger.isInfoEnabled()) {
+						logger.info("Instance converter matches file, so not modifying: " + out.getAbsolutePath());
+					}
+					return;
+				}
 				out = new File(esDir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.xqy");
-				logMessage = "Instance converter file already exists; writing new generated copy to: ";
+				logMessage = "Instance converter does not match existing file, so writing to: ";
 			}
 			try {
 				FileCopyUtils.copy(instanceConverter.getBytes(), out);
@@ -121,8 +127,14 @@ protected void generateSearchOptions(GeneratedCode code, File modulesDir) {
 			File out = new File(optionsDir, code.getTitle() + ".xml");
 			String logMessage = "Wrote search options to: ";
 			if (out.exists()) {
+				if (!fileHasDifferentContent(out, searchOptions)) {
+					if (logger.isInfoEnabled()) {
+						logger.info("Search options matches file, so not modifying: " + out.getAbsolutePath());
+					}
+					return;
+				}
 				out = new File(optionsDir, code.getTitle() + "-GENERATED.xml");
-				logMessage = "Search options file already exists; writing new generated copy to: ";
+				logMessage = "Search options does not match existing file, so writing to: ";
 			}
 			try {
 				FileCopyUtils.copy(searchOptions.getBytes(), out);
@@ -150,8 +162,14 @@ protected void generateDatabaseProperties(AppConfig appConfig, GeneratedCode cod
 			File out = new File(dbDir, "content-database.json");
 			String logMessage = "Wrote database properties to: ";
 			if (out.exists()) {
+				if (!fileHasDifferentContent(out, props)) {
+					if (logger.isInfoEnabled()) {
+						logger.info("Database properties matches file, so not modifying: " + out.getAbsolutePath());
+					}
+					return;
+				}
 				out = new File(dbDir, "content-database-GENERATED.json");
-				logMessage = "Database properties file already exists; writing new generated copy to: ";
+				logMessage = "Database properties does not match existing file, so writing to: ";
 			}
 			try {
 				FileCopyUtils.copy(props.getBytes(), out);
@@ -183,8 +201,14 @@ protected void generateSchema(AppConfig appConfig, GeneratedCode code) {
 			File out = new File(dir, code.getTitle() + "-" + code.getVersion() + ".xsd");
 			String logMessage = "Wrote schema to: ";
 			if (out.exists()) {
+				if (!fileHasDifferentContent(out, schema)) {
+					if (logger.isInfoEnabled()) {
+						logger.info("Schema matches file, so not modifying: " + out.getAbsolutePath());
+					}
+					return;
+				}
 				out = new File(dir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.xsd");
-				logMessage = "Schema file already exists; writing new generated copy to: ";
+				logMessage = "Schema does not match existing file, so writing to: ";
 			}
 			try {
 				FileCopyUtils.copy(schema.getBytes(), out);
@@ -205,8 +229,14 @@ protected void generateExtractionTemplate(AppConfig appConfig, GeneratedCode cod
 			File out = new File(dir, code.getTitle() + "-" + code.getVersion() + ".tdex");
 			String logMessage = "Wrote extraction template to: ";
 			if (out.exists()) {
+				if (!fileHasDifferentContent(out, template)) {
+					if (logger.isInfoEnabled()) {
+						logger.info("Extraction template matches file, so not modifying: " + out.getAbsolutePath());
+					}
+					return;
+				}
 				out = new File(dir, code.getTitle() + "-" + code.getVersion() + "-GENERATED.tdex");
-				logMessage = "Extraction template already exists; writing new generated copy to: ";
+				logMessage = "Extraction template does not match existing file, so writing to: ";
 			}
 			try {
 				FileCopyUtils.copy(template.getBytes(), out);
@@ -219,6 +249,42 @@ protected void generateExtractionTemplate(AppConfig appConfig, GeneratedCode cod
 		}
 	}
 
+	/**
+	 * Determines if a file matches generated code, in which case we don't need to do anything further with the
+	 * generated code.
+	 *
+	 * @param existingFile
+	 * @param content
+	 * @return
+	 */
+	protected boolean fileHasDifferentContent(File existingFile, String content) {
+		try {
+			String fileContent = new String(FileCopyUtils.copyToByteArray(existingFile));
+			fileContent = removeGeneratedAtTimestamp(fileContent);
+			content = removeGeneratedAtTimestamp(content);
+			return !fileContent.equals(content);
+		} catch (IOException e) {
+			// Shouldn't occur, but if it does, treat it as the file having different content
+			return true;
+		}
+	}
+
+	/**
+	 * The instance converter module has a timestamp in it that has to be removed in order to tell if its contents match
+	 * that of an existing instance converter; the timestamp will of course nearly always be different.
+	 *
+	 * @param content
+	 * @return
+	 */
+	protected String removeGeneratedAtTimestamp(String content) {
+		int pos = content.indexOf("Generated at timestamp");
+		if (pos > -1) {
+			int end = content.indexOf(":)", pos);
+			return content.substring(0, pos) + content.substring(end + 2);
+		}
+		return content;
+	}
+
 	public void setOptionsPath(String optionsPath) {
 		this.optionsPath = optionsPath;
 	}

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

@@ -18,7 +18,7 @@ public class GenerateModelArtifactsTest extends AbstractAppDeployerTest {
 	public void tearDown() {
 		initializeAppDeployer(new DeployContentDatabasesCommand(), new DeploySchemasDatabaseCommand(),
 			new DeployRestApiServersCommand());
-		undeploySampleApp();
+		//undeploySampleApp();
 	}
 
 	@Test
@@ -48,15 +48,16 @@ public void test() {
 
 		deploySampleApp();
 
-		assertTrue(new File(projectPath, "src/main/ml-modules/ext/entity-services/Race-0.0.1-GENERATED.xqy").exists());
-		assertTrue(new File(projectPath, "src/main/ml-modules/options/Race-GENERATED.xml").exists());
-		assertTrue(new File(projectPath, "src/main/ml-config/databases/content-database-GENERATED.json").exists());
-		assertTrue(new File(projectPath, "src/main/ml-schemas/Race-0.0.1-GENERATED.xsd").exists());
-		assertTrue(new File(projectPath, "src/main/ml-schemas/Race-0.0.1-GENERATED.tdex").exists());
+		// These shouldn't exist because the content is the same
+		assertFalse(new File(projectPath, "src/main/ml-modules/ext/entity-services/Race-0.0.1-GENERATED.xqy").exists());
+		assertFalse(new File(projectPath, "src/main/ml-modules/options/Race-GENERATED.xml").exists());
+		assertFalse(new File(projectPath, "src/main/ml-config/databases/content-database-GENERATED.json").exists());
+		assertFalse(new File(projectPath, "src/main/ml-schemas/Race-0.0.1-GENERATED.xsd").exists());
+		assertFalse(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 DeploySchemasDatabaseCommand(),
 			new LoadSchemasCommand(), new LoadModulesCommand());
-		deploySampleApp();
+		//deploySampleApp();
 	}
 }