#321 Can now list all supported properties

Author: rjrudin

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

@@ -152,6 +152,8 @@ 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("mlPrepareRestApiDependencies", type: PrepareRestApiDependenciesTask, group: devGroup, dependsOn: project.configurations["mlRestApi"], description: "Downloads (if necessary) and unzips in the build directory all mlRestApi dependencies")
+		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)")
 		project.task("mlNewProject", type: NewProjectTask, group: devGroup, description: "Run a wizard for creating a new project, which includes running mlScaffold")
 		project.task("mlNewAmp", type: NewAmpTask, group: devGroup, description: "Generate a new amp resource file. " + newResourceMessage)
@@ -253,9 +255,6 @@ class MarkLogicPlugin implements Plugin<Project> {
 		String triggerGroup = "ml-gradle Trigger"
 		project.task("mlDeployTriggers", type: DeployTriggersTask, group: triggerGroup, description: "Deploy each trigger, updating it if it exists, in the configuration directory")
 
-		String generalGroup = "ml-gradle General"
-		project.task("mlPrintCommands", type: PrintCommandsTask, group: generalGroup, description: "Print information about each command used by mlDeploy and mlUndeploy")
-
 		String shellGroup = "ml-gradle Shell"
 		project.task("mlShell", type: ShellTask, group: shellGroup, description: "Run groovysh with MarkLogic-specific support built in")
 
@@ -320,14 +319,20 @@ class MarkLogicPlugin implements Plugin<Project> {
 	}
 
 	void initializeAppDeployerObjects(Project project) {
-		AdminConfig adminConfig = new DefaultAdminConfigFactory(new ProjectPropertySource(project)).newAdminConfig()
+		DefaultAdminConfigFactory adminConfigFactory = new DefaultAdminConfigFactory(new ProjectPropertySource(project))
+		project.extensions.add("mlAdminConfigFactory", adminConfigFactory)
+		AdminConfig adminConfig = adminConfigFactory.newAdminConfig()
 		project.extensions.add("mlAdminConfig", adminConfig)
 
 		ProjectPropertySource propertySource = new ProjectPropertySource(project);
-		AppConfig appConfig = new DefaultAppConfigFactory(propertySource).newAppConfig()
+		DefaultAppConfigFactory appConfigFactory = new DefaultAppConfigFactory(propertySource)
+		project.extensions.add("mlAppConfigFactory", appConfigFactory)
+		AppConfig appConfig = appConfigFactory.newAppConfig()
 		project.extensions.add("mlAppConfig", appConfig)
 
-		ManageConfig manageConfig = new DefaultManageConfigFactory(new ProjectPropertySource(project)).newManageConfig()
+		DefaultManageConfigFactory manageConfigFactory = new DefaultManageConfigFactory(new ProjectPropertySource(project))
+		project.extensions.add("mlManageConfigFactory", manageConfigFactory)
+		ManageConfig manageConfig = manageConfigFactory.newManageConfig()
 		project.extensions.add("mlManageConfig", manageConfig)
 
 		ManageClient manageClient = new ManageClient(manageConfig)

src/main/groovy/com/marklogic/gradle/task/PrintPropertiesTask.groovy

@@ -0,0 +1,34 @@
+package com.marklogic.gradle.task
+
+import com.marklogic.appdeployer.DefaultAppConfigFactory
+import com.marklogic.mgmt.DefaultManageConfigFactory
+import com.marklogic.mgmt.admin.DefaultAdminConfigFactory
+import org.gradle.api.tasks.TaskAction
+
+class PrintPropertiesTask extends MarkLogicTask {
+
+	@TaskAction
+	void printProperties() {
+		DefaultManageConfigFactory manageConfigFactory = getProject().property("mlManageConfigFactory")
+		println "\nManage server connection properties"
+		for (String name : new TreeSet<>(manageConfigFactory.getPropertyConsumerMap().keySet())) {
+			println " - " + name
+		}
+
+		DefaultAdminConfigFactory adminConfigFactory = getProject().property("mlAdminConfigFactory")
+		println "\nAdmin server connection properties"
+		for (String name : new TreeSet<>(adminConfigFactory.getPropertyConsumerMap().keySet())) {
+			println " - " + name
+		}
+
+		DefaultAppConfigFactory appConfigFactory = getProject().property("mlAppConfigFactory")
+		println "\nApplication properties"
+		for (String name : new TreeSet<>(appConfigFactory.getPropertyConsumerMap().keySet())) {
+			println " - " + name
+		}
+
+		println "\nThe Manage server connection properties, Admin server connection properties, and " +
+			"application properties are listed above, with each set in alphabetical order. \nFor a list of " +
+			"all properties with documentation, see https://github.com/marklogic-community/ml-gradle/wiki/Property-reference ."
+	}
+}