*openUBMC bingo支持产品基于lockfile构建 - 详细设计说明书*

<table>
    <tr>
        <td>所属SIG组:</td>
        <td>CICD</td>
    </tr>
    <tr>
        <td>落入版本:</td>
        <td>26.03</td>
    </tr>
    <tr>
        <td>设计人员:</td>
        <td>姚顺</td>
    </tr>
    <tr>
        <td>日期:</td>
        <td>2026.2.2</td>
    </tr>
</table>

**Copyright © 2025 openUBMC Community**

您对&quot;本文档&quot;的复制，使用，修改及分发受木兰宽松许可证, 第2版协议(以下简称&quot;MulanPSL2&quot;)的约束。
为了方便用户理解，您可以通过访问<https://license.coscl.org.cn/MulanPSL2>了解MulanPSL2的概要 (但不是替代)。
MulanPSL2的完整协议内容您可以访问如下网址获取：<https://license.coscl.org.cn/MulanPSL2>。

**改版记录**

<table>
    <tr>
        <th>日期</th>
        <th>修订版本</th>
        <th>修订描述</th>
        <th>作者</th>
        <th>审核</th>
    </tr>
    <tr>
        <td>2025/02/02</td>
        <td>0.0.1</td>
        <td>初始版本</td>
        <td>姚顺</td>
        <td></td>
    </tr>
</table>

**List of abbreviations**  **缩略语清单** ：

<table>
    <tr>
        <th>Abbreviations 缩略语</th>
        <th>Full spelling 英文全名</th>
        <th>Chinese explanation 中文解释</th>
    </tr>
    <tr>
        <td>Conan</td>
        <td>Conan Package Manager</td>
        <td>C/C++依赖管理和包分发工具</td>
    </tr>
    <tr>
        <td>BMC</td>
        <td>Baseboard Management Controller</td>
        <td>基板管理控制器</td>
    </tr>
    <tr>
        <td>RootFS</td>
        <td>Root File System</td>
        <td>根文件系统</td>
    </tr>
</table>

[TOC]

# 1.功能分析

## 1.1 功能背景
<!-- 描述该需求的来源或背景，比如：支撑XXX功能、XXX优化等；以及该需求对用户（含组件）带来什么具体价值，如果没有该需求，对用户（含组件）带来什么损失； -->

### 需求来源

在openUBMC项目公共仓上库过程中，如vpd/mdb_interface/rackmount代码仓，因同时修改service.json造成大量上库代码冲突，这导致：

1. **开发体验不友好**：开发者上库需要多次解决冲突，体验及其不友好
2. **版本变更频繁**：公共仓组件版本变更频繁，造成不必要的资源浪费

### 用户价值

通过公共组件可重复发布，使用lockfile构建，为openUBMC社区带来以下价值：

1. **开发体验友好**：因不涉及修改service.json，公共代码仓无需一直处理冲突
2. **云空间节省**：公共代码仓可做到按需发布，避免发布无效版本，节省云空间
3. **manifest按需更新**：manifest可做到范围依赖，当版本需要更新时，简单执行命令更新lockfile即可实现功能兼容

### 损失描述

若无此功能，将导致：

- 公共仓代码上库冲突较多

## 1.2 功能描述
<!-- 描述该需求交付的整体功能，主要实现XXX功能，解决XXX问题，明确方案如何实现 -->

### 整体功能

1. 新增bingo lock命令，支持首次create lockfile、后续update lockfile中组件版本。
2. 产品构建适配基于lockfile构建。


### 实现方式

- 通过新增`bmcgo.functional.conan_lock.BmcgoCommand`命令类实现
- 调用`conan lock create/remove/add`命令完成lockfile维护
- manifest任务在`work.task_build_conan`方法`merge_manifest_v2`中适配使用lockfile中组件版本
- 调用`conan lock merge`命令合并bmc_sdk和manifest lockfile

## 1.3 功能场景
<!-- 描述该需求的业务使用场景，内容包括：
1) 场景出发条件及对象：什么角色/工具/接口等在什么具体情况下使用该特性，使用对象技能如何？
2) 使用时间及频度
3) 描述该特性主要有哪些场景、子场景及关键任务操作 -->

### 业务场景

| 场景编号 | 场景名称 | 描述 | 使用对象 |
| -------- | -------- | ---- | -------- |
| SC-01 | manifest维护lockfile | manifest生成lockfile，更新lockfile | 开发者 |
| SC-02 | 构建基于lockfile完成构建 | 构建基于lockfile完成构建 | 开发者、流水线 |

### 使用对象

| 对象 | 技能要求 | 使用频度 |
| ---- | -------- | -------- |
| 构建工具 | 熟悉Python、Conan基础 | 每次构建 |
| 版本管理员 | 了解Conan仓库操作 | 版本发布时 |
| 开发者 | 基础命令行操作与工具使用 | 开发调试时 |
| CI/CD系统 | 了解shell/python编程，流水线维护 | 持续集成 |

