zhongwei/gh-yaleh-meta-cc-claude
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fab98d059baa18e635b2f51a9e761919410286e0
gh-yaleh-meta-cc-claude/skills/testing-strategy/examples/cli-testing-example.md
Zhongwei Li fab98d059b Initial commit
2025-11-30 09:07:22 +08:00

19 KiB
Raw Blame History

CLI Testing Example: Cobra Command Test Suite

Project: meta-cc CLI tool Framework: Cobra (Go) Patterns Used: CLI Command (Pattern 7), Global Flag (Pattern 8), Integration (Pattern 3)

This example demonstrates comprehensive CLI testing for a Cobra-based application.

Project Structure

cmd/meta-cc/
├── root.go          # Root command with global flags
├── query.go         # Query subcommand
├── stats.go         # Stats subcommand
├── version.go       # Version subcommand
├── root_test.go     # Root command tests
├── query_test.go    # Query command tests
└── stats_test.go    # Stats command tests

Example 1: Root Command with Global Flags

Source Code (root.go)

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

var (
    projectPath string
    sessionID   string
    verbose     bool
)

func newRootCmd() *cobra.Command {
    cmd := &cobra.Command{
        Use:   "meta-cc",
        Short: "Meta-cognition for Claude Code",
        Long:  "Analyze Claude Code session history for insights and workflow optimization",
    }

    // Global flags
    cmd.PersistentFlags().StringVarP(&projectPath, "project", "p", getCwd(), "Project path")
    cmd.PersistentFlags().StringVarP(&sessionID, "session", "s", "", "Session ID filter")
    cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Verbose output")

    return cmd
}

func getCwd() string {
    cwd, _ := os.Getwd()
    return cwd
}

func Execute() error {
    cmd := newRootCmd()
    cmd.AddCommand(newQueryCmd())
    cmd.AddCommand(newStatsCmd())
    cmd.AddCommand(newVersionCmd())

    return cmd.Execute()
}

Test Code (root_test.go)

package main

import (
    "bytes"
    "testing"

    "github.com/spf13/cobra"
)

// Pattern 8: Global Flag Test Pattern
func TestRootCmd_GlobalFlags(t *testing.T) {
    tests := []struct {
        name            string
        args            []string
        expectedProject string
        expectedSession string
        expectedVerbose bool
    }{
        {
            name:            "default flags",
            args:            []string{},
            expectedProject: getCwd(),
            expectedSession: "",
            expectedVerbose: false,
        },
        {
            name:            "with session flag",
            args:            []string{"--session", "abc123"},
            expectedProject: getCwd(),
            expectedSession: "abc123",
            expectedVerbose: false,
        },
        {
            name:            "with all flags",
            args:            []string{"--project", "/tmp/test", "--session", "xyz", "--verbose"},
            expectedProject: "/tmp/test",
            expectedSession: "xyz",
            expectedVerbose: true,
        },
        {
            name:            "short flag notation",
            args:            []string{"-p", "/home/user", "-s", "123", "-v"},
            expectedProject: "/home/user",
            expectedSession: "123",
            expectedVerbose: true,
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            // Reset global flags
            projectPath = getCwd()
            sessionID = ""
            verbose = false

            // Create and parse command
            cmd := newRootCmd()
            cmd.SetArgs(tt.args)
            cmd.ParseFlags(tt.args)

            // Assert flags were parsed correctly
            if projectPath != tt.expectedProject {
                t.Errorf("projectPath = %q, want %q", projectPath, tt.expectedProject)
            }

            if sessionID != tt.expectedSession {
                t.Errorf("sessionID = %q, want %q", sessionID, tt.expectedSession)
            }

            if verbose != tt.expectedVerbose {
                t.Errorf("verbose = %v, want %v", verbose, tt.expectedVerbose)
            }
        })
    }
}

// Pattern 7: CLI Command Test Pattern (Help Output)
func TestRootCmd_Help(t *testing.T) {
    cmd := newRootCmd()

    var buf bytes.Buffer
    cmd.SetOut(&buf)
    cmd.SetArgs([]string{"--help"})

    err := cmd.Execute()

    if err != nil {
        t.Fatalf("Execute() error = %v", err)
    }

    output := buf.String()

    // Verify help output contains expected sections
    expectedSections := []string{
        "meta-cc",
        "Meta-cognition for Claude Code",
        "Available Commands:",
        "Flags:",
        "--project",
        "--session",
        "--verbose",
    }

    for _, section := range expectedSections {
        if !contains(output, section) {
            t.Errorf("help output missing section: %q", section)
        }
    }
}

