Add tests for Matter plugin

snapcraft/parts/plugins/__init__.py

@@ -21,15 +21,15 @@
 from .conda_plugin import CondaPlugin
 from .flutter_plugin import FlutterPlugin
 from .kernel_plugin import KernelPlugin
-from .matter_plugin import MatterPlugin
+from .matter_sdk_plugin import MatterSdkPlugin
 from .python_plugin import PythonPlugin
 from .register import register
 
 __all__ = [
     "ColconPlugin",
     "CondaPlugin",
     "FlutterPlugin",
-    "MatterPlugin",
+    "MatterSdkPlugin",
     "KernelPlugin",
     "PythonPlugin",
     "register",

snapcraft/parts/plugins/matter_plugin.py → snapcraft/parts/plugins/matter_sdk_plugin.py

@@ -14,26 +14,27 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""The matter plugin."""
+"""The matter SDK plugin."""
 import os
 from typing import Any, Dict, List, Set, cast
 
 from craft_parts import infos, plugins
 from overrides import overrides
 
 # The repository where the matter SDK resides.
-MATTER_REPO = "https://github.com/project-chip/connectedhomeip.git"
+MATTER_SDK_REPO = "https://github.com/project-chip/connectedhomeip.git"
+ZAP_REPO = "https://github.com/project-chip/zap"
 
 
-class MatterPluginProperties(plugins.PluginProperties, plugins.PluginModel):
-    """The part properties used by the matter plugin."""
+class MatterSdkPluginProperties(plugins.PluginProperties, plugins.PluginModel):
+    """The part properties used by the matter SDK plugin."""
 
     matter_sdk_version: str
-    matter_zap_version: str
+    matter_sdk_zap_version: str
 
     @classmethod
     @overrides
-    def unmarshal(cls, data: Dict[str, Any]) -> "MatterPluginProperties":
+    def unmarshal(cls, data: Dict[str, Any]) -> "MatterSdkPluginProperties":
         """Populate class attributes from the part specification.
 
         :param data: A dictionary containing part properties.
@@ -44,14 +45,14 @@ def unmarshal(cls, data: Dict[str, Any]) -> "MatterPluginProperties":
         """
         plugin_data = plugins.extract_plugin_properties(
             data,
-            plugin_name="matter",
-            required=["matter_sdk_version", "matter_zap_version"],
+            plugin_name="matter-sdk",
+            required=["matter_sdk_version", "matter_sdk_zap_version"],
         )
         return cls(**plugin_data)
 
 
-class MatterPlugin(plugins.Plugin):
-    """A plugin for matter project.
+class MatterSdkPlugin(plugins.Plugin):
+    """A plugin for matter SDK project.
 
     This plugin uses the common plugin keywords.
     For more information check the 'plugins' topic.
@@ -60,12 +61,12 @@ class MatterPlugin(plugins.Plugin):
         - matter-sdk-version
           (str, no default)
           The matter SDK version to use for the build.
-        - matter-zap-version
+        - matter-sdk-zap-version
           (str, no default)
           The zap version to use for the build.
     """
 
-    properties_class = MatterPluginProperties
+    properties_class = MatterSdkPluginProperties
 
     def __init__(
         self,
@@ -75,9 +76,41 @@ def __init__(
     ) -> None:
         super().__init__(properties=properties, part_info=part_info)
 
-        self.matter_dir = part_info.part_build_dir
+        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 {
@@ -111,47 +144,20 @@ def get_build_snaps(self) -> Set[str]:
 
     @overrides
     def get_build_commands(self) -> List[str]:
-        options = cast(MatterPluginProperties, self._options)
+        options = cast(MatterSdkPluginProperties, self._options)
         commands = []
 
-        if self.snap_arch == "arm64":
-            commands.extend(
-                [
-                    f"wget --no-verbose https://github.com/project-chip/zap/releases/download/"
-                    f"{options.matter_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 repository if not present
-        commands.extend(
-            [
-                "if [ ! -d matter ]; then",
-                f"    git clone --depth 1 -b {options.matter_sdk_version} {MATTER_REPO} matter;",
-                "else",
-                "    echo 'Matter repository already exists, skip clone';",
-                "fi",
-                "cd matter;",
-            ]
-        )
-
-        # 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.
+        # The project writes its data to /tmp which isn't persisted.
 
-        Setting TMPDIR env var when running the app isn't sufficient as
-         chip_[config,counter,factory,kvs].ini still get written under /tmp.
-         The chip-tool currently has no way of overriding the default paths to
-         storage and security config files.
+        # Setting TMPDIR env var when running the app isn't sufficient as
+        # chip_[config,counter,factory,kvs].ini still get written under /tmp.
+        # The chip-tool currently has no way of overriding the default paths to
+        # storage and security config files.
 
-        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.
-        """
+        # 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.
+        # The consumer snap needs to bind mount a persisted directory within
+        # the confined snap space on /mnt.
 
         # Replace storage paths
         commands.extend(
@@ -161,14 +167,29 @@ def get_build_commands(self) -> List[str]:
             ]
         )
 
-        """
-        Bootstrapping script for building Matter SDK with minimal "build" requirements
-         and setting up the environment.
-        """
+        # 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 setup/bootstrap.sh --platform build && set -u"]
+            ["set +u && source scripts/setup/bootstrap.sh --platform build && set -u"]
         )
-
         commands.extend(["echo 'Built Matter SDK'"])
 
+        # 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(
+            [
+                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'",
+            ]
+        )
+
         return commands

snapcraft/parts/plugins/register.py

@@ -22,7 +22,7 @@
 from .conda_plugin import CondaPlugin
 from .flutter_plugin import FlutterPlugin
 from .kernel_plugin import KernelPlugin
-from .matter_plugin import MatterPlugin
+from .matter_sdk_plugin import MatterSdkPlugin
 from .python_plugin import PythonPlugin
 
 
@@ -33,4 +33,4 @@ def register() -> None:
     craft_parts.plugins.register({"flutter": FlutterPlugin})
     craft_parts.plugins.register({"python": PythonPlugin})
     craft_parts.plugins.register({"kernel": KernelPlugin})
-    craft_parts.plugins.register({"matter": MatterPlugin})
+    craft_parts.plugins.register({"matter-sdk": MatterSdkPlugin})

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

@@ -0,0 +1,51 @@
+name: matter-lighting
+summary: Matter plugin test
+description: An lighting application to test the matter plugin.
+version: "1.0"
+
+base: core22
+
+grade: stable
+build-base: core22
+confinement: strict
+
+layout:
+  /mnt:
+    bind: $SNAP_COMMON/mnt
+
+apps:
+  matter-lighting:
+    daemon: simple
+    command: bin/lighting-app
+    install-mode: disable
+    plugs:
+      - network
+      - network-bind
+      - bluez
+      - avahi-control
+
+parts:
+  matter-sdk:
+    plugin: matter-sdk
+    matter-sdk-version: "1536ca20c5917578ca40ce509400e97b52751788" # use this commit with ptpython version fix; needs to be updated once matter sdk have a stable release
+    matter-sdk-zap-version: "v2023.11.13"
+
+  lighting:
+    plugin: nil
+    after: [matter-sdk]
+    build-environment:
+      - MATTER_SDK_ENV: ../../matter-sdk/build/matter_sdk_env
+    override-build: |
+      # Source the Matter SDK environment variables
+      source $MATTER_SDK_ENV
+
+      # 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
+
+      ldd out/build/chip-lighting-app
+
+      mkdir -p $CRAFT_PART_INSTALL/bin
+      cp out/build/chip-lighting-app $CRAFT_PART_INSTALL/bin/lighting-app   
+

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

@@ -0,0 +1,51 @@
+summary: Craft Parts matter SDK plugin test
+manual: true
+kill-timeout: 180m
+
+systems:
+  - ubuntu-22.04-64
+
+prepare: |
+  #shellcheck source=tests/spread/tools/snapcraft-yaml.sh
+  . "$TOOLS_DIR/snapcraft-yaml.sh"
+  set_base "$SNAP/snap/snapcraft.yaml"
+
+restore: |
+  cd "$SNAP"
+  snapcraft clean
+  rm -f ./*.snap
+
+  #shellcheck source=tests/spread/tools/snapcraft-yaml.sh
+  . "$TOOLS_DIR/snapcraft-yaml.sh"
+  restore_yaml "snap/snapcraft.yaml"
+
+execute: |
+  cd "$SNAP"
+
+  # Build and install the snap
+  snapcraft
+  snap install "${SNAP}"*.snap --dangerous
+
+  start_time=$(date +"%Y-%m-%d %H:%M:%S")
+  snap start matter-lighting
+
+  # Check if storage path replacement from /tmp to SNAP_COMMON/mnt works
+  for file in /tmp/chip_*; do
+    if [ -e "$file" ]; then
+      echo "Error: $file should not exist."
+      exit 1
+    fi
+  done
+
+  if [ ! -e "${SNAP_COMMON/mnt/chip_*}" ]; then
+    echo "Error: ${SNAP_COMMON}/mnt/chip_* does not exist."
+    exit 1
+  fi
+
+  # Check if server initialization is complete for matter-lighting
+  if ! journalctl --since "$start_time" | grep matter-lighting | grep "CHIP:SVR: Server initialization complete"; then
+    echo "Error: matter-lighting initialization failed."
+    exit 1
+  fi
+
+