added ability to get info from users table (#59)

Author: bigcat88

.github/workflows/py_analysis-coverage.yml

@@ -91,6 +91,7 @@ jobs:
           --admin-user admin --admin-pass adminpassword
           sed -i -e 's/${{ env.NC_dbname }}/xyz/g' config/config.php
           php occ config:system:set debug --value=true --type=boolean
+          OC_PASS=uSr1paSZsg php occ user:add --password-from-env --display-name="Test User" --group="users" user
           php -S localhost:8080 &
 
       - uses: actions/checkout@v3
@@ -111,6 +112,7 @@ jobs:
         env:
           SERVER_ROOT: "../.."
           CPA_LOGLEVEL: debug
+          USER_ID: admin
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3
@@ -183,6 +185,7 @@ jobs:
           --database-host=127.0.0.1 --database-user=root --database-pass=rootpassword \
           --admin-user admin --admin-pass adminpassword
           php occ config:system:set debug --value=true --type=boolean
+          OC_PASS=uSr1paSZsg php occ user:add --password-from-env --display-name="Test User" --group="users" user
           php -S localhost:8080 &
 
       - uses: actions/checkout@v3
@@ -203,6 +206,7 @@ jobs:
         env:
           SERVER_ROOT: "../.."
           CPA_LOGLEVEL: debug
+          USER_ID: admin
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3
@@ -275,6 +279,7 @@ jobs:
           --database-host=127.0.0.1 --database-user=root --database-pass=rootpassword \
           --admin-user admin --admin-pass adminpassword
           php occ config:system:set debug --value=true --type=boolean
+          OC_PASS=uSr1paSZsg php occ user:add --password-from-env --display-name="Test User" --group="users" user
           php -S localhost:8080 &
 
       - uses: actions/checkout@v3
@@ -295,6 +300,7 @@ jobs:
         env:
           SERVER_ROOT: "../.."
           CPA_LOGLEVEL: debug
+          USER_ID: admin
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3
@@ -356,6 +362,7 @@ jobs:
           --database-user=root --database-pass=root \
           --admin-user admin --admin-pass adminpassword
           php occ config:system:set debug --value=true --type=boolean
+          OC_PASS=uSr1paSZsg php occ user:add --password-from-env --display-name="Test User" --group="users" user
           php -S localhost:8080 &
 
       - uses: actions/checkout@v3
@@ -376,6 +383,7 @@ jobs:
         env:
           SERVER_ROOT: "../.."
           CPA_LOGLEVEL: debug
+          USER_ID: admin
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3
@@ -441,6 +449,7 @@ jobs:
           --database-user=username --database-pass=userpass \
           --admin-user admin --admin-pass adminpassword --database-host="/var/run/postgresql"
           php occ config:system:set debug --value=true --type=boolean
+          OC_PASS=uSr1paSZsg php occ user:add --password-from-env --display-name="Test User" --group="users" user
           php -S localhost:8080 &
 
       - uses: actions/checkout@v3
@@ -461,6 +470,7 @@ jobs:
         env:
           SERVER_ROOT: "../.."
           CPA_LOGLEVEL: debug
+          USER_ID: admin
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3

nc_py_api/__init__.py

@@ -17,3 +17,4 @@
 )
 from .log import cpa_logger
 from .occ import get_cloud_app_config_value, occ_call, occ_call_decode
+from .users import current_user_info, user_info, users_info

nc_py_api/db_misc.py

@@ -29,6 +29,10 @@ def file_cache(self) -> str:
     def mimetypes(self) -> str:
         return CONFIG["dbtprefix"] + "mimetypes"
 
+    @property
+    def users(self) -> str:
+        return CONFIG["dbtprefix"] + "users"
+
     @property
     def settings(self) -> str:
         return CONFIG["dbtprefix"] + "cloud_py_api_settings"

nc_py_api/db_requests.py

@@ -121,3 +121,18 @@ def get_non_direct_access_filesize_limit() -> int:
     if not result:
         return 256 * 1024 * 1024
     return int(result[0]["value"])
+
+
+def get_users() -> list[dict]:
+    """Returns `users` table as a list of dictionaries."""
+
+    return execute_fetchall(f"SELECT * FROM {TABLES.users};")
+
+
+def get_user(uid_lower: str) -> dict:
+    """Returns `user` table record as a dictionary."""
+
+    result = execute_fetchall(f"SELECT * FROM {TABLES.users} WHERE uid_lower='{uid_lower}';")
+    if result:
+        return result[0]
+    return {}

nc_py_api/users.py

@@ -0,0 +1,42 @@
+"""
+Functions related to user management.
+"""
+from os import environ
+from typing import Optional, TypedDict
+
+from .db_requests import get_user, get_users
+
+
+class UserInfo(TypedDict):
+    uid: str
+    display_name: Optional[str]
+    password: str
+    uid_lower: str
+
+
+USER_ID = environ.get("USER_ID", "")
+
+
+def current_user_info() -> Optional[UserInfo]:
+    raw_result = get_user(USER_ID.lower())
+    return db_record_to_user_info(raw_result) if raw_result else None
+
+
+def user_info(uid: str) -> Optional[UserInfo]:
+    raw_result = get_user(uid.lower())
+    if not raw_result:
+        return None
+    return db_record_to_user_info(raw_result)
+
+
+def users_info() -> list[UserInfo]:
+    return [db_record_to_user_info(i) for i in get_users()]
+
+
+def db_record_to_user_info(user_record: dict) -> UserInfo:
+    return {
+        "uid": user_record["uid"],
+        "display_name": user_record["displayname"],
+        "password": user_record["password"],
+        "uid_lower": user_record["uid_lower"],
+    }

tests/nc_py_api/users_test.py

@@ -0,0 +1,28 @@
+import pytest
+
+from nc_py_api import current_user_info, user_info, users_info
+
+
+def test_user_info():
+    info = current_user_info()
+    assert info
+    assert info["uid"]
+    assert info["password"]
+    assert info["uid_lower"]
+    assert "display_name" in info.keys()
+    assert info == user_info("admin")
+
+
+def test_users_info():
+    info = users_info()
+    assert len(info) == 2
+    for i in info:
+        assert i["uid"]
+        assert i["password"]
+        assert i["uid_lower"]
+        assert "display_name" in i.keys()
+
+
+@pytest.mark.parametrize("uid", ["", "invalid user"])
+def test_invalid_user(uid):
+    assert user_info(uid) is None