e2e | Robust framework for running complex workload scenarios | Testing library

Let's go through an example leveraging go test flow:.
Get e2e Go module to your go.mod using go get github.com/efficientgo/e2e.
Implement test. Start by creating environment. Currently e2e supports Docker environment only. Use unique name for all your tests. It's recommended to keep it stable so resources are consistently cleaned. // Start isolated environment with given ref. e, err := e2e.NewDockerEnvironment("e2e_example") testutil.Ok(t, err) // Make sure resources (e.g docker containers, network, dir) are cleaned. t.Cleanup(e.Close)
Implement the workload by embeddinge2e.Runnable or *e2e.InstrumentedRunnable. Or you can use existing ones in e2edb package. For example implementing function that schedules Jaeger with our desired configuration could look like this: // Setup Jaeger for example purposes, on how easy is to setup tracing pipeline in e2e framework. j := e.Runnable("tracing"). WithPorts( map[string]int{ "http.front": 16686, "jaeger.thrift": 14268, }). Init(e2e.StartOptions{Image: "jaegertracing/all-in-one:1.25"})
Program your scenario as you want. You can start, wait for their readiness, stop, check their metrics and use their network endpoints from both unit test (Endpoint) as well as within each workload (InternalEndpoint). You can also access workload directory. There is a shared directory across all workloads. Check Dir and InternalDir runnable methods. // Create structs for Prometheus containers scraping itself. p1 := e2edb.NewPrometheus(e, "prometheus-1") s1 := e2edb.NewThanosSidecar(e, "sidecar-1", p1) p2 := e2edb.NewPrometheus(e, "prometheus-2") s2 := e2edb.NewThanosSidecar(e, "sidecar-2", p2) // Create Thanos Query container. We can point the peer network addresses of both Prometheus instance // using InternalEndpoint methods, even before they started. t1 := e2edb.NewThanosQuerier(e, "query-1", []string{s1.InternalEndpoint("grpc"), s2.InternalEndpoint("grpc")}) // Start them. testutil.Ok(t, e2e.StartAndWaitReady(p1, s1, p2, s2, t1)) // To ensure query should have access we can check its Prometheus metric using WaitSumMetrics method. Since the metric we are looking for // only appears after init, we add option to wait for it. testutil.Ok(t, t1.WaitSumMetricsWithOptions(e2e.Equals(2), []string{"thanos_store_nodes_grpc_connections"}, e2e.WaitMissingMetrics())) // To ensure Prometheus scraped already something ensure number of scrapes. testutil.Ok(t, p1.WaitSumMetrics(e2e.Greater(50), "prometheus_tsdb_head_samples_appended_total")) testutil.Ok(t, p2.WaitSumMetrics(e2e.Greater(50), "prometheus_tsdb_head_samples_appended_total")) // We can now query Thanos Querier directly from here, using it's host address thanks to Endpoint method. a, err := api.NewClient(api.Config{Address: "http://" + t1.Endpoint("http")}) testutil.Ok(t, err) { now := model.Now() v, w, err := v1.NewAPI(a).Query(context.Background(), "up{}", now.Time()) testutil.Ok(t, err) testutil.Equals(t, 0, len(w)) testutil.Equals( t, fmt.Sprintf(`up{instance="%v", job="myself", prometheus="prometheus-1"} => 1 @[%v] up{instance="%v", job="myself", prometheus="prometheus-2"} => 1 @[%v]`, p1.InternalEndpoint(e2edb.AccessPortName), now, p2.InternalEndpoint(e2edb.AccessPortName), now), v.String(), ) } // Stop first Prometheus and sidecar. testutil.Ok(t, s1.Stop()) testutil.Ok(t, p1.Stop()) // Wait a bit until Thanos drops connection to stopped Prometheus. testutil.Ok(t, t1.WaitSumMetricsWithOptions(e2e.Equals(1), []string{"thanos_store_nodes_grpc_connections"}, e2e.WaitMissingMetrics())) { now := model.Now() v, w, err := v1.NewAPI(a).Query(context.Background(), "up{}", now.Time()) testutil.Ok(t, err) testutil.Equals(t, 0, len(w)) testutil.Equals( t, fmt.Sprintf(`up{instance="%v", job="myself", prometheus="prometheus-2"} => 1 @[%v]`, p2.InternalEndpoint(e2edb.AccessPortName), now), v.String(), ) } }