#172 Sorting roles multiple times if needed

Author: rjrudin

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

@@ -16,6 +16,8 @@
 
 public class DeployRolesCommand extends AbstractResourceCommand {
 
+	private int maxSortAttempts = 100;
+
 	public DeployRolesCommand() {
 		setExecuteSortOrder(SortOrderConstants.DEPLOY_ROLES);
 		setUndoSortOrder(SortOrderConstants.DELETE_ROLES);
@@ -72,7 +74,27 @@ protected List<RoleFile> sortFilesBasedOnRoleDependencies(File[] files, CommandC
 			roleFiles.add(rf);
 		}
 
-		return sortRoleFiles(roleFiles);
+		return keepSortingRoleFilesUntilOrderDoesntChange(roleFiles);
+	}
+
+	/**
+	 * Some sets of role files require multiple sorts until the order no longer changes. The maxSortAttempts class
+	 * attribute controls how many times this command will try to sort the roles.
+	 *
+	 * @param roleFiles
+	 * @return
+	 */
+	protected List<RoleFile> keepSortingRoleFilesUntilOrderDoesntChange(List<RoleFile> roleFiles) {
+		List<RoleFile> previousRoleFiles;
+		int counter = 0;
+		do {
+			previousRoleFiles = roleFiles;
+			roleFiles = new ArrayList<>();
+			roleFiles.addAll(previousRoleFiles);
+			roleFiles = sortRoleFiles(roleFiles);
+			counter++;
+		} while (!previousRoleFiles.equals(roleFiles) && counter < maxSortAttempts);
+		return roleFiles;
 	}
 
 	protected List<RoleFile> sortRoleFiles(List<RoleFile> roleFiles) {
@@ -90,8 +112,15 @@ protected ResourceManager getResourceManager(CommandContext context) {
 		return new RoleManager(context.getManageClient());
 	}
 
+	public void setMaxSortAttempts(int maxSortAttempts) {
+		this.maxSortAttempts = maxSortAttempts;
+	}
 }
 
+/**
+ * Simple data structure for associating a File that defines a role, and the parsed Role that is used for
+ * sorting the role files.
+ */
 class RoleFile {
 
 	File file;
@@ -103,6 +132,15 @@ public RoleFile(File file) {
 		this.role.setRole(new ArrayList<String>());
 	}
 
+	@Override
+	public int hashCode() {
+		return role.getRoleName().hashCode();
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		return role.getRoleName().equals(((RoleFile)obj).role.getRoleName());
+	}
 }
 
 /**
@@ -139,16 +177,13 @@ public RoleFileComparator(List<RoleFile> roleFiles) {
 
 	@Override
 	public int compare(RoleFile o1, RoleFile o2) {
-		if (o1 == null && o2 != null) {
-			return 1;
-		}
-		if (o2 == null) {
-			return -1;
+		if (o1.role.getRole().isEmpty() && o2.role.getRole().isEmpty()) {
+			return 0;
 		}
-		if (o1.role.getRole() == null || o1.role.getRole().isEmpty()) {
+		if (o1.role.getRole().isEmpty()) {
 			return -1;
 		}
-		if (o2.role.getRole() == null || o2.role.getRole().isEmpty()) {
+		if (o2.role.getRole().isEmpty()) {
 			return 1;
 		}
 		if (o2.role.getRole().contains(o1.role.getRoleName())) {

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

@@ -3,7 +3,6 @@
 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;
@@ -29,6 +28,29 @@ public void testSorting() {
 		assertEquals("role0.json", files[5].getName());
 	}
 
+	/**
+	 * This scenario features role files that must be sorted multiple times in order for them to be in the correct
+	 * order.
+	 */
+	@Test
+	public void testEvenMoreRoles() {
+		appConfig.getConfigDir().setBaseDir(new File("src/test/resources/sample-app/even-more-roles-with-dependencies"));
+
+		DeployRolesCommand command = new DeployRolesCommand();
+		File[] files = command.listFilesInDirectory(appConfig.getConfigDir().getRolesDir(),
+			new CommandContext(appConfig, manageClient, null));
+
+		assertEquals("abc-login-role.json", files[0].getName());
+		assertEquals("abc-ui-developer.json", files[1].getName());
+		assertEquals("xyz-reader.json", files[2].getName());
+		assertEquals("xyz-writer.json", files[3].getName());
+		assertEquals("xyz-admin.json", files[4].getName());
+		assertEquals("abc-sss-ui-role.json", files[5].getName());
+		assertEquals("abc-ui-offline-user.json", files[6].getName());
+		assertEquals("abc-ui-offline-admin.json", files[7].getName());
+		assertEquals("abc-ui-admin.json", files[8].getName());
+	}
+
 	/**
 	 * This scenario tests that when two roles are next to each other with different dependencies - role1 and role2 -
 	 * that we figure out that role1 has a dependency on a role closest to the end of the current list of files.

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-login-role.json

@@ -0,0 +1,3 @@
+{
+  "role-name" : "abc-login-role"
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-sss-ui-role.json

@@ -0,0 +1,4 @@
+{
+  "role-name" : "abc-sss-ui-role",
+  "role" : [ "xyz-reader", "xyz-writer" ]
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-ui-admin.json

@@ -0,0 +1,4 @@
+{
+  "role-name" : "abc-ui-admin",
+  "role" : [ "abc-ui-offline-admin", "flexrep-admin" ]
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-ui-developer.json

@@ -0,0 +1,3 @@
+{
+  "role-name" : "abc-ui-developer"
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-ui-offline-admin.json

@@ -0,0 +1,4 @@
+{
+  "role-name" : "abc-ui-offline-admin",
+  "role" : [ "abc-ui-offline-user" ]
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/abc-ui-offline-user.json

@@ -0,0 +1,4 @@
+{
+  "role-name" : "abc-ui-offline-user",
+  "role" : [ "abc-sss-ui-role" ]
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/xyz-admin.json

@@ -0,0 +1,4 @@
+{
+  "role-name" : "xyz-admin",
+  "role" : [ "xyz-reader", "xyz-writer", "qconsole-user" ]
+}

src/test/resources/sample-app/even-more-roles-with-dependencies/security/roles/xyz-reader.json

@@ -0,0 +1,3 @@
+{
+  "role-name" : "xyz-reader"
+}