modeltest

package
v0.62.0 Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package modeltest provides reusable contract tests for Core model interfaces. Provider tests run real SDK transports against local servers to check request immutability, ordered results, stream errors, cancellation, and teardown. Production code must not import this package.

Example 
package main

import (
	"fmt"
	"iter"

	"github.com/Tangerg/scope/core/modeltest"
)

func main() {
	sequence := iter.Seq2[string, error](func(yield func(string, error) bool) {
		yield("first", nil)
		yield("second", nil)
	})
	values, err := modeltest.Collect(sequence)
	fmt.Println(values, err)
}

Output:
[first second] <nil>

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func AnthropicSSEServer 

func AnthropicSSEServer(events []AnthropicEvent) *httptest.Server

AnthropicSSEServer emits named events in the supplied order. The caller supplies the complete event sequence and owns server cleanup.

func BinaryServer 

func BinaryServer(status int, contentType string, body []byte, inspections ...func(request *http.Request)) *httptest.Server

BinaryServer is JSONServer for a non-JSON body of the given content type.

func Collect 

func Collect[T any](seq iter.Seq2[T, error]) ([]T, error)

Collect stops at the first error and returns values yielded before it.

func CollectN 

func CollectN[T any](sequence iter.Seq2[T, error], count int) ([]T, error)

CollectN returns at most count values, stopping on the first error. A nonpositive count does not start the iterator.

func JSONServer 

func JSONServer(status int, body string, inspections ...func(request *http.Request)) *httptest.Server

JSONServer answers every request with body and status. Inspections run before the response is written and receive the live request; read the body during inspection, because it is unavailable after the handler returns.

func LookupEnv 

func LookupEnv(name string) (string, bool)

LookupEnv treats an empty value as absent.

func MuxServer 

func MuxServer(routes ...Route) *httptest.Server

MuxServer matches routes in order; place a catch-all last. The caller owns server cleanup.

func OpenAISSEServer 

func OpenAISSEServer(chunks []string) *httptest.Server

OpenAISSEServer frames JSON chunks as data events followed by [DONE]. The caller owns the server and must close it after use.

func RequireEnv 

func RequireEnv(t *testing.T, name string) string

RequireEnv skips the test when the named environment variable is empty.

func RequireKey 

func RequireKey(t *testing.T, provider string) string

RequireKey reads SCOPE_TEST_<PROVIDER>_KEY and skips the test when empty.

func RunChatBehaviorContract added in v0.36.0 

func RunChatBehaviorContract(t *testing.T, contract ChatBehaviorContract)

func RunChatContract added in v0.36.0 

func RunChatContract(t *testing.T, contract ChatContract)

func RunEmbeddingContract 

func RunEmbeddingContract(t *testing.T, contract EmbeddingContract)

func RunHTTPClientContract added in v0.58.0 

func RunHTTPClientContract(t *testing.T, contract HTTPClientContract)

The default-transport probe changes process state and must run sequentially.

func RunIntegrationEmbedding 

func RunIntegrationEmbedding(t *testing.T, probe IntegrationEmbeddingProbe)

func RunIntegrationRerank added in v0.12.0 

func RunIntegrationRerank(t *testing.T, probe IntegrationRerankProbe)

Live results may change ordering; validation checks request-relative bounds.

func RunRerankContract added in v0.12.0 

func RunRerankContract(t *testing.T, contract RerankContract)

RunRerankContract checks the wire request and the effective result limit: Core owns how a request limit, the default and the document count combine, and how many results the response must then hold.

Types

type AnthropicEvent 

type AnthropicEvent struct {
	Event string
	Data  string
}

type CallBehaviorCase 

type CallBehaviorCase struct {
	Model     chat.Model
	Lifecycle Lifecycle
}

type ChatBehaviorContract added in v0.36.0 

type ChatBehaviorContract struct {
	Request            func(t *testing.T) *chat.Request
	CallCancellation   func(t *testing.T) CallBehaviorCase
	StreamCancellation func(t *testing.T) StreamBehaviorCase
	EarlyStop          func(t *testing.T) StreamBehaviorCase
	FirstError         func(t *testing.T) chat.Streamer
}

Each factory must return fresh state backed by the provider transport.

type ChatContract added in v0.36.0 

type ChatContract struct {
	New              func(t *testing.T) (chat.Model, chat.Streamer)
	Request          func(t *testing.T) *chat.Request
	AssertCall       func(t *testing.T, response *chat.Response)
	AssertStream     func(t *testing.T, deltas []*chat.ResponseDelta)
	AssertAggregated func(t *testing.T, response *chat.Response)
}

New and Request must return fresh state for each Call and Stream subtest.

type EmbeddingContract 

type EmbeddingContract struct {
	ModelID string
	// Response must encode two embeddings matching ExpectedEmbeddings in order.
	Response string
	// InputField names the provider JSON field containing the ordered input texts.
	InputField string

	ExpectedEmbeddings [][]float64
	// An empty path skips the URL-path assertion.
	ExpectedPath string

	Build func(t *testing.T, baseURL string) embedding.Model
}

type HTTPClientContract added in v0.58.0 

type HTTPClientContract struct {
	// Return each client initialized by the binding so independent protocol
	// clients cannot accidentally share a mutable configuration slot.
	Build func(t *testing.T, baseURL string, borrowed *http.Client) []*http.Client
}

type IntegrationEmbeddingProbe 

type IntegrationEmbeddingProbe struct {
	Provider string
	Build    func(t *testing.T, key string) embedding.Model
}

type IntegrationRerankProbe added in v0.12.0 

type IntegrationRerankProbe struct {
	Provider string
	Build    func(t *testing.T, key string) rerank.Model
}

type Lifecycle 

type Lifecycle struct {
	Started <-chan struct{}
	Stopped <-chan struct{}
}

Lifecycle observes one in-flight provider request. Started closes after the mock has sent any initial stream event; Stopped closes when the request context is released and the handler exits.

func NewBlockingServer 

func NewBlockingServer(t *testing.T, writeInitial func(http.ResponseWriter)) (*httptest.Server, Lifecycle)

NewBlockingServer holds one request until cancellation. Lifecycle signals allow tests to synchronize with the initial write and handler exit.

type RerankContract added in v0.12.0 

type RerankContract struct {
	ModelID string
	// Response must be valid for a three-document query capped at two results.
	Response string

	ExpectedPath string
	// LimitField is the wire member carrying the effective result limit, and
	// ResultsField the response member listing {index, relevance_score} items.
	LimitField, ResultsField string

	// Build constructs the model against baseURL with defaults as its
	// DefaultOptions.
	Build func(t *testing.T, baseURL string, defaults rerank.Options) rerank.Model
}

type Route 

type Route struct {
	Method   string
	Contains string
	Handle   http.HandlerFunc
}

Route answers requests whose method equals Method and whose URL path contains Contains; an empty Method or Contains matches any method or path.

type StreamBehaviorCase 

type StreamBehaviorCase struct {
	Streamer  chat.Streamer
	Lifecycle Lifecycle
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.