[refactor] Cleanup up SecurityManager XQuery Module Test code

Author: adamretter

exist-core/pom.xml

@@ -724,6 +724,7 @@
                                 <include>src/test/java/org/exist/xquery/functions/fn/ParsingFunctionsTest.java</include>
                                 <include>src/test/java/org/exist/xquery/functions/fn/transform/ConvertTest.java</include>
                                 <include>src/test/java/org/exist/xquery/functions/fn/transform/FunTransformITTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/SecurityManagerTestUtil.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/system/FunctionAvailable.java</include>
                                 <include>src/test/java/org/exist/xquery/functions/xmldb/XMLDBStoreTest.java</include>
                                 <include>src/test/java/org/exist/xquery/functions/xquery3/SerializeTest.java</include>
@@ -1095,6 +1096,11 @@
                                 <include>src/main/java/org/exist/xquery/functions/fn/transform/Transform.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/fn/transform/TreeUtils.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/integer/WordPicture.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/GetPermissionsTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/GroupManagementFunctionRemoveGroupTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/GroupMembershipFunctionRemoveGroupMemberTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/PermissionsFunctionChmodTest.java</include>
+                                <include>src/test/java/org/exist/xquery/functions/securitymanager/PermissionsFunctionChownTest.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/system/GetUptime.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/system/Shutdown.java</include>
                                 <include>src/main/java/org/exist/xquery/functions/system/SystemModule.java</include>
@@ -1615,6 +1621,12 @@
                                 <exclude>src/main/java/org/exist/xquery/functions/fn/transform/TreeUtils.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/functions/integer/WordPicture.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/functions/map/MapType.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/GetPermissionsTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/GroupManagementFunctionRemoveGroupTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/GroupMembershipFunctionRemoveGroupMemberTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/PermissionsFunctionChmodTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/PermissionsFunctionChownTest.java</exclude>
+                                <exclude>src/test/java/org/exist/xquery/functions/securitymanager/SecurityManagerTestUtil.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/functions/session/AbstractSessionTest.java</exclude>
                                 <exclude>src/test/java/org/exist/xquery/functions/session/AttributeTest.java</exclude>
                                 <exclude>src/main/java/org/exist/xquery/functions/system/FunctionAvailable.java</exclude>

exist-core/src/test/java/org/exist/xquery/functions/securitymanager/GetPermissionsTest.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -23,7 +47,6 @@
 
 import org.exist.EXistException;
 import org.exist.dom.memtree.ElementImpl;
-import org.exist.dom.memtree.NodeImpl;
 import org.exist.security.PermissionDeniedException;
 import org.exist.security.internal.SecurityManagerImpl;
 import org.exist.storage.BrokerPool;

exist-core/src/test/java/org/exist/xquery/functions/securitymanager/GroupManagementFunctionRemoveGroupTest.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -21,23 +45,19 @@
  */
 package org.exist.xquery.functions.securitymanager;
 
-import com.evolvedbinary.j8fu.function.Runnable3E;
 import org.exist.EXistException;
 import org.exist.security.*;
 import org.exist.security.SecurityManager;
-import org.exist.security.internal.aider.GroupAider;
-import org.exist.security.internal.aider.UserAider;
 import org.exist.storage.BrokerPool;
 import org.exist.storage.DBBroker;
 import org.exist.storage.txn.Txn;
 import org.exist.test.ExistEmbeddedServer;
 import org.exist.xquery.XPathException;
-import org.exist.xquery.XQuery;
-import org.exist.xquery.value.Sequence;
 import org.junit.*;
 
 import java.util.Optional;
 
+import static org.exist.xquery.functions.securitymanager.SecurityManagerTestUtil.*;
 import static org.junit.Assert.*;
 
 public class GroupManagementFunctionRemoveGroupTest {
@@ -56,21 +76,21 @@ public class GroupManagementFunctionRemoveGroupTest {
     @Test(expected = PermissionDeniedException.class)
     public void cannotDeleteDbaGroup() throws XPathException, PermissionDeniedException, EXistException {
         extractPermissionDenied(() -> {
-            xqueryRemoveGroup(SecurityManager.DBA_GROUP);
+            xqueryRemoveGroup(existWebServer.getBrokerPool(), SecurityManager.DBA_GROUP);
         });
     }
 
     @Test(expected = PermissionDeniedException.class)
     public void cannotDeleteGuestGroup() throws XPathException, PermissionDeniedException, EXistException {
         extractPermissionDenied(() -> {
-            xqueryRemoveGroup(SecurityManager.GUEST_GROUP);
+            xqueryRemoveGroup(existWebServer.getBrokerPool(), SecurityManager.GUEST_GROUP);
         });
     }
 
     @Test(expected = PermissionDeniedException.class)
     public void cannotDeleteUnknownGroup() throws XPathException, PermissionDeniedException, EXistException {
         extractPermissionDenied(() -> {
-            xqueryRemoveGroup(SecurityManager.UNKNOWN_GROUP);
+            xqueryRemoveGroup(existWebServer.getBrokerPool(), SecurityManager.UNKNOWN_GROUP);
         });
     }
 
@@ -264,69 +284,4 @@ public void deleteUsersSharingPersonalPrimaryGroup() throws PermissionDeniedExce
             transaction.commit();
         }
     }
