Sharness 项目技术文档

1. 安装指南

首先，从Git仓库克隆Sharness项目：

git clone git://github.com/felipec/sharness.git

然后，根据需要选择以下安装方式：

项目内安装

如果希望将Sharness添加到项目源码中，只需将sharness.sh和example/Makefile文件复制到项目中的test文件夹，并在测试文件中引用sharness.sh。

也可以使用Sharnessify进行项目安装，或者将Sharness作为Git子模块添加到项目中。

在项目内安装中，如果存在sharness.d目录，Sharness将从中加载扩展。

用户安装

cd sharness
make install

此命令将Sharness安装到$HOME/share/sharness，并将文档和示例安装到$HOME/share/doc/sharness。

系统安装

cd sharness
make install prefix=/usr/local

该命令将Sharness安装到/usr/local/share/sharness，并将文档和示例安装到/usr/local/share/doc/sharness。当然，可以更改prefix参数以将Sharness安装到其他位置。

2. 使用说明

Sharness的核心文件是sharness.sh，它是一个提供测试功能的shell库。它被设计为从测试脚本中引用，而不是直接执行。

以下文件是可选的：

• example/Makefile - 测试驱动程序。默认目标会运行完整的测试套件。
• lib-sharness/functions.sh - 额外函数。这些函数虽然不错，但并非必需。
• tools/aggregate-results.sh - 结果显示工具。聚合test-results中的所有结果，通常在Makefile中测试完成后调用。

如果使用bash或zsh，Sharness会自动加载额外的函数，否则需要设置SHARNESS_TEST_SRCDIR到sharness.sh所在的目录。

关于所有函数的解释，请参阅单独的API文档。

3. 项目API使用文档

Sharness提供了一系列测试函数和实用工具，具体函数和用法请参阅API文档。

4. 项目安装方式

Sharness提供了多种安装方式，包括项目内安装、用户安装和系统安装。具体步骤请参考上文“安装指南”部分。

通过以上文档，用户可以了解如何安装、使用Sharness，并熟悉其API，以便更好地利用Sharness进行Unix程序的自动化测试。