go_client

module
v0.0.0-...-5e6f6af Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 13, 2025 License: Apache-2.0

README

Milvus Go Client Test Framework

Overview

This is a comprehensive test framework for the Milvus Go Client, designed to validate various functionalities of the Milvus vector database client. The framework provides a structured approach to writing tests with reusable components and helper functions.

Framework Architecture

Directory Structure
/go_client/
├── testcases/           # Main test cases
│   ├── helper/          # Helper functions and utilities
│   │   ├── helper.go
│   │   ├── data_helper.go
│   │   └── collection_helper.go
│   ├── search_test.go   # Search functionality tests
│   ├── index_test.go    # Index management tests
│   └── ...
├── common/             # Common utilities and constants
└── base/               # Base infrastructure code
Key Components
  • Collection Preparation: Utilities for creating and managing collections
  • Data Generation: Tools for generating test data
  • Helper Functions: Common operations and validations
  • Test Cases: Organized by functionality

Writing Test Cases

Basic Test Structure
func TestYourFeature(t *testing.T) {
    // 1. Setup context and client
    ctx := hp.CreateContext(t, time.Second*common.DefaultTimeout)
    mc := createDefaultMilvusClient(ctx, t)

    // 2. Prepare collection
    prepare, schema := hp.CollPrepare.CreateCollection(
        ctx, t, mc,
        hp.NewCreateCollectionParams(hp.Int64Vec),
        hp.TNewFieldsOption(),
        hp.TNewSchemaOption(),
    )

    // 3. Insert test data
    prepare.InsertData(ctx, t, mc,
        hp.NewInsertParams(schema),
        hp.TNewDataOption(),
    )

    // 4. Execute test operations
    // ... your test logic here ...

    // 5. Validate results
    require.NoError(t, err)
    require.Equal(t, expected, actual)
}
Using Custom Parameters
  1. Collection Creation Parameters
fieldsOption := hp.TNewFieldsOption().
    TWithEnableAnalyzer(true).
    TWithAnalyzerParams(map[string]any{
        "tokenizer": "standard",
    })

schemaOption := hp.TNewSchemaOption().
    TWithEnableDynamicField(true).
    TWithDescription("Custom schema").
    TWithAutoID(false)
  1. Data Insertion Options
insertOption := hp.TNewDataOption().
    TWithNb(1000).           // Number of records
    TWithDim(128).           // Vector dimension
    TWithStart(100).         // Starting ID
    TWithMaxLen(256).        // Maximum length
    TWithTextLang("en")      // Text language
  1. Index Parameters
indexParams := hp.TNewIndexParams(schema).
    TWithFieldIndex(map[string]index.Index{
        common.DefaultVectorFieldName: index.NewIVFSQIndex(
            &index.IVFSQConfig{
                MetricType: entity.L2,
                NList:     128,
            },
        ),
    })
  1. Search Parameters
searchOpt := client.NewSearchOption(schema.CollectionName, 100, vectors).
    WithOffset(0).
    WithLimit(100).
    WithConsistencyLevel(entity.ClStrong).
    WithFilter("int64 >= 100").
    WithOutputFields([]string{"*"}).
    WithSearchParams(map[string]any{
        "nprobe": 16,
        "ef":     64,
    })

Adding New Parameters

  1. Define New Option Type
// In helper/data_helper.go
type YourNewOption struct {
    newParam1 string
    newParam2 int
}
  1. Add Constructor
func TNewYourOption() *YourNewOption {
    return &YourNewOption{
        newParam1: "default",
        newParam2: 0,
    }
}
  1. Add Parameter Methods
func (opt *YourNewOption) TWithNewParam1(value string) *YourNewOption {
    opt.newParam1 = value
    return opt
}

func (opt *YourNewOption) TWithNewParam2(value int) *YourNewOption {
    opt.newParam2 = value
    return opt
}

Best Practices

  1. Test Organization

    • Group related tests in the same file
    • Use clear and descriptive test names
    • Add comments explaining test purpose
  2. Data Generation

    • Use helper functions for generating test data
    • Ensure data is appropriate for the test case
    • Clean up test data after use
  3. Error Handling

    • Use common.CheckErr for consistent error checking
    • Test both success and failure scenarios
    • Validate error messages when appropriate
  4. Performance Considerations

    • Use appropriate timeouts
    • Clean up resources after tests
    • Consider test execution time

Running Tests

# Run all tests
go test ./testcases/...

# Run specific test
go test -run TestYourFeature ./testcases/

# Run with verbose output
go test -v ./testcases/...

Contributing

  1. Follow the existing code structure
  2. Add comprehensive test cases
  3. Document new parameters and options
  4. Update this README for significant changes
  5. Ensure code quality standards:
    • Run golangci-lint run to check for style mistakes
    • Use gofmt -w your/code/path to format your code before submitting
    • CI will verify both golint and go format compliance

Directories

Path Synopsis
testcases

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL