Feat: refactor config file

debian/control

@@ -7,6 +7,6 @@ Standards-Version: 5.0.0
 
 Package: linuxmuster-linuxclient7
 Architecture: all
-Depends: python3, python3-ldap, cifs-utils, ldb-tools, bind9-host, ipcalc, hxtools, network-manager, krb5-user, keyutils, samba, sssd, sssd-tools, libsss-sudo, adcli, libpam-sss, sudo, realmd, cups (>= 2.3.0), coreutils, libcap2-bin
+Depends: python3, python3-ldap, python3-yaml, cifs-utils, ldb-tools, bind9-host, ipcalc, hxtools, network-manager, krb5-user, keyutils, samba, sssd, sssd-tools, libsss-sudo, adcli, libpam-sss, sudo, realmd, cups (>= 2.3.0), coreutils, libcap2-bin
 Description: Package for Ubuntu clients to connect to the linuxmuster.net 7 active directory server.
 Conflicts: linuxmuster-client-adsso, linuxmuster-client-adsso7, ni-lmn-client-adsso

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/config.py

@@ -1,5 +1,5 @@
-import configparser, re
-from linuxmusterLinuxclient7 import logging, constants
+import configparser, os, yaml
+from linuxmusterLinuxclient7 import logging, constants, fileHelper
 
 def network():
     """
@@ -8,59 +8,36 @@ def network():
     :return: Tuple (success, dict of keys)
     :rtype: tuple
     """
-    rc, rawNetworkConfig = _readNetworkConfig()
-    if not rc:
+    config = _readConfig()
+    if config is None or not "network" in config:
         return False, None
 
-    if not _checkNetworkConfigVersion(rawNetworkConfig)[0]:
-        return False, None
-
-    networkConfig = {}
-
-    try:
-        networkConfig["serverHostname"] = rawNetworkConfig["serverHostname"]
-        networkConfig["domain"] = rawNetworkConfig["domain"]
-        networkConfig["realm"] = rawNetworkConfig["realm"]
-    except KeyError as e:
-        logging.error("Error when reading network.conf (2)")
-        logging.exception(e)
+    networkConfig = config["network"]
+    if not _validateNetworkConfig(networkConfig):
+        logging.error("Error when reading network.conf")
         return False, None
 
     return True, networkConfig
 
 def writeNetworkConfig(newNetworkConfig):
     """
-    Write the network configuration in `/etc/linuxmuster-linuxclient7/network.conf`
+    Write the network configuration in `/etc/linuxmuster-linuxclient7/config.yml`.
+    Preserves other configurations.
 
     :param newNetworkConfig: The new config
     :type newNetworkConfig: dict
     :return: True or False
     :rtype: bool
     """
-    networkConfig = configparser.ConfigParser(interpolation=None)
-
-    try:
-        networkConfig["network"] = {}
-        networkConfig["network"]["version"] = str(_networkConfigVersion())
-        networkConfig["network"]["serverHostname"] = newNetworkConfig["serverHostname"]
-        networkConfig["network"]["domain"] = newNetworkConfig["domain"]
-        networkConfig["network"]["realm"] = newNetworkConfig["realm"]
-    except Exception as e:
-        logging.error("Error when preprocessing new network configuration!")
-        logging.exception(e)
+    if not _validateNetworkConfig(newNetworkConfig):
         return False
 
-    try:
-        logging.info("Writing new network Configuration")
-        with open(constants.networkConfigFilePath, 'w') as networkConfigFile:
-            networkConfig.write(networkConfigFile)
+    config = _readConfig()
+    if config is None:
+        config = {}
+    config["network"] = newNetworkConfig
 
-    except Exception as e:
-        logging.error("Failed!")
-        logging.exception(e)
-        return False
-
-    return True
+    return _writeConfig(config)
 
 def upgrade():
     """
@@ -70,67 +47,87 @@ def upgrade():
     :return: True or False
     :rtype: bool
     """
-    return _upgradeNetworkConfig()
+    return _upgrade()
+
+def delete():
+    """
+    Delete the network configuration file.
+
+    :return: True or False
+    :rtype: bool
+    """
+    legacyNetworkConfigFleDeleted = fileHelper.deleteFile(constants.legacyNetworkConfigFilePath)
+    configFileDeleted = fileHelper.deleteFile(constants.configFilePath)
+    return legacyNetworkConfigFleDeleted and configFileDeleted
+
 
 # --------------------
 # - Helper functions -
 # --------------------
 
-def _readNetworkConfig():
+def _readConfig():
+    if not os.path.exists(constants.configFilePath):
+        networkConfig = _readLegacyNetworkConfig()
+        return {"network": networkConfig} if networkConfig is not None else None
+
+    try:
+        with open(constants.configFilePath, "r") as configFile:
+            yamlContent = configFile.read()
+        config = yaml.safe_load(yamlContent)
+        return config
+    except Exception as e:
+        logging.error("Error when reading config.yml")
+        logging.exception(e)
+        return None
+
+def _readLegacyNetworkConfig():
     configParser = configparser.ConfigParser()
-    configParser.read(constants.networkConfigFilePath)
+    configParser.read(constants.legacyNetworkConfigFilePath)
     try:
         rawNetworkConfig = configParser["network"]
-        return True, rawNetworkConfig
+        networkConfig = {
+            "serverHostname": rawNetworkConfig["serverHostname"],
+            "domain": rawNetworkConfig["domain"],
+            "realm": rawNetworkConfig["realm"]
+        }
+        return networkConfig
     except KeyError as e:
         logging.error("Error when reading network.conf (1)")
         logging.exception(e)
