PrettyTest 技术文档

1. 安装指南

1.1 安装 PrettyTest

PrettyTest 是一个简单的测试库，提供了漂亮的输出格式。要安装 PrettyTest，您可以使用以下命令：

go get -v github.com/remogatto/prettytest

1.2 安装 PrettyAutoTest

PrettyAutoTest 是一个命令行工具，用于持续监视源代码目录中的更改，并在文件修改时重新执行测试。要安装 PrettyAutoTest，请使用以下命令：

go get -v github.com/remogatto/prettytest/pta/

安装完成后，您可以在工作目录中直接运行 pta 命令：

pta

2. 项目的使用说明

2.1 基本使用

PrettyTest 是一个与 go test 命令集成的测试库。您可以通过编写测试用例来使用 PrettyTest。以下是一个简单的示例：

package foo

import (
	"github.com/remogatto/prettytest"
	"testing"
)

// 测试套件的设置
type testSuite struct {
	prettytest.Suite
}

func TestRunner(t *testing.T) {
	prettytest.RunWithFormatter(
		t,
		new(prettytest.TDDFormatter),
		new(testSuite),
	)
}

// 测试用例
func (t *testSuite) TestTrueIsTrue() {
	t.True(true)
}

func (t *testSuite) TestEquality() {
	t.Equal("awesome", "awesome")
}

func (t *testSuite) TestNegation() {
	t.Not(t.Equal("awesome", "not good"))
}

// 失败的测试用例
func (t *testSuite) TestInequality() {
	t.Equal("awesome", "pretty")
}

2.2 运行测试

编写完测试用例后，您可以使用 go test 命令来运行测试：

go test

输出示例：

testSuite:
	OK	TestComposition               (2 assertion(s))
	OK	TestEquality                  (1 assertion(s))
	F	TestInequality                (1 assertion(s))
	OK	TestTrueIsTrue                (1 assertion(s))

4 tests, 3 passed, 1 failed, 0 pending, 0 with no assertions
--- FAIL: TestRunner (0.00 seconds)
prettytest.go:453: 	Expected awesome to be not equal to awesome -- /home/andrea/src/sandbox/go/prettytest/example_test.go:39
		
FAIL
exit status 1
FAIL	_/home/andrea/src/sandbox/go/prettytest	0.014s

3. 项目API使用文档

3.1 断言方法

PrettyTest 提供了一些简单的断言方法，用于编写测试用例：

• True(value bool)：断言 value 为 true。
• Equal(expected, actual interface{})：断言 expected 和 actual 相等。
• Not(assertion)：断言 assertion 不成立。

3.2 自定义格式化器

PrettyTest 允许通过接口自定义输出格式。您可以使用 RunWithFormatter 方法来指定格式化器：

prettytest.RunWithFormatter(t, new(prettytest.TDDFormatter), new(testSuite))

3.3 TDD 格式化器图例

• F - 测试失败
• OK - 测试通过
• EF - 预期的失败
• NA - 没有断言
• PE - 待处理的测试

4. 项目安装方式

4.1 安装 PrettyTest

go get -v github.com/remogatto/prettytest

4.2 安装 PrettyAutoTest

go get -v github.com/remogatto/prettytest/pta/

安装完成后，您可以在工作目录中直接运行 pta 命令：

pta

通过以上步骤，您可以顺利安装并使用 PrettyTest 和 PrettyAutoTest 进行测试。