Skip to content

Commit

Permalink
Add tests for volume plugins
Browse files Browse the repository at this point in the history
This involves a new test binary (a basic implementation of the
volume plugin protocol) and a new image on quay.io (Containerfile
to produce it and all sources located in this commit). The image
is used to run a containerized plugin we can test against.

Signed-off-by: Matthew Heon <[email protected]>
  • Loading branch information
mheon committed Jan 14, 2021
1 parent b53cb57 commit f781efd
Show file tree
Hide file tree
Showing 9 changed files with 529 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ release.txt
/test/checkseccomp/checkseccomp
/test/copyimg/copyimg
/test/goecho/goecho
/test/testvol/testvol
.vscode*
result
# Necessary to prevent hack/tree-status.sh false-positive
Expand Down
10 changes: 10 additions & 0 deletions Containerfile-testvol
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM golang:1.15-alpine AS build-img
COPY ./test/testvol/ /go/src/github.com/containers/podman/cmd/testvol/
COPY ./vendor /go/src/github.com/containers/podman/vendor/
WORKDIR /go/src/github.com/containers/podman
RUN go build -o /testvol ./cmd/testvol

FROM alpine
COPY --from=build-img /testvol /usr/local/bin
WORKDIR /
ENTRYPOINT ["/usr/local/bin/testvol"]
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,14 @@ gofmt: ## Verify the source code gofmt
test/checkseccomp/checkseccomp: .gopathok $(wildcard test/checkseccomp/*.go)
$(GO) build $(BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -tags "$(BUILDTAGS)" -o $@ ./test/checkseccomp

.PHONY: test/testvol/testvol
test/testvol/testvol: .gopathok $(wildcard test/testvol/*.go)
$(GO) build $(BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -o $@ ./test/testvol

.PHONY: volume-plugin-test-image
volume-plugin-test-img:
podman build -t quay.io/libpod/volume-plugin-test-img -f Containerfile-testvol .

.PHONY: test/goecho/goecho
test/goecho/goecho: .gopathok $(wildcard test/goecho/*.go)
$(GO) build $(BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -o $@ ./test/goecho
Expand Down
10 changes: 2 additions & 8 deletions test/e2e/common_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ var _ = SynchronizedBeforeSuite(func() []byte {
}

// Pull cirros but don't put it into the cache
pullImages := []string{cirros, fedoraToolbox}
pullImages := []string{cirros, fedoraToolbox, volumeTest}
pullImages = append(pullImages, CACHE_IMAGES...)
for _, image := range pullImages {
podman.createArtifact(image)
Expand Down Expand Up @@ -483,13 +483,7 @@ func (p *PodmanTestIntegration) CleanupVolume() {
session := p.Podman([]string{"volume", "rm", "-fa"})
session.Wait(90)

// Stop remove service on volume cleanup
p.StopRemoteService()

// Nuke tempdir
if err := os.RemoveAll(p.TempDir); err != nil {
fmt.Printf("%q\n", err)
}
p.Cleanup()
}

// InspectContainerToJSON takes the session output of an inspect
Expand Down
1 change: 1 addition & 0 deletions test/e2e/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ var (
healthcheck = "quay.io/libpod/alpine_healthcheck:latest"
ImageCacheDir = "/tmp/podman/imagecachedir"
fedoraToolbox = "registry.fedoraproject.org/f32/fedora-toolbox:latest"
volumeTest = "quay.io/libpod/volume-plugin-test-img:latest"

// This image has seccomp profiles that blocks all syscalls.
// The intention behind blocking all syscalls is to prevent
Expand Down
14 changes: 14 additions & 0 deletions test/e2e/config/containers.conf
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,17 @@ umask = "0002"
[engine]

network_cmd_options=["allow_host_loopback=true"]

# We need to ensure each test runs on a separate plugin instance...
# For now, let's just make a bunch of plugin paths and have each test use one.
[engine.volume_plugins]
testvol0 = "/run/docker/plugins/testvol0.sock"
testvol1 = "/run/docker/plugins/testvol1.sock"
testvol2 = "/run/docker/plugins/testvol2.sock"
testvol3 = "/run/docker/plugins/testvol3.sock"
testvol4 = "/run/docker/plugins/testvol4.sock"
testvol5 = "/run/docker/plugins/testvol5.sock"
testvol6 = "/run/docker/plugins/testvol6.sock"
testvol7 = "/run/docker/plugins/testvol7.sock"
testvol8 = "/run/docker/plugins/testvol8.sock"
testvol9 = "/run/docker/plugins/testvol9.sock"
184 changes: 184 additions & 0 deletions test/e2e/volume_plugin_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
package integration

import (
"fmt"
"os"
"path/filepath"

. "github.com/containers/podman/v2/test/utils"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
)

var _ = Describe("Podman volume plugins", func() {
var (
tempdir string
err error
podmanTest *PodmanTestIntegration
)

BeforeEach(func() {
tempdir, err = CreateTempDirInTempDir()
if err != nil {
os.Exit(1)
}
podmanTest = PodmanTestCreate(tempdir)
podmanTest.Setup()
podmanTest.SeedImages()
os.Setenv("CONTAINERS_CONF", "config/containers.conf")
SkipIfRemote("Volume plugins only supported as local")
SkipIfRootless("Root is required for volume plugin testing")
os.MkdirAll("/run/docker/plugins", 0755)
})

AfterEach(func() {
podmanTest.CleanupVolume()
f := CurrentGinkgoTestDescription()
processTestResult(f)
os.Unsetenv("CONTAINERS_CONF")
})

It("volume create with nonexistent plugin errors", func() {
session := podmanTest.Podman([]string{"volume", "create", "--driver", "notexist", "test_volume_name"})
session.WaitWithDefaultTimeout()
Expect(session.ExitCode()).To(Not(Equal(0)))
})

It("volume create with not-running plugin does not error", func() {
session := podmanTest.Podman([]string{"volume", "create", "--driver", "testvol0", "test_volume_name"})
session.WaitWithDefaultTimeout()
Expect(session.ExitCode()).To(Not(Equal(0)))
})

It("volume create and remove with running plugin succeeds", func() {
podmanTest.AddImageToRWStore(volumeTest)

pluginStatePath := filepath.Join(podmanTest.TempDir, "volumes")
os.Mkdir(pluginStatePath, 0755)

// Keep this distinct within tests to avoid multiple tests using the same plugin.
pluginName := "testvol1"
plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
plugin.WaitWithDefaultTimeout()
Expect(plugin.ExitCode()).To(Equal(0))

volName := "testVolume1"
create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
create.WaitWithDefaultTimeout()
Expect(create.ExitCode()).To(Equal(0))

ls1 := podmanTest.Podman([]string{"volume", "ls", "-q"})
ls1.WaitWithDefaultTimeout()
Expect(ls1.ExitCode()).To(Equal(0))
arrOutput := ls1.OutputToStringArray()
Expect(len(arrOutput)).To(Equal(1))
Expect(arrOutput[0]).To(ContainSubstring(volName))

remove := podmanTest.Podman([]string{"volume", "rm", volName})
remove.WaitWithDefaultTimeout()
Expect(remove.ExitCode()).To(Equal(0))

ls2 := podmanTest.Podman([]string{"volume", "ls", "-q"})
ls2.WaitWithDefaultTimeout()
Expect(ls2.ExitCode()).To(Equal(0))
Expect(len(ls2.OutputToStringArray())).To(Equal(0))
})

It("volume inspect with running plugin succeeds", func() {
podmanTest.AddImageToRWStore(volumeTest)

pluginStatePath := filepath.Join(podmanTest.TempDir, "volumes")
os.Mkdir(pluginStatePath, 0755)

// Keep this distinct within tests to avoid multiple tests using the same plugin.
pluginName := "testvol2"
plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
plugin.WaitWithDefaultTimeout()
Expect(plugin.ExitCode()).To(Equal(0))

volName := "testVolume1"
create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
create.WaitWithDefaultTimeout()
Expect(create.ExitCode()).To(Equal(0))

volInspect := podmanTest.Podman([]string{"volume", "inspect", "--format", "{{ .Driver }}", volName})
volInspect.WaitWithDefaultTimeout()
Expect(volInspect.ExitCode()).To(Equal(0))
Expect(volInspect.OutputToString()).To(ContainSubstring(pluginName))
})

It("remove plugin with stopped plugin succeeds", func() {
podmanTest.AddImageToRWStore(volumeTest)

pluginStatePath := filepath.Join(podmanTest.TempDir, "volumes")
os.Mkdir(pluginStatePath, 0755)

// Keep this distinct within tests to avoid multiple tests using the same plugin.
pluginName := "testvol3"
ctrName := "pluginCtr"
plugin := podmanTest.Podman([]string{"run", "--name", ctrName, "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
plugin.WaitWithDefaultTimeout()
Expect(plugin.ExitCode()).To(Equal(0))

volName := "testVolume1"
create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
create.WaitWithDefaultTimeout()
Expect(create.ExitCode()).To(Equal(0))

ls1 := podmanTest.Podman([]string{"volume", "ls", "-q"})
ls1.WaitWithDefaultTimeout()
Expect(ls1.ExitCode()).To(Equal(0))
arrOutput := ls1.OutputToStringArray()
Expect(len(arrOutput)).To(Equal(1))
Expect(arrOutput[0]).To(ContainSubstring(volName))

stop := podmanTest.Podman([]string{"stop", "--timeout", "0", ctrName})
stop.WaitWithDefaultTimeout()
Expect(stop.ExitCode()).To(Equal(0))

// Remove should exit non-zero because missing plugin
remove := podmanTest.Podman([]string{"volume", "rm", volName})
remove.WaitWithDefaultTimeout()
Expect(remove.ExitCode()).To(Not(Equal(0)))

// But the volume should still be gone
ls2 := podmanTest.Podman([]string{"volume", "ls", "-q"})
ls2.WaitWithDefaultTimeout()
Expect(ls2.ExitCode()).To(Equal(0))
Expect(len(ls2.OutputToStringArray())).To(Equal(0))
})

It("use plugin in containers", func() {
podmanTest.AddImageToRWStore(volumeTest)

pluginStatePath := filepath.Join(podmanTest.TempDir, "volumes")
os.Mkdir(pluginStatePath, 0755)

// Keep this distinct within tests to avoid multiple tests using the same plugin.
pluginName := "testvol4"
plugin := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", "/run/docker/plugins:/run/docker/plugins", "-v", fmt.Sprintf("%v:%v", pluginStatePath, pluginStatePath), "-d", volumeTest, "--sock-name", pluginName, "--path", pluginStatePath})
plugin.WaitWithDefaultTimeout()
Expect(plugin.ExitCode()).To(Equal(0))

volName := "testVolume1"
create := podmanTest.Podman([]string{"volume", "create", "--driver", pluginName, volName})
create.WaitWithDefaultTimeout()
Expect(create.ExitCode()).To(Equal(0))

ctr1 := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", fmt.Sprintf("%v:/test", volName), ALPINE, "sh", "-c", "touch /test/testfile && echo helloworld > /test/testfile"})
ctr1.WaitWithDefaultTimeout()
Expect(ctr1.ExitCode()).To(Equal(0))

ctr2 := podmanTest.Podman([]string{"run", "--security-opt", "label=disable", "-v", fmt.Sprintf("%v:/test", volName), ALPINE, "cat", "/test/testfile"})
ctr2.WaitWithDefaultTimeout()
Expect(ctr2.ExitCode()).To(Equal(0))
Expect(ctr2.OutputToString()).To(ContainSubstring("helloworld"))

// HACK: `volume rm -f` is timing out trying to remove containers using the volume.
// Solution: remove them manually...
// TODO: fix this when I get back
rmAll := podmanTest.Podman([]string{"rm", "-af"})
rmAll.WaitWithDefaultTimeout()
Expect(rmAll.ExitCode()).To(Equal(0))
})
})
8 changes: 0 additions & 8 deletions test/python/docker/test_containers.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,3 @@ def test_filters(self):
filters = {"name": "top"}
ctnrs = self.client.containers.list(all=True, filters=filters)
self.assertEqual(len(ctnrs), 1)

def test_rename_container(self):
top = self.client.containers.get(TestContainers.topContainerId)

# rename bogus container
with self.assertRaises(errors.APIError) as error:
top.rename(name="newname")
self.assertEqual(error.exception.response.status_code, 404)
Loading

0 comments on commit f781efd

Please sign in to comment.