Merge pull request #774 from marklogic/feature/deprecations

MLE-23304 Removed deprecated items

Author: rjrudin

examples/properties-project/README.md

@@ -2,11 +2,11 @@ This project shows a basic setup of the [Gradle properties plugin](https://githu
 The plugin allows you to define a properties file for each environment that you need to deploy to. These properties 
 override whatever is in gradle.properties. 
 
-The "environmentName" property is used to specify a properties file. If that property is not specified, then 
-"gradle-local.properties" is used by default. That file is almost always ignored by version control, which is the case
+The `environmentName` property is used to specify a properties file. If that property is not specified, then 
+`gradle-local.properties` is used by default. That file is almost always ignored by version control, which is the case
 in this sample project - the file is listed in .gitignore. 
 
-The sample property files in this project only override "mlHost", but of course you can get as creative as you want. A
-more extreme example would be to override the "mlConfigDir" property to specify a different configuration directory for
+The sample property files in this project only override `mlHost`, but of course you can get as creative as you want. A
+more extreme example would be to override the `mlConfigPaths` property to specify a different configuration directory for
 each environment.
 

examples/redaction-ruleset-project/README.md

@@ -1,6 +1,6 @@
 This project shows an example of how MarkLogic 9 Redaction Rulesets can be loaded into a schemas
 database from src/main/ml-schemas (the default path - this can be overridden via 
-mlSchemasPath). 
+`mlSchemaPaths`). 
 
 Note that in order for this to work, the content-database.json file must specify the schema
 database that it's associated with. And in most cases, you'll want your own schemas database - not the default Schemas one - so schemas-database.json can be used to create own with a name based on mlAppName.

examples/schemas-project/README.md

@@ -1,6 +1,6 @@
-This project shows an example of how MarkLogic 9 schemas can be loaded into a schemas
-database from src/main/ml-schemas (the default path - this can be overridden via 
-mlSchemasPath). 
+This project shows an example of how MarkLogic schemas can be loaded into a schemas
+database from src/main/ml-schemas (the default path - this can be overridden via `mlSchemaPaths`). 
 
 Note that in order for this to work, the content-database.json file must specify the schema
-database that it's associated with. And in most cases, you'll want your own schemas database - not the default Schemas one - so schemas-database.json can be used to create own with a name based on mlAppName.
+database that it's associated with. And in most cases, you'll want your own schemas database - not the default 
+Schemas one - so schemas-database.json can be used to create a database with a name based on `mlAppName`.

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

@@ -88,13 +88,6 @@ public void initialize() {
 			}
 		});
 