-
-    private static Account createUser(final DBBroker broker, final SecurityManager sm, final String username, final String password) throws PermissionDeniedException, EXistException {
-        Group userGroup = new GroupAider(username);
-        sm.addGroup(broker, userGroup);
-        final Account user = new UserAider(username);
-        user.setPassword(password);
-        user.setPrimaryGroup(userGroup);
-        sm.addAccount(user);
-
-        userGroup = sm.getGroup(username);
-        userGroup.addManager(sm.getAccount(username));
-        sm.updateGroup(userGroup);
-
-        return user;
-    }
-
-    private static Group createGroup(final DBBroker broker, final SecurityManager sm, final String groupName) throws PermissionDeniedException, EXistException {
-        final Group otherGroup = new GroupAider(groupName);
-        return sm.addGroup(broker, otherGroup);
-    }
-
-    private static void addUserToGroup(final SecurityManager sm, final Account user, final Group group) throws PermissionDeniedException, EXistException {
-        user.addGroup(group.getName());
-        sm.updateAccount(user);
-    }
-
-    private static void setPrimaryGroup(final SecurityManager sm, final Account user, final Group group) throws PermissionDeniedException, EXistException {
-        user.setPrimaryGroup(group);
-        sm.updateAccount(user);
-    }
-
-    private static void removeUser(final SecurityManager sm, final String username) throws PermissionDeniedException, EXistException {
-        sm.deleteAccount(username);
-        removeGroup(sm, username);
-    }
-
-    private static void removeGroup(final SecurityManager sm, final String groupname) throws PermissionDeniedException, EXistException {
-        sm.deleteGroup(groupname);
-    }
-
-    private Sequence xqueryRemoveGroup(final String groupname) throws EXistException, PermissionDeniedException, XPathException {
-            final BrokerPool pool = existWebServer.getBrokerPool();
-
-        final String query =
-                "import module namespace sm = 'http://exist-db.org/xquery/securitymanager';\n" +
-                        "sm:remove-group('" + groupname + "')";
-
-        try (final DBBroker broker = pool.get(Optional.of(pool.getSecurityManager().getSystemSubject()))) {
-            final XQuery xquery = existWebServer.getBrokerPool().getXQueryService();
-            final Sequence result = xquery.execute(broker, query, null);
-            return result;
-        }
-    }
-
-    private static void extractPermissionDenied(final Runnable3E<XPathException, PermissionDeniedException, EXistException> runnable) throws XPathException, PermissionDeniedException, EXistException {
-        try {
-            runnable.run();
-        } catch (final XPathException e) {
-            if (e.getCause() != null && e.getCause() instanceof PermissionDeniedException) {
-                throw (PermissionDeniedException)e.getCause();
-            } else {
-                throw e;
-            }
-        }
-    }
 }

exist-core/src/test/java/org/exist/xquery/functions/securitymanager/GroupMembershipFunctionRemoveGroupMemberTest.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -21,26 +45,22 @@
  */
 package org.exist.xquery.functions.securitymanager;
 
-import com.evolvedbinary.j8fu.function.Runnable3E;
 import org.exist.EXistException;
 import org.exist.TestUtils;
 import org.exist.security.*;
 import org.exist.security.SecurityManager;
-import org.exist.security.internal.aider.GroupAider;
-import org.exist.security.internal.aider.UserAider;
 import org.exist.storage.BrokerPool;
 import org.exist.storage.DBBroker;
 import org.exist.storage.txn.Txn;
 import org.exist.test.ExistEmbeddedServer;
 import org.exist.xquery.XPathException;
-import org.exist.xquery.XQuery;
-import org.exist.xquery.value.Sequence;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
 import java.util.Optional;
 
+import static org.exist.xquery.functions.securitymanager.SecurityManagerTestUtil.*;
 import static org.junit.Assert.*;
 
 public class GroupMembershipFunctionRemoveGroupMemberTest {
@@ -59,9 +79,9 @@ public void cannotRemoveAllGroupsFromUserAsOwner() throws XPathException, Permis
         final BrokerPool pool = existWebServer.getBrokerPool();
         final Subject owner = pool.getSecurityManager().authenticate(USER1_NAME, USER1_NAME);
         extractPermissionDenied(() -> {
-            xqueryRemoveUserFromGroup(USER1_NAME, OTHER_GROUP2_NAME, Optional.of(owner));
-            xqueryRemoveUserFromGroup(USER1_NAME, OTHER_GROUP1_NAME, Optional.of(owner));
-            xqueryRemoveUserFromGroup(USER1_NAME, USER1_NAME, Optional.of(owner));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, OTHER_GROUP2_NAME, Optional.of(owner));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, OTHER_GROUP1_NAME, Optional.of(owner));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, USER1_NAME, Optional.of(owner));
         });
     }
 
