conanfile.py

# (C) Copyright IBM 2023, 2024.
#
# This code is part of Qiskit.
#
# This code is licensed under the Apache License, Version 2.0 with LLVM
# Exceptions. You may obtain a copy of this license in the LICENSE.txt
# file in the root directory of this source tree.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
import os

from conans import ConanFile, CMake, tools


# Get version from environment variable.
# Note: QSSC_VERSION must be set in the environment when exporting
# to the Conan cache (i.e. via conan export or conan create).
# https://docs.conan.io/en/1.53/reference/conanfile/attributes.html#version
def get_version():
    return os.environ.get("QSSC_VERSION", None)


class QSSCompilerConan(ConanFile):
    name = "qss-compiler"
    version = get_version()
    url = "https://github.com/qiskit/qss-compiler"
    settings = "os", "compiler", "build_type", "arch"
    options = {
        "shared": [True, False],
        "pythonlib": [True, False],
        "enable_warnings": [True, False],
    }
    default_options = {"shared": False, "pythonlib": True, "enable_warnings": True}
    license = "Apache-2.0 WITH LLVM-exception"
    author = "OpenQASM Organization"
    topics = ("Compiler", "OpenQASM3", "MLIR", "Quantum", "Computing")
    description = "An LLVM- and MLIR-based Quantum compiler that consumes OpenQASM 3.0"
    generators = ["CMakeToolchain", "CMakeDeps", "VirtualBuildEnv"]
    exports_sources = "*"

    def requirements(self):
        for req in self.conan_data["requirements"]:
            self.requires(req)

    def configure(self):
        if self.settings.os == "Macos":
            self.options["qasm"].shared = True

        # LLVM prefers ZSTD shared libraries by default now so we force building
        # https://github.com/llvm/llvm-project/commit/fc1da043f4f9198303abd6f643cf23439115ce73
        self.options["zstd"].shared = True

    def build_requirements(self):
        tool_pkgs = ["llvm", "clang-tools-extra"]
        # Add packages necessary for build.
        for req in self.conan_data["requirements"]:
            if any(req.startswith(tool + "/") for tool in tool_pkgs):
                self.tool_requires(req)

    def _configure_cmake(self):
        cmake = CMake(self, generator="Ninja")
        cmake.definitions["CMAKE_TOOLCHAIN_FILE"] = "conan_toolchain.cmake"
        cmake.definitions["CMAKE_EXPORT_COMPILE_COMMANDS"] = "ON"
        cmake.definitions["QSSC_ENABLE_WARNINGS"] = "ON" if self.options.enable_warnings else "OFF"
        # linking in parallel on all CPUs may take up more memory than
        # available in a typical CI worker for debug builds.
        if self.settings.build_type == "Debug":
            cmake.definitions["LLVM_PARALLEL_LINK_JOBS"] = "2"

        cmake.verbose = True
        return cmake

    def build(self):
        cmake = self._configure_cmake()

        if self.should_configure:
            cmake.configure()

        if self.should_build:
            cmake.build()

            if self.options.pythonlib:
                self.run(
                    f"cd {self.build_folder}/python_lib \
                        && pip install -e .[test]"
                )

        if self.should_test:
            self.test(cmake)

    def package(self):
        cmake = self._configure_cmake()
        cmake.install()

        if self.options.pythonlib:
            self.run(
                f"cd {self.build_folder}/python_lib \
                    && pip install .[test]"
            )

        if self.should_test:
            self.test(cmake)

    def test(self, cmake):
        cmake = self._configure_cmake()
        cmake.test(target="check-tests")
        # Separate pytest calls to avoid
        # cross contaminating the test environments
        # due to fixtures/tests of the same name being cached
        self.run(
            f"cd {self.source_folder} && "
            "pytest test/python_lib && "
            "pytest targets/systems/mock/test/python_lib"
        )

    def package_info(self):
        self.cpp_info.libs = tools.collect_libs(self)