#428 Better error message when roles have circular dependencies

Author: rjrudin

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

@@ -78,7 +78,15 @@ else if (index > -1) {
 			}
 		}
 
-		String[] sortedRoleNames = sorter.sort();
+		String[] sortedRoleNames;
+		try {
+			sortedRoleNames = sorter.sort();
+		} catch (IllegalStateException ex) {
+			throw new IllegalArgumentException("Unable to deploy roles due to circular dependencies " +
+				"between two or more roles; please remove these circular dependencies in order to deploy" +
+				" your roles");
+		}
+
 		roles = new ArrayList<>();
 		for (String name : sortedRoleNames) {
 			roles.add(map.get(name));

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

@@ -6,7 +6,7 @@
 
 import java.io.File;
 
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * Each of these tests verifies that the roles in the given config dir can be deployed successfully based on their
@@ -73,6 +73,22 @@ public void anotherSortingTest() {
 		}
 	}
 
+	@Test
+	void circularDependencies() {
+		appConfig.getFirstConfigDir().setBaseDir(new File("src/test/resources/sample-app/roles-with-circular-dependencies"));
+		initializeAppDeployer(new DeployRolesCommand());
+		try {
+			deploySampleApp();
+			fail("Expected an error due to a circular dependency between the two roles");
+		} catch (IllegalArgumentException ex) {
+			assertEquals("Unable to deploy roles due to circular dependencies between two or more roles; " +
+					"please remove these circular dependencies in order to deploy your roles",
+				ex.getMessage());
+		} finally {
+			undeploySampleApp();
+		}
+	}
+
 	@Test
 	public void test() {
 		appConfig.getFirstConfigDir().setBaseDir(new File("src/test/resources/sample-app/roles-with-dependencies"));

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

@@ -0,0 +1,6 @@
+{
+	"role-name": "sample-app-role0",
+	"role": [
+		"sample-app-role1"
+	]
+}

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

@@ -0,0 +1,6 @@
+{
+	"role-name": "sample-app-role1",
+	"role": [
+		"sample-app-role0"
+	]
+}