[JCM] Fix DNS-SD Port Overrides, Port Randomization Collisions, and Storage Conflicts in Joint Fabrics JCM Python Tests (project-chip#72327)

* feat: skip DNS-SD port overwrite in combined server/commissioner

* feat: use port randomization in Joint Fabric Python tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add more logic to random port selection

* Restyle

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* feat: consolidate storage and add robust teardown cleanup in JCM Python tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: preserve preventDnssdPortOverwrite on reinit and resolve Python test feedback

* fix: resolve CA manager flakiness, memory leaks, and inconsistent teardowns

- Implement a strict fail-fast IPv6 port check in get_random_port to avoid hangs.
- Ensure consistent None assignments in TC_JFADMIN_2_1.py teardown.
- Proactively resolve CA manager and persistent storage resource leaks in TC_JFADMIN_1_1.py and TC_JFDS_2_1.py by promoting them to instance variables and ensuring explicit shutdown in teardown_class.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add comment explaining preventDnssdPortOverwrite in CommissionerMain

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: andy31415

examples/platform/linux/CommissionerMain.cpp

@@ -134,6 +134,10 @@ CHIP_ERROR InitCommissioner(uint16_t commissionerPort, uint16_t udcListenPort, F
     factoryParams.fabricIndependentStorage = &gServerStorage;
     factoryParams.fabricTable              = &Server::GetInstance().GetFabricTable();
     factoryParams.sessionKeystore          = &gSessionKeystore;
+    factoryParams.enableServerInteractions = true;
+    // Since CommissionerMain is used in combined server/commissioner applications,
+    // we must prevent the commissioner from overwriting the server's DNS-SD port.
+    factoryParams.preventDnssdPortOverwrite = true;
     // We're running alongside an existing Server, so use the existing DataModelProvider
     // without changing the underlying persistent storage delegate.
     factoryParams.dataModelProvider = chip::app::CodegenDataModelProviderInstance(nullptr);

src/controller/CHIPDeviceControllerFactory.cpp

@@ -69,6 +69,7 @@ CHIP_ERROR DeviceControllerFactory::Init(FactoryInitParams params)
     mCertificateValidityPolicy = params.certificateValidityPolicy;
     mSessionResumptionStorage  = params.sessionResumptionStorage;
     mEnableServerInteractions  = params.enableServerInteractions;
+    mPreventDnssdPortOverwrite = params.preventDnssdPortOverwrite;
     mDataModelProvider         = params.dataModelProvider;
 
     // Initialize the system state. Note that it is left in a somewhat
@@ -96,6 +97,7 @@ CHIP_ERROR DeviceControllerFactory::ReinitSystemStateIfNecessary()
     params.interfaceId               = mInterfaceId;
     params.fabricIndependentStorage  = mFabricIndependentStorage;
     params.enableServerInteractions  = mEnableServerInteractions;
+    params.preventDnssdPortOverwrite = mPreventDnssdPortOverwrite;
     params.groupDataProvider         = mSystemState->GetGroupDataProvider();
     params.sessionKeystore           = mSystemState->GetSessionKeystore();
     params.fabricTable               = mSystemState->Fabrics();
@@ -288,15 +290,18 @@ CHIP_ERROR DeviceControllerFactory::InitSystemState(FactoryInitParams params)
             stateParams.exchangeMgr, stateParams.sessionMgr, stateParams.fabricTable, sessionResumptionStorage,
             stateParams.certificateValidityPolicy, stateParams.groupDataProvider));
 
