feat(plugins): add Matter plugin support

snapcraft/parts/plugins/__init__.py

@@ -22,12 +22,14 @@
 from .flutter_plugin import FlutterPlugin
 from .kernel_plugin import KernelPlugin
 from .python_plugin import PythonPlugin
+from .matter_plugin import MatterPlugin
 from .register import register
 
 __all__ = [
     "ColconPlugin",
     "CondaPlugin",
     "FlutterPlugin",
+    "MatterPlugin",
     "KernelPlugin",
     "PythonPlugin",
     "register",

snapcraft/parts/plugins/matter_plugin.py

@@ -0,0 +1,138 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright 2023 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# 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."""
+import os
+
+from typing import Any, Dict, List, Set
+
+from craft_parts import infos, plugins
+from overrides import overrides
+
+MATTER_REPO = "https://github.com/project-chip/connectedhomeip.git"
+"""The repository where the matter SDK resides."""
+
+
+class MatterPluginProperties(plugins.PluginProperties, plugins.PluginModel):
+    """The part properties used by the matter plugin."""
+
+    # matter_branch: str
+    # zap_version: str
+
+    @classmethod
+    @overrides
+    def unmarshal(cls, data: Dict[str, Any]) -> "MatterPluginProperties":
+        """Populate class attributes from the part specification.
+
+        :param data: A dictionary containing part properties.
+
+        :return: The populated plugin properties data object.
+
+        :raise pydantic.ValidationError: If validation fails.
+        """
+        plugin_data = plugins.extract_plugin_properties(
+            data,
+            plugin_name="matter",
+            # required=["matter_branch", "zap_version"]
+        )
+        return cls(**plugin_data)
+
+
+class MatterPlugin(plugins.Plugin):
+    """A plugin for matter project.
+
+    This plugin uses the common plugin keywords.
+    For more information check the 'plugins' topic.
+
+    Additionally, this plugin uses the following plugin-specific keywords:
+        - matter-branch
+          (str, no default)
+          The matter branch to use for the build.
+        - zap-version
+          (str, no default)
+          The zap version to use for the build.
+    """
+
+    properties_class = MatterPluginProperties
+
+    def __init__(
+        self,
+        *,
+        properties: plugins.PluginProperties,
+        part_info: infos.PartInfo,
+    ) -> None:
+        super().__init__(properties=properties, part_info=part_info)
+
+        self.matter_dir = part_info.part_build_dir
+        self.snap_arch = os.getenv("SNAP_ARCH")
+
+    @overrides
+    def get_build_packages(self) -> Set[str]:
+        return {
+            "wget",
+            "unzip",
+            "clang",
+            "pkg-config",
+            "git",
+            "cmake",
+            "ninja-build",
+            "unzip",
+            "libssl-dev",
+            "libdbus-1-dev",
+            "libglib2.0-dev",
+            "libavahi-client-dev",
+            "python3-venv",
+            "python3-dev",
+            "python3-pip",
+            "libgirepository1.0-dev",
+            "libcairo2-dev",
+            "libreadline-dev",
+            "generate-ninja",
+        }
+
+    @overrides
+    def get_build_environment(self) -> Dict[str, str]:
+        return {}
+
+    @overrides
+    def get_build_snaps(self) -> Set[str]:
+        return set()
+
+    @overrides
+    def get_build_commands(self) -> List[str]:
+        commands = []
+
+        if self.snap_arch == "arm64":
+            commands.extend(
+                [
+                    f"wget --no-verbose https://github.com/project-chip/zap/releases/download/v2023.11.13/zap-linux-{self.snap_arch}.zip",
+                    f"unzip -o zap-linux-{self.snap_arch}.zip",
+                    "echo 'export ZAP_INSTALL_PATH=$PWD'",
+                ]
+            )
+
+        commands.extend(
+            [
+                f"if [ ! -d matter ]; then git clone --depth 1 -b v1.2.0.1 {MATTER_REPO} matter; fi",
+                "cd matter || echo 'skip clone'",
+                f"scripts/checkout_submodules.py --shallow --platform linux",
+                f"set +u && source scripts/activate.sh && set -u",
+                "cp -vr ./* $CRAFT_PART_INSTALL/",
+                "echo 'Cloned Matter repository and activated submodules'",
+            ]
+        )
+
+        return commands

snapcraft/parts/plugins/register.py

@@ -23,12 +23,13 @@
 from .flutter_plugin import FlutterPlugin
 from .kernel_plugin import KernelPlugin
 from .python_plugin import PythonPlugin
+from .matter_plugin import MatterPlugin
 
 
 def register() -> None:
     """Register Snapcraft plugins."""
     craft_parts.plugins.register({"colcon": ColconPlugin})
     craft_parts.plugins.register({"conda": CondaPlugin})
-    craft_parts.plugins.register({"flutter": FlutterPlugin})
+    craft_parts.plugins.register({"matter": MatterPlugin})
     craft_parts.plugins.register({"python": PythonPlugin})
     craft_parts.plugins.register({"kernel": KernelPlugin})