### 使用时间

- **构建时自动执行**：作为构建流程的一环，无需手动触发

## 1.4 功能列表
<!-- 描述该需求交付的功能列表，内容包括：列出功能详细描述，标题、描述。 -->
| 功能编号 | 功能标题 | 功能描述 |
| ------- | ------- | -------- |
| F-01 | 支持基于lockfile的产品级构建 | 支持基于lockfile的产品级构建 |

# 2.功能设计

## 2.1 总体方案分析
<!-- 描述该方案的总体设计（注：相关输出方案可同步刷新到各组件仓） -->

### 2.1.1 方案详细设计

#### 2.1.1.1 方案概述
<!-- 描述该方案的整体实现，内容包括：涉及的关键点，实现策略等 -->

**整体实现**

本方案通过在manifest生成lockfile，组件自行维护lockfile，达到公共代码仓组件重复发布使用：

**关键点**

| 关键点 | 描述 | 技术实现 |
| ------ | ---- | -------- |
| subsys支持组件范围描述 | manifest的`subsys/xx.yml`三段式版本组件支持范围描述 | `semver版本管理，yml校验` |
| lockfile生成 | 生成openubmc.lock | `conan lock` |
| 构建使用lockfile | 构建使用lockfile | `conan lock`、`semver版本替换` |
| 临时目录清理 | lock生成后完成后自动清理临时文件 | `shutil.rmtree` in finally block |

**实现策略**

1. **命令新增**：新增`bmcgo.functional.conan_lock.BmcgoCommand`，实现标准命令接口
2. **任务执行**：通过兼容适配`bmcgo.tasks.task_build_conan`兼容适配`merge_manifest_v2`

#### 2.1.1.2 开发视图
<!-- 开发视图面向系统开发及软件管理，描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构 -->

**代码结构**

```text
bmcgo/functional/
└── conan_lock.py                     # lock命令，实现lock create/update(新增)

bmcgo/tasks/
└── task_build_conan.py               # 组件构建逻辑，新增兼容lockfile(修改)

```

**构建产物目录结构**

```text

临时打包目录结构（运行时）:
.temp
├── openubmc.lock                 # 生成的lock文件
├── manifest.yml                  # 生成的依赖清单
└── conanfile.py                  # 动态生成的配方文件
```

#### 2.1.1.3 运行视图
<!-- 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系 -->

**构建流程时序**

```text
┌─────────────┐     ┌──────────────┐     ┌──────────────────┐
│  bmcgo CLI  │────▶│ work.prepare │────▶│ work.build.conan│
│   (frame)   │     │    _env      │     │  (兼容使用lockfile│
                                         │          构建)    │
                          └──────────────┴────────┬─────────┘


┌─────────────────────────────────────────────────────────────────┐
│         bmcgo.functional.conan_lock (新增命令)                   │
│  ┌─────────────────────────────────────────────────────────┐   │
│  │ 1. _create_lockfile() - 新增lockfile          │   │
│  └─────────────────────────────────────────────────────────┘   │
│  ┌─────────────────────────────────────────────────────────┐   │
│  │ 2. _update_lockfile() - 修改lockfile                │   │
│  └─────────────────────────────────────────────────────────┘   │
└─────────────────────────────────────────────────────────────────┘
```

### 2.1.2 内部依赖分析
<!-- 是否涉及与其他组件接口依赖，如果涉及需要确认当前是否已完成，是否匹配当前需求开发诉求 -->

| 依赖项 | 依赖组件 | 依赖内容 | 完成状态 |
| ------ | -------- | -------- | -------- |
| 命令读取 | bmcgo.functional.conan_lock | 版本号、板型名称、构建类型等 | 已完成 |
| 任务框架 | bmcgo.tasks.task_build_conan | 组件版本构建 | 已完成 |
| Conan版本检测 | bmcgo.misc.conan_v2() | 判断当前Conan版本 | 已完成 |

### 2.1.3 外部依赖分析
<!-- 是否涉及与平台SDK的依赖关系 -->

| 外部依赖 | 类型 | 版本要求 | 用途 |
| -------- | ---- | -------- | ---- |
| Conan | 外部工具 | v2.x | 包管理和制品创建 |
| Python | 运行环境 | >= 3.6 | 脚本执行 |
| node-semver | Python库 | 0.6.1 | 版本范围判定 |

### 2.1.4 北向接口分析
<!-- 需要分析当前功能是否有以下接口影响，如果有影响，则需要具体的补充影响点。其中注意点如下：
（1）如果有新增IPMI接口，请排查代码中IPMI命令注册的过滤字段，是否完全和IPMI命令的定义一致？
（2）新增一个接口时，需要咨询SIG组是否还有其他的接口受影响 -->

本功能为构建流程内部功能，不对外暴露北向接口。

