image: Add tests for build/list/tag/push/pull/remove

Signed-off-by: Qasim Sarfraz <[email protected]>

Author: mqasimsarfraz

Makefile

@@ -268,6 +268,11 @@ integration-tests: kubectl-gadget
 			-gadget-tag $(GADGET_TAG) \
 			$$INTEGRATION_TESTS_PARAMS
 
+
+.PHONY: component-tests
+component-tests:
+	go test -exec sudo -v ./integration/components/... -integration -timeout 5m --builder-image $(EBPF_BUILDER)
+
 .PHONY: generate-documentation
 generate-documentation:
 	go run -tags docs cmd/gen-doc/gen-doc.go -repo $(shell pwd)

cmd/common/image/build.go

@@ -88,7 +88,7 @@ func NewBuildCmd() *cobra.Command {
 
 			opts.path = args[0]
 
-			return runBuild(opts)
+			return runBuild(cmd, opts)
 		},
 	}
 
@@ -102,7 +102,7 @@ func NewBuildCmd() *cobra.Command {
 	return utils.MarkExperimental(cmd)
 }
 
-func runBuild(opts *cmdOpts) error {
+func runBuild(cmd *cobra.Command, opts *cmdOpts) error {
 	conf := &buildFile{
 		EBPFSource: DEFAULT_EBPF_SOURCE,
 		Wasm:       DEFAULT_WASM,
@@ -186,7 +186,7 @@ func runBuild(opts *cmdOpts) error {
 		return err
 	}
 
-	fmt.Printf("Successfully built %s\n", desc.String())
+	cmd.Printf("Successfully built %s\n", desc.String())
 
 	return nil
 }

cmd/common/image/list.go

@@ -17,7 +17,6 @@ package image
 import (
 	"context"
 	"fmt"
-	"os"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -52,7 +51,7 @@ func NewListCmd() *cobra.Command {
 				})
 			}
 			formatter := textcolumns.NewFormatter(cols.GetColumnMap())
-			formatter.WriteTable(os.Stdout, images)
+			formatter.WriteTable(cmd.OutOrStdout(), images)
 			return nil
 		},
 	}

cmd/common/image/pull.go

@@ -34,12 +34,12 @@ func NewPullCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			image := args[0]
 
-			fmt.Printf("Pulling %s...\n", image)
+			cmd.Printf("Pulling %s...\n", image)
 			desc, err := oci.PullGadgetImage(context.TODO(), image, &authOpts)
 			if err != nil {
 				return fmt.Errorf("pulling gadget: %w", err)
 			}
-			fmt.Printf("Successfully pulled %s\n", desc.String())
+			cmd.Printf("Successfully pulled %s\n", desc.String())
 			return nil
 		},
 	}

cmd/common/image/push.go

@@ -34,12 +34,12 @@ func NewPushCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			image := args[0]
 
-			fmt.Printf("Pushing %s...\n", image)
+			cmd.Printf("Pushing %s...\n", image)
 			desc, err := oci.PushGadgetImage(context.TODO(), image, &authOpts)
 			if err != nil {
 				return fmt.Errorf("pushing gadget: %w", err)
 			}
-			fmt.Printf("Successfully pushed %s\n", desc.String())
+			cmd.Printf("Successfully pushed %s\n", desc.String())
 			return nil
 		},
 	}

cmd/common/image/remove.go

@@ -38,7 +38,7 @@ func NewRemoveCmd() *cobra.Command {
 				return fmt.Errorf("removing gadget image: %w", err)
 			}
 
-			fmt.Printf("Successfully removed %s\n", image)
+			cmd.Printf("Successfully removed %s\n", image)
 
 			return nil
 		},

cmd/common/image/tag.go

@@ -38,7 +38,7 @@ func NewTagCmd() *cobra.Command {
 				return fmt.Errorf("tagging image: %w", err)
 			}
 
-			fmt.Printf("Successfully tagged with %s\n", desc.String())
+			cmd.Printf("Successfully tagged with %s\n", desc.String())
 			return nil
 		},
 	}

integration/components/image/image_test.go

