unit-test.md

单元测试

测试框架

如何需要一些测试指令，比如 assert, require, mock 以及 suite，可以使用这个包协助你进行测试： github.com/stretchr/testify。更多使用方法可以查看 使用说明。

测试工具

从插件开发以及 日志打印 篇幅可以看到，ilogtail.Context 接口包含了iLogtail 的元配置信息，因此提供了Mock Context 以及Mock Collector 实现进行单元测试。

import (
    "github.com/stretchr/testify/assert"

    "github.com/alibaba/ilogtail"
    "github.com/alibaba/ilogtail/plugins/test"
    "github.com/alibaba/ilogtail/plugins/test/mock"

    "testing"
)

func TestInputSystem_CollectOpenFD(t *testing.T) {
    cxt := mock.NewEmptyContext("project", "store", "config")
    p := ilogtail.MetricInputs["metric_system_v2"]().(*InputSystem)
    _, err := p.Init(cxt)
    assert.NoError(t, err, "cannot init the mock process plugin: %v", err)
    c := &test.MockMetricCollector{}
    p.CollectOpenFD(c)
    assert.Equal(t, 2, len(c.Logs))
    m := make(map[string]string)
    for _, log := range c.Logs {
        for _, content := range log.Contents {
            if content.Key == "__name__" {
                m[content.Value] = "exist"
            }
        }
    }
    assert.NotEqual(t, "", m["fd_allocated"])
    assert.NotEqual(t, "", m["fd_max"])
}

测试插件行为

如果需要日志的方式进行验证插件具体行为，可以参加日志功能高级用法