github.com/m3db/m3@v1.5.0/src/integration/resources/docker/options.go (about)

     1  // Copyright (c) 2020 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 docker
    22  
    23  // Image represents a docker image.
    24  type Image struct {
    25  	Name string
    26  	Tag  string
    27  }
    28  
    29  type setupOptions struct {
    30  	dbNodeImage      Image
    31  	coordinatorImage Image
    32  
    33  	existingCluster          bool
    34  	dbNodeContainerName      string
    35  	coordinatorContainerName string
    36  }
    37  
    38  // SetupOptions is a setup option.
    39  type SetupOptions func(*setupOptions)
    40  
    41  // WithDBNodeImage sets an option to use an image name and tag for the DB node.
    42  func WithDBNodeImage(name, tag string) SetupOptions {
    43  	return func(o *setupOptions) {
    44  		o.dbNodeImage = Image{Name: name, Tag: tag}
    45  	}
    46  }
    47  
    48  // WithCoordinatorImage sets an option to use an image name and tag for the coordinator.
    49  func WithCoordinatorImage(name, tag string) SetupOptions {
    50  	return func(o *setupOptions) {
    51  		o.coordinatorImage = Image{Name: name, Tag: tag}
    52  	}
    53  }
    54  
    55  // WithExistingCluster sets the names of already running containers dbnode and coordinator
    56  // containers that should be used for tests.
    57  func WithExistingCluster(dbNodeContainerName, coordinatorContainerName string) SetupOptions {
    58  	return func(o *setupOptions) {
    59  		o.existingCluster = true
    60  		o.dbNodeContainerName = dbNodeContainerName
    61  		o.coordinatorContainerName = coordinatorContainerName
    62  	}
    63  }