Merge pull request #219 from MerginMaps/first-implementation-limit-overrides

Implementing testing api for storage change to limits tests

Author: MarcelGeo

mergin/client.py

@@ -237,6 +237,13 @@ def post(self, path, data=None, headers={}):
         request = urllib.request.Request(url, data, headers, method="POST")
         return self._do_request(request)
 
+    def patch(self, path, data=None, headers={}):
+        url = urllib.parse.urljoin(self.url, urllib.parse.quote(path))
+        if headers.get("Content-Type", None) == "application/json":
+            data = json.dumps(data, cls=DateTimeEncoder).encode("utf-8")
+        request = urllib.request.Request(url, data, headers, method="PATCH")
+        return self._do_request(request)
+
     def is_server_compatible(self):
         """
         Test whether version of the server meets the required set of endpoints.

mergin/test/test_client.py

@@ -32,7 +32,6 @@
 from ..utils import (
     generate_checksum,
     get_versions_with_file_changes,
-    is_version_acceptable,
     unique_path_name,
     conflicted_copy_file_name,
     edit_conflict_file_name,
@@ -68,9 +67,27 @@ def mc2():
 
 
 @pytest.fixture(scope="function")
-def mcStorage():
+def mcStorage(request):
     client = create_client(API_USER, USER_PWD)
-    create_workspace_for_client(client, STORAGE_WORKSPACE)
+    workspace_name = create_workspace_for_client(client, STORAGE_WORKSPACE)
+    print(workspace_name)
+    client_workspace = None
+    for workspace in client.workspaces_list():
+        if workspace["name"] == workspace_name:
+            client_workspace = workspace
+            break
+    client_workspace_id = client_workspace["id"]
+    client_workspace_storage = client_workspace["storage"]
+
+    def teardown():
+        # back to original values... (1 project, api allowed ...)
+        client.patch(
+            f"/v1/tests/workspaces/{client_workspace_id}",
+            {"limits_override": {"storage": client_workspace_storage, "projects": 1, "api_allowed": True}},
+            {"Content-Type": "application/json"},
+        )
+
+    request.addfinalizer(teardown)
     return client
 
 
@@ -79,11 +96,13 @@ def create_client(user, pwd):
     return MerginClient(SERVER_URL, login=user, password=pwd)
 
 
-def create_workspace_for_client(mc: MerginClient, workspace_name=None):
+def create_workspace_for_client(mc: MerginClient, workspace_name=None) -> str:
+    workspace_name = workspace_name or mc.username()
     try:
-        mc.create_workspace(workspace_name or mc.username())
+        mc.create_workspace(workspace_name)
     except ClientError:
-        return
+        pass
+    return workspace_name
 
 
 def cleanup(mc, project, dirs):
@@ -745,12 +764,12 @@ def test_set_editor_access(mc):
     assert API_USER2 not in access["writersnames"]
 
 
-def test_available_storage_validation(mcStorage):
+def test_available_workspace_storage(mcStorage):
     """
     Testing of storage limit - applies to user pushing changes into own project (namespace matching username).
     This test also tests giving read and write access to another user. Additionally tests also uploading of big file.
     """
-    test_project = "test_available_storage_validation"
+    test_project = "test_available_workspace_storage"
     test_project_fullname = STORAGE_WORKSPACE + "/" + test_project
 
     # cleanups
@@ -766,15 +785,28 @@ def test_available_storage_validation(mcStorage):
 
     # get info about storage capacity
     storage_remaining = 0
+    client_workspace = None
+    for workspace in mcStorage.workspaces_list():
+        if workspace["name"] == STORAGE_WORKSPACE:
+            client_workspace = workspace
+            break
+    assert client_workspace is not None
+    current_storage = client_workspace["storage"]
+    client_workspace_id = client_workspace["id"]
+    # 5 MB
+    testing_storage = 5242880
+    # add  storage limit, to prevent creating too big files
+    mcStorage.patch(
+        f"/v1/tests/workspaces/{client_workspace_id}",
+        {"limits_override": {"storage": testing_storage, "projects": 1, "api_allowed": True}},
+        {"Content-Type": "application/json"},
+    )
 
     if mcStorage.server_type() == ServerType.OLD:
         user_info = mcStorage.user_info()
-        storage_remaining = user_info["storage"] - user_info["disk_usage"]
+        storage_remaining = testing_storage - user_info["disk_usage"]
     else:
-        for workspace in mcStorage.workspaces_list():
-            if workspace["name"] == STORAGE_WORKSPACE:
-                storage_remaining = workspace["storage"] - workspace["disk_usage"]
-                break
+        storage_remaining = testing_storage - client_workspace["disk_usage"]
 
     # generate dummy data (remaining storage + extra 1024b)
     dummy_data_path = project_dir + "/data"
@@ -789,15 +821,16 @@ def test_available_storage_validation(mcStorage):
         # Expecting "You have reached a data limit" 400 server error msg.
         assert "You have reached a data limit" in str(e)
         got_right_err = True
-    assert got_right_err
+    finally:
+        assert got_right_err
 
-    # Expecting empty project
-    project_info = get_project_info(mcStorage, STORAGE_WORKSPACE, test_project)
-    assert project_info["version"] == "v0"
-    assert project_info["disk_usage"] == 0
+        # Expecting empty project
+        project_info = get_project_info(mcStorage, STORAGE_WORKSPACE, test_project)
+        assert project_info["version"] == "v0"
+        assert project_info["disk_usage"] == 0
 
-    # remove dummy big file from a disk
-    remove_folders([project_dir])
+        # remove dummy big file from a disk
+        remove_folders([project_dir])
 
 
 def test_available_storage_validation2(mc, mc2):
@@ -866,7 +899,7 @@ def get_project_info(mc, namespace, project_name):
     :param project_name: project's name
     :return: dict with project info
     """
-    projects = mc.projects_list(flag="created")
+    projects = mc.projects_list(flag="created", namespace=namespace)
     test_project_list = [p for p in projects if p["name"] == project_name and p["namespace"] == namespace]
     assert len(test_project_list) == 1
     return test_project_list[0]
@@ -2653,6 +2686,19 @@ def test_error_projects_limit_hit(mcStorage: MerginClient):
     test_project = "test_another_project_above_projects_limit"
     test_project_fullname = STORAGE_WORKSPACE + "/" + test_project
 
+    client_workspace = None
+    for workspace in mcStorage.workspaces_list():
+        if workspace["name"] == STORAGE_WORKSPACE:
+            client_workspace = workspace
+            break
+    client_workspace_id = client_workspace["id"]
+    client_workspace_storage = client_workspace["storage"]
+    mcStorage.patch(
+        f"/v1/tests/workspaces/{client_workspace_id}",
+        {"limits_override": {"storage": client_workspace_storage, "projects": 0, "api_allowed": True}},
+        {"Content-Type": "application/json"},
+    )
+
     project_dir = os.path.join(TMP_DIR, test_project, API_USER)
 
     with pytest.raises(ClientError) as e: