fixed options + tests for that. (#74)

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

.github/workflows/analysis-coverage.yml

@@ -722,6 +722,9 @@ jobs:
       - name: Generate coverage report
         working-directory: nc_py_api
         run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html
+        env:
+          NPA_TIMEOUT: None
+          NPA_TIMEOUT_DAV: None
 
       - name: HTML coverage to artifacts
         uses: actions/upload-artifact@v3

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.29 - 2023-08-14]
+
+### Fixed
+
+- `options` error when setting timeouts with the `.env` file.
+
 ## [0.0.28 - 2023-08-11]
 
 ### Added

docs/Options.rst

@@ -25,6 +25,8 @@ With .env
 
 Place **.env** file in your project's directory, and it will be automatically loaded using `dotenv <https://github.com/theskumar/python-dotenv>`_
 
+`Loading occurs only once, when "nc_py_api" is imported into the Python interpreter.`
+
 Modifying at module level
 """""""""""""""""""""""""
 

nc_py_api/__init__.py

@@ -1,6 +1,6 @@
 """All possible stuff for Nextcloud & NextcloudApp that can be used."""
 
-from . import ex_app
+from . import ex_app, options
 from ._exceptions import NextcloudException, NextcloudExceptionNotFound
 from ._version import __version__
 from .files import FsNode

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.0.28"
+__version__ = "0.0.29.dev0"

nc_py_api/options.py

@@ -3,6 +3,7 @@
 Each setting only affects newly created instances of Nextcloud or NextcloudApp class, unless otherwise specified.
 Specifying options in **kwargs** has higher priority than this.
 """
+import typing
 from os import environ
 
 from dotenv import load_dotenv
@@ -12,11 +13,19 @@
 XDEBUG_SESSION = environ.get("XDEBUG_SESSION", "")
 """Dev option, for debugging PHP code."""
 
-NPA_TIMEOUT = environ.get("NPA_TIMEOUT", 50)
+NPA_TIMEOUT: typing.Optional[int]
 """Default timeout for OCS API calls. Set to ``None`` to disable timeouts for development."""
+try:
+    NPA_TIMEOUT = int(environ.get("NPA_TIMEOUT", 30))
+except (TypeError, ValueError):
+    NPA_TIMEOUT = None
 
-NPA_TIMEOUT_DAV = environ.get("NPA_TIMEOUT_DAV", NPA_TIMEOUT * 3 if isinstance(NPA_TIMEOUT, int) else None)
+NPA_TIMEOUT_DAV: typing.Optional[int]
 """File operations timeout, usually it is OCS timeout multiplied by 3."""
+try:
+    NPA_TIMEOUT_DAV = int(environ.get("NPA_TIMEOUT_DAV", 30 * 3))
+except (TypeError, ValueError):
+    NPA_TIMEOUT_DAV = None
 
 NPA_NC_CERT = environ.get("NPA_NC_CERT", True)
 """Option to enable/disable Nextcloud certificate verification.

tests/options_test.py

@@ -0,0 +1,50 @@
+import os
+import sys
+from subprocess import PIPE, run
+
+import pytest
+from gfixture import NC_TO_TEST
+
+import nc_py_api
+
+
+def test_timeouts():
+    project_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    env_file = os.path.join(project_dir, ".env")
+    env_backup_file = os.path.join(project_dir, ".env.backup")
+    if os.path.exists(env_file):
+        os.rename(env_file, env_backup_file)
+    try:
+        check_command = [sys.executable, "-c", "import nc_py_api\nassert nc_py_api.options.NPA_TIMEOUT is None"]
+        with open(env_file, "w") as env_f:
+            env_f.write("NPA_TIMEOUT=None")
+        r = run(check_command, stderr=PIPE, env={}, cwd=project_dir, check=False)
+        assert not r.stderr
+        check_command = [sys.executable, "-c", "import nc_py_api\nassert nc_py_api.options.NPA_TIMEOUT == 11"]
+        with open(env_file, "w") as env_f:
+            env_f.write("NPA_TIMEOUT=11")
+        r = run(check_command, stderr=PIPE, env={}, cwd=project_dir, check=False)
+        assert not r.stderr
+        check_command = [sys.executable, "-c", "import nc_py_api\nassert nc_py_api.options.NPA_TIMEOUT_DAV is None"]
+        with open(env_file, "w") as env_f:
+            env_f.write("NPA_TIMEOUT_DAV=None")
+        r = run(check_command, stderr=PIPE, env={}, cwd=project_dir, check=False)
+        assert not r.stderr
+        check_command = [sys.executable, "-c", "import nc_py_api\nassert nc_py_api.options.NPA_TIMEOUT_DAV == 11"]
+        with open(env_file, "w") as env_f:
+            env_f.write("NPA_TIMEOUT_DAV=11")
+        r = run(check_command, stderr=PIPE, env={}, cwd=project_dir, check=False)
+        assert not r.stderr
+    finally:
+        if os.path.exists(env_backup_file):
+            os.rename(env_backup_file, env_file)
+
+
+@pytest.mark.skipif(not NC_TO_TEST, reason="Need Nextcloud or NextcloudApp.")
+def test_xdebug_session():
+    nc_py_api.options.XDEBUG_SESSION = "12345"
+    if isinstance(NC_TO_TEST, nc_py_api.Nextcloud):
+        new_nc = nc_py_api.Nextcloud()
+    else:
+        new_nc = nc_py_api.NextcloudApp()
+    assert new_nc._session.adapter.cookies["XDEBUG_SESSION"] == "12345"