### 2.1.5 兼容性分析
<!-- 当前的功能对现有在网的功能是否有影响，具体的影响点进行分析之后输出影响分析表格 -->

**Conan版本兼容性**

本功能只支持conan2

**影响分析**

- 只支持conanv2，当manifest存在lockfile时，将使用lockfile版本判定

### 2.1.6 定制化接口分析
<!-- 如果支持定制化设置，则需要给出定制化时的默认值（空定制化项条件下的设置值），如果涉及到定制化接口变更或新增，注意定制化接口文档需配套修改。注意定制化默认值变更对白牌包的影响 -->

不涉及

### 2.1.7 导入导出分析
<!-- 如果支持导入导出的配置，则需要分析导入导出的schema。 -->
不涉及配置导入导出。

### 2.1.8 传感器分析
<!-- 如果需要新增传感器，则需要提前登记和评审新增的传感器要素。新增传感器评审需要上SIG-Interface进行评审 -->
不涉及传感器新增。

### 2.1.9 精准告警事件分析
<!-- 如果需要新增事件，则需要提前登记和评审新增的时间要素 -->
不涉及事件新增。

### 2.1.10 系统锁定分析
<!-- 对外的接口或者命令是否支持系统锁定 -->
不涉及系统锁定。

### 2.1.11 用例场景分析
<!-- 以表格的形式输出该需求涉及的用例场景 -->

| 用例编号 | 用例名称 | 前置条件 | 操作步骤 | 预期结果 |
| -------- | -------- | -------- | -------- | -------- |
| UC-01 | 正常构建流程 | manifest不存在lockfile | 1. 执行构建  | 成功创建Conan制品并打包hpm |
| UC-02 | 存在lockfile的构建流程 | manifest存在lockfile | 1. 执行构建 | 成功创建Conan制品并打包hpm |

## 2.2 非功能质量属性设计

### 2.2.1 扩展性分析
<!-- 考虑后续新增类似功能可以很好地扩展 -->

不涉及

### 2.2.2 重用性分析
<!-- 是否为通用处理方式、接口，如果是得考虑重用性 -->
不涉及

### 2.2.3 可测试性分析
<!-- 此需求如何验证，是否可直接验证，or通过XXX功能覆盖验证，or需要单独怎加测试接口验证 -->

1. **单元测试**：各私有方法可独立测试
不涉及

2. **集成测试**：
不涉及

### 2.2.4 资料分析
<!-- 是否涉及资料修改 -->

| 资料类型 | 是否涉及 | 说明 |
| -------- | -------- | ---- |
| 用户手册 | 否 | 用户直接可见，通过工具承载 |
| 开发指南 | 否 | 内部实现，无需用户文档 |
| API文档 | 否 | 无对外API |

### 2.2.5 资源使用分析
<!-- 新增线程、内存分配、模型属性名长度是否合理，CPU占用率是否会激增，Flash中新增文件是否合理（频繁读写Flash会大幅缩短emmc寿命）；是否涉及消息队列，如果涉及请检查是否存在某些场景下消息队列会满导致消息丢失，例如大量消息发送到队列且处理消息需要耗费较长时间的场景。 -->

不涉及

### 2.2.6 可靠性分析

不涉及

### 2.2.7 安全性分析

不涉及

# 3.功能实现
<!-- 通过表格、流程图、简明文字描述提供，力求容易看懂、容易实现，详细描述细节。 -->
## 3.1 MDS/MDB元数据归档功能实现

### 3.1.1 功能实现设计

**新增lock命令**

新增`bmcgo.functional.conan_lock`，调用`conan lock`系列命令实现lockfile的维护


### 3.1.2 功能详细设计

见第 2 节 功能设计

### 3.1.3 开发者测试
<!--
增加模块接口：以活动图/流程图等形式明确模块内处理流程，针对模块处理流程中的分支进行覆盖
修改模块接口处理流程：覆盖修改影响流程分支
-->

#### 3.1.3.1 单元测试
<!-- UT，主要是功能单元测试，测试对象是功能单元接口。UT测试设计要从黑盒（功能）角度设计，从输入(I)、处理（B）、预期输出（O）的角度进行用例分析设计，测试覆盖率仅作为反馈，用于分析哪些功能场景没有覆盖到，从而指导测试设计优化并补充测试用例 -->

不涉及

#### 3.1.3.2 集成测试
<!-- IT，主要是组件/模块内的集成测试，测试对象是模块/组件接口。IT测试设计将模块/组件当作黑盒测试，IT测试用例中禁止对组件/模块内部代码打桩，如果确实有少量场景难以构造，可以考虑在测试框架中统一打桩并提供接口供测试用例调用构造场景。
说明：API测试属于IT，其测试对象是微服务接口。
PCST，是指PC上的服务集成测试，测试对象是功能需求。PCST测试设计，要覆盖正常功能、异常功能和交叉功能，采用灰盒 -->

不涉及
