github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/integration/resources/docker/dockerexternal/etcd_options.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package dockerexternal
    22  
    23  // EtcdClusterOption configure an etcd cluster.
    24  type EtcdClusterOption interface {
    25  	apply(opts *etcdClusterOptions)
    26  }
    27  
    28  type etcdClusterOptions struct {
    29  	useBridge bool
    30  	port      int
    31  }
    32  
    33  // EtcdClusterUseBridge configures an EtcdNode to insert a networking "bridge" between the etcd container and the
    34  // calling processes. The bridge intercepts network traffic, and forwards it, unless told not to via e.g. Blackhole().
    35  // See the bridge package.
    36  // As noted in that package, this implementation is lifted directly from the etcd/integration package; all credit goes
    37  // to etcd authors for the approach.
    38  func EtcdClusterUseBridge(shouldUseBridge bool) EtcdClusterOption {
    39  	return useBridge(shouldUseBridge)
    40  }
    41  
    42  type useBridge bool
    43  
    44  func (u useBridge) apply(opts *etcdClusterOptions) {
    45  	opts.useBridge = bool(u)
    46  }
    47  
    48  // EtcdClusterPort sets a specific port for etcd to listen on. Default is to listen on :0 (any free port).
    49  func EtcdClusterPort(port int) EtcdClusterOption {
    50  	return withPort(port)
    51  }
    52  
    53  type withPort int
    54  
    55  func (w withPort) apply(opts *etcdClusterOptions) {
    56  	opts.port = int(w)
    57  }