Fix: Don't show confusing logs

Author: dorianim

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

@@ -100,6 +100,9 @@ def _readConfig():
         return None
 
 def _readLegacyNetworkConfig():
+    if not os.path.exists(constants.legacyNetworkConfigFilePath):
+        return None
+    
     configParser = configparser.ConfigParser()
     configParser.read(constants.legacyNetworkConfigFilePath)
     try:
@@ -111,7 +114,7 @@ def _readLegacyNetworkConfig():
         }
         return networkConfig
     except KeyError as e:
-        logging.error("Error when reading network.conf (1)")
+        logging.error("Error when reading network.conf. It exists but is invalid.")
         logging.exception(e)
         return None
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/test_config.py

@@ -34,10 +34,23 @@ def test_network_both():
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"/does/not/exist/config.yml")
-def test_network_none():
+@mock.patch("linuxmusterLinuxclient7.config.logging.exception")
+def test_network_none(mockLoggingException):
+    # make sure that no confusing error message is logged when config file does not exist
     rc, networkConfig = config.network()
     assert not rc
     assert networkConfig is None
+    assert not mockLoggingException.called
+
+@mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"{MOCK_FILE_PATH}/network.invalid.conf")
+@mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"/does/not/exist/config.yml")
+@mock.patch("linuxmusterLinuxclient7.config.logging.exception")
+def test_network_legacy_invalid(mockLoggingException):
+    # make sure that an error message is logged when the legacy config file exists but is invalid
+    rc, networkConfig = config.network()
+    assert not rc
+    assert networkConfig is None
+    assert mockLoggingException.called
 
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{MOCK_FILE_PATH}/config.invalid-network.yml")