package slogtest

import "testing/slogtest"

Package slogtest 支持测试 log/slog.Handler 的实现。

Example (Parsing)

This example demonstrates one technique for testing a handler with this package. The handler is given a bytes.Buffer to write to, and each line of the resulting output is parsed. For JSON output, encoding/json.Unmarshal produces a result in the desired format when given a pointer to a map[string]any.

package main

import (
	"bytes"
	"encoding/json"
	"log"
	"log/slog"
	"testing/slogtest"
)

func main() {
	var buf bytes.Buffer
	h := slog.NewJSONHandler(&buf, nil)

	results := func() []map[string]any {
		var ms []map[string]any
		for line := range bytes.SplitSeq(buf.Bytes(), []byte{'\n'}) {
			if len(line) == 0 {
				continue
			}
			var m map[string]any
			if err := json.Unmarshal(line, &m); err != nil {
				panic(err) // In a real test, use t.Fatal.
			}
			ms = append(ms, m)
		}
		return ms
	}
	err := slogtest.TestHandler(h, results)
	if err != nil {
		log.Fatal(err)
	}

}

Index

Examples

Functions

func Run

func Run(t *testing.T, newHandler func(*testing.T) slog.Handler, result func(*testing.T) map[string]any)

Run 在与 TestHandler 相同的测试用例上演练 slog.Handler,但 会在子测试中运行每个用例。对于每个测试用例,它首先调用 newHandler 以获取被测 handler 的实例,然后运行测试用例,接着 调用 result 获取结果。如果测试用例失败,它会调用 t.Error。

func TestHandler

func TestHandler(h slog.Handler, results func() []map[string]any) error

TestHandler 测试一个 slog.Handler。 如果 TestHandler 发现任何不当行为,它会为每个问题返回一个错误, 并用 errors.Join 合并为单个错误。

TestHandler 将给定的 Handler 安装到 slog.Logger 中, 并对 Logger 的输出方法进行若干次调用。 Handler 应针对 Info 及更高级别启用。

results 函数在所有这些调用之后被调用。 它应返回一个 map[string]any 切片,对应每次对 Logger 输出方法的调用。 该 map 的键和值应与 Handler 输出的键和值相对应。 输出中的每个组应表示为其自身的嵌套 map[string]any。 应使用标准键 slog.TimeKey、slog.LevelKey 和 slog.MessageKey。

如果 Handler 输出 JSON,则使用 `map[string]any` 调用 encoding/json.Unmarshal 会创建正确的数据结构。

如果 Handler 有意丢弃某个被测试检查的属性, 那么 results 函数应检查其不存在,并将其添加到返回的 map 中。