Add regression test to ACL ini handler (#281)

* Add QTest for issue validation

* Add file-existence check for test

* Update acl_roles_handler.cpp

* Appease clang

* Only look for unittest files

* Where art thou?

* Change root directory when running test

* Fix pathing on Windows CI

* Windows please just accept this path

* Too many CDs

* Bash is evil.

* Wildcard moment

* I swear to god Bill Gates why does your OS suck so much?

* Add cache, use working-directory

* Maybe? Maybe not? Who the fuck cares at this point

* Fix library path

Holy shit these tests almost work on Windows.

* FUCKING HELL

* Where art thou? 2nd Edition

* Edited wrong one

* Re-add execution code

* Remove Linux stuff

* Do it in batch

Bash is evil.

* Set to CMD

* I am now expected

* Missing libs

Should be good enough 🤷

* Powershell my beloved, save me

* Adjust pathing (again)

* Add some debug info

* Powershell syntax shenanigans

* I distrust Github Actions now

* I swear my windows is licensed, please work

* More debug info

* More debug

* For the love of all that is holy why the fuck do you not work

* Cheap path hack

* Upload test folder for debug

* Set Execution Policy<

Apparently tests on the Windows CI never worked???

* Remove debug information

* Does this even work? If not, fuck

* Try older Windows runner

* Comment out non-functional Windows QTest action

* Note that Linux is still functional, so QTest for Windows has to be conducted trough QtCreator till a solution is found.

* Unbreak-test

* Use latest runner version

Co-authored-by: TrickyLeifa <date.epoch@gmail.com>

.github/workflows/main.yml

@@ -47,9 +47,11 @@ jobs:
           qmake
           make
           mv bin/config_sample bin/config
+          
       - name: Run tests
         run: |
-            for test in bin_tests/*; do
+            cd ${{github.workspace}}/bin_tests/
+            for test in ./unittest_*; do
               LD_LIBRARY_PATH=./bin:$LD_LIBRARY_PATH ./$test
             done;
           
@@ -67,8 +69,17 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ilammy/msvc-dev-cmd@v1
       
+      - name: Cache Qt
+        id: cache-qt
+        uses: actions/cache@v1  # not v2!
+        with:
+          path: ../Qt
+          key: ${{ runner.os }}-QtCache
+
       - name: Install Qt
         uses: jurplel/install-qt-action@v2
+        with:
+          cached: ${{ steps.cache-qt.outputs.cache-hit }}
      
       - name: Build
         run: |
@@ -77,12 +88,14 @@ jobs:
           nmake
           windeployqt bin\akashi.exe --release --no-opengl-sw
           mv bin\config_sample bin\config
-      - name: Run tests
+
-        run: |
+# As QTest seems to be non-functional on Windows runners this is commented out. If a solution is found, please fix and uncomment - 27.06.2022 / Salanto         
-          for test in bin_tests/*; do
+#      - name: Run tests
-            LD_LIBRARY_PATH=./bin:$LD_LIBRARY_PATH ./$test
+#        run: |
-          done;
+#            windeployqt .\unittest_music_manager.exe --no-translations
-        shell: bash
+#            $tests = Get-ChildItem -Filter "unittest_*.exe" -Path ".\" | Select -ExpandProperty Name
+#            foreach ($test in $tests) {Write-Host(& ".\$test")}
+#        working-directory: ${{ github.workspace }}/bin_tests
 
       - name: Deploy OpenSSL
         run: |

.gitignore

@@ -73,7 +73,7 @@ Thumbs.db
 build/
 bin/akashi
 bin/config/
-bin_tests/
+bin_tests/unittest_*
 bin/logs/
 bin/core.lib
 bin/libcore.a

bin_tests/config/acl_roles.ini

@@ -0,0 +1,17 @@
+;Thanks to AwesomeAim for providing this malfunctioning ini
+[moderator]
+kick = true
+mute = true
+chat_moderator = true
+gamemaster = false
+lock_background = true
+bypass_locks = true
+ignore_background_list = true
+ban = true
+
+[supervisor]
+ban = true
+kick = true
+mute = true
+chat_moderator = true
+modify_users = true

core/include/acl_roles_handler.h

@@ -7,6 +7,8 @@
 
 class ACLRole
 {
+    Q_GADGET
+
   public:
     /**
      * @brief This enum is used to specify permissions of a role.
@@ -35,6 +37,7 @@ class ACLRole
         SUPER = 0xffffffff,
     };
     Q_DECLARE_FLAGS(Permissions, Permission);
+    Q_ENUM(Permission);
 
     /**
      * @brief Shared read-only captions for each permissions.

core/src/acl_roles_handler.cpp

@@ -203,10 +203,12 @@ bool ACLRolesHandler::loadFile(QString f_file_name)
         ACLRole l_role;
         const QList<ACLRole::Permission> l_permissions = ACLRole::PERMISSION_CAPTIONS.keys();
         for (const ACLRole::Permission &i_permission : l_permissions) {
-            l_role.setPermission(i_permission, l_settings.value(ACLRole::PERMISSION_CAPTIONS.value(i_permission), false).toBool());
+            const QVariant l_value = l_settings.value(ACLRole::PERMISSION_CAPTIONS.value(i_permission));
+            if (l_value.isValid()) {
+                l_role.setPermission(i_permission, l_value.toBool());
+            }
         }
         m_roles.insert(l_upper_group, std::move(l_role));
-
         l_settings.endGroup();
     }
 

core/src/server.cpp

@@ -44,7 +44,7 @@ Server::Server(int p_port, int p_ws_port, QObject *parent) :
 
     db_manager = new DBManager;
 
-    acl_roles_handler = new ACLRolesHandler;
+    acl_roles_handler = new ACLRolesHandler(this);
     acl_roles_handler->loadFile("config/acl_roles.ini");
 
     command_extension_collection = new CommandExtensionCollection;

tests/unittest_acl_roles_handler/tst_unittest_acl_roles_handler.cpp

@@ -43,6 +43,11 @@ class tst_ACLRolesHandler : public QObject
      */
     void modifyRoles();
 
+    /**
+     * @brief Tests file loading of roles and correct permission assignment.
+     */
+    void loadRolesFromIni();
+
     /**
      * @brief Tests clearance of roles.
      */
@@ -60,7 +65,7 @@ void tst_ACLRolesHandler::checkReadOnlyRoles()
         const QString l_role_name = ACLRolesHandler::NONE_ID;
 
         // Checks if the role exists
-        QCOMPARE(m_handler->roleExists(ACLRolesHandler::NONE_ID), true);
+        QCOMPARE(m_handler->roleExists(l_role_name), true);
 
         ACLRole l_role = m_handler->getRoleById(ACLRolesHandler::NONE_ID);
         // Checks every permissions
@@ -171,6 +176,44 @@ void tst_ACLRolesHandler::modifyRoles()
     }
 }
 
