plugins: qmake

.github/workflows/tests.yaml

@@ -81,7 +81,7 @@ jobs:
           pip install -e .
       - name: Install additional test dependencies
         run: |
-          sudo apt install -y ninja-build cmake scons
+          sudo apt install -y ninja-build cmake scons qt5-qmake
           # Build Chisel: needs a newer version of go than is available in Ubuntu 20.04
           sudo snap install --classic --channel=latest/stable go
           git clone https://github.com/canonical/chisel.git chisel-tmp

craft_parts/plugins/plugins.py

@@ -33,6 +33,7 @@
 from .npm_plugin import NpmPlugin
 from .properties import PluginProperties
 from .python_plugin import PythonPlugin
+from .qmake_plugin import QmakePlugin
 from .rust_plugin import RustPlugin
 from .scons_plugin import SConsPlugin
 
@@ -58,6 +59,7 @@
     "nil": NilPlugin,
     "npm": NpmPlugin,
     "python": PythonPlugin,
+    "qmake": QmakePlugin,
     "rust": RustPlugin,
     "scons": SConsPlugin,
 }

craft_parts/plugins/qmake_plugin.py

@@ -0,0 +1,118 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2020-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 qmake plugin."""
+
+from typing import Any, Dict, List, Set, cast
+
+from .base import Plugin, PluginModel, extract_plugin_properties
+from .properties import PluginProperties
+
+
+class QmakePluginProperties(PluginProperties, PluginModel):
+    """The part properties used by the qmake plugin."""
+
+    qmake_parameters: List[str] = []
+    qmake_project_file: str = ""
+
+    # part properties required by the plugin
+    source: str
+
+    @classmethod
+    def unmarshel(cls, data: Dict[str, Any]):
+        """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 = extract_plugin_properties(
+            data, plugin_name="qmake", required=["source"]
+        )
+        return cls(**plugin_data)
+
+
+class QMakePlugin(Plugin):
+    """The qmake plugin is useful for building qmake-based parts.
+
+    These are projects that are built using .pro files.
+
+    This plugin uses the common plugin keywords as well as those for "sources".
+    For more information check the 'plugins' topic for the former and the
+    'sources' topic for the latter.
+
+    Additionally, this plugin uses the following plugin-specific keywords:
+
+    - qmake-parameters:
+      (list of strings)
+      additional options to pass to the qmake invocation.
+
+    - qmake-project-file:
+      (string)
+      the qmake project file to use. This is usually only needed if
+      qmake can not determine what project file to use on its own.
+    """
+
+    properties_class = QmakePluginProperties
+
+    def get_build_snaps(self) -> Set[str]:
+        """Return a set of required snaps to install in the build environment."""
+        return set()
+
+    def get_build_packages(self) -> Set[str]:
+        """Return a set of required packages to install in the build environment."""
+        build_packages = {"g++", "make", "qt5-qmake"}
+
+        return build_packages
+
+    def get_build_environment(self) -> Dict[str, str]:
+        """Return a dictionary with the environment to use in the build step."""
+        return {"QT_SELECT": "qt5"}
+
+    def get_build_commands(self) -> List[str]:
+        """Return a list of commands to run during the build step."""
+        options = cast(QmakePluginProperties, self._options)
+
+        qmake_configure_command = [
+            "qmake",
+            'QMAKE_CFLAGS+="${CFLAGS:-}"',
+            'QMAKE_CXXFLAGS+="${CXXFLAGS:-}"',
+            'QMAKE_LFLAGS+="${LDFLAGS:-}"',
+        ] + options.qmake_parameters
+
+        if options.qmake_project_file:
+            qmake_configure_command.append(
+                [
+                    f'"{self._part_info.part_src_dir}"',
+                    "/",
+                    f'"{options.qmake_project_file}"',
+                ]
+            )
+        else:
+            qmake_configure_command.append(f'"{self._part_info.part_src_dir}"')
+
+        return [
+            " ".join(qmake_configure_command),
+            f"env -u CFLAGS -u CXXFLAGS make -j{self._part_info.parallel_build_count}",
+            f"make install INSTALL_ROOT={self._part_info.part_install_dir}",
+        ]
+
+    @property
+    def out_of_source_build(self) -> bool:
+        """Return whether the plugin performs out-of-source-tree builds."""
+        return True

