Feat: allow user to define custom template for share name

Author: dorianim

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

@@ -19,6 +19,23 @@ def network():
 
     return True, networkConfig
 
+def shares():
+    """
+    Get the shares configuration in `/etc/linuxmuster-linuxclient7/config.yml`
+
+    :return: Tuple (success, dict of keys)
+    :rtype: tuple
+    """
+    config = _readConfig()
+    sharesConfig = {}
+    if config is not None and "shares" in config:
+        sharesConfig = config["shares"]
+
+    if not "nameTemplate" in sharesConfig:
+        sharesConfig["nameTemplate"] = constants.defaultShareNameTemplate
+
+    return sharesConfig
+
 def writeNetworkConfig(newNetworkConfig):
     """
     Write the network configuration in `/etc/linuxmuster-linuxclient7/config.yml`.

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

@@ -10,6 +10,7 @@
 shareMountBasepath = "/home/{}/media"
 hiddenShareMountBasepath = "/srv/samba/{}"
 machineAccountSysvolMountPath = "/var/lib/samba/sysvol"
+defaultShareNameTemplate = "{label} ({letter}:)"
 
 etcBaseDir = "/etc/linuxmuster-linuxclient7"
 shareBaseDir = "/usr/share/linuxmuster-linuxclient7"

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

@@ -239,7 +239,8 @@ def _processDrivesPolicy(policyBasepath):
 
     for drive in shareList:
         if drive["useLetter"] == "1":
-            shareName = f"{drive['label']} ({drive['letter']}:)"  
+            nameTemplate = config.shares()["nameTemplate"]
+            shareName = nameTemplate.format(label=drive['label'], letter=drive['letter'])
         else:
             shareName = drive["label"]
 

usr/lib/python3/dist-packages/linuxmusterLinuxclient7/tests/files/config/config.no-shares.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/config.yml

@@ -1,3 +1,6 @@
+shares:
+  nameTemplate: "{label}_{letter}"
+
 network:
   serverHostname: server.linuxmuster.lan
   domain: linuxmuster.lan

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

@@ -44,6 +44,27 @@ def test_network_invalid():
     assert not rc
     assert networkConfig is None
 
+@mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
+@mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{os.path.dirname(os.path.realpath(__file__))}/files/config/config.yml")
+def test_shares():
+    sharesConfig = config.shares()
+    assert "nameTemplate" in sharesConfig
+    assert sharesConfig["nameTemplate"] == "{label}_{letter}"
+
+@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_shares_none():
+    sharesConfig = config.shares()
+    assert "nameTemplate" in sharesConfig
+    assert sharesConfig["nameTemplate"] == config.constants.defaultShareNameTemplate
+
+@mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
+@mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{os.path.dirname(os.path.realpath(__file__))}/files/config/config.no-shares.yml")
+def test_shares_missing():
+    sharesConfig = config.shares()
+    assert "nameTemplate" in sharesConfig
+    assert sharesConfig["nameTemplate"] == config.constants.defaultShareNameTemplate
+
 @mock.patch("linuxmusterLinuxclient7.config.constants.legacyNetworkConfigFilePath", f"/does/not/exist/network.conf")
 @mock.patch("linuxmusterLinuxclient7.config.constants.configFilePath", f"{os.path.dirname(os.path.realpath(__file__))}/files/config/config.invalid-syntax.yml")
 def test_syntax_invalid():

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

@@ -46,6 +46,47 @@ def test_allOkAllTrue(mockUserSchool, mockLdapHelperSearchOne, mockSharesGetMoun
     assert len(mockPrintersInstallPrinter.call_args_list) == 1
     assert mockPrintersInstallPrinter.call_args_list[0] == mock.call('ipp://SERVER/printers/PRINTER1', 'PRINTER1')
 
+@mock.patch("linuxmusterLinuxclient7.gpo.config.shares")
+@mock.patch("linuxmusterLinuxclient7.gpo.computer.isInGroup")
+@mock.patch("linuxmusterLinuxclient7.gpo.user.isInGroup")
+@mock.patch("linuxmusterLinuxclient7.gpo.printers.installPrinter")
+@mock.patch("linuxmusterLinuxclient7.gpo.shares.mountShare")
+@mock.patch("linuxmusterLinuxclient7.gpo.shares.getMountpointOfRemotePath")
+@mock.patch("linuxmusterLinuxclient7.gpo.ldapHelper.searchOne")
+@mock.patch("linuxmusterLinuxclient7.gpo.user.school")
+def test_customShareNameTemplate(mockUserSchool, mockLdapHelperSearchOne, mockSharesGetMountpointOfRemotePath, mockSharesmMountShare, mockPrintersInstallPrinter, mockUserIsInGroup, mockComputerIsInGroup, mockConfigShares):
+    mockUserSchool.return_value = (True, "school1")
+    mockLdapHelperSearchOne.return_value = (True, {
+        "distinguishedName": "policy1",
+        "gPCFileSysPath": "\\\\linuxmuster.lan\\sysvol\\linuxmuster.lan\\Policies\\policy1"
+    })
+    mockSharesGetMountpointOfRemotePath.return_value = (True, f"{os.path.dirname(os.path.realpath(__file__))}/files/policy1")
+    mockSharesmMountShare.return_value = (True, "")
+    mockPrintersInstallPrinter.return_value = True
+    mockUserIsInGroup.return_value = True
+    mockComputerIsInGroup.return_value = True
+    mockConfigShares.return_value = {
+        "nameTemplate": "{label}_{letter}"
+    }
+
+    assert gpo.processAllPolicies()
+    assert len(mockSharesmMountShare.call_args_list) == 3
+    assert mockSharesmMountShare.call_args_list[0] == mock.call('\\\\server\\default-school\\program', shareName='Programs_K')
+    # Projects (P:) is disabled and should not be mounted
+    assert mockSharesmMountShare.call_args_list[1] == mock.call('\\\\server\\default-school\\students', shareName='Students-Home_S')
+    assert mockSharesmMountShare.call_args_list[2] == mock.call('\\\\server\\default-school\\share', shareName='Shares')
+
+    # Test without letter
+    mockConfigShares.return_value = {
+        "nameTemplate": "{label}"
+    }
+    assert gpo.processAllPolicies()
+    assert len(mockSharesmMountShare.call_args_list) == 6
+    assert mockSharesmMountShare.call_args_list[3] == mock.call('\\\\server\\default-school\\program', shareName='Programs')
+    # Projects (P:) is disabled and should not be mounted
+    assert mockSharesmMountShare.call_args_list[4] == mock.call('\\\\server\\default-school\\students', shareName='Students-Home')
+    assert mockSharesmMountShare.call_args_list[5] == mock.call('\\\\server\\default-school\\share', shareName='Shares')
+
 @mock.patch("linuxmusterLinuxclient7.gpo.computer.isInGroup")
 @mock.patch("linuxmusterLinuxclient7.gpo.user.isInGroup")
 @mock.patch("linuxmusterLinuxclient7.gpo.printers.installPrinter")

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

@@ -135,6 +135,29 @@ def test_getHomeShareMountpoint(mockUsername, mockReadAttributes):
     rc, homeShareMountpoint = user.getHomeShareMountpoint()
     assert rc
     assert homeShareMountpoint == "/home/user1/media/user1 (H:)"
+
+
+@mock.patch("linuxmusterLinuxclient7.gpo.config.shares")
+@mock.patch("linuxmusterLinuxclient7.user.readAttributes")
+@mock.patch("linuxmusterLinuxclient7.user.username")
+def test_getHomeShareMountpointCustomShareNameTemplate(mockUsername, mockReadAttributes, mockConfigShares):
+    mockUsername.return_value = "user1"
+    mockReadAttributes.return_value = (True, {"homeDrive": "H:"})
+    mockConfigShares.return_value = {
+        "nameTemplate": "{label}_{letter}"
+    }
+
+    rc, homeShareMountpoint = user.getHomeShareMountpoint()
+    assert rc
+    assert homeShareMountpoint == "/home/user1/media/user1_H"
+
+    # Test without letter
+    mockConfigShares.return_value = {
+        "nameTemplate": "{label}"
+    }
+    rc, homeShareMountpoint = user.getHomeShareMountpoint()
+    assert rc
+    assert homeShareMountpoint == "/home/user1/media/user1"
 
 @mock.patch("linuxmusterLinuxclient7.user.shares.mountShare")
 @mock.patch("linuxmusterLinuxclient7.user.readAttributes")

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

@@ -146,8 +146,9 @@ def _getHomeShareName(userAttributes=None):
 
     if rc:
         try:
-            usernameString = username()
-            shareName = f"{usernameString} ({userAttributes['homeDrive']})"
+            nameTemplate = config.shares()["nameTemplate"]
+            letter = userAttributes['homeDrive'].replace(':', '')
+            shareName = nameTemplate.format(label=username(), letter=letter)
             return True, shareName
 
         except Exception as e: