README.md

# cmdc_test

> CMDC 集成方 / 第三方 plugin 作者 / cmdc 子库测试 helpers 一站式包。

cmdc 主库自身的 `test/support/` 目录在 hex 发布时**不会打包**,导致集成方写
contract test 时都各自重写 mock provider / plugin runner / 事件断言族。
本子库把这些常见测试基础设施统一发布到 hex.pm。

## 安装

```elixir
defp deps do
  [
    {:cmdc, "~> 0.5"},
    {:cmdc_test, "~> 0.1", only: :test}
  ]
end
```

## 4 大模块

| 模块 | 用途 |
|---|---|
| `CMDCTest.MockProvider` | Builder 式 mock LLM provider,配合 `CMDC.Config.provider_fn` 注入 |
| `CMDCTest.Plugin` + `Plugin.Spy` | `run_hook/3` 单元测 Plugin;Spy plugin 集成路径 inject anonymous handler |
| `CMDCTest.EventCapture` | EventBus 订阅 + 清理 |
| `CMDCTest.Assertions` | `assert_event_emitted` / `assert_event_count` / `refute_event_emitted` |

## Quick Start

### 1. Mock LLM Provider

```elixir
defmodule MyAgentTest do
  use ExUnit.Case
  alias CMDCTest.MockProvider

  test "Agent 收到 prompt 后 LLM 回复" do
    provider =
      MockProvider.new()
      |> MockProvider.respond("Hello from mock!")

    {:ok, session} =
      CMDC.create_agent(
        model: "mock:test",
        config: %{provider_fn: MockProvider.to_provider_fn(provider)}
      )

    CMDC.prompt(session, "hi")
    {:ok, reply} = CMDC.collect_reply(session, timeout: 2_000)
    assert reply == "Hello from mock!"
  end
end
```

### 2. 单元测试 Plugin

```elixir
import CMDCTest.Plugin

test "SecurityGuard 拦截危险 shell 命令" do
  assert {:ok, {:block_tool, reason, _state}} =
           run_hook(
             CMDC.Plugin.Builtin.SecurityGuard,
             {:before_tool, "shell", %{"cmd" => "rm -rf /"}}
           )

  assert reason =~ "dangerous"
end
```

### 3. 集成路径 hook 替换(Spy plugin)

```elixir
alias CMDCTest.Plugin.Spy

test "Spy 拦截 before_tool 收集所有工具调用" do
  test_pid = self()

  {:ok, session} =
    CMDC.create_agent(
      model: "mock:test",
      plugins: [
        {Spy,
         handler: fn
           {:before_tool, name, args}, state, _ctx ->
             send(test_pid, {:tool_intercepted, name, args})
             {:continue, state}

           _, state, _ -> {:continue, state}
         end}
      ]
    )

  CMDC.prompt(session, "go")
  assert_receive {:tool_intercepted, "shell", _}, 2_000
end
```

### 4. 事件断言族

```elixir
import CMDCTest.Assertions
alias CMDCTest.EventCapture

test "Agent 执行后发出 agent_end 事件" do
  {:ok, session} = CMDC.create_agent(...)
  :ok = EventCapture.start_capture(session)

  CMDC.prompt(session, "go")

  # 等待事件
  assert_event_emitted(session, :agent_end, timeout: 2_000)

  # payload 子集匹配
  assert_event_emitted(session, :tool_blocked, payload: %{tool: "shell"})

  # 事件不应出现
  refute_event_emitted(session, :approval_required, timeout: 200)

  # 数事件次数
  events = assert_event_count(session, :stream_chunk, 5, timeout: 1_000)
end
```

## v0.1 范围说明

v0.1 严控 4 大模块 + 8 个公开 API,不含:

- ❌ **fixtures 库**(`Message` / `Context` 等 sample 数据生成器)— 留 v0.2
- ❌ **`with_mock_plugin` macro**(推荐用 `Plugin.Spy` 替代,无需 :meck 依赖)
- ❌ **Property-based testing 集成**(用户自行配 stream_data)
- ❌ **Tool 测试 helper**(v0.2 跟随 cmdc 主库 Tool behaviour 演进再加)

## License

Apache 2.0