Merge pull request #8 from DazEdword/feature/windows-configuration-lo…

…ading

Feature/windows configuration loading - Rc 0.5.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.5.0
 commit = True
 tag = True
 

README.md

@@ -19,8 +19,13 @@ Install the package with pip:
 python -m pip install synotools
 ```
 
+Unix users (Linux, Mac)
 Create your credentials file in `~/.synotools/credentials`:
 
+Windows users:
+Use `C:\Users\<YourUsername>\.synotools\credentials.txt` instead.
+
+
 ```
 # Device access credentials
 SYNOLOGY_IP=your-ip

docker/scripts/tests

@@ -12,7 +12,7 @@ echo "--> Running tests with coverage..."
 
 coverage run \
     --source=synotools \
-    -- $(which pytest) -v --durations=20 --tb=short --junit-xml=artifacts/test-report.xml tests/unit
+    -- $(which pytest) -v --durations=20 --tb=short --junit-xml=artifacts/test-report.xml tests/unit tests/integration/settings
 
 echo "--> Coverage stats..."
 coverage html

requirements-dev.txt

@@ -6,6 +6,7 @@ coverage
 coveralls
 flake8
 freezegun
+ipython
 isort
 mypy
 pytest

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="synotools",
-    version="0.4.0",
+    version="0.5.0",
     author="Ed Garabito",
     author_email="eduardo@gottabegarabi.com",
     description="A Python API wrapper and toolset to interact with Synology NAS devices.",

synotools/settings.py

@@ -1,18 +1,22 @@
 import os
+import sys
 from os.path import join
 from pathlib import Path
 
 from dotenv import load_dotenv
 
-CREDENTIALS_PATH = ".synotools/credentials"
-
 
 class Settings:
     def __init__(self):
-        load_dotenv(dotenv_path=self.get_local_credentials_path, verbose=True)
+        load_dotenv(dotenv_path=self.credentials_path, verbose=True)
 
     @property
-    def get_local_credentials_path(self):
+    def credentials_path(self):
+        if sys.platform.startswith("win"):
+            CREDENTIALS_PATH = ".synotools\\credentials.txt"
+        else:
+            CREDENTIALS_PATH = ".synotools/credentials"
+
         return join(str(Path.home()), CREDENTIALS_PATH)
 
     def get_environmental_variable(self, var_name):

tests/integration/settings/test_settings_os.py

@@ -0,0 +1,31 @@
+from synotools.settings import Settings
+
+
+class TestSettingsOS:
+    def test_get_environmental_variable_loads_credentials_from_expected_location_on_linux(
+        self, mocker,
+    ):
+        # Arrange
+        mocker.patch("synotools.settings.sys.platform", "linux")
+
+        # Act
+        target = Settings()
+
+        actual = target.credentials_path
+
+        # Assert
+        assert actual.endswith("credentials")
+
+    def test_get_environmental_variable_loads_credentials_from_expected_location_on_windows(
+        self, mocker,
+    ):
+        # Arrange
+        mocker.patch("synotools.settings.sys.platform", "win32")
+
+        # Act
+        target = Settings()
+
+        actual = target.credentials_path
+
+        # Assert
+        assert actual.endswith("credentials.txt")

tests/unit/test_settings.py → tests/unit/settings/test_settings.py

@@ -4,7 +4,7 @@
 def test_get_environmental_variable_loads_credentials_from_expected_location(mocker):
 
     mocker.patch(
-        "synotools.settings.Settings.get_local_credentials_path",
+        "synotools.settings.Settings.credentials_path",
         "home/test-user/.my-test/credentials",
     )