Add tests for Matter plugin

snapcraft/parts/plugins/matter_sdk_plugin.py

@@ -23,6 +23,7 @@
 
 # The repository where the matter SDK resides.
 MATTER_SDK_REPO = "https://github.com/project-chip/connectedhomeip.git"
+ZAP_REPO = "https://github.com/project-chip/zap"
 
 
 class MatterSdkPluginProperties(plugins.PluginProperties, plugins.PluginModel):
@@ -78,6 +79,38 @@ def __init__(
         self.matter_sdk_dir = part_info.part_build_dir
         self.snap_arch = os.getenv("SNAP_ARCH")
 
+    @overrides
+    def get_pull_commands(self) -> List[str]:
+        options = cast(MatterSdkPluginProperties, self._options)
+        commands = []
+
+        if self.snap_arch == "arm64":
+            commands.extend(
+                [
+                    f"wget --no-verbose {ZAP_REPO}/releases/download/"
+                    f"{options.matter_sdk_zap_version}/zap-linux-{self.snap_arch}.zip",
+                    f"unzip -o zap-linux-{self.snap_arch}.zip -d zap",
+                    "echo 'export ZAP_INSTALL_PATH=$PWD/zap'",
+                ]
+            )
+
+        # Clone Matter SDK repository
+        commands.extend(
+            [
+                "if [ ! -d matter ]; then",
+                "    git init",
+                f"   git remote add origin {MATTER_SDK_REPO}",
+                f"   git fetch --depth 1 origin {options.matter_sdk_version}",
+                "    git checkout FETCH_HEAD",
+                "fi",
+            ]
+        )
+
+        # Checkout submodules for Linux platform
+        commands.extend(["scripts/checkout_submodules.py --shallow --platform linux"])
+
+        return commands
+
     @overrides
     def get_build_packages(self) -> Set[str]:
         return {
@@ -114,34 +147,6 @@ def get_build_commands(self) -> List[str]:
         options = cast(MatterSdkPluginProperties, self._options)
         commands = []
 
-        if self.snap_arch == "arm64":
-            commands.extend(
-                [
-                    "wget --no-verbose https://github.com/project-chip/zap/releases/download/"
-                    f"{options.matter_sdk_zap_version}/zap-linux-{self.snap_arch}.zip",
-                    f"unzip -o zap-linux-{self.snap_arch}.zip",
-                    "echo 'export ZAP_INSTALL_PATH=$PWD'",
-                ]
-            )
-
-        # Clone Matter SDK repository if not present
-        commands.extend(
-            [
-            "if [ ! -d matter ]; then",
-            "    git init matter-sdk",
-            "    cd matter-sdk",
-            f"   git remote add origin {MATTER_SDK_REPO}",
-            f"   git fetch --depth 1 origin {options.matter_sdk_version}",
-            "    git checkout FETCH_HEAD",
-            "else",
-            "    echo 'Matter SDK repository already exists, skip clone'",
-            "    cd matter-sdk;",
-            "fi",]
-        )
-
-        # Checkout submodules for Linux platform
-        commands.extend(["scripts/checkout_submodules.py --shallow --platform linux"])
-
         # The project writes its data to /tmp which isn't persisted.
 
         # Setting TMPDIR env var when running the app isn't sufficient as
@@ -151,8 +156,8 @@ def get_build_commands(self) -> List[str]:
 
         # Snap does not allow bind mounting a persistent directory on /tmp,
         # so we need to replace it in the source with another path, e.g. /mnt.
-        # See the top-level layout definition which bind mounts a persisted
-        # directory within the confined snap space on /mnt.
+        # The consumer snap needs to bind mount a persisted directory within
+        # the confined snap space on /mnt.
 
         # Replace storage paths
         commands.extend(
@@ -162,21 +167,28 @@ def get_build_commands(self) -> List[str]:
             ]
         )
 
+        # Capture initial environment variables
+        commands.extend(["initial_environment=$(printenv)"])
+
         # Bootstrapping script for building Matter SDK with minimal "build" requirements
         # and setting up the environment.
-
-        commands.extend(["set +u && source scripts/setup/bootstrap.sh --platform build && set -u"])
-
+        commands.extend(
+            ["set +u && source scripts/setup/bootstrap.sh --platform build && set -u"]
+        )
         commands.extend(["echo 'Built Matter SDK'"])
 
-        # Output environment variables to env file
-        # Remove environment variables related to snapcraft part
+        # Capture updated environment variables after the bootstrapping
+        commands.extend(["updated_environment=$(printenv)"])
+
+        # Compare and output environment variable differences to matter_sdk_env env file
         commands.extend(
             [
-                "env > matter_sdk_env",
-                r"sed -i '/^CRAFT_PART_/d' matter_sdk_env",
-                r"sed -i '/^SNAPCRAFT_PART_/d' matter_sdk_env",
-                "echo 'Environment variables exported to matter_sdk_env file'",
+                f"environment_differences=$(comm -3 <(echo $initial_environment | tr ' ' '\n' | sort) \\",
+                f" <(echo $updated_environment | tr ' ' '\n' | sort) | awk '{{print $1}}')",
+                "for env in $environment_differences; do",
+                f'    echo "export $env" >> matter_sdk_env',
+                "done",
+                "echo 'Environment variables differences exported to matter_sdk_env file'",
             ]
         )
 

tests/spread/plugins/craft-parts/matter-sdk/snapcraft.yaml

@@ -33,13 +33,14 @@ parts:
   lighting:
     plugin: nil
     after: [matter-sdk]
+    build-environment:
+      - MATTER_SDK_ENV: ../../matter-sdk/build/matter_sdk_env
     override-build: |
-      cd ../../matter-sdk/build/matter-sdk
+      # Source the Matter SDK environment variables
+      source $MATTER_SDK_ENV
 
-      source matter_sdk_env
-
-      # Build the lighting app
-      cd examples/lighting-app/linux
+      # Build the lighting app for snapcraft spread testing purposes
+      cd ../../matter-sdk/build/examples/lighting-app/linux
       gn gen out/build
       ninja -C out/build
 

tests/spread/plugins/craft-parts/matter-sdk/task.yaml

@@ -1,4 +1,4 @@
-summary: Craft Parts matter plugin test
+summary: Craft Parts matter SDK plugin test
 manual: true
 kill-timeout: 180m
 

tests/unit/parts/plugins/test_matter_sdk_plugin.py

@@ -34,6 +34,47 @@ def part_info(new_dir):
     )
 
 
