构建包: build() 方法¶

我们已经使用了一个包含 build() 方法的 Conan recipe，并学习了如何使用它来调用构建系统并构建我们的包。在本教程中，我们将修改该方法，并解释如何使用它来执行以下操作：

构建和运行测试
源代码的条件性补丁
有条件地选择您想要使用的构建系统

请先克隆源代码以重新创建此项目。您可以在 GitHub 上的 examples2 仓库中找到它们

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/creating_packages/build_method

构建并运行您的项目测试¶

您会注意到之前 recipe 中的 conanfile.py 文件发生了一些更改。让我们检查一下相关的部分

recipe 中引入的更改¶

conanfile.py¶

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    ...

    def source(self):
        git = Git(self)
        git.clone(url="https://github.com/conan-io/libhello.git", target=".")
        # Please, be aware that using the head of the branch instead of an immutable tag
        # or commit is not a good practice in general
        git.checkout("with_tests")

    ...

    def requirements(self):
        if self.options.with_fmt:
            self.requires("fmt/8.1.1")
        self.test_requires("gtest/1.11.0")

    ...

    def generate(self):
        tc = CMakeToolchain(self)
        if self.options.with_fmt:
            tc.variables["WITH_FMT"] = True
        tc.generate()

    def build(self):
        cmake = CMake(self)
        cmake.configure()
        cmake.build()
        if not self.conf.get("tools.build:skip_test", default=False):
            test_folder = os.path.join("tests")
            if self.settings.os == "Windows":
                test_folder = os.path.join("tests", str(self.settings.build_type))
            self.run(os.path.join(test_folder, "test_hello"))

    ...

我们将 gtest/1.11.0 需求作为 test_requires() 添加到 recipe 中。这是一种用于测试库（如 Catch2 或 gtest）的需求类型。
我们使用 tools.build:skip_test 配置（默认 False），来告知 CMake 是否构建和运行测试。需要记住以下几点：
- 如果我们将 tools.build:skip_test 配置设置为 True，Conan 将自动将 BUILD_TESTING 变量注入到 CMake 中，并设置为 OFF。您将在下一节中看到，我们在 CMakeLists.txt 中使用此变量来决定是否构建测试。
- 我们在 build() 方法中，在构建包和测试之后，使用 tools.build:skip_test 配置来决定是否要运行测试。
- 在本例中，我们使用 gtest 进行测试，并且必须检查构建方法是否要运行测试。如果您正在使用 CTest，此配置还会影响 CMake.test() 的执行；如果您正在使用 Meson，则影响 Meson.test() 的执行。

库源文件中引入的更改¶

首先，请注意我们正在使用 libhello 库的另一个分支。此分支在库端有两个新颖之处：

我们向库源文件添加了一个名为 compose_message() 的新函数，以便我们可以对此函数添加一些单元测试。此函数仅根据传递的参数创建输出消息。
正如我们在上一节中提到的，库的 CMakeLists.txt 使用 BUILD_TESTING CMake 变量，该变量有条件地添加 tests 目录。

CMakeLists.txt¶

cmake_minimum_required(VERSION 3.15)
project(hello CXX)

...

if (NOT BUILD_TESTING STREQUAL OFF)
    add_subdirectory(tests)
endif()

...

当 tools.build:skip_test 配置设置为值 True 时，Conan 声明 BUILD_TESTING CMake 变量并将其设置为 OFF（如果尚未定义）。当您使用 CTest 时，此变量通常由 CMake 声明，但是使用 tools.build:skip_test 配置，即使您正在使用另一个测试框架，也可以在 CMakeLists.txt 中使用它。

我们在 tests 文件夹中有一个 CMakeLists.txt，它使用 googletest 进行测试。

tests/CMakeLists.txt¶

cmake_minimum_required(VERSION 3.15)
project(PackageTest CXX)

find_package(GTest REQUIRED CONFIG)

add_executable(test_hello test.cpp)
target_link_libraries(test_hello GTest::gtest GTest::gtest_main hello)

对 compose_message() 函数的功能进行基本测试

tests/test.cpp¶

#include "../include/hello.h"
#include "gtest/gtest.h"

namespace {
    TEST(HelloTest, ComposeMessages) {
    EXPECT_EQ(std::string("hello/1.0: Hello World Release! (with color!)\n"), compose_message("Release", "with color!"));
    ...
    }
}

现在我们已经了解了代码中的所有更改，让我们试用一下

$ conan create . --build=missing -tf=""
...
[ 25%] Building CXX object CMakeFiles/hello.dir/src/hello.cpp.o
[ 50%] Linking CXX static library libhello.a
[ 50%] Built target hello
[ 75%] Building CXX object tests/CMakeFiles/test_hello.dir/test.cpp.o
[100%] Linking CXX executable test_hello
[100%] Built target test_hello
hello/1.0: RUN: ./tests/test_hello
Capturing current environment in /Users/user/.conan2/p/tmp/c51d80ef47661865/b/build/generators/deactivate_conanbuildenv-release-x86_64.sh
Configuring environment variables
Running main() from /Users/user/.conan2/p/tmp/3ad4c6873a47059c/b/googletest/src/gtest_main.cc
[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from HelloTest
[ RUN      ] HelloTest.ComposeMessages
[       OK ] HelloTest.ComposeMessages (0 ms)
[----------] 1 test from HelloTest (0 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (0 ms total)
[  PASSED  ] 1 test.
hello/1.0: Package '82b6c0c858e739929f74f59c25c187b927d514f3' built
...

如您所见，测试已构建并运行。现在让我们在命令行中使用 tools.build:skip_test 配置来跳过测试构建和运行

$ conan create . -c tools.build:skip_test=True -tf=""
...
[ 50%] Building CXX object CMakeFiles/hello.dir/src/hello.cpp.o
[100%] Linking CXX static library libhello.a
[100%] Built target hello
hello/1.0: Package '82b6c0c858e739929f74f59c25c187b927d514f3' built
...

您现在可以看到，仅构建了库目标，并且没有构建或运行任何测试。

源代码的条件性补丁¶

如果您需要修补源代码，建议的方法是在 source() 方法中执行此操作。有时，如果该补丁依赖于 settings 或 options，则必须使用 build() 方法在启动构建之前将补丁应用于源代码。在 Conan 中，有几种方法可以做到这一点。其中一种是使用 replace_in_file 工具

import os
from conan import ConanFile
from conan.tools.files import replace_in_file


class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    # Binary configuration
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}

    def build(self):
        replace_in_file(self, os.path.join(self.source_folder, "src", "hello.cpp"),
                        "Hello World",
                        "Hello {} Friends".format("Shared" if self.options.shared else "Static"))

请注意，如果可能，应避免在 build() 中进行修补，并且仅应在非常特殊的情况下进行修补，因为它会使本地开发包更加困难（我们将在后面的本地开发流程部分中对此进行更多说明）

有条件地选择您的构建系统¶

有些包需要根据我们构建的平台使用一个或另一个构建系统，这并不罕见。例如，hello 库可以在 Windows 中使用 CMake 构建，而在 Linux 和 MacOS 中使用 Autotools。这可以在 build() 方法中轻松处理，如下所示

...

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    # Binary configuration
    settings = "os", "compiler", "build_type", "arch"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}

    ...

    def generate(self):
        if self.settings.os == "Windows":
            tc = CMakeToolchain(self)
            tc.generate()
            deps = CMakeDeps(self)
            deps.generate()
        else:
            tc = AutotoolsToolchain(self)
            tc.generate()
            deps = PkgConfigDeps(self)
            deps.generate()

    ...

    def build(self):
        if self.settings.os == "Windows":
            cmake = CMake(self)
            cmake.configure()
            cmake.build()
        else:
            autotools = Autotools(self)
            autotools.autoreconf()
            autotools.configure()
            autotools.make()

    ...

参见

修补源文件