Merge branch 'master' into pyqt6_migration

Author: RaghavaAlajangi

CHANGELOG

@@ -1,5 +1,8 @@
 0.17.0
  - BREAKING CHANGE: migrate codebase from PyQt5 to PyQt6
+0.16.12
+ - tests: allow to use different DCOR instance for testing
+ - tests: make tests independent of testing user
 0.16.11
  - fix: support CKAN 2.11 (authorization and status_show)
  - fix: implement non-functional `DownloadQueue.get_status`

tests/.gitignore

@@ -1 +1 @@
-api_key
+api_key*

tests/common.py

@@ -13,13 +13,9 @@
 from dcoraid.upload import UploadQueue
 
 
-CIRCLE = "dcoraid-circle"
-COLLECTION = "dcoraid-collection"
-DATASET = "dcoraid-dataset"
-SERVER = "dcor-dev.mpl.mpg.de"
-USER = "dcoraid"
-USER_NAME = "DCOR-Aid tester"
-TITLE = "DCOR-Aid test dataset"
+# You can run e.g. tests on a local DCOR instance with
+# export DCORAID_TEST_SERVER="http://192.168.122.143"
+SERVER = os.environ.get("DCORAID_TEST_SERVER", "dcor-dev.mpl.mpg.de")
 
 dpath = pathlib.Path(__file__).parent / "data" / "calibration_beads_47.rtdc"
 
@@ -40,14 +36,32 @@ def get_api_key():
     return key
 
 
+@functools.lru_cache()
+def get_test_defaults():
+    api = get_api()
+    user_dict = api.get("user_show")
+    name = user_dict["name"]
+    return {
+        "circle": f"{name}-circle",
+        "collection": f"{name}-collection",
+        "dataset": f"{name}-dataset",
+        "user": name,
+        "user_name": f"DCOR-Aid Tester {name.capitalize()}",
+        "user_dict": user_dict,
+        "title": "DCOR-Aid test dataset",
+        "server": SERVER,
+    }
+
+
 def make_dataset_dict(hint=""):
+    defaults = get_test_defaults()
     space = " " if hint else ""
     dataset_dict = {
         "title": f"A test dataset {hint}{space}{time.time()}",
         "private": True,
         "license_id": "CC0-1.0",
-        "owner_org": CIRCLE,
-        "authors": USER_NAME,
+        "owner_org": defaults["circle"],
+        "authors": defaults["user_name"],
     }
     return dataset_dict
 

tests/conftest.py

@@ -51,7 +51,7 @@ def pytest_configure(config):
     settings = QtCore.QSettings()
     settings.setValue("check for updates", "0")
     settings.setValue("user scenario", "dcor-dev")
-    settings.setValue("auth/server", "dcor-dev.mpl.mpg.de")
+    settings.setValue("auth/server", common.SERVER)
     settings.setValue("auth/api key", common.get_api_key())
     settings.setValue("debug/without timers", "1")
     settings.sync()
