test/testvol: rework testvol binary

Add 4 new subcommands to the testvol binary, instead of just serving the
volume api it now also can create/list/remove plugins. This is required
to test new functionality where volumes are create outside of podman in
the plugin. Podman should then be able to pick up the new volumes.

The new testvol commands are:
- serve: serve the podman api like the the testvol command before
- create: create a volume with the given name
- list: list all volume names
- remove: remove the volume with the given name

Also make a small update to the testvol Containerfile so that it can
build correctly.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>

6 files changed, 131 insertions, 12 deletions

diff --git a/test/testvol/Containerfile b/test/testvol/Containerfile
index de44798fe..32448f5a9 100644
--- a/test/testvol/Containerfile
+++ b/test/testvol/Containerfile
@@ -1,10 +1,9 @@
 FROM docker.io/library/golang:1.18-alpine AS build-img
-COPY ./test/testvol/ /go/src/github.com/containers/podman/cmd/testvol/
-COPY ./vendor /go/src/github.com/containers/podman/vendor/
+COPY ./ /go/src/github.com/containers/podman/
 WORKDIR /go/src/github.com/containers/podman
-RUN GO111MODULE=off go build -o /testvol ./cmd/testvol
+RUN GO111MODULE=off go build -o /testvol ./test/testvol
 
 FROM alpine
 COPY --from=build-img /testvol /usr/local/bin
 WORKDIR /
-ENTRYPOINT ["/usr/local/bin/testvol"]
+ENTRYPOINT ["/usr/local/bin/testvol", "serve"]
diff --git a/test/testvol/create.go b/test/testvol/create.go
new file mode 100644
index 000000000..d29300f0b
--- /dev/null
+++ b/test/testvol/create.go
@@ -0,0 +1,26 @@
+package main
+
+import (
+	pluginapi "github.com/docker/go-plugins-helpers/volume"
+	"github.com/spf13/cobra"
+)
+
+var createCmd = &cobra.Command{
+	Use:   "create NAME",
+	Short: "create a volume",
+	Long:  `Create a volume in the volume plugin listening on --sock-name`,
+	Args:  cobra.ExactArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return createVol(config.sockName, args[0])
+	},
+}
+
+func createVol(sockName, volName string) error {
+	plugin, err := getPlugin(sockName)
+	if err != nil {
+		return err
+	}
+	createReq := new(pluginapi.CreateRequest)
+	createReq.Name = volName
+	return plugin.CreateVolume(createReq)
+}
diff --git a/test/testvol/list.go b/test/testvol/list.go
new file mode 100644
index 000000000..fea615a70
--- /dev/null
+++ b/test/testvol/list.go
@@ -0,0 +1,32 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var listCmd = &cobra.Command{
+	Use:   "list",
+	Short: "list all volumes",
+	Long:  `List all volumes from the volume plugin listening on --sock-name`,
+	Args:  cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return listVol(config.sockName)
+	},
+}
+
+func listVol(sockName string) error {
+	plugin, err := getPlugin(sockName)
+	if err != nil {
+		return err
+	}
+	vols, err := plugin.ListVolumes()
+	if err != nil {
+		return err
+	}
+	for _, vol := range vols {
+		fmt.Println(vol.Name)
+	}
+	return nil
+}
diff --git a/test/testvol/main.go b/test/testvol/main.go
index 30ab365b3..99c6fb694 100644
--- a/test/testvol/main.go
+++ b/test/testvol/main.go
@@ -14,13 +14,20 @@ import (
 )
 
 var rootCmd = &cobra.Command{
-	Use:   "testvol",
-	Short: "testvol - volume plugin for Podman",
+	Use:               "testvol",
+	Short:             "testvol - volume plugin for Podman testing",
+	PersistentPreRunE: before,
+	SilenceUsage:      true,
+}
+
+var serveCmd = &cobra.Command{
+	Use:   "serve",
+	Short: "serve the volume plugin on the unix socket",
 	Long:  `Creates simple directory volumes using the Volume Plugin API for testing volume plugin functionality`,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return startServer(config.sockName)
 	},
-	PersistentPreRunE: before,
 }
 
 // Configuration for the volume plugin
@@ -37,9 +44,12 @@ var config = cliConfig{
 }
 
 func init() {
-	rootCmd.Flags().StringVar(&config.sockName, "sock-name", config.sockName, "Name of unix socket for plugin")
-	rootCmd.Flags().StringVar(&config.path, "path", "", "Path to initialize state and mount points")
+	rootCmd.PersistentFlags().StringVar(&config.sockName, "sock-name", config.sockName, "Name of unix socket for plugin")
 	rootCmd.PersistentFlags().StringVar(&config.logLevel, "log-level", config.logLevel, "Log messages including and over the specified level: debug, info, warn, error, fatal, panic")
+
+	serveCmd.Flags().StringVar(&config.path, "path", "", "Path to initialize state and mount points")
+
+	rootCmd.AddCommand(serveCmd, createCmd, removeCmd, listCmd)
 }
 
 func before(cmd *cobra.Command, args []string) error {
@@ -59,11 +69,8 @@ func before(cmd *cobra.Command, args []string) error {
 
 func main() {
 	if err := rootCmd.Execute(); err != nil {
-		logrus.Errorf("Running volume plugin: %v", err)
 		os.Exit(1)
 	}
-
-	os.Exit(0)
 }
 
 // startServer runs the HTTP server and responds to requests
diff --git a/test/testvol/remove.go b/test/testvol/remove.go
new file mode 100644
index 000000000..2839b0b50
--- /dev/null
+++ b/test/testvol/remove.go
@@ -0,0 +1,26 @@
+package main
+
+import (
+	pluginapi "github.com/docker/go-plugins-helpers/volume"
+	"github.com/spf13/cobra"
+)
+
+var removeCmd = &cobra.Command{
+	Use:   "remove NAME",
+	Short: "remove a volume",
+	Long:  `Remove a volume in the volume plugin listening on --sock-name`,
+	Args:  cobra.ExactArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return removeVol(config.sockName, args[0])
+	},
+}
+
+func removeVol(sockName, volName string) error {
+	plugin, err := getPlugin(sockName)
+	if err != nil {
+		return err
+	}
+	removeReq := new(pluginapi.RemoveRequest)
+	removeReq.Name = volName
+	return plugin.RemoveVolume(removeReq)
+}
diff --git a/test/testvol/util.go b/test/testvol/util.go
new file mode 100644
index 000000000..7a0aeba86
--- /dev/null
+++ b/test/testvol/util.go
@@ -0,0 +1,29 @@
+package main
+
+import (
+	"path/filepath"
+	"strings"
+
+	"github.com/containers/podman/v4/libpod/plugin"
+)
+
+const pluginSockDir = "/run/docker/plugins"
+
+func getSocketPath(pathOrName string) string {
+	if filepath.IsAbs(pathOrName) {
+		return pathOrName
+	}
+
+	// only a name join it with the default path
+	return filepath.Join(pluginSockDir, pathOrName+".sock")
+}
+
+func getPluginName(pathOrName string) string {
+	return strings.TrimSuffix(filepath.Base(pathOrName), ".sock")
+}
+
+func getPlugin(sockNameOrPath string) (*plugin.VolumePlugin, error) {
+	path := getSocketPath(sockNameOrPath)
+	name := getPluginName(sockNameOrPath)
+	return plugin.GetVolumePlugin(name, path)
+}