chore: update CRI client runtime version to v1 (test with multiple k8s versions) (#499)

* Update CRI client runtime version to v1

Signed-off-by: Peter Engelbert <[email protected]>

* Refactor

Signed-off-by: Peter Engelbert <[email protected]>

* Restore log message

Signed-off-by: Peter Engelbert <[email protected]>

* Please the linter

Signed-off-by: Peter Engelbert <[email protected]>

* Add codegen check for CI

Signed-off-by: Peter Engelbert <[email protected]>

* Fix inaccurate label due to copy/paste

Signed-off-by: Peter Engelbert <[email protected]>

* Formatting

Signed-off-by: Peter Engelbert <[email protected]>

Signed-off-by: Peter Engelbert <[email protected]>

Author: pmengelbert

.github/workflows/test.yaml

@@ -125,6 +125,28 @@ jobs:
           make manifests
           git diff --exit-code
 
+  check-codegen:
+    name: "Check Codegen"
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@2e205a28d0e1da00c5f53b161f4067b052c61f34
+        with:
+          egress-policy: audit
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up Go 1.19
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+      - name: Check codegen
+        run: |
+          go mod tidy
+          git diff --exit-code
+          make generate
+          git diff --exit-code
+
   e2e-test:
       name: "E2E Tests"
       runs-on: ubuntu-latest

api/v1alpha1/zz_generated.deepcopy.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"context"
 	"encoding/json"
 	"flag"
 	"fmt"
@@ -11,9 +10,9 @@ import (
 	"os"
 	"time"
 
+	"github.com/Azure/eraser/pkg/cri"
 	"github.com/Azure/eraser/pkg/logger"
 	"golang.org/x/sys/unix"
-	pb "k8s.io/cri-api/pkg/apis/runtime/v1alpha2"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 
 	util "github.com/Azure/eraser/pkg/utils"
@@ -56,15 +55,12 @@ func main() {
 		os.Exit(1)
 	}
 
-	imageclient, conn, err := util.GetImageClient(context.Background(), socketPath)
+	client, err := cri.NewCollectorClient(socketPath)
 	if err != nil {
 		log.Error(err, "failed to get image client")
 		os.Exit(1)
 	}
 
-	runTimeClient := pb.NewRuntimeServiceClient(conn)
-	client := &client{imageclient, runTimeClient}
-
 	excluded, err = util.ParseExcluded()
 	if os.IsNotExist(err) {
 		log.Info("configmaps for exclusion do not exist")

pkg/collector/collector.go

@@ -4,14 +4,15 @@ import (
 	"context"
 
 	eraserv1alpha1 "github.com/Azure/eraser/api/v1alpha1"
+	"github.com/Azure/eraser/pkg/cri"
 	util "github.com/Azure/eraser/pkg/utils"
 )
 
-func getImages(c Client) ([]eraserv1alpha1.Image, error) {
+func getImages(c cri.Collector) ([]eraserv1alpha1.Image, error) {
 	backgroundContext, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 
-	images, err := c.listImages(backgroundContext)
+	images, err := c.ListImages(backgroundContext)
 	if err != nil {
 		return nil, err
 	}
@@ -40,7 +41,7 @@ func getImages(c Client) ([]eraserv1alpha1.Image, error) {
 		idToImageMap[img.Id] = newImg
 	}
 
-	containers, err := c.listContainers(backgroundContext)
+	containers, err := c.ListContainers(backgroundContext)
 	if err != nil {
 		return nil, err
 	}

pkg/collector/helpers.go

@@ -0,0 +1,103 @@
+package cri
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/Azure/eraser/pkg/utils"
+	"google.golang.org/grpc"
+	v1 "k8s.io/cri-api/pkg/apis/runtime/v1"
+	v1alpha2 "k8s.io/cri-api/pkg/apis/runtime/v1alpha2"
+)
+
+const (
+	RuntimeV1       runtimeVersion = "v1"
+	RuntimeV1Alpha2 runtimeVersion = "v1alpha2"
+)
+
+type (
+	Collector interface {
+		ListImages(context.Context) ([]*v1.Image, error)
+		ListContainers(context.Context) ([]*v1.Container, error)
+	}
+
+	Eraser interface {
+		Collector
+		DeleteImage(context.Context, string) error
+	}
+
+	runtimeTryFunc func(context.Context, *grpc.ClientConn) (string, error)
+)
+
+func NewCollectorClient(socketPath string) (Collector, error) {
+	return NewEraserClient(socketPath)
+}
+
+func NewEraserClient(socketPath string) (Eraser, error) {
+	ctx := context.Background()
+
+	conn, err := utils.GetConn(ctx, socketPath)
+	if err != nil {
+		return nil, err
+	}
+
+	return newClientWithFallback(ctx, conn)
+}
+
+func newClientWithFallback(ctx context.Context, conn *grpc.ClientConn) (Eraser, error) {
+	errs := new(errors)
+	funcs := []runtimeTryFunc{tryV1, tryV1Alpha2}
+
+	for _, f := range funcs {
+		version, err := f(ctx, conn)
+		if err != nil {
+			errs.Append(err)
+			continue
+		}
+
+		client, err := getClientFromRuntimeVersion(conn, version)
+		if err != nil {
+			errs.Append(err)
+			continue
+		}
+
+		return client, nil
+	}
+
+	return nil, errs
+}
+
+func tryV1Alpha2(ctx context.Context, conn *grpc.ClientConn) (string, error) {
+	runtimeClientV1Alpha2 := v1alpha2.NewRuntimeServiceClient(conn)
+	req2 := v1alpha2.VersionRequest{}
+	respv1Alpha2, err := runtimeClientV1Alpha2.Version(ctx, &req2)
+	return respv1Alpha2.RuntimeApiVersion, err
+}
+
+func tryV1(ctx context.Context, conn *grpc.ClientConn) (string, error) {
+	runtimeClient := v1.NewRuntimeServiceClient(conn)
+	req := v1.VersionRequest{}
+	resp, err := runtimeClient.Version(ctx, &req)
+	return resp.RuntimeApiVersion, err
+}
+
+func getClientFromRuntimeVersion(conn *grpc.ClientConn, runtimeAPIVersion string) (Eraser, error) {
+	switch runtimeAPIVersion {
+	case string(RuntimeV1):
+		imageClient := v1.NewImageServiceClient(conn)
+		runtimeClient := v1.NewRuntimeServiceClient(conn)
+		return &v1Client{
+			images:  imageClient,
+			runtime: runtimeClient,
+		}, nil
+	case string(RuntimeV1Alpha2):
+		runtimeClient := v1alpha2.NewRuntimeServiceClient(conn)
+		imageClient := v1alpha2.NewImageServiceClient(conn)
+		return &v1alpha2Client{
+			images:  imageClient,
+			runtime: runtimeClient,
+		}, nil
+	}
+
+	return nil, fmt.Errorf("unrecognized CRI version: '%s'", runtimeAPIVersion)
+}

pkg/collector/types.go

@@ -0,0 +1,53 @@
+package cri
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+	v1 "k8s.io/cri-api/pkg/apis/runtime/v1"
+)
+
+type (
+	v1Client struct {
+		images  v1.ImageServiceClient
+		runtime v1.RuntimeServiceClient
+	}
+)
+
+func (c *v1Client) ListContainers(ctx context.Context) (list []*v1.Container, err error) {
+	resp, err := c.runtime.ListContainers(context.Background(), new(v1.ListContainersRequest))
+	if err != nil {
+		return nil, err
+	}
+	return resp.Containers, nil
+}
+
+func (c *v1Client) ListImages(ctx context.Context) (list []*v1.Image, err error) {
+	request := &v1.ListImagesRequest{Filter: nil}
+
+	resp, err := c.images.ListImages(ctx, request)
+	if err != nil {
+		return nil, err
+	}
+
+	return resp.Images, nil
+}
+
+func (c *v1Client) DeleteImage(ctx context.Context, image string) (err error) {
+	if image == "" {
+		return err
+	}
+
+	request := &v1.RemoveImageRequest{Image: &v1.ImageSpec{Image: image}}
+
+	_, err = c.images.RemoveImage(ctx, request)
+	if err != nil {
+		if status.Code(err) == codes.NotFound {
+			return nil
+		}
+		return err
+	}
+
+	return nil
+}