+void tst_ACLRolesHandler::loadRolesFromIni()
+{
+    {
+        qDebug() << QDir::currentPath();
+        QFile config_file("config/acl_roles.ini");
+        QCOMPARE(config_file.exists(), true);
+    }
+    {
+        m_handler->loadFile("config/acl_roles.ini");
+    }
+    {
+        QString l_role_id = "moderator";
+        QCOMPARE(m_handler->roleExists(l_role_id), true);
+        ACLRole l_role = m_handler->getRoleById(l_role_id);
+
+        QCOMPARE(l_role.checkPermission(ACLRole::NONE), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::KICK), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::BAN), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::BGLOCK), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::MODIFY_USERS), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::CM), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::GLOBAL_TIMER), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::EVI_MOD), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::MOTD), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::ANNOUNCE), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::MODCHAT), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::MUTE), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::UNCM), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::SAVETEST), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::FORCE_CHARSELECT), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::BYPASS_LOCKS), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::IGNORE_BGLIST), true);
+        QCOMPARE(l_role.checkPermission(ACLRole::SEND_NOTICE), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::JUKEBOX), false);
+        QCOMPARE(l_role.checkPermission(ACLRole::SUPER), false);
+    }
+}
+
 void tst_ACLRolesHandler::clearAllRoles()
 {
     {