func contains(s, substr string) bool {
    return len(s) >= len(substr) && (s == substr || len(s) > len(substr) && (s[:len(substr)] == substr || contains(s[1:], substr)))
}

Time to write: ~22 minutes Coverage: root.go 0% → 78%

Example 2: Subcommand with Flags

Source Code (query.go)

package main

import (
    "encoding/json"
    "fmt"
    "os"

    "github.com/spf13/cobra"
    "github.com/yaleh/meta-cc/internal/query"
)

func newQueryCmd() *cobra.Command {
    var (
        status      string
        limit       int
        outputFormat string
    )

    cmd := &cobra.Command{
        Use:   "query <type>",
        Short: "Query session data",
        Long:  "Query various aspects of session history: tools, messages, files",
        Args:  cobra.ExactArgs(1),
        RunE: func(cmd *cobra.Command, args []string) error {
            queryType := args[0]

            // Build query options
            opts := query.Options{
                ProjectPath:  projectPath,
                SessionID:    sessionID,
                Status:       status,
                Limit:        limit,
                OutputFormat: outputFormat,
            }

            // Execute query
            results, err := executeQuery(queryType, opts)
            if err != nil {
                return fmt.Errorf("query failed: %w", err)
            }

            // Output results
            return outputResults(cmd.OutOrStdout(), results, outputFormat)
        },
    }

    cmd.Flags().StringVar(&status, "status", "", "Filter by status (error, success)")
    cmd.Flags().IntVar(&limit, "limit", 0, "Limit number of results")
    cmd.Flags().StringVar(&outputFormat, "format", "jsonl", "Output format (jsonl, tsv)")

    return cmd
}

func executeQuery(queryType string, opts query.Options) ([]interface{}, error) {
    // Implementation...
    return nil, nil
}

func outputResults(w io.Writer, results []interface{}, format string) error {
    // Implementation...
    return nil
}

Test Code (query_test.go)

package main

import (
    "bytes"
    "strings"
    "testing"
)

// Pattern 7: CLI Command Test Pattern
func TestQueryCmd_Execution(t *testing.T) {
    tests := []struct {
        name       string
        args       []string
        wantErr    bool
        errContains string
    }{
        {
            name:       "no arguments",
            args:       []string{},
            wantErr:    true,
            errContains: "requires 1 arg(s)",
        },
        {
            name:    "query tools",
            args:    []string{"tools"},
            wantErr: false,
        },
        {
            name:    "query with status filter",
            args:    []string{"tools", "--status", "error"},
            wantErr: false,
        },
        {
            name:    "query with limit",
            args:    []string{"messages", "--limit", "10"},
            wantErr: false,
        },
        {
            name:    "query with format",
            args:    []string{"files", "--format", "tsv"},
            wantErr: false,
        },
        {
            name:    "all flags combined",
            args:    []string{"tools", "--status", "error", "--limit", "5", "--format", "jsonl"},
            wantErr: false,
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            // Setup: Create root command with query subcommand
            rootCmd := newRootCmd()
            rootCmd.AddCommand(newQueryCmd())

            // Setup: Capture output
            var buf bytes.Buffer
            rootCmd.SetOut(&buf)
            rootCmd.SetErr(&buf)

            // Setup: Set arguments
            rootCmd.SetArgs(append([]string{"query"}, tt.args...))

            // Execute
            err := rootCmd.Execute()

            // Assert: Error expectation
            if (err != nil) != tt.wantErr {
                t.Errorf("Execute() error = %v, wantErr %v", err, tt.wantErr)
                return
            }

            // Assert: Error message
            if tt.wantErr && tt.errContains != "" {
                errMsg := buf.String()
                if !strings.Contains(errMsg, tt.errContains) {
                    t.Errorf("error message %q doesn't contain %q", errMsg, tt.errContains)
                }
            }
        })
    }
}

