KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use ShouldBuildImage method of testcontainers Package

Best Testcontainers-go code snippet using testcontainers.ShouldBuildImage

docker.go

Source:docker.go

...671		return nil, err672	}673	var tag string674	var platform *specs.Platform675	if req.ShouldBuildImage() {676		tag, err = p.BuildImage(ctx, &req)677		if err != nil {678			return nil, err679		}680	} else {681		tag = req.Image682		if req.ImagePlatform != "" {683			p, err := platforms.Parse(req.ImagePlatform)684			if err != nil {685				return nil, fmt.Errorf("invalid platform %s: %w", req.ImagePlatform, err)686			}687			platform = &p688		}689		var shouldPullImage bool690		if req.AlwaysPullImage {691			shouldPullImage = true // If requested always attempt to pull image692		} else {693			image, _, err := p.client.ImageInspectWithRaw(ctx, tag)694			if err != nil {695				if client.IsErrNotFound(err) {696					shouldPullImage = true697				} else {698					return nil, err699				}700			}701			if platform != nil && (image.Architecture != platform.Architecture || image.Os != platform.OS) {702				shouldPullImage = true703			}704		}705		if shouldPullImage {706			pullOpt := types.ImagePullOptions{707				Platform: req.ImagePlatform, // may be empty708			}709			if req.RegistryCred != "" {710				pullOpt.RegistryAuth = req.RegistryCred711			}712			if err := p.attemptToPullImage(ctx, tag, pullOpt); err != nil {713				return nil, err714			}715		}716	}717	dockerInput := &container.Config{718		Entrypoint:   req.Entrypoint,719		Image:        tag,720		Env:          env,721		ExposedPorts: exposedPortSet,722		Labels:       req.Labels,723		Cmd:          req.Cmd,724		Hostname:     req.Hostname,725		User:         req.User,726	}727	// prepare mounts728	mounts := mapToDockerMounts(req.Mounts)729	hostConfig := &container.HostConfig{730		ExtraHosts:   req.ExtraHosts,731		PortBindings: exposedPortMap,732		Mounts:       mounts,733		Tmpfs:        req.Tmpfs,734		AutoRemove:   req.AutoRemove,735		Privileged:   req.Privileged,736		NetworkMode:  req.NetworkMode,737		Resources:    req.Resources,738	}739	endpointConfigs := map[string]*network.EndpointSettings{}740	// #248: Docker allows only one network to be specified during container creation741	// If there is more than one network specified in the request container should be attached to them742	// once it is created. We will take a first network if any specified in the request and use it to create container743	if len(req.Networks) > 0 {744		attachContainerTo := req.Networks[0]745		nw, err := p.GetNetwork(ctx, NetworkRequest{746			Name: attachContainerTo,747		})748		if err == nil {749			endpointSetting := network.EndpointSettings{750				Aliases:   req.NetworkAliases[attachContainerTo],751				NetworkID: nw.ID,752			}753			endpointConfigs[attachContainerTo] = &endpointSetting754		}755	}756	networkingConfig := network.NetworkingConfig{757		EndpointsConfig: endpointConfigs,758	}759	resp, err := p.client.ContainerCreate(ctx, dockerInput, hostConfig, &networkingConfig, platform, req.Name)760	if err != nil {761		return nil, err762	}763	// #248: If there is more than one network specified in the request attach newly created container to them one by one764	if len(req.Networks) > 1 {765		for _, n := range req.Networks[1:] {766			nw, err := p.GetNetwork(ctx, NetworkRequest{767				Name: n,768			})769			if err == nil {770				endpointSetting := network.EndpointSettings{771					Aliases: req.NetworkAliases[n],772				}773				err = p.client.NetworkConnect(ctx, nw.ID, resp.ID, &endpointSetting)774				if err != nil {775					return nil, err776				}777			}778		}779	}780	c := &DockerContainer{781		ID:                resp.ID,782		WaitingFor:        req.WaitingFor,783		Image:             tag,784		imageWasBuilt:     req.ShouldBuildImage(),785		sessionID:         sessionID,786		provider:          p,787		terminationSignal: termSignal,788		skipReaper:        req.SkipReaper,789		stopProducer:      make(chan bool),790		logger:            p.Logger,791	}792	return c, nil793}794// attemptToPullImage tries to pull the image while respecting the ctx cancellations.795// Besides, if the image cannot be pulled due to ErrorNotFound then no need to retry but terminate immediately.796func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pullOpt types.ImagePullOptions) error {797	var (798		err  error...

container.go

Source:container.go

...55type ImageBuildInfo interface {56	GetContext() (io.Reader, error)   // the path to the build context57	GetDockerfile() string            // the relative path to the Dockerfile, including the fileitself58	ShouldPrintBuildLog() bool        // allow build log to be printed to stdout59	ShouldBuildImage() bool           // return true if the image needs to be built60	GetBuildArgs() map[string]*string // return the environment args used to build the from Dockerfile61}62// FromDockerfile represents the parameters needed to build an image from a Dockerfile63// rather than using a pre-built one64type FromDockerfile struct {65	Context        string             // the path to the context of of the docker build66	ContextArchive io.Reader          // the tar archive file to send to docker that contains the build context67	Dockerfile     string             // the path from the context to the Dockerfile for the image, defaults to "Dockerfile"68	BuildArgs      map[string]*string // enable user to pass build args to docker daemon69	PrintBuildLog  bool               // enable user to print build log70}71// ContainerRequest represents the parameters used to get a running container72type ContainerRequest struct {73	FromDockerfile74	Image           string75	Entrypoint      []string76	Env             map[string]string77	ExposedPorts    []string // allow specifying protocol info78	Cmd             []string79	Labels          map[string]string80	Mounts          ContainerMounts81	Tmpfs           map[string]string82	RegistryCred    string83	WaitingFor      wait.Strategy84	Name            string // for specifying container name85	Hostname        string86	ExtraHosts      []string87	Privileged      bool                // for starting privileged container88	Networks        []string            // for specifying network names89	NetworkAliases  map[string][]string // for specifying network aliases90	NetworkMode     container.NetworkMode91	Resources       container.Resources92	User            string // for specifying uid:gid93	SkipReaper      bool   // indicates whether we skip setting up a reaper for this94	ReaperImage     string // alternative reaper image95	AutoRemove      bool   // if set to true, the container will be removed from the host when stopped96	AlwaysPullImage bool   // Always pull image97	ImagePlatform   string // ImagePlatform describes the platform which the image runs on.98}99type (100	// ProviderType is an enum for the possible providers101	ProviderType int102	// GenericProviderOptions defines options applicable to all providers103	GenericProviderOptions struct {104		Logger Logging105	}106	// GenericProviderOption defines a common interface to modify GenericProviderOptions107	// These options can be passed to GetProvider in a variadic way to customize the returned GenericProvider instance108	GenericProviderOption interface {109		ApplyGenericTo(opts *GenericProviderOptions)110	}111	// GenericProviderOptionFunc is a shorthand to implement the GenericProviderOption interface112	GenericProviderOptionFunc func(opts *GenericProviderOptions)113)114func (f GenericProviderOptionFunc) ApplyGenericTo(opts *GenericProviderOptions) {115	f(opts)116}117// possible provider types118const (119	ProviderDocker ProviderType = iota // Docker is default = 0120)121// GetProvider provides the provider implementation for a certain type122func (t ProviderType) GetProvider(opts ...GenericProviderOption) (GenericProvider, error) {123	opt := &GenericProviderOptions{124		Logger: Logger,125	}126	for _, o := range opts {127		o.ApplyGenericTo(opt)128	}129	switch t {130	case ProviderDocker:131		provider, err := NewDockerProvider(Generic2DockerOptions(opts...)...)132		if err != nil {133			return nil, fmt.Errorf("%w, failed to create Docker provider", err)134		}135		return provider, nil136	}137	return nil, errors.New("unknown provider")138}139// Validate ensures that the ContainerRequest does not have invalid parameters configured to it140// ex. make sure you are not specifying both an image as well as a context141func (c *ContainerRequest) Validate() error {142	validationMethods := []func() error{143		c.validateContextAndImage,144		c.validateContextOrImageIsSpecified,145		c.validateMounts,146	}147	var err error148	for _, validationMethod := range validationMethods {149		err = validationMethod()150		if err != nil {151			return err152		}153	}154	return nil155}156// GetContext retrieve the build context for the request157func (c *ContainerRequest) GetContext() (io.Reader, error) {158	if c.ContextArchive != nil {159		return c.ContextArchive, nil160	}161	buildContext, err := archive.TarWithOptions(c.Context, &archive.TarOptions{})162	if err != nil {163		return nil, err164	}165	return buildContext, nil166}167// GetBuildArgs returns the env args to be used when creating from Dockerfile168func (c *ContainerRequest) GetBuildArgs() map[string]*string {169	return c.FromDockerfile.BuildArgs170}171// GetDockerfile returns the Dockerfile from the ContainerRequest, defaults to "Dockerfile"172func (c *ContainerRequest) GetDockerfile() string {173	f := c.FromDockerfile.Dockerfile174	if f == "" {175		return "Dockerfile"176	}177	return f178}179func (c *ContainerRequest) ShouldBuildImage() bool {180	return c.FromDockerfile.Context != "" || c.FromDockerfile.ContextArchive != nil181}182func (c *ContainerRequest) ShouldPrintBuildLog() bool {183	return c.FromDockerfile.PrintBuildLog184}185func (c *ContainerRequest) validateContextAndImage() error {186	if c.FromDockerfile.Context != "" && c.Image != "" {187		return errors.New("you cannot specify both an Image and Context in a ContainerRequest")188	}189	return nil190}191func (c *ContainerRequest) validateContextOrImageIsSpecified() error {192	if c.FromDockerfile.Context == "" && c.FromDockerfile.ContextArchive == nil && c.Image == "" {193		return errors.New("you must specify either a build context or an image")...

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	ctx := context.Background()4	req := testcontainers.ContainerRequest{5		ExposedPorts: []string{"80/tcp"},6		WaitingFor:   wait.ForListeningPort("80/tcp"),7	}8	if testcontainers.ShouldBuildImage(ctx, req) {9		fmt.Println("Image is not present locally")10	} else {11		fmt.Println("Image is present locally")12	}13}

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	ctx := context.Background()4	req := testcontainers.ContainerRequest{5		ExposedPorts: []string{"3306/tcp"},6		WaitingFor:   wait.ForListeningPort("3306/tcp"),7	}8	mysql, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{9	})10	if err != nil {11		panic(err)12	}13	defer mysql.Terminate(ctx)14	fmt.Println("MySQL container is up and running!")15}

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	ctx := context.Background()4	req := testcontainers.ContainerRequest{5		ExposedPorts: []string{"80/tcp"},6		WaitingFor:   wait.ForListeningPort("80/tcp"),7	}8	provider, err := testcontainers.NewDockerProvider()9	if err != nil {10		log.Fatal(err)11	}12	shouldBuild, err := provider.ShouldBuildImage(ctx, req)13	if err != nil {14		log.Fatal(err)15	}16	fmt.Println(shouldBuild)17	provider.StartContainer(ctx, req)18	provider.StopContainer(ctx, req)19	provider.RemoveContainer(ctx, req)20	provider.RemoveImage(ctx, req)21}22import (23func main() {24	ctx := context.Background()25	req := testcontainers.ContainerRequest{26		ExposedPorts: []string{"80/tcp"},27		WaitingFor:   wait.ForListeningPort("80/tcp"),28	}

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	ctx := context.Background()4	req := testcontainers.ContainerRequest{5		Cmd:          []string{"echo", "hello world"},6		ExposedPorts: []string{"80/tcp"},7		WaitingFor:   wait.ForLog("hello world"),8	}9	provider, err := testcontainers.NewDockerProvider()10	if err != nil {11		panic(err)12	}13	exists, err := provider.ShouldBuildImage(ctx, req)14	if err != nil {15		panic(err)16	}17	fmt.Println(exists)18	exists, err = provider.ShouldBuildImage(ctx, req)19	if err != nil {20		panic(err)21	}22	fmt.Println(exists)23	exists, err = provider.ShouldBuildImage(ctx, req)24	if err != nil {25		panic(err)26	}

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	req := testcontainers.ContainerRequest{4		ExposedPorts: []string{"80/tcp"},5		WaitingFor:   wait.ForLog("Starting nginx"),6	}7	ctx := context.Background()8	provider, _ := testcontainers.NewDockerProvider()9	provider.ShouldPullImage(ctx, req)10}

ShouldBuildImage

Using AI Code Generation

1func TestShouldBuildImage(t *testing.T) {2    ctx := context.Background()3    req := testcontainers.ContainerRequest{4        Cmd:   []string{"echo", "hello world"},5    }6    resp, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{7    })8    if err != nil {9        t.Fatal(err)10    }11    defer resp.Terminate(ctx)12    log.Println("Container ID: ", resp.GetContainerID())13    log.Println("Container IP: ", resp.GetContainerIP())14    log.Println("Container Name: ", resp.GetContainerName())15    log.Println("Container Host: ", resp.GetHost())16}17func TestShouldBuildImage(t *testing.T) {18    ctx := context.Background()19    req := testcontainers.ContainerRequest{20        Cmd:   []string{"echo", "hello world"},21    }22    resp, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{23    })24    if err != nil {25        t.Fatal(err)26    }27    defer resp.Terminate(ctx)28    log.Println("Container ID: ", resp.GetContainerID())29    log.Println("Container IP: ", resp.GetContainerIP())30    log.Println("Container Name: ", resp.GetContainerName())31    log.Println("Container Host: ", resp.GetHost())32}33func TestShouldBuildImage(t *testing.T) {34    ctx := context.Background()35    req := testcontainers.ContainerRequest{36        Cmd:   []string{"echo", "hello world"},37    }38    resp, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{39    })40    if err != nil {41        t.Fatal(err)42    }43    defer resp.Terminate(ctx)44    log.Println("Container ID: ", resp.GetContainerID())45    log.Println("Container IP: ", resp.GetContainerIP())46    log.Println("Container Name: ", resp.GetContainerName())47    log.Println("Container Host: ", resp.GetHost())

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3	ctx := context.Background()4	req := testcontainers.ContainerRequest{5		ExposedPorts: []string{"80/tcp"},6		WaitingFor:   wait.ForLog("listening on IPv4 address"),7	}8	container, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{9	})10	if err != nil {11		log.Fatal(err)12	}13	defer container.Terminate(ctx)14	ip, err := container.Host(ctx)15	if err != nil {16		log.Fatal(err)17	}18	port, err := container.MappedPort(ctx, "80")19	if err != nil {20		log.Fatal(err)21	}22	fmt.Println(url)23}24import (

ShouldBuildImage

Using AI Code Generation

1import (2func main() {3    ctx := context.Background()4    req := testcontainers.ContainerRequest{5        Cmd:          []string{"echo", "hello world"},6        WaitingFor:   wait.ForLog("hello world"),7    }8    container, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{9    })10    if err != nil {11        panic(err)12    }13    id, err := container.ContainerID(ctx)14    if err != nil {15        panic(err)16    }

ShouldBuildImage

Using AI Code Generation

1func TestShouldBuildImage(t *testing.T) {2	ctx := context.Background()3	cli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())4	if err != nil {5		panic(err)6	}7	tc := testcontainers.NewTestContainer(ctx, testcontainers.GenericContainerRequest{8		ContainerRequest: dockercontainer.ContainerRequest{9			ExposedPorts: []string{"80/tcp"},10			HostConfig: dockercontainer.HostConfig{11				PortBindings: nat.PortMap{12					"80/tcp": []nat.PortBinding{13						{

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.