tests/unit/plugins/test_plugins.py

@@ -33,6 +33,7 @@
     NilPlugin,
     NpmPlugin,
     PythonPlugin,
+    QmakePlugin,
     RustPlugin,
 )
 
@@ -57,6 +58,7 @@ class TestGetPlugin:
             ("nil", NilPlugin, {}),
             ("npm", NpmPlugin, {"source": "."}),
             ("python", PythonPlugin, {"source": "."}),
+            ("qmake", QmakePlugin, {"source": "."}),
             ("rust", RustPlugin, {"source": "."}),
         ],
     )

tests/unit/plugins/test_qmake_plugin.py

@@ -0,0 +1,106 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright 2020-2022 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/>.
+
+from pathlib import Path
+
+import pytest
+
+from craft_parts.infos import PartInfo, ProjectInfo
+from craft_parts.parts import Part
+from craft_parts.plugins.qmake_plugin import QMakePlugin
+
+
+@pytest.fixture
+def setup_method_fixture():
+    def _setup_method_fixture(new_dir, properties=None):
+        if properties is None:
+            properties = {}
+        properties["source"] = "."
+        plugin_properties = QMakePlugin.properties_class.unmarshal(properties)
+        part = Part("foo", {})
+
+        project_info = ProjectInfo(application_name="test", cache_dir=new_dir)
+        project_info._parallel_build_count = 42
+
+        part_info = PartInfo(project_info=project_info, part=part)
+        part_info._part_install_dir = Path("install/dir")
+
+        return QMakePlugin(properties=plugin_properties, part_info=part_info)
+
+    yield _setup_method_fixture
+
+
+class TestPluginQMakePlugin:
+    """QMake plugin tests."""
+
+    def test_get_build_snaps(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir)
+        assert plugin.get_build_snaps() == set()
+
+    def test_get_build_packages_default(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir)
+        assert plugin.get_build_packages() == {
+            "g++",
+            "make",
+            "qt5-qmake",
+        }
+
+    def test_get_build_environment(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir)
+
+        assert plugin.get_build_environment() == {
+            "QT_SELECT": "qt5",
+        }
+
+    def test_get_build_commands_default(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir)
+
+        assert plugin.get_build_commands() == [
+            f"qmake QMAKE_CFLAGS+=${CFLAGS:-} QMAKE_CXXFLAGS+=${CXXFLAGS:-} QMAKE_LFLAGS+=${LDFLAGS:-}",
+            f"env -u CFLAGS -u CXXFLAGS make -j{self._part_info.parallel_build_count}",
+            f"make install INSTALL_ROOT={self._part_info.part_install_dir}",
+        ]
+
+    def test_get_build_commands_qmake_project_file(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir, properties={"qmake_project_file": "hello.pro"})
+
+        assert plugin.get_build_commands() == [
+            f"qmake QMAKE_CFLAGS+=${CFLAGS:-} QMAKE_CXXFLAGS+=${CXXFLAGS:-} \
+            QMAKE_LFLAGS+=${LDFLAGS:-} {self._part_info.part_src_dir}/hello.pro",
+            f"env -u CFLAGS -u CXXFLAGS make -j{self._part_info.parallel_build_count}",
+            f"make install INSTALL_ROOT={self._part_info.part_install_dir}",
+        ]
+
+    def test_get_build_commands_cmake_parameters(self, setup_method_fixture, new_dir):
+        qmake_parameters = [
+            "QMAKE_LIBDIR+=/foo",
+        ]
+
+        plugin = setup_method_fixture(new_dir, {"qmake-parameters": qmake_parameters})
+
+        assert plugin.get_build_commands() == [
+            (
+                f"qmake QMAKE_CFLAGS+=${CFLAGS:-} QMAKE_CXXFLAGS+=${CXXFLAGS:-} QMAKE_LFLAGS+=${LDFLAGS:-}",
+                f'{" ".join(qmake_parameters)}'
+            ),
+            f"env -u CFLAGS -u CXXFLAGS make -j{self._part_info.parallel_build_count}",
+            f"make install INSTALL_ROOT={self._part_info.part_install_dir}",
+        ]
+
+    def test_get_out_of_source_build(self, setup_method_fixture, new_dir):
+        plugin = setup_method_fixture(new_dir)
+
+        assert plugin.get_out_of_source_build() is True