Sharness: 一个面向Unix程序的轻量级测试框架教程

Sharness: 一个面向Unix程序的轻量级测试框架教程

sharness 项目地址: https://gitcode.com/gh_mirrors/sha/sharness

1. 项目目录结构及介绍

Sharness作为源于Git测试框架的开源项目，其目录结构设计简洁，旨在便于用户理解和扩展。以下是典型的Sharness项目目录结构及其简要说明：

sharness/
├── sharness.sh             # 核心库文件，包含了所有的测试辅助函数。
├── t/                      # 测试脚本存放目录，每个测试用例通常以t开头，后跟编号，如t001_test_example.sh。
├── test-help.sh            # 可选的帮助脚本，用于展示如何运行测试或提供测试框架使用的额外信息。
├── README.md               # 项目的主要说明文档，介绍了项目的目的、安装和基本用法。
├── examples/               # 示例测试脚本，帮助新用户快速上手。
└── sharness.d/             # 扩展功能目录，用户在此添加自定义的.sh脚本来扩展Sharness的功能。

说明：

• sharness.sh 是整个框架的核心，包含了测试用例执行所需的全部函数。
• t/ 目录下的脚本是实际的测试逻辑实现，每个脚本代表一个或一组相关联的测试用例。
• 用户可以根据需求在项目中增加自己的目录结构，如示例、文档等。

2. 项目的启动文件介绍

主要的启动交互不是通过单一的“启动文件”，而是通过在你的测试脚本中引入sharness.sh并调用它的API来完成。通常，你的测试脚本应该以以下方式开始：

#!/bin/bash
. path/to/sharness.sh

# 然后调用 Sharness 的函数来定义和执行测试用例。
plan tests 1;
ok true "This is a simple test case."
done_testing;

在这个场景中，. path/to/sharness.sh 是关键步骤，它导入了测试框架的函数，允许你使用Sharness提供的测试逻辑。

3. 项目的配置文件介绍

Sharness本身并不强调传统意义上的配置文件。然而，其灵活性体现在环境变量的使用和脚本内部的参数设定上。你可以通过设置环境变量来定制化一些行为，比如指定日志级别、测试目录等。例如，通过设置环境变量SHARNESS_TMPDIR可以改变临时文件的存储位置。

对于特定的配置需求，用户通常会在测试脚本自身或通过在sharness.d/目录下添加个性化脚本来实现。这种方式被视为“配置”或“扩展”的一部分，而不是依赖于单独的、传统的配置文件。

总结

Sharness的设计鼓励用户通过脚本编写和环境变量来控制测试流程，而不是依赖复杂的配置文件结构。这保持了其轻量化和易于集成的特点，非常适合于命令行工具和shell脚本的自动化测试场景。了解并熟练运用上述核心元素，就能有效利用Sharness提升你的项目质量。

sharness 项目地址: https://gitcode.com/gh_mirrors/sha/sharness