[E2E][JF] Add TC_JCM_1_1 test case; Enable JointFabrics testing in CI (project-chip#39637)

* Initial JF integration test case

* Spawn Python controller using EcoA and EcoB certificates in order to reuse Python infrastructure

* Automatically generate Python controller storage from jfc-app storage; extract CATs from jfc-app storage and apply them to Python controller

* Fix issue with script exection never ending; cleanup all storage dirs after execution.

* Add comments, build automatically Subjects value to compare with the one from the device; Clean Test steps description and expected

* Fix path in BUILD.gn for jfc-app; enable JFA, JFC apps build in CI; validate anchor cat and admin cat on jfa-app; switch to all-clusters-app instead of lighting-app

* Update src/python_testing/matter_testing_infrastructure/chip/testing/apps.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Restyled by gn

* Restyled by isort

* Fix comment in script

* Add JF apps in expected file

* Update order of jf apps in expected output; remove function from subprocess that is not required; update paramter type to a builtin type

* Add NFC pairing patch to jfc-app

* Remove JF apps build artifacts; reuse the ones from artifacts folder

* Export for JFA and JFC were inversed

* Final artifact name is wrong for JFA and JFC apps

* Add jfa and jfc apps in local.py script

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>

Author: 3 people

.github/workflows/tests.yaml

@@ -539,10 +539,15 @@ jobs:
                       --target linux-x64-light-data-model-no-unique-id-${BUILD_VARIANT}-clang \
                       --target linux-x64-terms-and-conditions \
                       --target linux-x64-python-bindings \
+                      --target linux-x64-jf-control-app \
+                      --target linux-x64-jf-admin-app \
                       build \
                       --copy-artifacts-to objdir-clone \
                    "
             - name: Generate an argument environment file
+              # GitHub VM remains out of memory after adding Joint Fabrics example apps to be built.
+              # Add as a temporary fix the removal of out/ folders for JF apps and use artifacts from objdir-clone (see step above) as .o files are no longer requred.
+              # Maybe do this for all apps. 
               run: |
                   echo -n "" >/tmp/test_env.yaml
                   echo "ALL_CLUSTERS_APP: out/linux-x64-all-clusters-${BUILD_VARIANT}-tsan-clang-test/chip-all-clusters-app" >> /tmp/test_env.yaml
@@ -565,6 +570,10 @@ jobs:
                   echo "TRACE_APP: out/trace_data/app-{SCRIPT_BASE_NAME}" >> /tmp/test_env.yaml
                   echo "TRACE_TEST_JSON: out/trace_data/test-{SCRIPT_BASE_NAME}" >> /tmp/test_env.yaml
                   echo "TRACE_TEST_PERFETTO: out/trace_data/test-{SCRIPT_BASE_NAME}" >> /tmp/test_env.yaml
+                  echo "JF_CONTROL_APP: objdir-clone/linux-x64-jf-control-app/jfc-app" >> /tmp/test_env.yaml
+                  rm -rf out/linux-x64-jf-control-app
+                  echo "JF_ADMIN_APP: objdir-clone/linux-x64-jf-admin-app/jfa-app" >> /tmp/test_env.yaml
+                  rm -rf out/linux-x64-jf-admin-app
 
             - name: Verify Testing Support
               run: |

examples/jf-control-app/BUILD.gn

@@ -66,10 +66,10 @@ config("config") {
 
 static_library("jfc-utils") {
   sources = [
-    "${chip_root}/examples/chip-tool/CHIPCommand.h",
     "${chip_root}/examples/chip-tool/commands/clusters/ModelCommand.cpp",
     "${chip_root}/examples/chip-tool/commands/clusters/ModelCommand.h",
     "${chip_root}/examples/chip-tool/commands/common/BDXDiagnosticLogsServerDelegate.cpp",
+    "${chip_root}/examples/chip-tool/commands/common/CHIPCommand.h",
     "${chip_root}/examples/chip-tool/commands/common/Command.cpp",
     "${chip_root}/examples/chip-tool/commands/common/Command.h",
     "${chip_root}/examples/chip-tool/commands/common/Commands.cpp",

examples/jf-control-app/commands/pairing/PairingCommand.cpp

@@ -122,6 +122,17 @@ CHIP_ERROR PairingCommand::RunInternal(NodeId remoteId)
     case PairingMode::Ble:
         err = Pair(remoteId, PeerAddress::BLE());
         break;
+    case PairingMode::Nfc:
+        if (mDiscriminator.has_value())
+        {
+            err = Pair(remoteId, PeerAddress::NFC(mDiscriminator.value()));
+        }
+        else
+        {
+            // Discriminator is mandatory
+            err = CHIP_ERROR_MESSAGE_INCOMPLETE;
+        }
+        break;
     case PairingMode::OnNetwork:
         err = PairWithMdns(remoteId);
         break;

examples/jf-control-app/commands/pairing/PairingCommand.h

@@ -42,6 +42,7 @@ enum class PairingMode
     AlreadyDiscoveredByIndex,
     AlreadyDiscoveredByIndexWithCode,
     OnNetwork,
+    Nfc,
 };
 
 enum class PairingNetworkType
@@ -121,6 +122,11 @@ class PairingCommand : public CHIPCommand,
             AddArgument("setup-pin-code", 0, 134217727, &mSetupPINCode.emplace());
             AddArgument("discriminator", 0, 4096, &mDiscriminator.emplace());
             break;
+        case PairingMode::Nfc:
+            AddArgument("skip-commissioning-complete", 0, 1, &mSkipCommissioningComplete);
+            AddArgument("setup-pin-code", 0, 134217727, &mSetupPINCode.emplace());
+            AddArgument("discriminator", 0, 4096, &mDiscriminator.emplace());
+            break;
         case PairingMode::OnNetwork:
             AddArgument("setup-pin-code", 0, 134217727, &mSetupPINCode.emplace());
             AddArgument("pase-only", 0, 1, &mPaseOnly);

scripts/build/build/targets.py

@@ -151,6 +151,8 @@ def BuildHostTarget():
         TargetPart('terms-and-conditions', app=HostApp.TERMS_AND_CONDITIONS),
         TargetPart('camera', app=HostApp.CAMERA),
         TargetPart('camera-controller', app=HostApp.CAMERA_CONTROLLER),
+        TargetPart('jf-control-app', app=HostApp.JF_CONTROL),
+        TargetPart('jf-admin-app', app=HostApp.JF_ADMIN),
     ]
 
     if (HostBoard.NATIVE.PlatformName() == 'darwin'):

scripts/build/builders/host.py

@@ -91,6 +91,8 @@ class HostApp(Enum):
     TERMS_AND_CONDITIONS = auto()
     CAMERA = auto()
     CAMERA_CONTROLLER = auto()
+    JF_CONTROL = auto()
+    JF_ADMIN = auto()
 
     def ExamplePath(self):
         if self == HostApp.ALL_CLUSTERS:
@@ -173,6 +175,10 @@ def ExamplePath(self):
             return 'camera-app/linux'
         elif self == HostApp.CAMERA_CONTROLLER:
             return 'camera-controller'
+        elif self == HostApp.JF_CONTROL:
+            return 'jf-control-app'
+        elif self == HostApp.JF_ADMIN:
+            return 'jf-admin-app/linux'
         else:
             raise Exception('Unknown app type: %r' % self)
 
@@ -303,6 +309,10 @@ def OutputNames(self):
         elif self == HostApp.CAMERA_CONTROLLER:
             yield 'chip-camera-controller'
             yield 'chip-camera-controller.map'
+        elif self == HostApp.JF_CONTROL:
+            yield 'jfc-app'
+        elif self == HostApp.JF_ADMIN:
+            yield 'jfa-app'
         else:
             raise Exception('Unknown app type: %r' % self)
 

scripts/build/testdata/all_targets_linux_x64.txt

@@ -9,7 +9,7 @@ efr32-{brd2601b,brd2605a,brd2703a,brd2704b,brd4186a,brd4186c,brd4187a,brd4187c,b
 esp32-{c3devkit,devkitc,m5stack,qemu}-{all-clusters,all-clusters-minimal,bridge,energy-gateway,energy-management,light,lock,ota-provider,ota-requestor,ota-requestor,shell,temperature-measurement,tests}[-ipv6only][-rpc][-tracing]
 genio-lighting-app
 linux-fake-tests[-asan][-boringssl][-clang][-coverage][-dmalloc][-libfuzzer][-mbedtls][-ossfuzz][-pw-fuzztest][-tsan][-ubsan]
-linux-{arm64,x64}-{address-resolve-tool,air-purifier,air-quality-sensor,all-clusters,all-clusters-minimal,bridge,camera,camera-controller,chip-cert,chip-tool,contact-sensor,dishwasher,energy-gateway,energy-management,fabric-admin,fabric-bridge,fabric-sync,java-matter-controller,kotlin-matter-controller,light,light-data-model-no-unique-id,lit-icd,lock,microwave-oven,minmdns,network-manager,ota-provider,ota-requestor,python-bindings,refrigerator,rpc-console,rvc,shell,simulated-app1,simulated-app2,terms-and-conditions,tests,thermostat,tv-app,tv-casting-app,water-leak-detector}[-asan][-boringssl][-chip-casting-simplified][-clang][-coverage][-disable-dnssd-tests][-dmalloc][-enable-dnssd-tests][-evse-test-event][-googletest][-ipv6only][-libfuzzer][-libnl][-mbedtls][-minmdns-verbose][-nfc-commission][-nlfaultinject][-no-ble][-no-interactive][-no-shell][-no-thread][-no-wifi][-no-wifipaf][-nodeps][-ossfuzz][-platform-mdns][-pw-fuzztest][-rpc][-same-event-loop][-terms-and-conditions][-test][-tsan][-ubsan][-with-ui]
+linux-{arm64,x64}-{address-resolve-tool,air-purifier,air-quality-sensor,all-clusters,all-clusters-minimal,bridge,camera,camera-controller,chip-cert,chip-tool,contact-sensor,dishwasher,energy-gateway,energy-management,fabric-admin,fabric-bridge,fabric-sync,java-matter-controller,jf-admin-app,jf-control-app,kotlin-matter-controller,light,light-data-model-no-unique-id,lit-icd,lock,microwave-oven,minmdns,network-manager,ota-provider,ota-requestor,python-bindings,refrigerator,rpc-console,rvc,shell,simulated-app1,simulated-app2,terms-and-conditions,tests,thermostat,tv-app,tv-casting-app,water-leak-detector}[-asan][-boringssl][-chip-casting-simplified][-clang][-coverage][-disable-dnssd-tests][-dmalloc][-enable-dnssd-tests][-evse-test-event][-googletest][-ipv6only][-libfuzzer][-libnl][-mbedtls][-minmdns-verbose][-nfc-commission][-nlfaultinject][-no-ble][-no-interactive][-no-shell][-no-thread][-no-wifi][-no-wifipaf][-nodeps][-ossfuzz][-platform-mdns][-pw-fuzztest][-rpc][-same-event-loop][-terms-and-conditions][-test][-tsan][-ubsan][-with-ui]
 linux-x64-efr32-test-runner[-clang]
 imx-{all-clusters-app,all-clusters-minimal-app,chip-tool,lighting-app,ota-provider-app,thermostat}[-release]
 infineon-psoc6-{all-clusters,all-clusters-minimal,light,lock}[-ota][-trustm][-updateimage]

scripts/tests/local.py

@@ -260,6 +260,20 @@ def _get_targets(coverage: Optional[bool]) -> list[ApplicationTarget]:
             binary="chip-camera-app",
         )
     )
+    targets.append(
+        ApplicationTarget(
+            key="JF_CONTROL_APP",
+            target=f"{target_prefix}-jf-control-app",
+            binary="jfc-app",
+        )
+    )
+    targets.append(
+        ApplicationTarget(
+            key="JF_ADMIN_APP",
+            target=f"{target_prefix}-jf-admin-app",
+            binary="jfa-app",
+        )
+    )
 
     return targets