+def test_get_pull_commands(part_info):
+    properties = MatterSdkPlugin.properties_class.unmarshal(
+        {"matter-sdk-version": "master", "matter-sdk-zap-version": "v2023.11.13"}
+    )
+    plugin = MatterSdkPlugin(properties=properties, part_info=part_info)
+
+    sdk_version = properties.matter_sdk_version  # type: ignore
+    zap_version = properties.matter_sdk_zap_version  # type: ignore
+
+    expected_commands = []
+
+    if plugin.snap_arch == "arm64":
+        expected_commands.extend(
+            [
+                f"wget --no-verbose {ZAP_REPO}/releases/download/"
+                f"{zap_version}/zap-linux-arm64.zip",
+                "unzip -o zap-linux-arm64.zip",
+                "echo 'export ZAP_INSTALL_PATH=$PWD'",
+            ]
+        )
+
+    expected_commands.extend(
+        [
+            "if [ ! -d matter ]; then",
+            "    git init",
+            f"   git remote add origin {MATTER_SDK_REPO}",
+            f"   git fetch --depth 1 origin {sdk_version}",
+            "    git checkout FETCH_HEAD",
+            "fi",
+        ]
+    )
+
+    expected_commands.extend(
+        [
+            "scripts/checkout_submodules.py --shallow --platform linux",
+        ]
+    )
+
+    assert plugin.get_pull_commands() == expected_commands
+
+
 def test_get_build_snaps(part_info):
     properties = MatterSdkPlugin.properties_class.unmarshal(
         {"matter-sdk-version": "master", "matter-sdk-zap-version": "v2023.11.13"}
@@ -89,52 +130,30 @@ def test_get_build_commands(part_info):
 
     expected_commands = []
 
-    if plugin.snap_arch == "arm64":
-        expected_commands.extend(
-            [
-                f"wget --no-verbose https://github.com/project-chip/zap/releases/download/"
-                f"{zap_version}/zap-linux-arm64.zip",
-                "unzip -o zap-linux-arm64.zip",
-                "echo 'export ZAP_INSTALL_PATH=$PWD'",
-            ]
-        )
-
-    expected_commands.extend(
-        [
-            "if [ ! -d matter ]; then",
-            "    git init matter-sdk",
-            "    cd matter-sdk",
-            f"   git remote add origin {MATTER_SDK_REPO}",
-            f"   git fetch --depth 1 origin {sdk_version}",
-            "    git checkout FETCH_HEAD",
-            "else",
-            "    echo 'Matter SDK repository already exists, skip clone'",
-            "    cd matter-sdk;",
-            "fi",]
-    )
-
-    expected_commands.extend(["scripts/checkout_submodules.py --shallow --platform linux",])
-
     expected_commands.extend(
         [
             r"sed -i 's/\/tmp/\/mnt/g' src/platform/Linux/CHIPLinuxStorage.h",
             r"sed -i 's/\/tmp/\/mnt/g' src/platform/Linux/CHIPPlatformConfig.h",
         ]
     )
 
+    expected_commands.extend(["initial_environment=$(printenv)"])
+
     expected_commands.extend(
-        [
-            "set +u && source scripts/setup/bootstrap.sh --platform build && set -u",
-            "echo 'Built Matter SDK'",
-        ]
+        ["set +u && source scripts/setup/bootstrap.sh --platform build && set -u"]
     )
+    expected_commands.extend(["echo 'Built Matter SDK'"])
+
+    expected_commands.extend(["updated_environment=$(printenv)"])
 
     expected_commands.extend(
         [
-            "env > matter_sdk_env",
-            r"sed -i '/^CRAFT_PART_/d' matter_sdk_env",
-            r"sed -i '/^SNAPCRAFT_PART_/d' matter_sdk_env",
-            "echo 'Environment variables exported to matter_sdk_env file'",
+            f"environment_differences=$(comm -3 <(echo $initial_environment | tr ' ' '\n' | sort) \\",
+            f" <(echo $updated_environment | tr ' ' '\n' | sort) | awk '{{print $1}}')",
+            "for env in $environment_differences; do",
+            f'    echo "export $env" >> matter_sdk_env',
+            "done",
+            "echo 'Environment variables differences exported to matter_sdk_env file'",
         ]
     )