Rename rdma.capable_services to rdma.capable_protocols. (#14796)

And added a CI test.

src/middlewared/middlewared/api/v25_04_0/rdma.py

@@ -4,7 +4,7 @@
 __all__ = [
     "RdmaLinkConfigArgs", "RdmaLinkConfigResult",
     "RdmaCardConfigArgs", "RdmaCardConfigResult",
-    "RdmaCapableServicesArgs", "RdmaCapableServicesResult"
+    "RdmaCapableProtocolsArgs", "RdmaCapableProtocolsResult"
 ]
 
 
@@ -33,9 +33,9 @@ class RdmaCardConfigResult(BaseModel):
     links: list[RdmaLinkConfig]
 
 
-class RdmaCapableServicesArgs(BaseModel):
+class RdmaCapableProtocolsArgs(BaseModel):
     pass
 
 
-class RdmaCapableServicesResult(BaseModel):
+class RdmaCapableProtocolsResult(BaseModel):
     result: list[Literal["NFS"]]

src/middlewared/middlewared/plugins/nfs.py

@@ -417,8 +417,8 @@ async def do_update(self, data):
             verrors.add("nfs_update.v4_domain", "This option does not apply to NFSv3")
 
         if new["rdma"]:
-            available_rdma_services = await self.middleware.call('rdma.capable_services')
-            if "NFS" not in available_rdma_services:
+            available_rdma_protocols = await self.middleware.call('rdma.capable_protocols')
+            if 'NFS' not in available_rdma_protocols:
                 verrors.add(
                     "nfs_update.rdma",
                     "This platform cannot support NFS over RDMA or is missing an RDMA capable NIC."

src/middlewared/middlewared/plugins/rdma/rdma.py

@@ -7,7 +7,7 @@
 from middlewared.api.current import (
     RdmaLinkConfigArgs, RdmaLinkConfigResult,
     RdmaCardConfigArgs, RdmaCardConfigResult,
-    RdmaCapableServicesArgs, RdmaCapableServicesResult
+    RdmaCapableProtocolsArgs, RdmaCapableProtocolsResult
 )
 from middlewared.service import Service, private
 from middlewared.service_exception import CallError
@@ -126,8 +126,8 @@ def get_card_choices(self):
             v['name'] = ':'.join(sorted(names))
         return list(grouper.values())
 
-    @api_method(RdmaCapableServicesArgs, RdmaCapableServicesResult)
-    async def capable_services(self):
+    @api_method(RdmaCapableProtocolsArgs, RdmaCapableProtocolsResult)
+    async def capable_protocols(self):
         result = []
         is_ent = await self.middleware.call('system.is_enterprise')
         if is_ent and 'MINI' not in await self.middleware.call('truenas.get_chassis_hardware'):

tests/api2/test_300_nfs.py

@@ -1734,6 +1734,35 @@ def test_manage_gids(self, start_nfs, state, expected):
             s = parse_server_config()
             assert s['mountd']['manage-gids'] == expected, str(s)
 
+    def test_rdma_config(self, start_nfs):
+        '''
+        Mock response from rdma.capable_protocols to confirm NFS over RDMA config setting
+        '''
+        assert start_nfs is True
+
+        # Confirm the setting does not exist by default
+        s = parse_server_config()
+        assert s.get('rdma') is None, str(s)
+
+        # RDMA setting should fail on a test vm.
+        with pytest.raises(ValidationErrors) as ve:
+            call("nfs.update", {"rdma": True})
+        assert ve.value.errors == [
+            ValidationError(
+                'nfs_update.rdma',
+                'This platform cannot support NFS over RDMA or is missing an RDMA capable NIC.',
+                22
+            )
+        ]
+
+        with mock("rdma.capable_protocols", return_value=['NFS']):
+            with nfs_config():
+                call("nfs.update", {"rdma": True})
+                s = parse_server_config()
+                assert s['nfsd']['rdma'] == 'y', str(s)
+                # 20049 is the default port for NFS over RDMA.
+                assert s['nfsd']['rdma-port'] == '20049', str(s)
+
 
 def test_pool_delete_with_attached_share():
     '''