etcd_harness

package module

v0.0.0-...-4dc1cb3 Latest Latest Go to latest Published: Mar 25, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mwitkow/go-etcd-harness

Links

Open Source Insights

README ¶

etcd Golang Integration Test Harness

Harness code that spins up and manages a local-only etcd server for Go (golang) integration tests.

It is meant to be used with suite-tests, such as testify Suites or gocheck fixtures, to leverage single startup of a test suite.

Features:

dynamic port allocation - multiple Harnesses can be run in parallel
dynamic data directory - each Harness has an independent data dirctory
full etcd server lifecycle management - start, stop and data cleanup
uses etcd from $PATH - makes it easy to test against an etcd version you run in production
typical boostrap of 400-500ms

Usage

Harness exports the official Golang client bindings under harness.Client. For raw access purposes harness.Endpoint returns the client-side endpoint of the etcd server.

For an example of usage that utilises testify Suites, please see harness_test.go.

Travis CI Configuration

If you're creating an open source project, chances are you're using Travis as your CI. Travis by default places your $GOPATH/bin on the build's $PATH. Since etcd Harness looks for the etcd binary in $PATH, using it is as easy as:

install:
  - go get github.com/coreos/etcd
  - go get github.com/mwitkow/go-etcd-harness
  ...

###License

etcd-harness is under the Apache 2.0 license. See the LICENSE file for details.

Documentation ¶

Index ¶

func LocalEtcdAvailable() bool
type Harness
- func New(etcdErrWriter io.Writer) (*Harness, error)
- func (s *Harness) Stop()

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func LocalEtcdAvailable ¶

func LocalEtcdAvailable() bool

LocalEtcdAvailable returns true if an etcd binary is available on PATH.

Types ¶

type Harness ¶

type Harness struct {
	Client   etcd.Client
	Endpoint string
	// contains filtered or unexported fields
}

Harness represents a running etcd server for an integraiton test environment.

func New ¶

func New(etcdErrWriter io.Writer) (*Harness, error)

New initializes and returns a new Harness. Failures here will be indicated as errors.

func (*Harness) Stop ¶

func (s *Harness) Stop()

Stop kills the harnessed etcd server and cleans up the data directory.

Source Files ¶

View all Source files

harness.go

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