// Pattern 2: Table-Driven Test Pattern (Flag Parsing)
func TestQueryCmd_FlagParsing(t *testing.T) {
    tests := []struct {
        name             string
        args             []string
        expectedStatus   string
        expectedLimit    int
        expectedFormat   string
    }{
        {
            name:             "default flags",
            args:             []string{"tools"},
            expectedStatus:   "",
            expectedLimit:    0,
            expectedFormat:   "jsonl",
        },
        {
            name:             "status flag",
            args:             []string{"tools", "--status", "error"},
            expectedStatus:   "error",
            expectedLimit:    0,
            expectedFormat:   "jsonl",
        },
        {
            name:             "all flags",
            args:             []string{"tools", "--status", "success", "--limit", "10", "--format", "tsv"},
            expectedStatus:   "success",
            expectedLimit:    10,
            expectedFormat:   "tsv",
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            cmd := newQueryCmd()
            cmd.SetArgs(tt.args)

            // Parse flags without executing
            if err := cmd.ParseFlags(tt.args); err != nil {
                t.Fatalf("ParseFlags() error = %v", err)
            }

            // Get flag values
            status, _ := cmd.Flags().GetString("status")
            limit, _ := cmd.Flags().GetInt("limit")
            format, _ := cmd.Flags().GetString("format")

            // Assert
            if status != tt.expectedStatus {
                t.Errorf("status = %q, want %q", status, tt.expectedStatus)
            }

            if limit != tt.expectedLimit {
                t.Errorf("limit = %d, want %d", limit, tt.expectedLimit)
            }

            if format != tt.expectedFormat {
                t.Errorf("format = %q, want %q", format, tt.expectedFormat)
            }
        })
    }
}

Time to write: ~28 minutes Coverage: query.go 0% → 82%

Example 3: Integration Test (Full Workflow)

Test Code (integration_test.go)

package main

import (
    "bytes"
    "encoding/json"
    "os"
    "path/filepath"
    "testing"
)

// Pattern 3: Integration Test Pattern
func TestIntegration_QueryToolsWorkflow(t *testing.T) {
    // Setup: Create temporary project directory
    tmpDir := t.TempDir()
    sessionFile := filepath.Join(tmpDir, ".claude", "logs", "session.jsonl")

    // Setup: Create test session data
    if err := os.MkdirAll(filepath.Dir(sessionFile), 0755); err != nil {
        t.Fatalf("failed to create session dir: %v", err)
    }

    testData := []string{
        `{"type":"tool_use","tool":"Read","file":"/test/file.go","timestamp":"2025-10-18T10:00:00Z"}`,
        `{"type":"tool_use","tool":"Edit","file":"/test/file.go","timestamp":"2025-10-18T10:01:00Z","status":"success"}`,
        `{"type":"tool_use","tool":"Bash","command":"go test","timestamp":"2025-10-18T10:02:00Z","status":"error"}`,
    }

    if err := os.WriteFile(sessionFile, []byte(strings.Join(testData, "\n")), 0644); err != nil {
        t.Fatalf("failed to write session data: %v", err)
    }

    // Setup: Create root command
    rootCmd := newRootCmd()
    rootCmd.AddCommand(newQueryCmd())

    // Setup: Capture output
    var buf bytes.Buffer
    rootCmd.SetOut(&buf)

    // Setup: Set arguments
    rootCmd.SetArgs([]string{
        "--project", tmpDir,
        "query", "tools",
        "--status", "error",
    })

    // Execute
    err := rootCmd.Execute()

    // Assert: No error
    if err != nil {
        t.Fatalf("Execute() error = %v", err)
    }

    // Assert: Parse output
    output := buf.String()
    lines := strings.Split(strings.TrimSpace(output), "\n")

    if len(lines) != 1 {
        t.Errorf("expected 1 result, got %d", len(lines))
    }

    // Assert: Verify result content
    var result map[string]interface{}
    if err := json.Unmarshal([]byte(lines[0]), &result); err != nil {
        t.Fatalf("failed to parse result: %v", err)
    }

    if result["tool"] != "Bash" {
        t.Errorf("tool = %v, want Bash", result["tool"])
    }

    if result["status"] != "error" {
        t.Errorf("status = %v, want error", result["status"])
    }
}

