feat: use qgs settings instead of config yml (#249)

Co-authored-by: Jakob Schnell <[email protected]>

CHANGELOG.md

@@ -40,6 +40,11 @@ RELEASING:
 14. Create new release in GitHub with tag version and release title of `vX.X.X`
  -->
 
+## Unreleased
+
+### Changed
+- Use QgsSettings instead of config.yml file to avoid deletion of providers on update ([#108](https://github.com/GIScience/orstools-qgis-plugin/issues/108))
+
 ## [1.8.4] - 2024-07-29
 
 ### Fixed

ORStools/ORStoolsPlugin.py

@@ -73,6 +73,8 @@ def __init__(self, iface: QgisInterface) -> None:
         except TypeError:
             pass
 
+        self.add_default_provider_to_settings()
+
     def initGui(self) -> None:
         """Create the menu entries and toolbar icons inside the QGIS GUI."""
 
@@ -83,3 +85,23 @@ def unload(self) -> None:
         """remove menu entry and toolbar icons"""
         QgsApplication.processingRegistry().removeProvider(self.provider)
         self.dialog.unload()
+
+    def add_default_provider_to_settings(self):
+        s = QgsSettings()
+        settings = s.value("ORStools/config")
+        if not settings:
+            def_settings = {
+                "providers": [
+                    {
+                        "ENV_VARS": {
+                            "ORS_QUOTA": "X-Ratelimit-Limit",
+                            "ORS_REMAINING": "X-Ratelimit-Remaining",
+                        },
+                        "base_url": "https://api.openrouteservice.org",
+                        "key": "",
+                        "name": "openrouteservice",
+                        "timeout": 60,
+                    }
+                ]
+            }
+            s.setValue("ORStools/config", def_settings)

ORStools/utils/configmanager.py

@@ -29,9 +29,7 @@
 
 import os
 
-import yaml
-
-from ORStools import CONFIG_PATH
+from qgis.core import QgsSettings
 
 
 def read_config() -> dict:
@@ -41,10 +39,10 @@ def read_config() -> dict:
     :returns: Parsed settings dictionary.
     :rtype: dict
     """
-    with open(CONFIG_PATH) as f:
-        doc = yaml.safe_load(f)
+    s = QgsSettings()
+    config = s.value("ORStools/config")
 
-    return doc
+    return config
 
 
 def write_config(new_config: dict) -> None:
@@ -54,8 +52,8 @@ def write_config(new_config: dict) -> None:
     :param new_config: new provider settings after altering in dialog.
     :type new_config: dict
     """
-    with open(CONFIG_PATH, "w") as f:
-        yaml.safe_dump(new_config, f)
+    s = QgsSettings()
+    s.setValue("ORStools/config", new_config)
 
 
 def write_env_var(key: str, value: str) -> None:

tests/conftest.py

@@ -1,11 +1,16 @@
 import os
-import yaml
 
+from qgis.core import QgsSettings
+
+from ORStools.ORStoolsPlugin import ORStools
 from ORStools.utils.configmanager import read_config
+from tests.utils.utilities import get_qgis_app
 
-with open("ORStools/config.yml", "r+") as file:
-    data = yaml.safe_load(file)
+QGISAPP, CANVAS, IFACE, PARENT = get_qgis_app()
 
+ORStools(IFACE).add_default_provider_to_settings()
+s = QgsSettings()
+data = s.value("ORStools/config")
 
 def pytest_sessionstart(session):
     """
@@ -14,8 +19,7 @@ def pytest_sessionstart(session):
     """
     if data["providers"][0]["key"] == "":
         data["providers"][0]["key"] = os.environ.get("ORS_API_KEY")
-        with open("ORStools/config.yml", "w") as file:
-            yaml.dump(data, file)
+        s.setValue("ORStools/config", data)
     else:
         raise ValueError("API key is not empty.")
 
@@ -25,10 +29,8 @@ def pytest_sessionfinish(session, exitstatus):
     Called after whole test run finished, right before
     returning the exit status to the system.
     """
-    with open("ORStools/config.yml", "w") as file:
-        if not data["providers"][0]["key"] == "":
-            data['providers'][0]['key'] = ''  # fmt: skip
-        yaml.dump(data, file)
-
+    if not data["providers"][0]["key"] == "":
+        data['providers'][0]['key'] = ''  # fmt: skip
+    s.setValue("ORStools/config", data)
     config = read_config()
     assert config["providers"][0]["key"] == ''  # fmt: skip

tests/test_gui.py

@@ -63,6 +63,6 @@ def test_ORStoolsDialog(self):
         dlg.line_tool.canvasDoubleClickEvent(map_dclick)
 
         self.assertTrue(dlg.isVisible())
-        self.assertAlmostEqual(
+        self.assertEqual(
             dlg.routing_fromline_list.item(0).text(), "Point 0: -0.187575, 56.516620"
         )