#172 Sorting roles by dependencies before deploying

Author: rjrudin

src/main/java/com/marklogic/appdeployer/AppConfig.java

@@ -111,6 +111,8 @@ public class AppConfig {
     // Controls whether replicas are deleted or not when undeploying a database
     private boolean deleteReplicas = true;
 
+    private boolean sortRolesByDependencies = true;
+
     // As defined by the REST API
     private String modulePermissions = "rest-admin,read,rest-admin,update,rest-extension-user,execute";
 
@@ -801,4 +803,12 @@ public String getAppServicesPassword() {
 	public void setAppServicesPassword(String appServicesPassword) {
 		this.appServicesPassword = appServicesPassword;
 	}
+
+	public boolean isSortRolesByDependencies() {
+		return sortRolesByDependencies;
+	}
+
+	public void setSortRolesByDependencies(boolean sortRolesByDependencies) {
+		this.sortRolesByDependencies = sortRolesByDependencies;
+	}
 }

src/main/java/com/marklogic/appdeployer/ConfigDir.java

@@ -76,6 +76,10 @@ public File getSecurityDir() {
 		return new File(baseDir, "security");
 	}
 
+	public File getRolesDir() {
+		return new File(getSecurityDir(), "roles");
+	}
+
 	public File getServersDir() {
 		return new File(baseDir, "servers");
 	}

src/main/java/com/marklogic/appdeployer/DefaultAppConfigFactory.java

@@ -420,6 +420,16 @@ public AppConfig newAppConfig() {
 			c.setResourceFilenamesToIgnore(values);
 		}
 
+		/**
+		 * Version 2.9.0 of ml-app-deployer, by default, sorts role files by reading each file and looking at the role
+		 * dependencies. You can disable this behavior by setting this property to false.
+		 */
+		prop = getProperty("mlSortRolesByDependencies");
+		if (prop != null) {
+			logger.info("Sort roles by dependencies: " + prop);
+			c.setSortRolesByDependencies(Boolean.parseBoolean(prop));
+		}
+
 		return c;
 	}
 

src/main/java/com/marklogic/appdeployer/command/AbstractResourceCommand.java