-        // Our IPv6 transport is at index 0.
-        app::DnssdServer::Instance().SetSecuredIPv6Port(
-            stateParams.transportMgr->GetTransport().GetImplAtIndex<0>().GetBoundPort());
+        if (!params.preventDnssdPortOverwrite)
+        {
+            // Our IPv6 transport is at index 0.
+            app::DnssdServer::Instance().SetSecuredIPv6Port(
+                stateParams.transportMgr->GetTransport().GetImplAtIndex<0>().GetBoundPort());
 
 #if INET_CONFIG_ENABLE_IPV4
-        // If enabled, our IPv4 transport is at index 1.
-        app::DnssdServer::Instance().SetSecuredIPv4Port(
-            stateParams.transportMgr->GetTransport().GetImplAtIndex<1>().GetBoundPort());
+            // If enabled, our IPv4 transport is at index 1.
+            app::DnssdServer::Instance().SetSecuredIPv4Port(
+                stateParams.transportMgr->GetTransport().GetImplAtIndex<1>().GetBoundPort());
 #endif // INET_CONFIG_ENABLE_IPV4
+        }
 
         if (params.interfaceId)
         {

src/controller/CHIPDeviceControllerFactory.h

@@ -161,6 +161,12 @@ struct FactoryInitParams
     //
     bool enableServerInteractions = false;
 
+    // Controls whether the controller factory initialization is prevented from
+    // overwriting the global DnssdServer's secured port. When running in a
+    // combined server/controller app where the server's port is primary, this
+    // must be set to true to keep DNS-SD advertising the server's port.
+    bool preventDnssdPortOverwrite = false;
+
     /* The port used for operational communication to listen for and send messages over UDP/TCP.
      * The default value of `0` will pick any available port. */
     uint16_t listenPort = 0;
@@ -315,6 +321,7 @@ class DeviceControllerFactory
     SessionResumptionStorage * mSessionResumptionStorage                = nullptr;
     app::DataModel::Provider * mDataModelProvider                       = nullptr;
     bool mEnableServerInteractions                                      = false;
+    bool mPreventDnssdPortOverwrite                                     = false;
 };
 
 } // namespace Controller

src/python_testing/TC_JFADMIN_1_1.py

@@ -62,6 +62,9 @@ async def setup_class(self):
         self.fabric_a_ctrl = None
         self.fabric_a_admin = None
         self.storage_fabric_a = self.user_params.get("fabric_a_storage", None)
+        self.fabric_a_persistent_storage = None
+        self.cert_authority_manager_a = None
+        self.dev_ctrl_eco_a = None
 
         self.jfc_server_app = self.user_params.get("jfc_server_app", None)
         if not self.jfc_server_app:
@@ -88,6 +91,16 @@ def teardown_class(self):
         if self.fabric_a_ctrl is not None:
             self.fabric_a_ctrl.terminate()
 
+        if self.dev_ctrl_eco_a is not None:
+            self.dev_ctrl_eco_a.Shutdown()
+            self.dev_ctrl_eco_a = None
+        if self.cert_authority_manager_a is not None:
+            self.cert_authority_manager_a.Shutdown()
+            self.cert_authority_manager_a = None
+        if self.fabric_a_persistent_storage is not None:
+            self.fabric_a_persistent_storage.Shutdown()
+            self.fabric_a_persistent_storage = None
+
         super().teardown_class()
 
     def steps_TC_JFADMIN_1_1(self) -> list[TestStep]:
@@ -115,12 +128,12 @@ async def test_TC_JFADMIN_1_1(self):
             dut_rpc_server_ip = "127.0.0.1"
             jfadmin_fabric_a_passcode = random.randint(110220011, 110220999)
             jfadmin_fabric_a_discriminator = random.randint(0, 4095)
-            dut_rpc_server_port = "33033"
+            dut_rpc_server_port = str(self.get_random_port())
             # Start Fabric A JF-Administrator App
             self.fabric_a_admin = AppServerSubprocess(
                 self.jfa_server_app,
                 storage_dir=self.storage_fabric_a,
-                port=random.randint(5001, 5999),
+                port=self.get_random_port(),
                 discriminator=jfadmin_fabric_a_discriminator,
                 passcode=jfadmin_fabric_a_passcode,
                 extra_args=["--capabilities", "0x04", "--rpc-server-port", dut_rpc_server_port])
@@ -182,20 +195,20 @@ async def test_TC_JFADMIN_1_1(self):
         self.ecoACATs = base64.b64decode(jfcStorage.get("Default", "CommissionerCATs"))[::-1].hex().strip('0')
 
         # Creating a Controller for Ecosystem A