@@ -0,0 +1,216 @@
+// Copyright 2024 The Inspektor Gadget authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package image
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/spf13/cobra"
+	"github.com/stretchr/testify/require"
+
+	commonImage "github.com/inspektor-gadget/inspektor-gadget/cmd/common/image"
+	. "github.com/inspektor-gadget/inspektor-gadget/integration"
+)
+
+func TestImage(t *testing.T) {
+	// ensure that experimental is enabled
+	os.Setenv("IG_EXPERIMENTAL", "true")
+
+	// start registry
+	r := StartRegistry(t, "test-image-registry")
+	t.Cleanup(func() {
+		r.Stop(t)
+	})
+	if len(r.PortBindings()) == 0 || r.PortBindings()["5000/tcp"] == nil {
+		t.Fatal("registry port not exposed")
+	}
+	pb := r.PortBindings()["5000/tcp"][0]
+	registryAddr := fmt.Sprintf("%s:%s", pb.HostIP, pb.HostPort)
+
+	testReg := "reg.com"
+	testRepo := "repo1"
+	testTag := "tag1"
+	testLocalImage := fmt.Sprintf("%s/%s:%s", testReg, testRepo, testTag)
+	testRegistryImage := fmt.Sprintf("%s/%s:%s", registryAddr, testRepo, testTag)
+
+	// ensure all images are removed
+	t.Cleanup(func() {
+		// remove local image
+		cmd := commonImage.NewRemoveCmd()
+		cmd.SetArgs([]string{testLocalImage})
+		cmd.Execute()
+
+		// remove registry image
+		cmd = commonImage.NewRemoveCmd()
+		cmd.SetArgs([]string{testRegistryImage})
+		cmd.Execute()
+	})
+
+	type testCase struct {
+		name           string
+		cmd            *cobra.Command
+		args           []string
+		expectedStdout []string
+		expectedStderr []string
+		negateExpected bool
+	}
+
+	testCases := []testCase{
+		{
+			name: "build",
+			cmd:  commonImage.NewBuildCmd(),
+			args: []string{
+				"--builder-image", *testBuilderImage, "--tag", testLocalImage, "../../../gadgets/trace_open",
+			},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully built %s", testLocalImage),
+			},
+		},
+		{
+			name: "list",
+			cmd:  commonImage.NewListCmd(),
+			args: []string{},
+			expectedStdout: []string{
+				testRepo,
+				testTag,
+			},
+		},
+		{
+			name: "tag",
+			cmd:  commonImage.NewTagCmd(),
+			args: []string{testLocalImage, testRegistryImage},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully tagged with %s", testRegistryImage),
+			},
+		},
+		{
+			name: "push",
+			cmd:  commonImage.NewPushCmd(),
+			args: []string{testRegistryImage, "--insecure"},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully pushed %s", testRegistryImage),
+			},
+		},
+		{
+			name: "push-invalid-image",
+			cmd:  commonImage.NewPushCmd(),
+			args: []string{"unknown", "--insecure"},
+			expectedStderr: []string{
+				"failed to resolve ghcr.io/inspektor-gadget/gadget/unknown:latest: not found",
+			},
+		},
+		{
+			name: "push-unknown-tag",
+			cmd:  commonImage.NewPushCmd(),
+			args: []string{fmt.Sprintf("%s/%s:%s", registryAddr, testRepo, "unknown"), "--insecure"},
+			expectedStderr: []string{
+				fmt.Sprintf("%s/%s:%s: not found", registryAddr, testRepo, "unknown"),
+			},
+		},
+		{
+			name: "remove-local-image",
+			cmd:  commonImage.NewRemoveCmd(),
+			args: []string{testLocalImage},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully removed %s", testLocalImage),
+			},
+		},
+		{
+			name: "remove-registry-image",
+			cmd:  commonImage.NewRemoveCmd(),
+			args: []string{testRegistryImage},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully removed %s", testRegistryImage),
+			},
+		},
+		{
+			name:           "validate-remove",
+			cmd:            commonImage.NewListCmd(),
+			args:           []string{},
+			negateExpected: true,
+			// can't use combined repository here as REPOSITORY column can be truncated
+			expectedStdout: []string{
+				registryAddr,
+				testRepo,
+			},
+		},
+		{
+			name: "pull",
+			cmd:  commonImage.NewPullCmd(),
+			args: []string{testRegistryImage, "--insecure"},
+			expectedStdout: []string{
+				fmt.Sprintf("Successfully pulled %s", testRegistryImage),
+			},
+		},
+		{
+			name: "validate-pull",
+			cmd:  commonImage.NewListCmd(),
+			args: []string{},
+			expectedStdout: []string{
+				registryAddr,
+				testTag,
+			},
+		},
+		{
+			name: "pull-invalid-image",
+			cmd:  commonImage.NewPullCmd(),
+			args: []string{"unknown", "--insecure"},
+			expectedStderr: []string{
+				"failed to resolve ghcr.io/inspektor-gadget/gadget/unknown:latest",
+			},
+		},
+		{
+			name: "pull-unknown-tag",
+			cmd:  commonImage.NewPullCmd(),
+			args: []string{fmt.Sprintf("%s/%s:%s", registryAddr, testRepo, "unknown"), "--insecure"},
+			expectedStderr: []string{
+				fmt.Sprintf("%s/%s:%s: not found", registryAddr, testRepo, "unknown"),
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			var stdout, stderr bytes.Buffer
+			tc.cmd.SetArgs(tc.args)
+			tc.cmd.SetOut(&stdout)
+			tc.cmd.SetErr(&stderr)
+			err := tc.cmd.Execute()
+			if len(tc.expectedStderr) > 0 {
+				require.NotNil(t, err)
+				for _, expected := range tc.expectedStderr {
+					if tc.negateExpected {
+						require.NotContains(t, stderr.String(), expected)
+						continue
+					}
+					require.Contains(t, stderr.String(), expected)
+				}
+				return
+			}
+			require.Nil(t, err)
+			require.Empty(t, stderr.String())
+			for _, expected := range tc.expectedStdout {
+				if tc.negateExpected {
+					require.NotContains(t, stdout.String(), expected)
+					continue
+				}
+				require.Contains(t, stdout.String(), expected)
+			}
+		})
+	}
+}

