fix: update providers on update of plugin

Author: merydian

ORStools/ORStoolsPlugin.py

@@ -52,6 +52,7 @@ def __init__(self, iface: QgisInterface) -> None:
         """
         self.dialog = ORStoolsDialog.ORStoolsDialogMain(iface)
         self.provider = provider.ORStoolsProvider()
+        self.settings_keys = ["ENV_VARS", "base_url", "key", "name", "endpoints", "profiles"]
 
         # initialize plugin directory
         self.plugin_dir = os.path.dirname(__file__)
@@ -74,10 +75,7 @@ def __init__(self, iface: QgisInterface) -> None:
         except TypeError:
             pass
 
-        try:
-            configmanager.read_config()["providers"]
-        except (TypeError, KeyError):
-            self.add_default_provider_to_settings()
+        self.update_settings()
 
     def initGui(self) -> None:
         """Create the menu entries and toolbar icons inside the QGIS GUI."""
@@ -90,24 +88,21 @@ def unload(self) -> None:
         QgsApplication.processingRegistry().removeProvider(self.provider)
         self.dialog.unload()
 
-    def add_default_provider_to_settings(self):
-        s = QgsSettings()
-        settings = s.value("ORStools/config")
+    def update_settings(self):
+        settings = configmanager.read_config()
 
-        settings_keys = ["ENV_VARS", "base_url", "key", "name", "endpoints", "profiles"]
+        if settings is not None and settings != {}:
+            endpoints = settings.get("endpoints", ENDPOINTS)
+            profiles = settings.get("profiles", PROFILES)
 
-        # Add any new settings here for backwards compatibility
-        if settings:
             changed = False
             for i, prov in enumerate(settings["providers"]):
-                if any([i not in prov for i in settings_keys]):
+                if any([key not in prov for key in self.settings_keys]):
                     changed = True
-                    # Add here, like the endpoints
-                    prov["endpoints"] = ENDPOINTS
-                    settings["providers"][i] = prov
-                    prov["profiles"] = PROFILES
+                    prov["endpoints"] = endpoints
+                    prov["profiles"] = profiles
                     settings["providers"][i] = prov
             if changed:
-                s.setValue("ORStools/config", settings)
+                configmanager.write_config(settings)
         else:
-            s.setValue("ORStools/config", DEFAULT_SETTINGS)
+            configmanager.write_config(DEFAULT_SETTINGS)

tests/conftest.py

@@ -1,9 +1,9 @@
 import os
 
-from qgis.core import QgsSettings
 
 from ORStools.ORStoolsPlugin import ORStools
 from tests.utils.utilities import get_qgis_app
+from ORStools.utils import configmanager
 
 
 def pytest_sessionstart(session):
@@ -13,13 +13,13 @@ def pytest_sessionstart(session):
     """
     QGISAPP, CANVAS, IFACE, PARENT = get_qgis_app()
 
-    ORStools(IFACE).add_default_provider_to_settings()
-    s = QgsSettings()
-    data = s.value("ORStools/config")
+    ORStools(IFACE)
+
+    data = configmanager.read_config()
 
     if not os.environ.get("ORS_API_KEY"):
         raise ValueError(
             "No API key found in environment variables. Please set ORS_API_KEY environment variable to run tests."
         )
     data["providers"][0]["key"] = os.environ.get("ORS_API_KEY")
-    s.setValue("ORStools/config", data)
+    configmanager.write_config(data)

tests/test_gui.py

@@ -872,4 +872,4 @@ def test_load_layer_exception_handling(self):
         dialog_main.dlg.load_vertices_from_layer("ok")
 
         # Should not crash and list should be empty
-        self.assertEqual(dialog_main.dlg.routing_fromline_list.count(), 0)
+        self.assertEqual(dialog_main.dlg.routing_fromline_list.count(), 0)