跳转至

MindStudio Tools Extension Library 开发指南


本文档介绍 msTX(MindStudio Tools Extension Library)的开发环境搭建、编译构建及 UT 单元测试方法。

1. 前置条件

1.1 知识准备

开发前请先阅读 msTX 接口列表,了解 msTX 提供的核心 API 及其功能简介。

1.2 环境准备

按照《msTX 安装指南 — 源码安装》章节完成编译和测试环境的搭建。

说明: 环境镜像的构建方法及配套软件版本由 MindStudio 统一镜像制作指南维护,本仓库不重复定义。

2. 编译构建

在项目根目录执行:

python3 build.py

2.1 构建产物

构建成功后,输出将生成在 artifacts 目录下。

2.2 清理构建

如需全量重新编译,删除构建目录后重新执行上述步骤:

rm -rf build

3. 单元测试

3.1 执行测试

python3 build.py test

该命令会依次执行:下载测试依赖 → Debug 编译 C/CPP 测试目标 → 运行 C/C++ 单元测试 → 运行 Python 单元测试。

全部通过时输出类似如下示例:

[----------] 4 tests from CoreApi (8ms total)
============= 4 passed in 0.03s =============

判定标准: ran 的用例数与 PASSED 的用例数一致即为通过。若存在 FAILED 用例,请根据日志定位失败原因。存在多个独立测试套,输出结果与样例类似时,即表示运行成功。

3.2 清理测试环境

删除 UT 构建目录后重新执行测试:

rm -rf build_ut