integration/components/image/integration_test.go

@@ -0,0 +1,39 @@
+// Copyright 2024 The Inspektor Gadget authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package image
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"testing"
+)
+
+var (
+	integration      = flag.Bool("integration", false, "run integration tests")
+	testBuilderImage = flag.String("builder-image", "ghcr.io/inspektor-gadget/ebpf-builder:latest", "ebpf builder image")
+)
+
+func TestMain(m *testing.M) {
+	flag.Parse()
+
+	if !*integration {
+		fmt.Println("Skipping image tests")
+		os.Exit(0)
+	}
+
+	fmt.Println("Running image tests")
+	os.Exit(m.Run())
+}

integration/helpers.go

@@ -23,10 +23,12 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/docker/go-connections/nat"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/stretchr/testify/require"
 
 	containercollection "github.com/inspektor-gadget/inspektor-gadget/pkg/container-collection"
+	"github.com/inspektor-gadget/inspektor-gadget/pkg/container-utils/testutils"
 	eventtypes "github.com/inspektor-gadget/inspektor-gadget/pkg/types"
 )
 
@@ -276,3 +278,17 @@ func GetIPVersion(t *testing.T, address string) uint8 {
 	t.Fatalf("Failed to determine IP version for address %s", address)
 	return 0
 }
+
+func StartRegistry(t *testing.T, name string) testutils.Container {
+	t.Helper()
+
+	c := testutils.NewDockerContainer(name, "registry serve /etc/docker/registry/config.yml",
+		testutils.WithImage("registry:2"),
+		testutils.WithoutWait(),
+		testutils.WithPortBindings(nat.PortMap{
+			"5000/tcp": []nat.PortBinding{{HostIP: "127.0.0.1"}},
+		}),
+	)
+	c.Start(t)
+	return c
+}