refactoring tests(part1) (#101)

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>

Author: bigcat88

pyproject.toml

@@ -134,6 +134,9 @@ filterwarnings = [
 ]
 log_cli = true
 addopts = "-rs --color=yes"
+markers = [
+    "require_nc: marks a test that requires a minimum version of Nextcloud.",
+]
 
 [tool.coverage.run]
 cover_pylib = true

tests/_tests_at_the_end.py

@@ -2,15 +2,12 @@
 import sys
 from subprocess import Popen
 
-import pytest
 from _install_wait import check_heartbeat
-from gfixture import NC, NC_APP
 
 # These tests will be run separate, and at the end of all other tests.
 
 
-@pytest.mark.skipif(NC_APP is None or NC is None, reason="Requires both Nextcloud Client and App modes.")
-def test_ex_app_enable_disable():
+def test_ex_app_enable_disable(nc_client, nc_app):
     child_environment = os.environ.copy()
     child_environment["APP_PORT"] = os.environ.get("APP_PORT", "9009")
     r = Popen(
@@ -22,12 +19,12 @@ def test_ex_app_enable_disable():
     try:
         if check_heartbeat(url, '"status":"ok"', 15, 0.3):
             raise RuntimeError("`_install_only_enabled_handler` can not start.")
-        if NC.apps.ex_app_is_enabled("nc_py_api"):
-            NC.apps.ex_app_disable("nc_py_api")
-        assert NC.apps.ex_app_is_disabled("nc_py_api") is True
-        assert NC.apps.ex_app_is_enabled("nc_py_api") is False
-        NC.apps.ex_app_enable("nc_py_api")
-        assert NC.apps.ex_app_is_disabled("nc_py_api") is False
-        assert NC.apps.ex_app_is_enabled("nc_py_api") is True
+        if nc_client.apps.ex_app_is_enabled("nc_py_api"):
+            nc_client.apps.ex_app_disable("nc_py_api")
+        assert nc_client.apps.ex_app_is_disabled("nc_py_api") is True
+        assert nc_client.apps.ex_app_is_enabled("nc_py_api") is False
+        nc_client.apps.ex_app_enable("nc_py_api")
+        assert nc_client.apps.ex_app_is_disabled("nc_py_api") is False
+        assert nc_client.apps.ex_app_is_enabled("nc_py_api") is True
     finally:
         r.terminate()

tests/appcfg_prefs_ex_test.py

@@ -1,10 +1,10 @@
 import pytest
-from gfixture import NC_APP
+from conftest import NC_APP
 
 from nc_py_api import NextcloudExceptionNotFound
 
-if NC_APP is None or "app_ecosystem_v2" not in NC_APP.capabilities:
-    pytest.skip("app_ecosystem_v2 is not installed.", allow_module_level=True)
+if NC_APP is None:
+    pytest.skip("Need App mode", allow_module_level=True)
 
 
 @pytest.mark.parametrize("class_to_test", (NC_APP.appconfig_ex, NC_APP.preferences_ex))
@@ -114,30 +114,30 @@ def test_cfg_ex_get_typing(class_to_test):
     assert r[1].value == "321"
 
 
-def test_appcfg_sensitive():
-    appcfg = NC_APP.appconfig_ex
+def test_appcfg_sensitive(nc_app):
+    appcfg = nc_app.appconfig_ex
     appcfg.delete("test_key")
     appcfg.set_value("test_key", "123", sensitive=True)
     assert appcfg.get_value("test_key") == "123"
     assert appcfg.get_values(["test_key"])[0].value == "123"
     appcfg.delete("test_key")
     # next code tests `sensitive` value from the `AppEcosystem`
     params = {"configKey": "test_key", "configValue": "123"}
-    result = NC_APP._session.ocs(method="POST", path=f"{NC_APP._session.ae_url}/{appcfg._url_suffix}", json=params)
+    result = nc_app._session.ocs(method="POST", path=f"{nc_app._session.ae_url}/{appcfg._url_suffix}", json=params)
     assert not result["sensitive"]  # by default if sensitive value is unspecified it is False
     appcfg.delete("test_key")
     params = {"configKey": "test_key", "configValue": "123", "sensitive": True}
-    result = NC_APP._session.ocs(method="POST", path=f"{NC_APP._session.ae_url}/{appcfg._url_suffix}", json=params)
+    result = nc_app._session.ocs(method="POST", path=f"{nc_app._session.ae_url}/{appcfg._url_suffix}", json=params)
     assert result["configkey"] == "test_key"
     assert result["configvalue"] == "123"
     assert bool(result["sensitive"]) is True
     params.pop("sensitive")  # if we not specify value, AppEcosystem should not change it.
-    result = NC_APP._session.ocs(method="POST", path=f"{NC_APP._session.ae_url}/{appcfg._url_suffix}", json=params)
+    result = nc_app._session.ocs(method="POST", path=f"{nc_app._session.ae_url}/{appcfg._url_suffix}", json=params)
     assert result["configkey"] == "test_key"
     assert result["configvalue"] == "123"
     assert bool(result["sensitive"]) is True
     params["sensitive"] = False
-    result = NC_APP._session.ocs(method="POST", path=f"{NC_APP._session.ae_url}/{appcfg._url_suffix}", json=params)
+    result = nc_app._session.ocs(method="POST", path=f"{nc_app._session.ae_url}/{appcfg._url_suffix}", json=params)
     assert result["configkey"] == "test_key"
     assert result["configvalue"] == "123"
     assert bool(result["sensitive"]) is False

tests/apps_test.py

@@ -1,71 +1,59 @@
 import pytest
-from gfixture import NC_TO_TEST
-
-from nc_py_api import Nextcloud
 
 APP_NAME = "files_trashbin"
 
 
-@pytest.mark.parametrize("nc", NC_TO_TEST)
 def test_list_apps_types(nc):
     assert isinstance(nc.apps.get_list(), list)
     assert isinstance(nc.apps.get_list(enabled=True), list)
     assert isinstance(nc.apps.get_list(enabled=False), list)
 
 
-@pytest.mark.parametrize("nc", NC_TO_TEST)
 def test_list_apps(nc):
     apps = nc.apps.get_list()
     assert apps
     assert APP_NAME in apps
 
 
-@pytest.mark.skipif(not isinstance(NC_TO_TEST[:1][0], Nextcloud), reason="Not available for NextcloudApp.")
-@pytest.mark.parametrize("nc", NC_TO_TEST[:1])
-def test_app_enable_disable(nc):
-    assert nc.apps.is_installed(APP_NAME) is True
-    if nc.apps.is_enabled(APP_NAME):
-        nc.apps.disable(APP_NAME)
-    assert nc.apps.is_disabled(APP_NAME) is True
-    assert nc.apps.is_enabled(APP_NAME) is False
-    assert nc.apps.is_installed(APP_NAME) is True
-    nc.apps.enable(APP_NAME)
-    assert nc.apps.is_enabled(APP_NAME) is True
-    assert nc.apps.is_installed(APP_NAME) is True
+def test_app_enable_disable(nc_client):
+    assert nc_client.apps.is_installed(APP_NAME) is True
+    if nc_client.apps.is_enabled(APP_NAME):
+        nc_client.apps.disable(APP_NAME)
+    assert nc_client.apps.is_disabled(APP_NAME) is True
+    assert nc_client.apps.is_enabled(APP_NAME) is False
+    assert nc_client.apps.is_installed(APP_NAME) is True
+    nc_client.apps.enable(APP_NAME)
+    assert nc_client.apps.is_enabled(APP_NAME) is True
+    assert nc_client.apps.is_installed(APP_NAME) is True
 
 
-@pytest.mark.parametrize("nc", NC_TO_TEST)
 def test_is_installed_enabled(nc):
     assert nc.apps.is_enabled(APP_NAME) != nc.apps.is_disabled(APP_NAME)
     assert nc.apps.is_installed(APP_NAME)
 
 
-@pytest.mark.parametrize("nc", NC_TO_TEST[:1])
-def test_invalid_param(nc):
+def test_invalid_param(nc_any):
     with pytest.raises(ValueError):
-        nc.apps.is_enabled("")
+        nc_any.apps.is_enabled("")
     with pytest.raises(ValueError):
-        nc.apps.is_installed("")
+        nc_any.apps.is_installed("")
     with pytest.raises(ValueError):
-        nc.apps.is_disabled("")
+        nc_any.apps.is_disabled("")
     with pytest.raises(ValueError):
-        nc.apps.enable("")
+        nc_any.apps.enable("")
     with pytest.raises(ValueError):
-        nc.apps.disable("")
+        nc_any.apps.disable("")
     with pytest.raises(ValueError):
-        nc.apps.ex_app_is_enabled("")
+        nc_any.apps.ex_app_is_enabled("")
     with pytest.raises(ValueError):
-        nc.apps.ex_app_is_disabled("")
+        nc_any.apps.ex_app_is_disabled("")
     with pytest.raises(ValueError):
-        nc.apps.ex_app_disable("")
+        nc_any.apps.ex_app_disable("")
     with pytest.raises(ValueError):
-        nc.apps.ex_app_enable("")
+        nc_any.apps.ex_app_enable("")
 
 
-@pytest.mark.parametrize("nc", NC_TO_TEST)
-def test_ex_app_get_list(nc):
-    if "app_ecosystem_v2" not in nc.capabilities:
-        pytest.skip("app_ecosystem_v2 is not installed.")
+def test_ex_app_get_list(nc, nc_app):
     enabled_ex_apps = nc.apps.ex_app_get_list(enabled=True)
     assert isinstance(enabled_ex_apps, list)
     for i in enabled_ex_apps:

tests/conftest.py

@@ -0,0 +1,74 @@
+from os import environ
+from typing import Optional, Union
+
+import gfixture_set_env  # noqa
+import pytest
+
+from nc_py_api import Nextcloud, NextcloudApp, _session  # noqa
+
+NC_CLIENT = None if environ.get("SKIP_NC_CLIENT_TESTS", False) else Nextcloud()
+if environ.get("SKIP_AE_TESTS", False):
+    NC_APP = None
+else:
+    NC_APP = NextcloudApp(user="admin")
+    if "app_ecosystem_v2" not in NC_APP.capabilities:
+        NC_APP = None
+if NC_CLIENT is None and NC_APP is None:
+    raise EnvironmentError("Tests require at least Nextcloud or NextcloudApp.")
+
+
+@pytest.fixture(scope="session")
+def nc_version() -> _session.ServerVersion:
+    return NC_APP.srv_version if NC_APP else NC_CLIENT.srv_version
+
+
+@pytest.fixture(scope="session")
+def nc_client() -> Optional[Nextcloud]:
+    if NC_CLIENT is None:
+        pytest.skip("Need Client mode")
+    return NC_CLIENT
+
+
+@pytest.fixture(scope="session")
+def nc_app() -> Optional[NextcloudApp]:
+    if NC_APP is None:
+        pytest.skip("Need App mode")
+    return NC_APP
+
+
+@pytest.fixture(scope="session")
+def nc_any() -> Union[Nextcloud, NextcloudApp]:
+    """Marks a test to run once for any of the modes."""
+    return NC_APP if NC_APP else NC_CLIENT
+
+
+@pytest.fixture(scope="session")
+def nc(request):
+    """Marks a test to run for both modes if possible."""
+    return request.param
+
+
+def pytest_generate_tests(metafunc):
+    if "nc" in metafunc.fixturenames:
+        values_ids = []
+        values = []
+        if NC_CLIENT is not None:
+            values.append(NC_CLIENT)
+            values_ids.append("client")
+        if NC_APP is not None:
+            values.append(NC_APP)
+            values_ids.append("app")
+        metafunc.parametrize("nc", values, ids=values_ids)
+
+
+def pytest_collection_modifyitems(items):
+    for item in items:
+        require_nc = [i for i in item.own_markers if i.name == "require_nc"]
+        if require_nc:
+            min_major = require_nc[0].kwargs["major"]
+            min_minor = require_nc[0].kwargs.get("minor", 0)
+            srv_ver = NC_APP.srv_version if NC_APP else NC_CLIENT.srv_version
+            if srv_ver["major"] < min_major:
+                item.add_marker(pytest.mark.skip(reason=f"Need NC>={min_major}"))
+            elif srv_ver["major"] == min_major and srv_ver["minor"] < min_minor:
+                item.add_marker(pytest.mark.skip(reason=f"Need NC>={min_major}.{min_minor}"))