-        return False, None
-    return configParser
-
-def _networkConfigVersion():
-    return 1
+        return None
 
-def _checkNetworkConfigVersion(rawNetworkConfig):
+def _writeConfig(config):
     try:
-        networkConfigVersion = int(rawNetworkConfig["version"])
-    except KeyError as e:
-        logging.warning("The network.conf version could not be identified, assuming 0")
-        networkConfigVersion = 0
-
-    if networkConfigVersion != _networkConfigVersion():
-        logging.warning("The network.conf Version is a mismatch!")
-        return False, networkConfigVersion
-
-    return True, networkConfigVersion
-
-def _upgradeNetworkConfig():
-    logging.info("Upgrading network config.")
-    rc, rawNetworkConfig = _readNetworkConfig()
-    if not rc:
+        with open(constants.configFilePath, "w") as configFile:
+            yamlContent = yaml.dump(config)
+            configFile.write(yamlContent)
+        return True
+    except Exception as e:
+        logging.error("Error when writing config.yml")
+        logging.exception(e)
         return False
 
-    rc, networkConfigVersion = _checkNetworkConfigVersion(rawNetworkConfig)
-    if rc:
+def _validateNetworkConfig(networkConfig):
+    requiredKeys = {"serverHostname", "domain", "realm"}
+    return networkConfig is not None and networkConfig.keys() >= requiredKeys
+
+def _upgrade():
+    logging.info("Upgrading config.")
+    if os.path.exists(constants.configFilePath):
         logging.info("No need to upgrade, already up-to-date.")
         return True
 
-    logging.info("Upgrading network config from {0} to {1}".format(networkConfigVersion, _networkConfigVersion()))
-
-    if networkConfigVersion > _networkConfigVersion():
-        logging.error("Cannot upgrade from a newer version to an older one!")
-        return False
+    logging.info("Upgrading config from network.conf to config.yml")
 
-    try:
-        if networkConfigVersion == 0:
-            newNetworkConfig = {}
-            newNetworkConfig["serverHostname"] = rawNetworkConfig["serverHostname"] + "." + rawNetworkConfig["domain"]
-            newNetworkConfig["domain"] = rawNetworkConfig["domain"]
-            newNetworkConfig["realm"] = rawNetworkConfig["domain"].upper()
-            return writeNetworkConfig(newNetworkConfig)
-    except Exception as e:
-        logging.error("Error when upgrading network config!")
-        logging.exception(e)
+    config = _readConfig()
+    if config is None or not "network" in config or not _validateNetworkConfig(config["network"]):
+        logging.error("Error when upgrading config, network.conf is invalid")
         return False
-
+
+    if not _writeConfig(config):
+        logging.error("Error when upgrading config, could not write config.yml")
+        return False
+
+    fileHelper.deleteFile(constants.legacyNetworkConfigFilePath)
+    logging.info("Config upgrade successfull")
     return True

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/constants.py

@@ -16,7 +16,8 @@
 configFileTemplateDir = shareBaseDir + "/templates"
 scriptDir = shareBaseDir + "/scripts"
 
-networkConfigFilePath = etcBaseDir + "/network.conf"
+legacyNetworkConfigFilePath = etcBaseDir + "/network.conf"
+configFilePath = etcBaseDir + "/config.yml"
 # {} will be substituted for the username
 tmpEnvironmentFilePath = "/home/{}/.linuxmuster-linuxclient7-environment.sh"
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/requirements.txt

@@ -11,3 +11,4 @@ pytest==7.1.1
 pytest-cov==3.0.0
 python-ldap==3.4.0
 tomli==2.0.1
+pyyaml==6.0

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/setup.py

@@ -179,7 +179,8 @@ def isSetup():
     :return: True if setup, False otherwise
     :rtype: bool
     """
-    return os.path.isfile(constants.networkConfigFilePath) 
+    rc, networkConfig = config.network()
+    return rc and networkConfig is not None
 
 # --------------------
 # - Helper functions -
@@ -209,9 +210,9 @@ def _cleanOldDomainJoins():
     if not fileHelper.deleteFilesWithExtension("/var/lib/samba/private/tls", ".pem"):
         return False
 
-    # remove network.conf
-    logging.info(f"Deleting {constants.networkConfigFilePath} if exists ...")
-    if not fileHelper.deleteFile(constants.networkConfigFilePath):
+    # remove configuration
+    logging.info(f"Deleting configuration files if exist ...")
+    if not config.delete():
         return False
 
     return True

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/config.invalid-network.yml

@@ -0,0 +1,4 @@
+network:
+  sserverHostname: server.linuxmuster.lan
+  ddomain: linuxmuster.lan
+  rrealm: LINUXMUSTER.LAN

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/config.invalid-syntax.yml

@@ -0,0 +1,5 @@
+*-?
+network:
+  serverHostname: server.linuxmuster.lan
+  domain: linuxmuster.lan
+  realm: LINUXMUSTER.LAN

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/config.yml

@@ -0,0 +1,4 @@
+network:
+  serverHostname: server.linuxmuster.lan
+  domain: linuxmuster.lan
+  realm: LINUXMUSTER.LAN

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/network.conf

@@ -0,0 +1,5 @@
+[network]
+version = 1
+serverhostname = server.linuxmuster.legacy
+domain = linuxmuster.legacy
+realm = LINUXMUSTER.LEGACY

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/network.invalid.conf

@@ -0,0 +1,5 @@
+[network]
+version = 1
+sserverhostname = server.linuxmuster.legacy
+ddomain = linuxmuster.legacy
+rrealm = LINUXMUSTER.LEGACY