使用 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 备份仓库以及如何为其提供公共读取权限，同时仅为授权代理保留写入访问权限