@@ -84,17 +84,17 @@ def pytest_sessionstart(session):
     before performing collection and entering the run test loop.
     """
     api = common.get_api()
-    api.get("group_show", id=common.COLLECTION)
+    defaults = common.get_test_defaults()
     try:
-        api.post("group_create", {"name": common.COLLECTION})
+        api.post("group_create", {"name": defaults["collection"]})
     except APIConflictError:
         pass
     try:
-        api.post("organization_create", {"name": common.CIRCLE})
+        api.post("organization_create", {"name": defaults["circle"]})
     except APIConflictError:
         pass
-    user_dict = api.get("user_show", id=common.USER)
-    user_dict["fullname"] = common.USER_NAME
+    user_dict = api.get("user_show")
+    user_dict["fullname"] = defaults["user_name"]
     api.post("user_update", user_dict)
 
 

tests/test_api_base.py

@@ -13,7 +13,7 @@ def test_api_requests_cache_no_parameters():
     t0 = time.perf_counter()
     api.get("status_show")
     t1 = time.perf_counter()
-    for ii in range(50):
+    for ii in range(20):
         api.get("status_show")
     t2 = time.perf_counter()
     assert (t1 - t0) > (t2 - t1)
@@ -25,7 +25,7 @@ def test_api_requests_cache_with_parameters():
     t0 = time.perf_counter()
     api.get("organization_list_for_user", permission="create_dataset")
     t1 = time.perf_counter()
-    for ii in range(50):
+    for ii in range(20):
         api.get("organization_list_for_user", permission="create_dataset")
     t2 = time.perf_counter()
     assert (t1 - t0) > (t2 - t1)

tests/test_api_dataset.py

@@ -70,9 +70,10 @@ def test_dataset_creation():
     data = dataset_create(dataset_dict=dataset_dict,
                           api=api,
                           )
+    defaults = common.get_test_defaults()
     # simple test
     assert "authors" in data
-    assert data["authors"] == common.USER_NAME
+    assert data["authors"] == defaults["user_name"]
     assert data["state"] == "draft"
     # remove draft dataset
     dataset_draft_remove(dataset_id=data["id"],

tests/test_dbmodel_api.py

@@ -10,110 +10,121 @@
 
 dpath = pathlib.Path(__file__).parent / "data" / "calibration_beads_47.rtdc"
 
+HAS_FIGSHARE_ACCESS = common.get_test_defaults()["user"] == "dcoraid"
 
+
+@pytest.mark.skipif(not HAS_FIGSHARE_ACCESS,
+                    reason="No access to figshare-import circle")
 def test_get_circles():
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
     circles = db.get_circles()
-    assert common.CIRCLE in circles
+    defaults = common.get_test_defaults()
+    assert defaults["circle"] in circles
     # requires that the "dcoraid" user is in the figshare-import circle
     assert "figshare-import" in circles
 
 
+@pytest.mark.skipif(not HAS_FIGSHARE_ACCESS,
+                    reason="No access to figshare-import circle")
 def test_get_collections():
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
     collections = db.get_collections()
-    assert common.COLLECTION in collections
-    # requires that the "dcoraid" user is in the figshare-collection collection
+    defaults = common.get_test_defaults()
+    assert defaults["collection"] in collections
+    # requires that the "dcoraid" user is in figshare-collection collection
     assert "figshare-collection" in collections
 
 
 def test_get_users_anonymous():
-    api = CKANAPI(server="dcor-dev.mpl.mpg.de")
+    api = CKANAPI(server=common.SERVER)  # anonymous access
     db = db_api.APIInterrogator(api=api)
     with pytest.raises(errors.APIAuthorizationError, match="Access denied"):
         db.get_users()
 
 
 def test_public_api_interrogator():
-    """This test uses the figshare datasets on SERVER"""
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
-    assert common.CIRCLE in db.get_circles()
-    assert common.COLLECTION in db.get_collections()
-    assert common.USER in db.get_users()
+    defaults = common.get_test_defaults()
+    assert defaults["circle"] in db.get_circles()
+    assert defaults["collection"] in db.get_collections()
+    assert defaults["user"] in db.get_users()
 
 
 def test_user_data():
     """Test the user information"""
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
     data = db.user_data
-    assert data["fullname"] == common.USER_NAME, "fullname not correct"
+    defaults = common.get_test_defaults()
+    assert data["fullname"] == defaults["user_name"], "fullname not correct"
 
 
 def test_search_dataset_basic():
     api = common.get_api()
     ranstr = ''.join(random.choice("0123456789") for _i in range(10))
+    defaults = common.get_test_defaults()
     # Create a test dataset
-    dataset_create({"title": "{} {}".format(common.TITLE, ranstr),
-                    "owner_org": common.CIRCLE,
-                    "authors": common.USER_NAME,
+    dataset_create({"title": "{} {}".format(defaults["title"], ranstr),
+                    "owner_org": defaults["circle"],
+                    "authors": defaults["user_name"],
                     "license_id": "CC0-1.0",
-                    "groups": [{"name": common.COLLECTION}],
+                    "groups": [{"name": defaults["collection"]}],
                     },
                    api=api,
                    resources=[dpath],
                    activate=True)
     db = db_api.APIInterrogator(api=api)
     # Positive test
     data = db.search_dataset(query="dcoraid",
-                             circles=[common.CIRCLE],
-                             collections=[common.COLLECTION],
+                             circles=[defaults["circle"]],
+                             collections=[defaults["collection"]],
                              )
     assert len(data) >= 1
     for dd in data:
         if dd["name"].endswith(ranstr):
             break
     else:
-        assert False, "{} not found!".format(common.DATASET)
+        assert False, "{} not found!".format(defaults["dataset"])
     # Negative test
     data = db.search_dataset(query="cliauwenlc_should_never_exist",
-                             circles=[common.CIRCLE],
-                             collections=[common.COLLECTION],
+                             circles=[defaults["circle"]],
+                             collections=[defaults["collection"]],
                              )
     assert len(data) == 0, "search result for non-existent dataset?"
 
 
 def test_search_dataset_limit():
     api = common.get_api()
     ranstr = ''.join(random.choice("0123456789") for _i in range(10))
+    defaults = common.get_test_defaults()
     dataset_ids = []
     # Create three test datasets
     for _ in range(3):
         ds_dict = dataset_create(
-            {"title": "{} {}".format(common.TITLE, ranstr),
-             "owner_org": common.CIRCLE,
-             "authors": common.USER_NAME,
+            {"title": "{} {}".format(defaults["title"], ranstr),
+             "owner_org": defaults["circle"],
+             "authors": defaults["user_name"],
              "license_id": "CC0-1.0",
-             "groups": [{"name": common.COLLECTION}],
+             "groups": [{"name": defaults["collection"]}],
              },
             api=api,
             resources=[dpath],
             activate=True)
         dataset_ids.append(ds_dict["id"])
     db = db_api.APIInterrogator(api=api)
     data_limited = db.search_dataset(query=ranstr,
-                                     circles=[common.CIRCLE],
-                                     collections=[common.COLLECTION],
+                                     circles=[defaults["circle"]],
+                                     collections=[defaults["collection"]],
                                      circle_collection_union=True,
                                      limit=2
                                      )
     assert len(data_limited) == 2
     data_unlimited = db.search_dataset(query=ranstr,
-                                       circles=[common.CIRCLE],
-                                       collections=[common.COLLECTION],
+                                       circles=[defaults["circle"]],
+                                       collections=[defaults["collection"]],
                                        circle_collection_union=True,
                                        limit=0
                                        )
@@ -123,28 +134,32 @@ def test_search_dataset_limit():
 def test_search_dataset_limit_negative_error():
     api = common.get_api()
     ranstr = ''.join(random.choice("0123456789") for _i in range(10))
+    defaults = common.get_test_defaults()
     # Create three test datasets
     dataset_create(
-        {"title": "{} {}".format(common.TITLE, ranstr),
-         "owner_org": common.CIRCLE,
-         "authors": common.USER_NAME,
+        {"title": "{} {}".format(defaults["title"], ranstr),
+         "owner_org": defaults["circle"],
+         "authors": defaults["user_name"],
          "license_id": "CC0-1.0",
-         "groups": [{"name": common.COLLECTION}],
+         "groups": [{"name": defaults["collection"]}],
          },
         api=api,
         resources=[dpath],
         activate=True)
     db = db_api.APIInterrogator(api=api)
     with pytest.raises(ValueError, match="must be 0 or >0"):
         db.search_dataset(query=ranstr,
-                          circles=[common.CIRCLE],
-                          collections=[common.COLLECTION],
+                          circles=[defaults["circle"]],
+                          collections=[defaults["collection"]],
                           circle_collection_union=True,
                           limit=-1
                           )
 
 
+@pytest.mark.skipif(not HAS_FIGSHARE_ACCESS,
+                    reason="No access to figshare-import circle")
 def test_search_dataset_only_one_filter_query():
+    # The figshare circle must have the testing user as a member
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
     ds = db.search_dataset(filter_queries=[f"-creator_user_id:{api.user_id}"])
@@ -155,9 +170,10 @@ def test_search_dataset_only_one_filter_query():
         assert False, "Search did not return figshare-7771184-v2!"
 
 
+@pytest.mark.skipif(not HAS_FIGSHARE_ACCESS,
+                    reason="No access to figshare-import circle")
 def test_get_datasets_user_shared_figshare():
-    """The figshare circle must have the user "dcoraid" as a member
-    """
+    # The figshare circle must have the testing user as a member
     api = common.get_api()
     db = db_api.APIInterrogator(api=api)
     datasets = db.get_datasets_user_shared()
@@ -166,11 +182,3 @@ def test_get_datasets_user_shared_figshare():
             break
     else:
         assert False, "Search did not return figshare-7771184-v2!"
-
-
-if __name__ == "__main__":
-    # Run all tests
-    loc = locals()
-    for key in list(loc.keys()):
-        if key.startswith("test_") and hasattr(loc[key], "_call_"):
-            loc[key]()