home / skills / openharmonyinsight / openharmony-skills / oh-xts-build-run

oh-xts-build-run skill

safe

This skill orchestrates XTS build and run in one workflow, compiling to HAP and executing tests with optional package and api parameters.

npx playbooks add skill openharmonyinsight/openharmony-skills --skill oh-xts-build-run

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.4 KB

---
name: oh-xts-build-run
description: OpenHarmony XTS 编译和运行组合命令。一站式完成 XTS 测试项目的编译和运行。当用户需要执行完整的 XTS 测试流程时使用此 Skill： (1) 编译 XTS 测试项目生成 HAP 文件，(2) 运行 XTS 测试并展示结果。支持 --package 和 --api 参数传递给运行阶段。
---

# OpenHarmony XTS 编译和运行

此 Skill 将 XTS 编译 (`/oh-xts-build`) 和运行 (`/oh-xts-run`) 组合成一个完整的工作流。

## 工作流程

1. **执行编译**：运行 `/oh-xts-build`
   - 更新 List.test.ets 注册测试用例
   - 使用 hvigorw 编译生成 HAP 文件
   - 检查主 HAP 和测试 HAP 是否生成成功

2. **判断结果**：
   - 如果编译失败 → 停止流程，返回编译错误
   - 如果编译成功 → 继续执行运行

3. **执行运行**：运行 `/oh-xts-run [参数]`
   - 自动解析包名（从 pack.info 或 module.json5）
   - 运行测试并解析结果统计

4. **汇总结果**：统一展示编译和运行的完整输出

## 参数

- `--package=<package-name>`：指定包名（可选）
- `--api=<api-name>`：指定测试类名（可选）

## 实现位置

- 编译命令：`packages/cli/src/ui/commands/ohXtsBuildCommand.ts`
- 运行命令：`packages/cli/src/ui/commands/ohXtsRunCommand.ts`
- 核心模块：`packages/cli/src/modules/xts/build-runner.ts`

Overview

This skill combines OpenHarmony XTS compilation and test execution into a single, automated workflow. It builds XTS test projects to produce HAP files, then runs the tests and presents consolidated results. Optional parameters let you target a specific package or API class for the run stage. Use this skill to streamline end-to-end XTS test runs with one command.

How this skill works

The skill first invokes the build step to update test lists, run the hvigorw tool, and verify that both main and test HAP artifacts are produced. If the build fails, the process stops and returns the build error. On successful build, it automatically determines the package name (from pack.info or module.json5) and invokes the run step, optionally passing --package and --api arguments. The run step executes tests, parses test statistics, and returns a unified output showing compile and test results.

When to use it

You need a single command to compile XTS tests and then execute them end-to-end.
You want automatic package detection to avoid manually specifying the test package.
You need parsed test results and consolidated logs for CI or local verification.
You want to target a specific package or API class during test runs.
You need a fail-fast workflow that stops if compilation fails.

Best practices

Ensure pack.info or module.json5 is present and up to date for automatic package detection.
Run in a clean workspace so hvigorw produces deterministic HAP outputs.
Pass --package or --api only when you need to override automatic detection.
Inspect build logs first if the workflow stops; most failures originate in the compilation step.
Integrate this skill into CI pipelines to simplify XTS test phases.

Example use cases

Local developer runs one command to build an XTS test suite and immediately see pass/fail counts.
CI job compiles XTS artifacts and runs tests, failing the pipeline on compile errors.
Targeted test run for a single API class using --api to reproduce a failing test quickly.
Automated nightly runs that build multiple modules and collect unified test reports.

FAQ

What happens if compilation fails?

The workflow stops immediately and returns the compilation error; tests are not executed.

How is the package name determined?

The skill auto-parses pack.info or module.json5 to find the package name unless you supply --package.