Add tests for Matter plugin

snapcraft/parts/plugins/matter_plugin.py

@@ -117,41 +117,40 @@ def get_build_commands(self) -> List[str]:
         if self.snap_arch == "arm64":
             commands.extend(
                 [
-                    f"wget --no-verbose https://github.com/project-chip/zap/releases/download/"
+                    "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;",
-            ]
-        )
+        commands.extend([
+            "if [ ! -d matter ]; then",
+            f"    git clone {MATTER_REPO} matter",
+            "    cd matter",
+            "    git config advice.detachedHead false",
+            f"    git checkout {options.matter_sdk_version};",
+            "else",
+            "    echo 'Matter repository already exists, skip clone'",
+            "    cd matter;",
+            "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.
+        # 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.
+        # See the top-level layout definition which bind mounts a persisted
+        # directory within the confined snap space on /mnt.
 
         # Replace storage paths
         commands.extend(
@@ -161,12 +160,11 @@ def get_build_commands(self) -> List[str]:
             ]
         )
 
-        """
-        Bootstrapping script for building Matter SDK with minimal "build" requirements
-         and setting up the environment.
-        """
+        # 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'"])

tests/spread/plugins/craft-parts/build-and-run-hello/matter-hello/README.md

@@ -0,0 +1,8 @@
+# matter_hello
+
+A new Matter project.
+
+## Getting Started
+
+This project is a starting point for a simple application based on [Matter SDK](https://github.com/project-chip/connectedhomeip).
+

tests/spread/plugins/craft-parts/build-and-run-hello/matter-hello/app/main.cpp

@@ -0,0 +1,88 @@
+/*
+ *
+ *    Copyright (c) 2020 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "LightingAppCommandDelegate.h"
+#include "LightingManager.h"
+#include <AppMain.h>
+
+#include <app-common/zap-generated/ids/Attributes.h>
+#include <app-common/zap-generated/ids/Clusters.h>
+#include <app/ConcreteAttributePath.h>
+#include <app/server/Server.h>
+#include <lib/support/logging/CHIPLogging.h>
+
+#if defined(CHIP_IMGUI_ENABLED) && CHIP_IMGUI_ENABLED
+#include <imgui_ui/ui.h>
+#include <imgui_ui/windows/light.h>
+#include <imgui_ui/windows/occupancy_sensing.h>
+#include <imgui_ui/windows/qrcode.h>
+
+#include <iostream>
+
+#endif
+
+using namespace chip;
+using namespace chip::app;
+using namespace chip::app::Clusters;
+
+namespace {
+
+constexpr char kChipEventFifoPathPrefix[] = "/tmp/chip_lighting_fifo_";
+NamedPipeCommands sChipNamedPipeCommands;
+LightingAppCommandDelegate sLightingAppCommandDelegate;
+} // namespace
+
+void MatterPostAttributeChangeCallback(const chip::app::ConcreteAttributePath & attributePath, uint8_t type, uint16_t size,
+                                       uint8_t * value)
+{
+    if (attributePath.mClusterId == OnOff::Id && attributePath.mAttributeId == OnOff::Attributes::OnOff::Id)
+    {
+        LightingMgr().InitiateAction(*value ? LightingManager::ON_ACTION : LightingManager::OFF_ACTION);
+    }
+}
+
+void emberAfOnOffClusterInitCallback(EndpointId endpoint)
+{
+    // TODO: implement any additional Cluster Server init actions
+}
+
+void ApplicationInit()
+{
+    std::string path = kChipEventFifoPathPrefix + std::to_string(getpid());
+
+    if (sChipNamedPipeCommands.Start(path, &sLightingAppCommandDelegate) != CHIP_NO_ERROR)
+    {
+        ChipLogError(NotSpecified, "Failed to start CHIP NamedPipeCommands");
+        sChipNamedPipeCommands.Stop();
+    }
+}
+
+void ApplicationShutdown()
+{
+    if (sChipNamedPipeCommands.Stop() != CHIP_NO_ERROR)
+    {
+        ChipLogError(NotSpecified, "Failed to stop CHIP NamedPipeCommands");
+    }
+}
+
+int main(int argc, char * argv[])
+{
+    std::cout << "hello world" << std::endl;
+
+    return 0;
+}

tests/spread/plugins/craft-parts/build-and-run-hello/matter-hello/snap/snapcraft.yaml

@@ -0,0 +1,34 @@
+name: matter-hello
+version: "1.0"
+summary: simple matter application
+description: build an example lighting application using the Matter SDK and say "hello world"
+base: core22
+confinement: strict
+
+apps:
+  matter-hello:
+    command: bin/lighting-app
+
+parts:
+  lighting-hello:
+    plugin: matter
+    matter-sdk-version: "1536ca2" # use this commit with ptpython version fix; needs to be updated once sdk have a stable release
+    matter-zap-version: "v2023.11.13"
+    source: app
+    override-build: |
+      craftctl default
+      cd $CRAFT_PART_BUILD/matter
+
+      # Overwrite the main application file so that it prints "hello world"
+      cp -v $CRAFT_PART_BUILD/main.cpp examples/lighting-app/linux/main.cpp
+
+      # Build the lighting app
+      scripts/examples/gn_build_example.sh examples/lighting-app/linux/ ./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/build-and-run-hello/task.yaml

@@ -7,6 +7,7 @@ environment:
   SNAP/colcon_ros2_humble: colcon-ros2-humble-hello
   SNAP/colcon_ros2_wrapper: colcon-ros2-wrapper
   SNAP/flutter: flutter-hello
+  SNAP/matter: matter-hello
   SNAP/python: python-hello
 
 prepare: |

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

@@ -0,0 +1,37 @@
+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
+
+parts:
+  matter-lighting:
+    plugin: matter
+    matter-sdk-version: "1536ca2" # use this commit with ptpython version fix; needs to be updated once sdk have a stable release
+    matter-zap-version: "v2023.11.13"
+    override-build: |
+      craftctl default
+      cd $CRAFT_PART_BUILD/matter
+
+      scripts/examples/gn_build_example.sh examples/lighting-app/linux/ ./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/task.yaml

@@ -0,0 +1,40 @@
+summary: Craft Parts matter 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
+
+  snap start matter-lighting
+
+  # Check if storage path replacement from /tmp to SNAP_COMMON/mnt works
+  if [ -e /tmp/chip_* ]; then
+    echo "Error: /tmp/chip_* should not exist."
+    exit 1
+  fi
+
+  if [ ! -e "${SNAP_COMMON/mnt/chip_*}" ]; then
+    echo "Error: $SNAP_COMMON/mnt/chip_* does not exist."
+    exit 1
+  fi