-        _fabric_a_persistent_storage = VolatileTemporaryPersistentStorage(
+        self.fabric_a_persistent_storage = VolatileTemporaryPersistentStorage(
             self.ecoACtrlStorage['repl-config'], self.ecoACtrlStorage['sdk-config'])
-        _certAuthorityManagerA = CertificateAuthority.CertificateAuthorityManager(
+        self.cert_authority_manager_a = CertificateAuthority.CertificateAuthorityManager(
             chipStack=self.matter_stack._chip_stack,
-            persistentStorage=_fabric_a_persistent_storage)
-        _certAuthorityManagerA.LoadAuthoritiesFromStorage()
-        devCtrlEcoA = _certAuthorityManagerA.activeCaList[0].adminList[0].NewController(
+            persistentStorage=self.fabric_a_persistent_storage)
+        self.cert_authority_manager_a.LoadAuthoritiesFromStorage()
+        self.dev_ctrl_eco_a = self.cert_authority_manager_a.activeCaList[0].adminList[0].NewController(
             nodeId=101,
             paaTrustStorePath=str(self.matter_test_config.paa_trust_store_path),
             catTags=[int(self.ecoACATs, 16)])
 
         if self.pics_guard(self.check_pics("JFADMIN.S.A0000")):
             self.step("2")
-            response = await devCtrlEcoA.ReadAttribute(
+            response = await self.dev_ctrl_eco_a.ReadAttribute(
                 nodeId=1, attributes=[(1, Clusters.JointFabricAdministrator.Attributes.AdministratorFabricIndex)],
                 returnClusterObject=True)
             attributeAdminFabricIndex = response[1][Clusters.JointFabricAdministrator].administratorFabricIndex
@@ -204,7 +217,7 @@ async def test_TC_JFADMIN_1_1(self):
 
             # Step 3 is under same PICS guard as Step 2 becasue it relies on attributeAdminFabricIndex
             self.step("3")
-            response = await devCtrlEcoA.ReadAttribute(
+            response = await self.dev_ctrl_eco_a.ReadAttribute(
                 nodeId=1, attributes=[(0, Clusters.OperationalCredentials.Attributes.Fabrics)],
                 returnClusterObject=True)
             fabricid_found = False
@@ -217,9 +230,6 @@ async def test_TC_JFADMIN_1_1(self):
             asserts.assert_true(fabricid_found,
                                 "No FabricDescriptorStruct with fabricIndex = AdministratorFabricIndex found in Operational Cluster Fabrics attribute on EP0")
 
-        # Shutdown the Python Controllers started at the beginning of this script
-        devCtrlEcoA.Shutdown()
-
 
 if __name__ == "__main__":
     default_matter_test_main()

src/python_testing/TC_JFADMIN_1_2.py

@@ -83,14 +83,15 @@ async def setup_class(self):
         if self.is_pics_sdk_ci_only:
             self.admin_passcode = random.randint(20202021, 20202099)
             self.admin_discriminator = random.randint(0, 4095)
+            rpc_port = self.get_random_port()
             # Start JF-Administrator App
             self.jf_admin = AppServerSubprocess(
                 self.jfa_server_app,
                 storage_dir=self.fabric_storage,
-                port=random.randint(5001, 5999),
+                port=self.get_random_port(),
                 discriminator=self.admin_discriminator,
                 passcode=self.admin_passcode,
-                extra_args=["--capabilities", "0x04", "--rpc-server-port", "33033"])
+                extra_args=["--capabilities", "0x04", "--rpc-server-port", str(rpc_port)])
             self.jf_admin.start(
                 expected_output="Server initialization complete",
                 timeout=10)

src/python_testing/TC_JFADMIN_1_4.py

@@ -192,12 +192,12 @@ async def setup_class(self):
             self.jfadmin_fabric_a_passcode = random.randint(20202021, 20202099)
             self.jfadmin_fabric_a_discriminator = random.randint(0, 4095)
             dut_rpc_server_ip = "127.0.0.1"
-            dut_rpc_server_port = "33033"
+            dut_rpc_server_port = str(self.get_random_port())
             self.fabric_a_admin = JFAdministratorSubprocess(
                 self.jfa_server_app,
                 prefix="JFA-A",
                 storage_dir=self.storage_fabric_a,
-                port=random.randint(5001, 5999),
+                port=self.get_random_port(),
                 discriminator=self.jfadmin_fabric_a_discriminator,
                 passcode=self.jfadmin_fabric_a_passcode,
                 extra_args=["--capabilities", "0x04", "--rpc-server-port", dut_rpc_server_port, "--min_commissioning_timeout", f"{self.ojcw_timeout_baseline}"])