vearch

Documentation

Index

• type VearchContainer
  • func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*VearchContainer, error)
  • func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*VearchContainer, error)
  • func (c *VearchContainer) RESTEndpoint(ctx context.Context) (string, error)

Examples

• Run

Types

type VearchContainer

type VearchContainer struct {
	testcontainers.Container
}

VearchContainer represents the Vearch container type used in the module

func Run

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*VearchContainer, error)

Run creates an instance of the Vearch container type

Example

// runVearchContainer {
ctx := context.Background()

vearchContainer, err := vearch.Run(ctx, "vearch/vearch:3.5.1")
defer func() {
	if err := testcontainers.TerminateContainer(vearchContainer); err != nil {
		log.Printf("failed to terminate container: %s", err)
	}
}()
if err != nil {
	log.Printf("failed to start container: %s", err)
	return
}
// }

state, err := vearchContainer.State(ctx)
if err != nil {
	log.Printf("failed to get container state: %s", err)
	return
}

fmt.Println(state.Running)

Output:

true

func RunContainer

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*VearchContainer, error)

Deprecated: use Run instead RunContainer creates an instance of the Vearch container type

func (*VearchContainer) RESTEndpoint

func (c *VearchContainer) RESTEndpoint(ctx context.Context) (string, error)

RESTEndpoint returns the REST endpoint of the Vearch container