Files
ragflow/internal/ingestion/task/real_consumer_test.go
Jack 5ba8c4febb chore(go): classify tests into unit/integration/e2e/manual tiers via build tags (#17586)
## Summary
Classify the Go test suite by dependency level using build tags so the
default
`go test ./...` run stays self-contained, and add local convenience
commands
plus a documented convention.

- Add build tags to 5 real-service tests that were previously un-tagged
and only
soft-isolated via `t.Skip`: `kg_test.go` (integration), `minio_test.go`
  (integration), `template_integration_test.go` (integration),
`stagehand_runtime_integration_test.go` (integration),
`pipeline_e2e_test.go` (e2e).
  The default unit run no longer compiles/attempts these.
- Reclassify the full-pipeline `real_consumer` tests from `integration`
to `e2e`.
- Add `build.sh` shortcuts: `--test-integration`, `--test-e2e`,
`--test-manual`,
`--test-all` (integration + e2e; `manual` is excluded and is local
opt-in only,
  never run in CI).
- Document the tier scheme (unit / integration / e2e / manual +
orthogonal cgo) in
  `AGENTS.md`.

## Tier definitions
| Tier | Build tag | Runs by default? |
|---|---|---|
| Unit | (none) | Yes — in-memory SQLite / miniredis / httptest stubs |
| Integration | `integration` | No (`-tags integration`) — single real
service |
| E2E | `e2e` | No (`-tags e2e`) — full ingest→index→retrieve pipeline |
| Manual | `manual` | No (`-tags manual`) — very slow; never in CI |

## Verification
- `gofmt -l` clean on all changed files; `bash -n build.sh` OK.
- `go list` confirms the default set excludes the tagged files, and
  `-tags integration` / `-tags e2e` include them.
- Full regression: unit / integration / e2e each **97 ok, 0 FAIL**.
- Fixed a regression where `pipeline_knowledge_compiler_test.go` relied
on a
transitive import side-effect from `template_integration_test.go` to
register
the `File`/`Parser`/`TokenChunker` components; it now blank-imports the
  component packages directly.

## Test plan
- [ ] `./build.sh --test` (unit) passes
- [ ] `./build.sh --test-integration` passes (needs real services; skips
otherwise)
- [ ] `./build.sh --test-e2e` passes (needs real services; skips
otherwise)

---------

Co-authored-by: CodeBuddy <noreply@cnb.cool>
2026-07-31 11:52:48 +08:00

177 lines
5.9 KiB
Go

//
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build e2e
package task
import (
"context"
"encoding/json"
"testing"
"ragflow/internal/common"
"ragflow/internal/dao"
"ragflow/internal/entity"
"ragflow/internal/ingestion/testutil"
)
// TestRealProducerConsumer exercises the project's real producer and consumer code paths:
//
// Producer: document.go pattern — Create(IngestionTask) → PublishTask(NATS)
// Consumer: Ingestor.Start() core logic — calls each actual function in sequence
func TestRealProducerConsumer(t *testing.T) {
// ── 1. NATS (embedded in-process server) ──
natsEngine := testutil.SetupNatsEngine(t)
if err := natsEngine.InitConsumer("tasks.>"); err != nil {
t.Fatalf("InitConsumer: %v", err)
}
// Purge stale messages
for {
h, _ := natsEngine.GetMessages(1)
if len(h) == 0 {
break
}
h[0].Ack()
}
// ── 2. SQLite DB ──
db := testutil.SetupTestDB(t)
cleanup := testutil.ReplaceDBForTest(t, db)
defer cleanup()
db.Create(&entity.Tenant{ID: "t1", LLMID: "gpt-4", Status: testutil.StrPtr("1")})
db.Create(&entity.Knowledgebase{ID: "kb1", TenantID: "t1", EmbdID: "e1", Status: testutil.StrPtr("1"), ParserConfig: entity.JSONMap{}})
docName := "doc-real.pdf"
db.Create(&entity.Document{ID: "doc-real", KbID: "kb1", ParserID: "naive", ParserConfig: entity.JSONMap{}, Name: &docName})
// ── 3. Producer: Mirrors document.go:1062-1085 exactly ──
ingestionTask := &entity.IngestionTask{
ID: "ingest-task-1",
UserID: "u1",
DocumentID: "doc-real",
DatasetID: "kb1",
Status: common.CREATED,
}
created, err := dao.NewIngestionTaskDAO().Create(context.Background(), db, ingestionTask)
if err != nil {
t.Fatalf("Create: %v", err)
}
t.Logf("Producer: IngestionTask created id=%s status=%s", created.ID, created.Status)
taskMessage := common.TaskMessage{
TaskID: created.ID,
TaskType: common.TaskTypeIngestionTask,
}
payload, _ := json.Marshal(taskMessage)
if err := natsEngine.PublishTask("tasks.RAGFLOW", payload); err != nil {
t.Fatalf("PublishTask: %v", err)
}
t.Logf("Producer: Published %s", payload)
// ── 4. Consumer: Mirrors Ingestor.Start():131-189 exactly ──
handles, err := natsEngine.GetMessages(1)
if err != nil {
t.Fatalf("GetMessages: %v", err)
}
if len(handles) != 1 {
t.Fatalf("expected 1 message, got %d", len(handles))
}
taskHandle := handles[0]
taskMsg := taskHandle.GetMessage()
t.Logf("Consumer: Received TaskID=%s TaskType=%s", taskMsg.TaskID, taskMsg.TaskType)
// Mirrors Start():133 — type filter
if taskMsg.TaskType != common.TaskTypeIngestionTask {
taskHandle.Ack()
t.Fatalf("unexpected task type: %s", taskMsg.TaskType)
}
// Mirrors Start():142-143 — UpdateStatusIfCurrent
ingestionTaskDAO := dao.NewIngestionTaskDAO()
_, err = ingestionTaskDAO.UpdateStatusIfCurrent(context.Background(), db, taskMsg.TaskID, common.CREATED, common.RUNNING)
if err != nil {
t.Fatalf("UpdateStatusIfCurrent: %v", err)
}
task, err := ingestionTaskDAO.GetByID(context.Background(), db, taskMsg.TaskID)
if err != nil {
t.Fatalf("GetByID: %v", err)
}
if task == nil {
t.Logf("Consumer: task %s not found in ingestion_task table — skipped", taskMsg.TaskID)
taskHandle.Ack()
return
}
t.Logf("Consumer: UpdateStatusIfCurrent status=%s", task.Status)
// Mirrors Start():167-180 — status check
switch task.Status {
case common.COMPLETED, common.STOPPED, common.FAILED:
taskHandle.Ack()
t.Fatalf("task already terminal: %s", task.Status)
case common.STOPPING, common.CREATED:
t.Fatalf("unexpected status: %s", task.Status)
case common.RUNNING:
t.Logf("Consumer: task is RUNNING — dispatching to executeTask")
}
// ── 5. executeTask (our modified version) ──
// Set a pipeline ID so the handler can resolve the canvas.
if err := db.Model(&entity.Document{}).Where("id = ?", "doc-real").Update("pipeline_id", "pipeline-real").Error; err != nil {
t.Fatalf("set pipeline_id: %v", err)
}
tc, err := LoadFromIngestionTask(context.Background(), task)
if err != nil {
t.Fatalf("LoadFromIngestionTask: %v", err)
}
t.Logf("Consumer: Loaded Doc=%s Parser=%s KB=%s Tenant=%s",
tc.Doc.ID, tc.Doc.ParserID, tc.KB.ID, tc.Tenant.ID)
svc, err := NewPipelineExecutor(tc, tc.PipelineID, 0)
if err != nil {
t.Fatalf("NewPipelineExecutor: %v", err)
}
svc.WithLoadDSLFunc(func(ctx context.Context, canvasID string) (string, string, error) {
return `{"nodes":[{"id":"test","type":"parser"}],"edges":[]}`, canvasID, nil
})
svc.WithRunPipelineFunc(func(ctx context.Context, dsl string) (map[string]any, string, error) {
return nil, "", nil
})
svc.WithInsertFunc(func(ctx context.Context, chunks []map[string]any, baseName, datasetID string) ([]string, error) {
return nil, nil
})
if _, err := svc.Execute(tc.Ctx); err != nil {
t.Fatalf("Execute: %v", err)
}
t.Log("Consumer: PipelineExecutor.Execute() - OK")
// Mirrors executeTask — mark as completed
if _, err := ingestionTaskDAO.UpdateStatusIfCurrent(context.Background(), db, task.ID, common.RUNNING, common.COMPLETED); err != nil {
t.Fatalf("UpdateStatus: %v", err)
}
// Mirrors Start():135 — Ack
taskHandle.Ack()
// ── 6. Verify ──
final, _ := ingestionTaskDAO.GetByID(context.Background(), db, task.ID)
if final.Status != common.COMPLETED {
t.Errorf("final status = %s, want %s", final.Status, common.COMPLETED)
}
t.Logf("Final: IngestionTask status=%s ✅", final.Status)
}