79 lines
2.1 KiB
Markdown
79 lines
2.1 KiB
Markdown
Consul Testing Utilities
|
|
========================
|
|
|
|
This package provides some generic helpers to facilitate testing in Consul.
|
|
|
|
TestServer
|
|
==========
|
|
|
|
TestServer is a harness for managing Consul agents and initializing them with
|
|
test data. Using it, you can form test clusters, create services, add health
|
|
checks, manipulate the K/V store, etc. This test harness is completely decoupled
|
|
from Consul's core and API client, meaning it can be easily imported and used in
|
|
external unit tests for various applications. It works by invoking the Consul
|
|
CLI, which means it is a requirement to have Consul installed in the `$PATH`.
|
|
|
|
Following is an example usage:
|
|
|
|
```go
|
|
package my_program
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/hashicorp/consul/consul/structs"
|
|
"github.com/hashicorp/consul/testutil"
|
|
)
|
|
|
|
func TestFoo_bar(t *testing.T) {
|
|
// Create a test Consul server
|
|
srv1, err := testutil.NewTestServer()
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer srv1.Stop()
|
|
|
|
// Create a secondary server, passing in configuration
|
|
// to avoid bootstrapping as we are forming a cluster.
|
|
srv2, err := testutil.NewTestServerConfig(t, func(c *testutil.TestServerConfig) {
|
|
c.Bootstrap = false
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer srv2.Stop()
|
|
|
|
// Join the servers together
|
|
srv1.JoinLAN(t, srv2.LANAddr)
|
|
|
|
// Create a test key/value pair
|
|
srv1.SetKV(t, "foo", []byte("bar"))
|
|
|
|
// Create lots of test key/value pairs
|
|
srv1.PopulateKV(t, map[string][]byte{
|
|
"bar": []byte("123"),
|
|
"baz": []byte("456"),
|
|
})
|
|
|
|
// Create a service
|
|
srv1.AddService(t, "redis", structs.HealthPassing, []string{"master"})
|
|
|
|
// Create a service that will be accessed in target source code
|
|
srv1.AddAccessibleService("redis", structs.HealthPassing, "127.0.0.1", 6379, []string{"master"})
|
|
|
|
// Create a service check
|
|
srv1.AddCheck(t, "service:redis", "redis", structs.HealthPassing)
|
|
|
|
// Create a node check
|
|
srv1.AddCheck(t, "mem", "", structs.HealthCritical)
|
|
|
|
// The HTTPAddr field contains the address of the Consul
|
|
// API on the new test server instance.
|
|
println(srv1.HTTPAddr)
|
|
|
|
// All functions also have a wrapper method to limit the passing of "t"
|
|
wrap := srv1.Wrap(t)
|
|
wrap.SetKV("foo", []byte("bar"))
|
|
}
|
|
```
|