@@ -39,7 +39,7 @@ protected void processExecuteOnResourceDir(CommandContext context, File resource
             if (logger.isInfoEnabled()) {
                 logger.info("Processing files in directory: " + resourceDir.getAbsolutePath());
             }
-            for (File f : listFilesInDirectory(resourceDir)) {
+            for (File f : listFilesInDirectory(resourceDir, context)) {
                 if (logger.isInfoEnabled()) {
                     logger.info("Processing file: " + f.getAbsolutePath());
                 }
@@ -49,6 +49,19 @@ protected void processExecuteOnResourceDir(CommandContext context, File resource
         }
     }
 
+	/**
+	 * Defaults to the parent method. This was extracted so that a subclass can override it and have access to the
+	 * CommandContext, which allows for reading in the contents of each file and replacing tokens, which may impact the
+	 * order in which the files are processed.
+	 *
+	 * @param resourceDir
+	 * @param context
+	 * @return
+	 */
+	protected File[] listFilesInDirectory(File resourceDir, CommandContext context) {
+    	return listFilesInDirectory(resourceDir);
+    }
+
     /**
      * Subclasses can override this to add functionality after a resource has been saved.
      *

src/main/java/com/marklogic/appdeployer/command/security/DeployRolesCommand.java

@@ -1,27 +1,102 @@
 package com.marklogic.appdeployer.command.security;
 
-import java.io.File;
-
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.marklogic.appdeployer.command.AbstractResourceCommand;
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.SortOrderConstants;
+import com.marklogic.mgmt.PayloadParser;
 import com.marklogic.mgmt.ResourceManager;
+import com.marklogic.mgmt.api.security.Role;
 import com.marklogic.mgmt.security.RoleManager;
+import com.marklogic.rest.util.Fragment;
+
+import java.io.File;
+import java.util.*;
 
 public class DeployRolesCommand extends AbstractResourceCommand {
 
-    public DeployRolesCommand() {
-        setExecuteSortOrder(SortOrderConstants.DEPLOY_ROLES);
-        setUndoSortOrder(SortOrderConstants.DELETE_ROLES);
-    }
+	public DeployRolesCommand() {
+		setExecuteSortOrder(SortOrderConstants.DEPLOY_ROLES);
+		setUndoSortOrder(SortOrderConstants.DELETE_ROLES);
+	}
+
+	/**
+	 * Overriding this so we can list the files based on role dependencies.
+	 *
+	 * @param dir
+	 * @return
+	 */
+	@Override
+	protected File[] listFilesInDirectory(File dir, CommandContext context) {
+		File[] files = super.listFilesInDirectory(dir);
+
+		if (context.getAppConfig().isSortRolesByDependencies()) {
+			if (logger.isInfoEnabled()) {
+				logger.info("Sorting role files by role dependencies");
+			}
+			List<RoleFile> roleFiles = sortFilesBasedOnRoleDependencies(files, context);
+			files = new File[files.length];
+			for (int i = 0; i < roleFiles.size(); i++) {
+				files[i] = roleFiles.get(i).file;
+			}
+		}
+
+		return files;
+	}
+
+	protected List<RoleFile> sortFilesBasedOnRoleDependencies(File[] files, CommandContext context) {
+		List<RoleFile> roleFiles = new ArrayList<>();
+		PayloadParser parser = new PayloadParser();
+		for (File f : files) {
+			RoleFile rf = new RoleFile(f);
+			String payload = copyFileToString(f, context);
+			if (parser.isJsonPayload(payload)) {
+				JsonNode json = parser.parseJson(payload);
+				rf.role.setRoleName(json.get("role-name").asText());
+				if (json.has("role")) {
+					ArrayNode roles = (ArrayNode) json.get("role");
+					Iterator<JsonNode> iter = roles.elements();
+					while (iter.hasNext()) {
+						rf.role.getRole().add(iter.next().asText());
+					}
+				}
+			} else {
+				Fragment frag = new Fragment(payload);
+				rf.role.setRoleName(frag.getElementValue("/node()/m:role-name"));
+				rf.role.setRole(frag.getElementValues("/node()/m:roles/m:role"));
+			}
+			roleFiles.add(rf);
+		}
+
+		Collections.sort(roleFiles);
+		return roleFiles;
+	}
+
+	protected File[] getResourceDirs(CommandContext context) {
+		return new File[]{context.getAppConfig().getConfigDir().getRolesDir()};
+	}
+
+	@Override
+	protected ResourceManager getResourceManager(CommandContext context) {
+		return new RoleManager(context.getManageClient());
+	}
+
+}
+
+class RoleFile implements Comparable<RoleFile> {
 
-    protected File[] getResourceDirs(CommandContext context) {
-        return new File[] { new File(context.getAppConfig().getConfigDir().getSecurityDir(), "roles") };
-    }
+	File file;
+	Role role;
 
-    @Override
-    protected ResourceManager getResourceManager(CommandContext context) {
-        return new RoleManager(context.getManageClient());
-    }
+	public RoleFile(File file) {
+		this.file = file;
+		this.role = new Role();
+		this.role.setRole(new ArrayList<String>());
+	}
 
+	@Override
+	public int compareTo(RoleFile o) {
+		return this.role.compareTo(o.role);
+	}
 }

src/main/java/com/marklogic/mgmt/api/security/Role.java

@@ -8,7 +8,7 @@
 import com.marklogic.mgmt.api.Resource;
 import com.marklogic.mgmt.security.RoleManager;
 
-public class Role extends Resource {
+public class Role extends Resource implements Comparable<Role> {
 
     private String roleName;
     private String description;
@@ -27,7 +27,27 @@ public Role(API api, String roleName) {
         this.roleName = roleName;
     }
 
-    public void addExternalName(String name) {
+	@Override
+	public int compareTo(Role other) {
+    	if (other == null) {
+    		return 0;
+	    }
+    	if (this.role == null || this.role.isEmpty()) {
+    		return -1;
+	    }
+	    if (other.role == null || other.role.isEmpty()) {
+    		return 1;
+	    }
+		if (other.role.contains(this.roleName)) {
+    		return -1;
+		}
+		if (this.role.contains(other.roleName)) {
+    		return 1;
+		}
+		return -1;
+	}
+
+	public void addExternalName(String name) {
         if (externalName == null) {
             externalName = new ArrayList<>();
         }

src/test/java/com/marklogic/appdeployer/DefaultAppConfigFactoryTest.java

@@ -118,6 +118,8 @@ public void allProperties() {
 	    p.setProperty("mlReplicaForestFastDataDirectory", "/var/fast");
 	    p.setProperty("mlReplicaForestLargeDataDirectory", "/var/large");
 
+	    p.setProperty("mlSortRolesByDependencies", "false");
+
 	    sut = new DefaultAppConfigFactory(new SimplePropertySource(p));
         AppConfig config = sut.newAppConfig();
 
@@ -170,6 +172,8 @@ public void allProperties() {
 	    assertEquals("/var/data", config.getReplicaForestDataDirectory());
 	    assertEquals("/var/fast", config.getReplicaForestFastDataDirectory());
 	    assertEquals("/var/large", config.getReplicaForestLargeDataDirectory());
+
+	    assertFalse(config.isSortRolesByDependencies());
     }
 
 	/**

src/test/java/com/marklogic/appdeployer/command/security/DeployRolesWithDependenciesTest.java

@@ -0,0 +1,47 @@
+package com.marklogic.appdeployer.command.security;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.appdeployer.command.CommandContext;
+import com.marklogic.mgmt.security.RoleManager;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.File;
+
+public class DeployRolesWithDependenciesTest extends AbstractAppDeployerTest {
+
+	@Before
+	public void setup() {
+		appConfig.getConfigDir().setBaseDir(new File("src/test/resources/sample-app/roles-with-dependencies"));
+	}
+
+	@Test
+	public void testSorting() {
+		DeployRolesCommand command = new DeployRolesCommand();
+		File[] files = command.listFilesInDirectory(appConfig.getConfigDir().getRolesDir(),
+			new CommandContext(appConfig, manageClient, null));
+
+		assertEquals("role3.json", files[0].getName());
+		assertEquals("role2.xml", files[1].getName());
+		assertEquals("role1.json", files[2].getName());
+		assertEquals("role4.xml", files[3].getName());
+		assertEquals("role5.json", files[4].getName());
+		assertEquals("role0.json", files[5].getName());
+	}
+
+	@Test
+	public void test() {
+		initializeAppDeployer(new DeployRolesCommand());
+
+		try {
+			appDeployer.deploy(appConfig);
+
+			RoleManager mgr = new RoleManager(manageClient);
+			for (int i = 0; i <= 5; i++) {
+				assertTrue(mgr.exists("sample-app-role" + i));
+			}
+		} finally {
+			undeploySampleApp();
+		}
+	}
+}

src/test/resources/sample-app/roles-with-dependencies/security/roles/role0.json

@@ -0,0 +1,10 @@
+{
+	"role-name": "sample-app-role0",
+	"role": [
+		"sample-app-role1",
+		"sample-app-role2",
+		"sample-app-role3",
+		"sample-app-role4",
+		"sample-app-role5"
+	]
+}

src/test/resources/sample-app/roles-with-dependencies/security/roles/role1.json

@@ -0,0 +1,7 @@
+{
+	"role-name": "sample-app-role1",
+	"role": [
+		"sample-app-role2",
+		"sample-app-role3"
+	]
+}