Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove custom built docker image on container termination #405

Merged
merged 2 commits into from
Feb 28, 2022
Merged

Remove custom built docker image on container termination #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f676b8
Remove custom built docker image on container termination
gaborszakacs Feb 14, 2022
e98e4e1
Clarify test name
gaborszakacs Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions docker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ type DockerContainer struct {
WaitingFor wait.Strategy
Image string

imageWasBuilt bool
provider *DockerProvider
sessionID uuid.UUID
terminationSignal chan bool
Expand Down Expand Up @@ -192,15 +193,26 @@ func (c *DockerContainer) Terminate(ctx context.Context) error {
RemoveVolumes: true,
Force: true,
})
if err != nil {
return err
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! It seems we missed to handle this error

}

if err == nil {
if err := c.provider.client.Close(); err != nil {
if c.imageWasBuilt {
_, err := c.provider.client.ImageRemove(ctx, c.Image, types.ImageRemoveOptions{
Force: true,
PruneChildren: true,
})
if err != nil {
return err
}
c.sessionID = uuid.UUID{}
}

return err
if err := c.provider.client.Close(); err != nil {
return err
}

c.sessionID = uuid.UUID{}
return nil
}

// update container raw info
Expand Down Expand Up @@ -876,6 +888,7 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
ID: resp.ID,
WaitingFor: req.WaitingFor,
Image: tag,
imageWasBuilt: req.ShouldBuildImage(),
sessionID: sessionID,
provider: p,
terminationSignal: termSignal,
Expand Down
90 changes: 75 additions & 15 deletions docker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ func TestContainerAttachedToNewNetwork(t *testing.T) {
CheckDuplicate: true,
},
})

if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -292,7 +291,8 @@ func TestContainerStartsWithoutTheReaper(t *testing.T) {
Image: "nginx",
ExposedPorts: []string{
"80/tcp",
"gotest.tools/assert"},
"gotest.tools/assert",
},
SkipReaper: true,
},
Started: true,
Expand Down Expand Up @@ -460,6 +460,76 @@ func TestContainerTerminationWithoutReaper(t *testing.T) {
}
}

func TestContainerTerminationRemovesDockerImage(t *testing.T) {
t.Run("if not built from Dockerfile", func(t *testing.T) {
ctx := context.Background()
client, err := client.NewClientWithOpts(client.FromEnv)
if err != nil {
t.Fatal(err)
}
client.NegotiateAPIVersion(ctx)
container, err := GenericContainer(ctx, GenericContainerRequest{
ContainerRequest: ContainerRequest{
Image: "nginx",
ExposedPorts: []string{
"80/tcp",
},
SkipReaper: true,
},
Started: true,
})
if err != nil {
t.Fatal(err)
}
err = container.Terminate(ctx)
if err != nil {
t.Fatal(err)
}
_, _, err = client.ImageInspectWithRaw(ctx, "nginx")
if err != nil {
t.Fatal("nginx image should not have been removed")
}
})

t.Run("if built from Dockerfile", func(t *testing.T) {
ctx := context.Background()
client, err := client.NewClientWithOpts(client.FromEnv)
if err != nil {
t.Fatal(err)
}
client.NegotiateAPIVersion(ctx)
req := ContainerRequest{
FromDockerfile: FromDockerfile{
Context: "./testresources",
},
ExposedPorts: []string{"6379/tcp"},
WaitingFor: wait.ForLog("Ready to accept connections"),
}
container, err := GenericContainer(ctx, GenericContainerRequest{
ContainerRequest: req,
Started: true,
})
if err != nil {
t.Fatal(err)
}
containerID := container.GetContainerID()
resp, err := client.ContainerInspect(ctx, containerID)
if err != nil {
t.Fatal(err)
}
imageID := resp.Config.Image

err = container.Terminate(ctx)
if err != nil {
t.Fatal(err)
}
_, _, err = client.ImageInspectWithRaw(ctx, imageID)
if err == nil {
t.Fatal("custom built image should have been removed")
}
})
}

func TestTwoContainersExposingTheSamePort(t *testing.T) {
ctx := context.Background()
nginxA, err := GenericContainer(ctx, GenericContainerRequest{
Expand Down Expand Up @@ -927,7 +997,6 @@ func Test_BuildContainerFromDockerfileWithBuildArgs(t *testing.T) {
}

c, err := GenericContainer(ctx, genContainerReq)

if err != nil {
t.Fatal(err)
}
Expand All @@ -938,13 +1007,11 @@ func Test_BuildContainerFromDockerfileWithBuildArgs(t *testing.T) {
}

resp, err := http.Get(ep + "/env")

if err != nil {
t.Fatal(err)
}

body, err := ioutil.ReadAll(resp.Body)

if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -985,7 +1052,6 @@ func Test_BuildContainerFromDockerfileWithBuildLog(t *testing.T) {
}

c, err := GenericContainer(ctx, genContainerReq)

if err != nil {
t.Fatal(err)
}
Expand All @@ -1007,7 +1073,6 @@ func Test_BuildContainerFromDockerfileWithBuildLog(t *testing.T) {
if temp[0] != "Step 1/1 : FROM alpine" {
t.Errorf("Expected stout firstline to be %s. Got '%s'.", "Step 1/2 : FROM alpine", temp[0])
}

}

func TestContainerCreationWaitsForLogAndPortContextTimeout(t *testing.T) {
Expand All @@ -1032,7 +1097,6 @@ func TestContainerCreationWaitsForLogAndPortContextTimeout(t *testing.T) {
if err == nil {
t.Fatal("Expected timeout")
}

}

func TestContainerCreationWaitingForHostPort(t *testing.T) {
Expand Down Expand Up @@ -1100,7 +1164,6 @@ func TestContainerCreationWaitsForLogAndPort(t *testing.T) {
ContainerRequest: req,
Started: true,
})

if err != nil {
t.Fatal(err)
}
Expand All @@ -1120,7 +1183,6 @@ func TestContainerCreationWaitsForLogAndPort(t *testing.T) {
"root", "password", host, port, "database")

db, err := sql.Open("mysql", connectionString)

if err != nil {
t.Fatal(err)
}
Expand All @@ -1130,7 +1192,6 @@ func TestContainerCreationWaitsForLogAndPort(t *testing.T) {
if err = db.Ping(); err != nil {
t.Errorf("error pinging db: %+v\n", err)
}

}

func TestCMD(t *testing.T) {
Expand All @@ -1154,7 +1215,6 @@ func TestCMD(t *testing.T) {
ContainerRequest: req,
Started: true,
})

if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -1184,7 +1244,6 @@ func TestEntrypoint(t *testing.T) {
ContainerRequest: req,
Started: true,
})

if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -1239,7 +1298,8 @@ func TestReadTCPropsFile(t *testing.T) {
0,
"",
},
{`docker.host = tcp://127.0.0.1:33293
{
`docker.host = tcp://127.0.0.1:33293
docker.host = tcp://127.0.0.1:4711
docker.host = tcp://127.0.0.1:1234
docker.tls.verify = 1
Expand Down Expand Up @@ -1437,7 +1497,7 @@ func TestContainerWithTmpFs(t *testing.T) {
}
}()

var path = "/testtmpfs/test.file"
path := "/testtmpfs/test.file"

c, err := container.Exec(ctx, []string{"ls", path})
if err != nil {
Expand Down