-		propertyConsumerMap.put("mlOptimizeWithCma", (config, prop) -> {
-			logger.info("mlOptimizeWithCma is DEPRECATED; please use a property specific to the resource that you want to deploy with CMA");
-			// mlOptimizeWithCma was deprecated in 3.11; it was only used for deploying forests, so if the
-			// property is still used, the client in theory expects forests to still be deployed with CMA
-			config.getCmaConfig().setDeployForests(true);
-		});
-
 		propertyConsumerMap.put("mlCombineCmaRequests", (config, prop) -> {
 			logger.info("Combine requests" + cmaMessage + prop);
 			config.getCmaConfig().setCombineRequests(Boolean.parseBoolean(prop));
@@ -161,31 +154,18 @@ public void initialize() {
 
 		/**
 		 * The path to the directory containing all the resource configuration files. Defaults to src/main/ml-config.
-		 * mlConfigPath is the preferred one, as its name is consistent with other properties that refer to a path.
-		 * mlConfigDir is deprecated but still supported.
 		 *
-		 * As of 3.3.0, mlConfigPaths is the preferred property, and mlConfigDir and mlConfigPath will be ignored if
-		 * it's set.
+		 * As of 3.3.0, mlConfigPaths is the preferred property, and mlConfigPath will be ignored if it's set.
 		 */
 		propertyConsumerMap.put("mlConfigPaths", (config, prop) -> {
-			logger.info("Config paths: " + prop);
+			logger.info("Config paths: {}", prop);
 			List<ConfigDir> list = new ArrayList<>();
 			for (String path : prop.split(",")) {
 				list.add(buildConfigDir(path));
 			}
 			config.setConfigDirs(list);
 		});
 
-		// TODO Only process if mlConfigPaths not set?
-		propertyConsumerMap.put("mlConfigDir", (config, prop) -> {
-			logger.info("mlConfigDir is deprecated; please use mlConfigPath; Config dir: " + prop);
-			config.setConfigDir(buildConfigDir(prop));
-		});
-		propertyConsumerMap.put("mlConfigPath", (config, prop) -> {
-			logger.info("Config path: " + prop);
-			config.setConfigDir(buildConfigDir(prop));
-		});
-
 		/**
 		 * Defines the MarkLogic host that requests should be sent to. Defaults to localhost.
 		 */
@@ -571,12 +551,6 @@ public void initialize() {
 			config.setTestContentDatabaseName(prop);
 		});
 
-		// Deprecated - use mlSchemaPaths instead
-		propertyConsumerMap.put("mlSchemasPath", (config, prop) -> {
-			logger.info("mlSchemasPath is deprecated as of version 3.13.0; please use mlSchemaPaths instead; schemas path: " + prop);
-			config.setSchemaPaths(buildPathListFromCommaDelimitedString(prop));
-		});
-
 		propertyConsumerMap.put("mlSchemaPaths", (config, prop) -> {
 			logger.info("Schema paths: " + prop);
 			config.setSchemaPaths(buildPathListFromCommaDelimitedString(prop));

ml-app-deployer/src/test/java/com/marklogic/appdeployer/DefaultAppConfigFactoryTest.java

@@ -41,7 +41,7 @@ public void withProjectDir() {
 		factory = new DefaultAppConfigFactory(new SimplePropertySource(
 			"mlConfigPaths", "path1,path2",
 			"mlModulePaths", "modulesPath1,modulesPath2",
-			"mlSchemasPath", "schemasPath"));
+			"mlSchemaPaths", "schemasPath"));
 
 		final String testPath = new File("").getAbsolutePath();
 
@@ -564,19 +564,6 @@ public void mostProperties() {
 		assertTrue(config.isCascadePermissions());
 	}
 
-	/**
-	 * Verifies that mlConfigDir is still supported, though mlConfigPath is preferred.
-	 */
-	@Test
-	public void mlConfigDir() {
-		Properties p = new Properties();
-		p.setProperty("mlConfigDir", "src/test/resources/sample-app/empty-ml-config");
-
-		factory = new DefaultAppConfigFactory(new SimplePropertySource(p));
-		AppConfig config = factory.newAppConfig();
-		assertTrue(config.getFirstConfigDir().getBaseDir().getAbsolutePath().contains("empty-ml-config"));
-	}
-
 	@Test
 	public void mlUsernameAndPassword() {
 		AppConfig config = configure("mlUsername", "customuser", "mlPassword", "custompassword");

ml-gradle/src/main/groovy/com/marklogic/gradle/MarkLogicPlugin.groovy

@@ -98,8 +98,6 @@ class MarkLogicPlugin implements Plugin<Project> {
 		copyGradlePropertiesToCustomTokensIfRequested(project)
 
 		project.getConfigurations().create("mlBundle")
-		// Per #420, this is deprecated, but still need to create it
-		project.getConfigurations().create("mlRestApi")
 
 		// No group or description on these so they don't show up in "gradle tasks"
 		project.task("mlDeployApp", type: DeployAppTask, dependsOn: ["mlDeleteModuleTimestampsFile"])
@@ -188,7 +186,6 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlCreateTransform", type: CreateTransformTask, group: devGroup, description: "Create a new transform in the modules transforms directory; use -PtransformName and -PtransformType to set the transform name and type (xqy, xsl, or sjs)")
 		project.task("mlExportResources", type: ExportResourcesTask, group: devGroup, description: "Export resources based on a properties file specified via -PpropertiesFile, -Pprefix, or -Pregex; use -PincludeTypes to select resource types to export via a comma-delimited string; use -PexportPath to specify where to export resources to")
 		project.task("mlPrepareBundles", type: PrepareBundlesTask, group: devGroup, dependsOn: project.configurations["mlBundle"], description: "Downloads (if necessary) and unzips in the build directory all mlBundle dependencies")
-		project.task("mlPrepareRestApiDependencies", type: PrepareBundlesTask, group: devGroup, dependsOn: project.configurations["mlBundle"], description: "Deprecated in 3.13.0; please use mlPrepareBundles instead")
 		project.task("mlPrintCommands", type: PrintCommandsTask, group: devGroup, description: "Print information about each command used by mlDeploy and mlUndeploy")
 		project.task("mlPrintProperties", type: PrintPropertiesTask, group: devGroup, description: "Print all of the properties supported by ml-gradle")
 		project.task("mlPrintTokens", type: PrintTokensTask, group: devGroup, description: "Print the customTokens map on the mlAppConfig object (typically for debugging purposes)")
@@ -220,10 +217,10 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlEnableAllFlexrepTargets", type: EnableAllFlexrepTargetsTask, group: flexrepGroup, description: "Enable every target on every flexrep config")
 
 		String forestGroup = "ml-gradle Forest"
-		project.task("mlConfigureForestReplicas", type: ConfigureForestReplicasTask, group: forestGroup, description: "Deprecated - configure forest replicas via the command.forestNamesAndReplicaCounts map")
-		project.task("mlDeleteForestReplicas", type: DeleteForestReplicasTask, group: forestGroup, description: "Deprecated - delete forest replicas via the command.forestNamesAndReplicaCounts map; requires -Pconfirm=true to be set so this isn't accidentally executed")
+		project.task("mlConfigureForestReplicas", type: ConfigureForestReplicasTask, group: forestGroup, description: "Configures forest replicas based on ml-gradle properties")
+		project.task("mlDeleteForestReplicas", type: DeleteForestReplicasTask, group: forestGroup, description: "Deletes forest replicas based on ml-gradle properties; requires -Pconfirm=true to be set so this isn't accidentally executed")
 		project.task("mlDeployCustomForests", type: DeployCustomForestsTask, group: forestGroup, description: "Deploy custom forests as defined in subdirectories of the forests configuration directory")
-		project.task("mlDeployForestReplicas", type: DeployForestReplicasTask, group: forestGroup, description: "Prefer this over mlConfigureForestReplicas; it does the same thing, but uses the ConfigureForestReplicasCommand that is used by mlDeploy")
+		project.task("mlDeployForestReplicas", type: DeployForestReplicasTask, group: forestGroup, description: "Alias for mlConfigureForestReplicas for naming consistency")
 		project.task("mlPrintForestPlan", type: PrintForestPlanTask, group: forestGroup, description: "Print a list of primary forests to be created for a database specified by -Pdatabase=(name of database) when the database is next deployed. " +
 			"This is only intended to be used when forests are created dynamically via properties.")
 

ml-gradle/src/main/groovy/com/marklogic/gradle/task/client/AbstractModuleCreationTask.groovy

@@ -9,7 +9,7 @@ class AbstractModuleCreationTask extends MarkLogicTask{
 
 	/**
 	 * Select the first modules path that is a valid location for creating a new module. Intent is to filter out
-	 * paths containing "mlRestApi" or "mlBundle" as those almost certainly point to directories where bundles have been
+	 * paths containing "mlBundle" as those almost certainly point to directories where bundles have been
 	 * unzipped to, and we don't want to create new modules in those directories.
 	 *
 	 * @return
@@ -18,7 +18,7 @@ class AbstractModuleCreationTask extends MarkLogicTask{
 		String path
 		List<String> modulePaths = getAppConfig().getModulePaths()
 		for (String modulePath : modulePaths) {
-			if (modulePath != null && !modulePath.contains("mlRestApi") && !modulePath.contains("mlBundle")) {
+			if (modulePath != null && !modulePath.contains("mlBundle")) {
 				path = modulePath
 				break
 			}

ml-gradle/src/main/groovy/com/marklogic/gradle/task/client/PrepareBundlesTask.groovy

@@ -19,7 +19,6 @@ class PrepareBundlesTask extends MarkLogicTask {
 
 	@TaskAction
 	void prepareBundles() {
-		prepareBundlesForConfiguration("mlRestApi")
 		prepareBundlesForConfiguration("mlBundle")
 	}
 
@@ -30,10 +29,6 @@ class PrepareBundlesTask extends MarkLogicTask {
 
 				getLogger().info("Found " + configurationName + " configuration, will extract all of its dependencies to build/" + configurationName)
 
-				if ("mlRestApi".equals(configurationName)) {
-					println "\nWARNING: mlRestApi is deprecated as of release 3.13.0, please use mlBundle instead, which is a drop-in replacement.\n"
-				}
-				
 				def buildDir = new File(getProject().getProjectDir(), "build")
 				buildDir.mkdirs()
 				def bundleDir = new File(buildDir, configurationName)