Added update_secrets_generator to connection profile

Will be used to automatically fetch secrets

Author: igo95862

sdbus_async/networkmanager/settings/profile.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field, fields
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Generator, Optional
 
 from .base import NetworkManagerSettingsMixin
 from .adsl import AdslSettings
@@ -463,6 +463,33 @@ def update(self, other: ConnectionProfile) -> None:
 
                 setattr(my_settings, setting_field_name, other_setting)
 
+    def update_secrets_generator(
+            self) -> Generator[str, ConnectionProfile, None]:
+        for attr_name, value in vars(self).items():
+            if value is None:
+                continue
+
+            if not isinstance(value, NetworkManagerSettingsMixin):
+                continue
+
+            secret_setting_name = value.secret_name
+
+            if not secret_setting_name:
+                continue
+
+            secret_profile = yield secret_setting_name
+            current_setting_secrets = getattr(secret_profile, attr_name)
+
+            for secret_attribute in value.secret_fields_names:
+                setattr(
+                    value,
+                    secret_attribute,
+                    getattr(
+                        current_setting_secrets,
+                        secret_attribute,
+                    ),
+                )
+
 
 SETTING_DBUS_NAME_TO_NAME: Dict[str, str] = {
     f.metadata['dbus_name']: f.name

tests/test_settings_profile.py

@@ -62,3 +62,19 @@ def test_update(self) -> None:
         connection.update(secrets)
 
         self.assertEqual(connection.wireguard.private_key, 'secret_key')
+
+    def test_update_secrets(self) -> None:
+        connection = ConnectionProfile.from_settings_dict(connection_dict)
+        secrets = ConnectionProfile.from_settings_dict(secret_dict)
+
+        connection_secret_update_generator = (
+            connection.update_secrets_generator()
+        )
+
+        setting_name = next(connection_secret_update_generator)
+        self.assertEqual(setting_name, 'wireguard')
+
+        with self.assertRaises(StopIteration):
+            connection_secret_update_generator.send(secrets)
+
+        self.assertEqual(connection.wireguard.private_key, 'secret_key')

tools/jinja_templates/profile.py.jinja2

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field, fields
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Generator, Optional
 
 from .base import NetworkManagerSettingsMixin
 {% for setting in all_settings -%}
@@ -165,6 +165,33 @@ class ConnectionProfile:
 
                 setattr(my_settings, setting_field_name, other_setting)
 
+    def update_secrets_generator(
+            self) -> Generator[str, ConnectionProfile, None]:
+        for attr_name, value in vars(self).items():
+            if value is None:
+                continue
+
+            if not isinstance(value, NetworkManagerSettingsMixin):
+                continue
+
+            secret_setting_name = value.secret_name
+
+            if not secret_setting_name:
+                continue
+
+            secret_profile = yield secret_setting_name
+            current_setting_secrets = getattr(secret_profile, attr_name)
+
+            for secret_attribute in value.secret_fields_names:
+                setattr(
+                    value,
+                    secret_attribute,
+                    getattr(
+                        current_setting_secrets,
+                        secret_attribute,
+                    ),
+                )
+
 
 SETTING_DBUS_NAME_TO_NAME: Dict[str, str] = {
     f.metadata['dbus_name']: f.name