@@ -70,9 +90,9 @@ public void cannotRemoveAllGroupsFromUserAsDBA() throws XPathException, Permissi
         final BrokerPool pool = existWebServer.getBrokerPool();
         final Subject admin = pool.getSecurityManager().authenticate(TestUtils.ADMIN_DB_USER, TestUtils.ADMIN_DB_PWD);
         extractPermissionDenied(() -> {
-            xqueryRemoveUserFromGroup(USER1_NAME, OTHER_GROUP2_NAME, Optional.of(admin));
-            xqueryRemoveUserFromGroup(USER1_NAME, OTHER_GROUP1_NAME, Optional.of(admin));
-            xqueryRemoveUserFromGroup(USER1_NAME, USER1_NAME, Optional.of(admin));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, OTHER_GROUP2_NAME, Optional.of(admin));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, OTHER_GROUP1_NAME, Optional.of(admin));
+            xqueryRemoveUserFromGroup(pool, USER1_NAME, USER1_NAME, Optional.of(admin));
         });
     }
 
@@ -88,11 +108,11 @@ public void setup() throws EXistException, PermissionDeniedException, XPathExcep
 
             final Group otherGroup1 = createGroup(broker, sm, OTHER_GROUP1_NAME);
             addUserToGroup(sm, user1, otherGroup1);
-            addUserAsGroupManager(USER1_NAME, OTHER_GROUP1_NAME);
+            xqueryAddUserAsGroupManager(pool, USER1_NAME, OTHER_GROUP1_NAME);
 
             final Group otherGroup2 = createGroup(broker, sm, OTHER_GROUP2_NAME);
             addUserToGroup(sm, user1, otherGroup2);
-            addUserAsGroupManager(USER1_NAME, OTHER_GROUP2_NAME);
+            xqueryAddUserAsGroupManager(pool, USER1_NAME, OTHER_GROUP2_NAME);
 
             transaction.commit();
         }
@@ -110,75 +130,4 @@ public void setup() throws EXistException, PermissionDeniedException, XPathExcep
             transaction.commit();
         }
     }
-
-    private Sequence xqueryRemoveUserFromGroup(final String username, final String groupname) throws XPathException, PermissionDeniedException, EXistException {
-        final BrokerPool pool = existWebServer.getBrokerPool();
-        final Optional<Subject> asUser = Optional.of(pool.getSecurityManager().getSystemSubject());
-        return xqueryRemoveUserFromGroup(username, groupname, asUser);
-    }
-
-    private Sequence xqueryRemoveUserFromGroup(final String username, final String groupname, final Optional<Subject> asUser) throws EXistException, PermissionDeniedException, XPathException {
-        final BrokerPool pool = existWebServer.getBrokerPool();
-
-        final String query =
-                "import module namespace sm = 'http://exist-db.org/xquery/securitymanager';\n" +
-                        "sm:remove-group-member('" + groupname + "', '" + username + "')";
-
-        try (final DBBroker broker = pool.get(asUser)) {
-            final XQuery xquery = existWebServer.getBrokerPool().getXQueryService();
-            final Sequence result = xquery.execute(broker, query, null);
-            return result;
-        }
-    }
-
-    private Sequence addUserAsGroupManager(final String username, final String groupname) throws EXistException, PermissionDeniedException, XPathException {
-        final BrokerPool pool = existWebServer.getBrokerPool();
-
-        final String query =
-                "import module namespace sm = 'http://exist-db.org/xquery/securitymanager';\n" +
-                        "sm:add-group-manager('" + groupname + "', '" + username + "')";
-
-        try (final DBBroker broker = pool.get(Optional.of(pool.getSecurityManager().getSystemSubject()))) {
-            final XQuery xquery = existWebServer.getBrokerPool().getXQueryService();
-            final Sequence result = xquery.execute(broker, query, null);
-            return result;
-        }
-    }
-
-    private static Account createUser(final DBBroker broker, final SecurityManager sm, final String username, final String password) throws PermissionDeniedException, EXistException {
-        Group userGroup = new GroupAider(username);
-        sm.addGroup(broker, userGroup);
-        final Account user = new UserAider(username);
-        user.setPassword(password);
-        user.setPrimaryGroup(userGroup);
-        sm.addAccount(user);
-
-        userGroup = sm.getGroup(username);
-        userGroup.addManager(sm.getAccount(username));
-        sm.updateGroup(userGroup);
-
-        return user;
-    }
-
-    private static Group createGroup(final DBBroker broker, final SecurityManager sm, final String groupName) throws PermissionDeniedException, EXistException {
-        final Group otherGroup = new GroupAider(groupName);
-        return sm.addGroup(broker, otherGroup);
-    }
-
-    private static void addUserToGroup(final SecurityManager sm, final Account user, final Group group) throws PermissionDeniedException, EXistException {
-        user.addGroup(group.getName());
-        sm.updateAccount(user);
-    }
-
-    private static void extractPermissionDenied(final Runnable3E<XPathException, PermissionDeniedException, EXistException> runnable) throws XPathException, PermissionDeniedException, EXistException {
-        try {
-            runnable.run();
-        } catch (final XPathException e) {
-            if (e.getCause() != null && e.getCause() instanceof PermissionDeniedException) {
-                throw (PermissionDeniedException)e.getCause();
-            } else {
-                throw e;
-            }
-        }
-    }
 }