NETOBSERV-2113 CLI Integration tests

.gitignore

@@ -1,4 +1,4 @@
-build
+build/*
 output
 tmp
 cover.out

.golangci.yml

@@ -16,6 +16,7 @@ linters:
     - stylecheck
     - typecheck
     - unused
+    - ginkgolinter
 run:
   go: "1.22"
 linters-settings:

e2e/integration-tests/cli.go

@@ -0,0 +1,71 @@
+package integrationtests
+
+import (
+	"context"
+	"io/fs"
+	"os"
+	"time"
+
+	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/wait"
+	"k8s.io/client-go/kubernetes"
+)
+
+func isCLIReady(clientset *kubernetes.Clientset, cliNS string) (bool, error) {
+	var collectorReady, cliDaemonsetReady bool
+	err := wait.PollUntilContextTimeout(context.Background(), 30*time.Second, 300*time.Second, false, func(context.Context) (done bool, err error) {
+		if !collectorReady {
+			collectorPod, err := getNamespacePods(clientset, cliNS, &metav1.ListOptions{FieldSelector: "status.phase=Running", LabelSelector: "run=collector"})
+			if err != nil {
+				return false, err
+			}
+
+			if len(collectorPod) > 0 {
+				collectorReady = true
+			}
+		}
+
+		daemonset := "netobserv-cli"
+		cliDaemonset, err := getDaemonSet(clientset, daemonset, cliNS)
+
+		if err != nil {
+			if errors.IsNotFound(err) {
+				return false, nil
+			}
+			return false, err
+		}
+		if cliDaemonset.Status.DesiredNumberScheduled == cliDaemonset.Status.NumberReady {
+			cliDaemonsetReady = true
+		}
+		return collectorReady && cliDaemonsetReady, nil
+	})
+	if err != nil {
+		return false, err
+	}
+	return true, nil
+}
+
+// get latest flows.json file
+func getFlowsJSONFile() (string, error) {
+	// var files []fs.DirEntry
+	var files []string
+	outputDir := "./output/flow/"
+	dirFS := os.DirFS(outputDir)
+	files, err := fs.Glob(dirFS, "*.json")
+	if err != nil {
+		return "", err
+	}
+	// this could be problematic if two tests are running in parallel with --copy=true
+	var mostRecentFile fs.FileInfo
+	for _, file := range files {
+		fileInfo, err := os.Stat(outputDir + file)
+		if err != nil {
+			return "", nil
+		}
+		if mostRecentFile == nil || fileInfo.ModTime().After(mostRecentFile.ModTime()) {
+			mostRecentFile = fileInfo
+		}
+	}
+	return outputDir + mostRecentFile.Name(), nil
+}

e2e/integration-tests/cluster.go

@@ -0,0 +1,59 @@
+package integrationtests
+
+import (
+	"context"
+	"os"
+
+	appsv1 "k8s.io/api/apps/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/tools/clientcmd"
+)
+
+func getNewClient() (*kubernetes.Clientset, error) {
+	config, err := clientcmd.BuildConfigFromFlags("", os.Getenv("KUBECONFIG"))
+	if err != nil {
+		return nil, err
+	}
+	clientset, err := kubernetes.NewForConfig(config)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return clientset, nil
+}
+
+func getClusterNodes(clientset *kubernetes.Clientset, options *metav1.ListOptions) ([]string, error) {
+	nodes, err := clientset.CoreV1().Nodes().List(context.TODO(), *options)
+	var allNodes []string
+	if err != nil {
+		return allNodes, err
+	}
+	for i := range nodes.Items {
+		allNodes = append(allNodes, nodes.Items[i].Name)
+	}
+	return allNodes, nil
+}
+
+func getDaemonSet(clientset *kubernetes.Clientset, daemonset string, ns string) (*appsv1.DaemonSet, error) {
+	ds, err := clientset.AppsV1().DaemonSets(ns).Get(context.TODO(), daemonset, metav1.GetOptions{})
+
+	if err != nil {
+		return nil, err
+	}
+
+	return ds, nil
+}
+
+func getNamespacePods(clientset *kubernetes.Clientset, namespace string, options *metav1.ListOptions) ([]string, error) {
+	pods, err := clientset.CoreV1().Pods(namespace).List(context.TODO(), *options)
+	var allPods []string
+	if err != nil {
+		return allPods, err
+	}
+	for i := range pods.Items {
+		allPods = append(allPods, pods.Items[i].Name)
+	}
+	return allPods, nil
+}

e2e/integration-tests/integration_test.go

@@ -0,0 +1,77 @@
+package integrationtests
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"os/exec"
+
+	g "github.com/onsi/ginkgo/v2"
+	o "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+var _ = g.Describe("NetObserv CLI e2e integration test suite", g.Serial, func() {
+	cliNS := "netobserv-cli"
+
+	g.It("Verify all CLI pods are deployed", g.Label("Sanity"), func() {
+		cliArgs := []string{"flows", "--copy=false"}
+		cmd := exec.Command(ocNetObservBinPath, cliArgs...)
+		err := cmd.Start()
+		o.Expect(err).NotTo(o.HaveOccurred())
+		// cleanup()
+		defer func() {
+			cliArgs := []string{"cleanup"}
+			cmd := exec.Command(ocNetObservBinPath, cliArgs...)
+			err := cmd.Run()
+			o.Expect(err).NotTo(o.HaveOccurred())
+		}()
+		var allPods []string
+		clientset, err := getNewClient()
+		o.Expect(err).NotTo(o.HaveOccurred())
+		nodes, err := getClusterNodes(clientset, &metav1.ListOptions{})
+		// agent pods + collector pods
+		totalExpectedPods := len(nodes) + 1
+		o.Expect(err).NotTo(o.HaveOccurred())
+		_, err = isCLIReady(clientset, cliNS)
+		o.Expect(err).NotTo(o.HaveOccurred(), "CLI didn't come ready")
+		allPods, err = getNamespacePods(clientset, cliNS, &metav1.ListOptions{})
+		o.Expect(err).NotTo(o.HaveOccurred())
+		o.Expect(allPods).To(o.HaveLen(totalExpectedPods), fmt.Sprintf("Number of CLI pods are not as expected %d", totalExpectedPods))
+	})
+
+	g.It("Verify regexes filters are applied", func() {
+		// capture upto 500KB
+		nsfilter := "openshift-monitoring"
+		cliArgs := []string{"flows", "--regexes=SrcK8S_Namespace~" + nsfilter, "--copy=true", "--max-bytes=500000"}
+		cmd := exec.Command(ocNetObservBinPath, cliArgs...)
+		err := cmd.Run()
+		o.Expect(err).NotTo(o.HaveOccurred())
+		// cleanup()
+		defer func() {
+			cliArgs := []string{"cleanup"}
+			cmd := exec.Command(ocNetObservBinPath, cliArgs...)
+			err := cmd.Run()
+			o.Expect(err).NotTo(o.HaveOccurred())
+		}()
+		o.Expect(cmd.ProcessState.ExitCode()).To(o.BeNumerically("==", 0), "oc-netobserv returned non-zero exit code")
+		flowsJsonfile, err := getFlowsJSONFile()
+		o.Expect(err).NotTo(o.HaveOccurred())
+		flowsFile, err := os.Open(flowsJsonfile)
+		o.Expect(err).NotTo(o.HaveOccurred())
+		defer flowsFile.Close()
+		decoder := json.NewDecoder(flowsFile)
+		_, err = decoder.Token()
+		o.Expect(err).NotTo(o.HaveOccurred())
+		var flow struct {
+			SrcK8sNamespace string `json:"SrcK8S_Namespace"`
+		}
+		for decoder.More() {
+			err := decoder.Decode(&flow)
+			o.Expect(err).NotTo(o.HaveOccurred())
+			if flow.SrcK8sNamespace != nsfilter {
+				o.Expect(true).To(o.BeFalse(), fmt.Sprintf("Flow %v does not meet regexes condition SrcK8S_Namespace~%s", flow, nsfilter))
+			}
+		}
+	})
+})

e2e/integration-tests/integration_tests_suite_test.go

@@ -0,0 +1,30 @@
+package integrationtests
+
+import (
+	"os"
+	"os/exec"
+	"strings"
+	"testing"
+
+	g "github.com/onsi/ginkgo/v2"
+	o "github.com/onsi/gomega"
+)
+
+var ocNetObservBinPath string
+
+func TestIntegrationTests(t *testing.T) {
+	o.RegisterFailHandler(g.Fail)
+	g.RunSpecs(t, "IntegrationTests Suite")
+}
+
+var _ = g.BeforeSuite(func() {
+	//  kubeconfig env var and see if the cluster is reachable.
+	if kubeconfig := os.Getenv("KUBECONFIG"); kubeconfig == "" {
+		g.Skip("Set KUBECONFIG env variable")
+	}
+
+	cmd := exec.Command("which", "oc-netobserv")
+	out, err := cmd.Output()
+	o.Expect(err).NotTo(o.HaveOccurred())
+	ocNetObservBinPath = strings.TrimSuffix(string(out), "\n")
+})

go.mod

@@ -12,6 +12,8 @@ require (
 	github.com/mattn/go-sqlite3 v1.14.24
 	github.com/netobserv/flowlogs-pipeline v1.7.0-community.0.20241217113023-fa0540a1658e
 	github.com/netobserv/netobserv-ebpf-agent v1.7.0-community.0.20250220123714-ff37a09f6232
+	github.com/onsi/ginkgo/v2 v2.23.0
+	github.com/onsi/gomega v1.36.2
 	github.com/rodaine/table v1.3.0
 	github.com/ryankurte/go-pcapng v0.0.0-20170712041429-73fd1a63fab4
 	github.com/sirupsen/logrus v1.9.3
@@ -21,45 +23,52 @@ require (
 	sigs.k8s.io/e2e-framework v0.6.0
 )
 
+require (
+	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
+	github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e // indirect
+	github.com/ovn-org/ovn-kubernetes/go-controller v0.0.0-20250215040159-dd2a70c928d3 // indirect
+	golang.org/x/tools v0.31.0 // indirect
+	sigs.k8s.io/randfill v1.0.0 // indirect
+)
+
 require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/blang/semver/v4 v4.0.0 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
-	github.com/emicklei/go-restful/v3 v3.12.1 // indirect
-	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
+	github.com/emicklei/go-restful/v3 v3.12.2 // indirect
+	github.com/evanphx/json-patch/v5 v5.9.11 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
-	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonpointer v0.21.1 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect
-	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/go-openapi/swag v0.23.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
-	github.com/google/gnostic-models v0.6.8 // indirect
-	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/gnostic-models v0.6.9 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/gorilla/websocket v1.5.3 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/jpillora/backoff v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/compress v1.17.11 // indirect
-	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/mailru/easyjson v0.9.0 // indirect
+	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/moby/spdystream v0.5.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect
 	github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f // indirect
-	github.com/ovn-org/ovn-kubernetes/go-controller v0.0.0-20250215040159-dd2a70c928d3 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
-	github.com/prometheus/client_golang v1.20.5 // indirect
+	github.com/prometheus/client_golang v1.21.1 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
-	github.com/prometheus/common v0.59.1 // indirect
+	github.com/prometheus/common v0.63.0 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/segmentio/kafka-go v0.4.47 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
@@ -68,29 +77,29 @@ require (
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.2 // indirect
 	github.com/xdg-go/stringprep v1.0.4 // indirect
-	go.opentelemetry.io/otel v1.32.0 // indirect
-	go.opentelemetry.io/otel/trace v1.32.0 // indirect
-	golang.org/x/net v0.36.0 // indirect
-	golang.org/x/oauth2 v0.24.0 // indirect
-	golang.org/x/sys v0.30.0 // indirect
-	golang.org/x/term v0.29.0 // indirect
-	golang.org/x/text v0.22.0 // indirect
-	golang.org/x/time v0.7.0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20241202173237-19429a94021a // indirect
-	google.golang.org/grpc v1.70.0 // indirect
-	google.golang.org/protobuf v1.36.6
+	go.opentelemetry.io/otel v1.35.0 // indirect
+	go.opentelemetry.io/otel/trace v1.35.0 // indirect
+	golang.org/x/net v0.37.0 // indirect
+	golang.org/x/oauth2 v0.28.0 // indirect
+	golang.org/x/sys v0.31.0 // indirect
+	golang.org/x/term v0.30.0 // indirect
+	golang.org/x/text v0.23.0 // indirect
+	golang.org/x/time v0.11.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250313205543-e70fdf4c4cb4 // indirect
+	google.golang.org/grpc v1.71.0 // indirect
+	google.golang.org/protobuf v1.36.5
 	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	k8s.io/api v0.32.2 // indirect
-	k8s.io/apimachinery v0.32.2 // indirect
-	k8s.io/client-go v0.32.2 // indirect
-	k8s.io/component-base v0.32.1 // indirect
+	k8s.io/api v0.32.3
+	k8s.io/apimachinery v0.32.3
+	k8s.io/client-go v0.32.3
+	k8s.io/component-base v0.32.3 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
-	k8s.io/kube-openapi v0.0.0-20241105132330-32ad38e42d3f // indirect
-	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
-	sigs.k8s.io/controller-runtime v0.20.0 // indirect
-	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
-	sigs.k8s.io/structured-merge-diff/v4 v4.4.2 // indirect
+	k8s.io/kube-openapi v0.0.0-20250304201544-e5f78fe3ede9 // indirect
+	k8s.io/utils v0.0.0-20241210054802-24370beab758 // indirect
+	sigs.k8s.io/controller-runtime v0.20.3 // indirect
+	sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.6.0 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )