使用 Conan 备份第三方来源

对于开源的、公开可用的库的配方和构建脚本，通常的做法是从规范来源（如 Github 发布版或项目下载网页）下载源代码。记录这些文件的来源对于可追溯性很有用，但是，这些文件是否长期可用通常无法保证，并且未来用户从源代码构建相同配方时可能会遇到问题。因此，Conan 可以配置为透明地从配置的镜像检索源代码，而无需修改配方或 conandata.yml。此外，这些源代码可以通过 conan upload 与包一起透明地上传。

源备份功能旨在将下载的配方源存储在你自己的基础设施中的文件服务器中，即使原始下载 URL 不再可用，也能确保你的构建在未来可重现。

当提供了 sha256 文件签名时，调用 download 和 get 方法会触发备份。

配置概述

此功能由几个 global.conf 项控制

  • core.sources:download_cache：存储源备份的本地路径。如果未设置，将使用默认的 Conan 主缓存路径。

  • core.sources:download_urls：Conan 将尝试从中下载源的有序 URL 列表，其中 origin 表示传递给 conandata.yml 中的 get/download 的原始 URL。这允许控制获取顺序，可以是 ["origin", "https://your.backup/remote/"]，仅当原始源不存在时才查找并从你的备份远程获取，或者 ["https://your.backup/remote/", "origin"]，优先使用你的备份服务器而非配方的规范链接。由于是列表，也可以有多个远程。默认为 ["origin"]

  • core.sources:upload_url：在调用 conan upload 时，用于上传备份的远程 URL，它可能与为下载定义的任何 URL 不同。默认为空

  • core.sources:exclude_urls：要跳过备份的来源列表。如果传递给 get/download 的 URL 以此列表中包含的任何来源开头，则在调用 conan upload 时，该源将不会上传到备份远程。默认为空

用法

让我们通过一个从头到尾的示例用法来概述该功能的工作原理

总而言之，它看起来像这样

  • 设置一个远程备份仓库。这应该允许 PUT 和 GET HTTP 方法来修改和获取其内容。如果需要访问凭据（强烈建议用于上传权限），你可以使用 source_credentials.json 功能。如果需要配置自己的，请参见下文。

  • 然后可以在 core.sources:download_urls 和 core.sources:upload_url 中设置远程的 URL。

  • 在你的配方的 source() 方法中，确保相关的 get/download 调用提供了下载文件的 sha256 签名。

  • 如果需要自定义位置，请在你的 global.conf 文件中设置 core.sources:download_cache，否则将使用默认缓存文件夹

  • 正常运行 Conan，创建包等。

  • 一旦一些源已本地下载，core.sources:download_cache 指向的文件夹将为每个下载的文件包含

    • 一个没有扩展名的 blob 文件，其名称为在 get/download 中提供的 sha256 签名。

    • 一个 .json 文件，其名称也将是 sha256 签名，其中将包含有关此 blob 属于哪些引用和哪些镜像的信息。

  • 如果设置了 core.sources:upload_url，调用 conan upload 将可选择性地上传匹配引用的备份。

注意

请参见下文，了解如何配置你自己的备份服务器的指南

设置必要的配置

如果需要从自定义备份源远程下载，global.conf 文件应包含 core.sources:download_urls，如果需要自定义本地缓存路径来下载备份，则应包含 core.sources:download_cache。

global.conf
core.sources:download_urls=["https://myteam.myorg.com/artifactory/backup-sources/", "origin"]
core.sources:download_cache=/path/to/backup/sources

注意

core.sources:download_urls 或 core.sources:download_cache 应该定义一个才能启用该功能。

你可能需要根据你的用例添加额外的配置，如 本文档开头 所述。

注意

处理组织中 CI 工作人员和开发人员配置的推荐方法是使用 conan config install 命令在仓库中安装配置。在此处阅读更多信息 这里

正常运行 Conan

完成上述步骤后，Conan 现在可以正常使用，对于每个下载的源，Conan 将首先查看 core.sources:download_cache 中指示的文件夹，如果未找到，将遍历 core.sources:download_urls，直到找到文件或失败，并将本地副本存储在相同的 core.sources:download_cache 位置。

当从备份远程获取备份时，将向用户显示如下消息

客户端现在将打印有关它能够从哪个远程下载源的信息
$ conan create . --version=1.3

...

======== Installing packages ========
zlib/1.3: Calling source() in /Users/ruben/.conan2/p/zlib0f4e45286ecd1/s/src
zlib/1.3: Sources for ['https://zlib.net/fossils/zlib-1.3.tar.gz', 'https://github.com/madler/zlib/releases/download/v1.3/zlib-1.3.tar.gz']
          found in remote backup https://myteam.myorg.com/artifactory/backup-sources

-------- Installing package zlib/1.3 (1 of 1) --------

...

如果我们现在再次尝试运行此操作，我们会发现没有执行下载，而是使用了文件的本地存储版本。

上传包

如上所示创建包后，当执行 conan upload zlib/1.3 -c 调用以将生成的二进制文件上传到你的 Conan 仓库时，如果配置了，它还将该相同引用的源备份上传到你的备份远程，并且将来此配方的源下载在必要时将使用新更新的内容。

注意

请参阅 包列表功能，了解一种仅上传已构建包的方法

如果需要上传与任何包未链接的源备份，或者上传已在远程上的包（因此在上传期间将被跳过），可以使用 conan cache backup-upload 命令来解决此情况。

创建备份仓库

你也可以设置自己的远程备份仓库，而不是依赖现有的仓库。虽然建议使用 Artifactory 通用仓库（Artifactory CE 免费提供）用于此目的，但任何允许 PUT 和 GET HTTP 方法来修改和获取其内容的简单服务器都足够了。

阅读以下部分，了解如何创建 Artifactory 通用备份仓库以及如何为其提供公共读取权限，同时仅为授权代理保留写入权限的说明