Spring boot extension

.github/workflows/tests.yaml

@@ -77,11 +77,14 @@ jobs:
 
       - name: Install dependencies
         run: |
+          echo "::group::snap install"
+          sudo snap install chisel --edge
+          echo "::endgroup::"
           echo "::group::apt-get update"
           sudo apt-get update
           echo "::endgroup::"
           echo "::group::apt-get install..."
-          sudo apt-get install -y python3 python3-dev libapt-pkg-dev libyaml-dev umoci
+          sudo apt-get install -y python3 python3-dev libapt-pkg-dev libyaml-dev umoci git openjdk-21-jdk
           echo "::endgroup::"
           echo "::group::pip install"
           python -m pip install -U wheel setuptools pip
@@ -99,4 +102,3 @@ jobs:
       - name: Run integration tests
         run: |
           make test-integrations
-

rockcraft/extensions/__init__.py

@@ -19,6 +19,7 @@
 from ._utils import apply_extensions
 from .go import GoFramework
 from .gunicorn import DjangoFramework, FlaskFramework
+from .spring_boot import SpringBootFramework
 from .registry import get_extension_class, get_extension_names, register, unregister
 
 __all__ = [
@@ -32,3 +33,4 @@
 register("django-framework", DjangoFramework)
 register("flask-framework", FlaskFramework)
 register("go-framework", GoFramework)
+register("spring-boot-framework", SpringBootFramework)

rockcraft/extensions/spring_boot.py

@@ -0,0 +1,149 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright 2024 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/>.
+
+"""An extension for the Java runtime."""
+
+import os
+from typing import Tuple
+from typing import Any
+from typing import Dict
+from overrides import override
+
+from ..errors import ExtensionError
+from .extension import Extension
+
+
+class SpringBootFramework(Extension):
+
+    def _check_project(self):
+        """Ensure that either pom.xml or gradlew is present."""
+        if "spring-boot-framework/install-app" not in self.yaml_data.get("parts", {}):
+            if not os.path.exists(f"{self.project_root}/pom.xml") and not os.path.exists(
+                f"{self.project_root}/gradlew"
+            ):
+                raise ExtensionError(
+                    "missing pom.xml or gradlew file",
+                    doc_slug="/reference/extensions/spring-boot-framework",
+                    logpath_report=False,
+                )
+
+    @property
+    def name(self) -> str:
+        """Return the normalized name of the rockcraft project."""
+        return self.yaml_data["name"].replace("-", "_").lower()
+
+    @staticmethod
+    @override
+    def get_supported_bases() -> Tuple[str, ...]:
+        """Return supported bases."""
+        return "bare", "[email protected]", "ubuntu:24.04"
+
+    @staticmethod
+    @override
+    def is_experimental(base: str | None) -> bool:
+        """Check if the extension is in an experimental state."""
+        return True
+
+    @override
+    def get_part_snippet(self) -> Dict[str, Any]:
+        """Return the part snippet to apply to existing parts."""
+        return {}
+
+    def get_root_snippet(self) -> Dict[str, Any]:
+        self._check_project()
+        return {}
+
+    def get_runtime_deps_part(self) -> Dict[str, Any]:
+        if "spring-boot-framework/runtime-deps" not in self.yaml_data.get("parts", {}):
+            return {
+                "plugin": "nil",
+                "source": "https://github.com/vpa1977/chisel-releases",
+                "source-type": "git",
+                "source-branch": "24.04-openjdk-21-jre-headless",
+                "override-build": """
+                    chisel cut --release ./ --root ${CRAFT_PART_INSTALL} \
+                        base-files_base \
+                        libc6_libs \
+                        libgcc-s1_libs \
+                        libstdc++6_libs \
+                        zlib1g_libs \
+                        libnss3_libs
+                    craftctl default
+                """,
+            }
+
+    def gen_install_app_part(self) -> Dict[str, Any]:
+        if "spring-boot-framework/install-app" not in self.yaml_data.get("parts", {}):
+            if os.path.exists(f"{self.project_root}/pom.xml"):
+                return {
+                    "plugin": "nil",
+                    "source": ".",
+                    "source-type": "local",
+                    "build-packages": ["openjdk-21-jdk", "maven"],
+                    "build-environment": [
+                        {
+                            "JAVA_HOME": "/usr/lib/jvm/java-21-openjdk-${CRAFT_ARCH_BUILD_FOR}"
+                        }
+                    ],
+                    "override-build": """
+                        mvn package
+                        mkdir -p ${CRAFT_PART_INSTALL}/jars
+                        find ${CRAFT_PART_BUILD}/target -iname "*.jar" -exec ln {} ${CRAFT_PART_INSTALL}/jars \\;
+                        craftctl default
+                    """,
+                }
+            elif os.path.exists(f"{self.project_root}/gradlew"):
+                return {
+                    "plugin": "nil",
+                    "source": ".",
+                    "source-type": "local",
+                    "build-packages": ["openjdk-21-jdk"],
+                    "build-environment": [
+                        {
+                            "JAVA_HOME": "/usr/lib/jvm/java-21-openjdk-${CRAFT_ARCH_BUILD_FOR}"
+                        }
+                    ],
+                    "override-build": "./gradlew jar --no-daemon",
+                    "override-stage": """
+                                    mkdir -p ${CRAFT_STAGE}/jars
+                                    find ${CRAFT_PART_BUILD}/build -iname "*.jar" -exec ln {} ${CRAFT_STAGE}/jars \\;
+                                    craftctl default
+                                    """,
+                    "override-prime": """
+                                    cp -r ${CRAFT_STAGE}/jars ${CRAFT_PRIME}
+                                    craftctl default
+                                    """,
+                }
+        return {}
+
+    def get_runtime_app_part(self) -> Dict[str, Any]:
+        if "spring-boot-framework/runtime" not in self.yaml_data.get("parts", {}):
+            return {
+                "plugin": "jlink",
+                "after": [
+                    "spring-boot-framework/install-app",
+                    "spring-boot-framework/runtime-deps",
+                ],
+            }
+        return {}
+
+    def get_parts_snippet(self) -> dict[str, Any]:
+        """Return the parts to add to parts."""
+        return {
+            "spring-boot-framework/install-app": self.gen_install_app_part(),
+            "spring-boot-framework/runtime": self.get_runtime_app_part(),
+            "spring-boot-framework/runtime-deps": self.get_runtime_deps_part(),
+        }

rockcraft/plugins/__init__.py

@@ -17,6 +17,7 @@
 """Rockcraft-specific plugins."""
 
 from .python_plugin import PythonPlugin
+from .jlink_plugin import JLinkPlugin
 from .register import get_plugins, register
 
-__all__ = ["PythonPlugin", "get_plugins", "register"]
+__all__ = ["PythonPlugin", "JLinkPlugin", "get_plugins", "register"]

rockcraft/plugins/jlink_plugin.py

@@ -0,0 +1,112 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright 2024 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""The Java runtime plugin."""
+
+from typing import Dict, List, Literal, Set, cast
+
+from craft_parts.plugins import Plugin, PluginProperties
+from overrides import override
+
+
+class JLinkPluginProperties(PluginProperties, frozen=True):
+    """The part properties used by the JLink plugin."""
+
+    plugin: Literal["jlink"] = "jlink"
+    jlink_java_version: int = 21
+    jlink_jars: list[str] = []
+
+
+class JLinkPlugin(Plugin):
+    """Create a Java Runtime using JLink."""
+
+    properties_class = JLinkPluginProperties
+
+    @override
+    def get_build_packages(self) -> Set[str]:
+        options = cast(JLinkPluginProperties, self._options)
+        return {f"openjdk-{options.jlink_java_version}-jdk"}
+
+    @override
+    def get_build_environment(self) -> Dict[str, str]:
+        return {}
+
+    @override
+    def get_build_snaps(self) -> Set[str]:
+        return set()
+
+    @override
+    def get_build_commands(self) -> List[str]:
+        """Return a list of commands to run during the build step."""
+        options = cast(JLinkPluginProperties, self._options)
+
+        commands = []
+
+        if len(options.jlink_jars) > 0:
+            jars = " ".join(["${CRAFT_STAGE}/" + x for x in options.jlink_jars])
+            commands.append(f"PROCESS_JARS={jars}")
+        else:
+            commands.append("PROCESS_JARS=$(find ${CRAFT_STAGE} -type f -name *.jar)")
+
+        # create temp folder
+        commands.append("mkdir -p ${CRAFT_PART_BUILD}/tmp")
+        # extract jar files into temp folder
+        commands.append(
+            "(cd ${CRAFT_PART_BUILD}/tmp && for jar in ${PROCESS_JARS}; do jar xvf ${jar}; done;)"
+        )
+        commands.append("CPATH=$(find ${CRAFT_PART_BUILD}/tmp -type f -name *.jar)")
+        commands.append("CPATH=$(echo ${CPATH}:. | sed s'/[[:space:]]/:/'g)")
+        commands.append("echo ${CPATH}")
+        commands.append(
+            """if [ "x${PROCESS_JARS}" != "x" ]; then
+                deps=$(jdeps --class-path=${CPATH} -q --recursive  --ignore-missing-deps \
+                    --print-module-deps --multi-release """
+            + str(options.jlink_java_version)
+            + """ ${PROCESS_JARS}); else deps=java.base; fi
+            """
+        )
+        commands.append(
+            "INSTALL_ROOT=${CRAFT_PART_INSTALL}/usr/lib/jvm/java-"
+            + str(options.jlink_java_version)
+            + "-openjdk-${CRAFT_TARGET_ARCH}/"
+        )
+
+        commands.append(
+            "rm -rf ${INSTALL_ROOT} && jlink --add-modules ${deps} --output ${INSTALL_ROOT}"
+        )
+        # create /usr/bin/java link
+        commands.append(
+            "(cd ${CRAFT_PART_INSTALL} && mkdir -p usr/bin && ln -s --relative usr/lib/jvm/java-"
+            + str(options.jlink_java_version)
+            + "-openjdk-${CRAFT_TARGET_ARCH}/bin/java usr/bin/)"
+        )
+        commands.append("mkdir -p ${CRAFT_PART_INSTALL}/etc/ssl/certs/java/")
+        # link cacerts
+        commands.append(
+            "cp /etc/ssl/certs/java/cacerts ${CRAFT_PART_INSTALL}/etc/ssl/certs/java/cacerts"
+        )
+        commands.append("cd ${CRAFT_PART_INSTALL}")
+        commands.append(
+            "rm -f usr/lib/jvm/java-"
+            + str(options.jlink_java_version)
+            + "-openjdk-${CRAFT_TARGET_ARCH}/lib/security/cacerts"
+        )
+        commands.append(
+            "ln -s --relative etc/ssl/certs/java/cacerts usr/lib/jvm/java-"
+            + str(options.jlink_java_version)
+            + "-openjdk-${CRAFT_TARGET_ARCH}/lib/security/cacerts"
+        )
+        return commands

rockcraft/plugins/register.py

@@ -19,6 +19,7 @@
 import craft_parts
 from craft_parts.plugins.plugins import PluginType
 
+from .jlink_plugin import JLinkPlugin
 from .python_plugin import PythonPlugin
 
 
@@ -29,4 +30,4 @@ def register() -> None:
 
 def get_plugins() -> dict[str, PluginType]:
     """Get a dict of Rockcraft-specific plugins."""
-    return {"python": PythonPlugin}
+    return {"python": PythonPlugin, "jlink": JLinkPlugin}