73b92fe688
This CL tries to connect 2 objectives:
- Examples should be close (the same package) to the original code,
such that they can participate in documentation.
- Examples should be runnable - such that they are not getting out of
sync with underlying API/implementation.
In case of etcd-client, the examples are assuming running 'integration'
style, i.e. thay do connect to fully functional etcd-server.
That would lead to a cyclic dependencies between modules:
- server depends on client (as client need to be lightweight)
- client (for test purposes) depend on server.
Go modules does not allow to distingush testing dependency from
prod-code dependency.
Thus to meet the objective:
- The examples are getting executed within testing/integration packages against real etcd
- The examples are symlinked to 'unit' tests, such that they included in documentation.
- Long-term the unit examples should get rewritten to use 'mocks' instead of real integration tests.
60 lines
1.6 KiB
Go
60 lines
1.6 KiB
Go
// Copyright 2017 The etcd Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package client_test
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"go.etcd.io/etcd/tests/v3/integration"
|
|
"go.etcd.io/etcd/v3/pkg/testutil"
|
|
"go.etcd.io/etcd/v3/pkg/transport"
|
|
)
|
|
|
|
var exampleEndpoints []string
|
|
var exampleTransport *http.Transport
|
|
|
|
func forUnitTestsRunInMockedContext(mocking func(), example func()) {
|
|
// For integration tests runs in the provided environment
|
|
example()
|
|
}
|
|
|
|
// TestMain sets up an etcd cluster if running the examples.
|
|
func TestMain(m *testing.M) {
|
|
tr, trerr := transport.NewTransport(transport.TLSInfo{}, time.Second)
|
|
if trerr != nil {
|
|
fmt.Fprintf(os.Stderr, "%v", trerr)
|
|
os.Exit(1)
|
|
}
|
|
cfg := integration.ClusterConfig{Size: 1}
|
|
clus := integration.NewClusterV3(nil, &cfg)
|
|
exampleEndpoints = []string{clus.Members[0].URL()}
|
|
exampleTransport = tr
|
|
v := m.Run()
|
|
clus.Terminate(nil)
|
|
if err := testutil.CheckAfterTest(time.Second); err != nil {
|
|
fmt.Fprintf(os.Stderr, "%v", err)
|
|
os.Exit(1)
|
|
}
|
|
|
|
if v == 0 {
|
|
testutil.MustCheckLeakedGoroutine()
|
|
}
|
|
os.Exit(v)
|
|
}
|