// Pattern 3: Integration Test Pattern (Multiple Commands)
func TestIntegration_MultiCommandWorkflow(t *testing.T) {
    tmpDir := t.TempDir()

    // Test scenario: Query tools, then get stats, then analyze
    tests := []struct {
        name     string
        command  []string
        validate func(t *testing.T, output string)
    }{
        {
            name:    "query tools",
            command: []string{"--project", tmpDir, "query", "tools"},
            validate: func(t *testing.T, output string) {
                if !strings.Contains(output, "tool") {
                    t.Error("output doesn't contain tool data")
                }
            },
        },
        {
            name:    "get stats",
            command: []string{"--project", tmpDir, "stats"},
            validate: func(t *testing.T, output string) {
                if !strings.Contains(output, "total") {
                    t.Error("output doesn't contain stats")
                }
            },
        },
        {
            name:    "version",
            command: []string{"version"},
            validate: func(t *testing.T, output string) {
                if !strings.Contains(output, "meta-cc") {
                    t.Error("output doesn't contain version info")
                }
            },
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            // Setup command
            rootCmd := newRootCmd()
            rootCmd.AddCommand(newQueryCmd())
            rootCmd.AddCommand(newStatsCmd())
            rootCmd.AddCommand(newVersionCmd())

            var buf bytes.Buffer
            rootCmd.SetOut(&buf)
            rootCmd.SetArgs(tt.command)

            // Execute
            if err := rootCmd.Execute(); err != nil {
                t.Fatalf("Execute() error = %v", err)
            }

            // Validate
            tt.validate(t, buf.String())
        })
    }
}

Time to write: ~35 minutes Coverage: Adds +5% to overall coverage through end-to-end paths

Key Testing Patterns for CLI

1. Flag Parsing Tests

Goal: Verify flags are parsed correctly

func TestCmd_FlagParsing(t *testing.T) {
    cmd := newCmd()
    cmd.SetArgs([]string{"--flag", "value"})
    cmd.ParseFlags(cmd.Args())

    flagValue, _ := cmd.Flags().GetString("flag")
    if flagValue != "value" {
        t.Errorf("flag = %q, want %q", flagValue, "value")
    }
}

2. Command Execution Tests

Goal: Verify command logic executes correctly

func TestCmd_Execute(t *testing.T) {
    cmd := newCmd()
    var buf bytes.Buffer
    cmd.SetOut(&buf)
    cmd.SetArgs([]string{"arg1", "arg2"})

    err := cmd.Execute()

    if err != nil {
        t.Fatalf("Execute() error = %v", err)
    }

    if !strings.Contains(buf.String(), "expected") {
        t.Error("output doesn't contain expected result")
    }
}

3. Error Handling Tests

Goal: Verify error conditions are handled properly

func TestCmd_ErrorCases(t *testing.T) {
    tests := []struct {
        name        string
        args        []string
        wantErr     bool
        errContains string
    }{
        {"no args", []string{}, true, "requires"},
        {"invalid flag", []string{"--invalid"}, true, "unknown flag"},
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            cmd := newCmd()
            cmd.SetArgs(tt.args)

            err := cmd.Execute()

            if (err != nil) != tt.wantErr {
                t.Errorf("error = %v, wantErr %v", err, tt.wantErr)
            }
        })
    }
}

Testing Checklist for CLI Commands

  • Help Text: Verify --help output is correct
  • Flag Parsing: All flags parse correctly (long and short forms)
  • Default Values: Flags use correct defaults when not specified
  • Required Args: Commands reject missing required arguments
  • Error Messages: Error messages are clear and helpful
  • Output Format: Output is formatted correctly
  • Exit Codes: Commands return appropriate exit codes
  • Global Flags: Global flags work with all subcommands
  • Flag Interactions: Conflicting flags handled correctly
  • Integration: End-to-end workflows function properly

Common CLI Testing Challenges

Challenge 1: Global State

Problem: Global variables (flags) persist between tests

Solution: Reset globals in each test

func resetGlobalFlags() {
    projectPath = getCwd()
    sessionID = ""
    verbose = false
}

func TestCmd(t *testing.T) {
    resetGlobalFlags()  // Reset before each test
    // ... test code
}

Challenge 2: Output Capture

Problem: Commands write to stdout/stderr

Solution: Use SetOut() and SetErr()

var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.SetErr(&buf)
cmd.Execute()
output := buf.String()

Challenge 3: File I/O

Problem: Commands read/write files

Solution: Use t.TempDir() for isolated test directories

func TestCmd(t *testing.T) {
    tmpDir := t.TempDir()  // Automatically cleaned up
    // ... use tmpDir for test files
}

Results

Coverage Achieved

Package: cmd/meta-cc
Before: 55.2%
After: 72.8%
Improvement: +17.6%

Test Functions: 8
Test Cases: 24
Time Investment: ~180 minutes

Efficiency Metrics

Average time per test: 22.5 minutes
Average time per test case: 7.5 minutes
Coverage gain per hour: ~6%

Source: Bootstrap-002 Test Strategy Development Framework: BAIME (Bootstrapped AI Methodology Engineering) Status: Production-ready, validated through 4 iterations

Reference in New Issue View Git Blame Copy Permalink