Add ginkgo e2e tests

Author: paulwilljones

go.mod

@@ -43,8 +43,12 @@ require (
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/stretchr/testify v1.10.0
 	sigs.k8s.io/controller-runtime v0.20.4
+	github.com/onsi/ginkgo/v2 v2.19.0
+	github.com/onsi/gomega v1.33.1
 )
 
+require github.com/itchyny/timefmt-go v0.1.6 // indirect
+
 require (
 	github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c // indirect
 	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
@@ -79,17 +83,21 @@ require (
 	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.1 // indirect
+	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang-jwt/jwt/v4 v4.5.2 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/btree v1.1.3 // indirect
 	github.com/google/gnostic-models v0.6.9 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/itchyny/gojq v0.12.16
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/compress v1.18.0 // indirect

go.sum

@@ -148,6 +148,10 @@ github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISH
 github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/itchyny/gojq v0.12.16 h1:yLfgLxhIr/6sJNVmYfQjTIv0jGctu6/DgDoivmxTr7g=
+github.com/itchyny/gojq v0.12.16/go.mod h1:6abHbdC2uB9ogMS38XsErnfqJ94UlngIJGlRAIj4jTM=
+github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q=
+github.com/itchyny/timefmt-go v0.1.6/go.mod h1:RRDZYC5s9ErkjQvTvvU7keJjxUYzIISJGxm9/mAERQg=
 github.com/jarcoal/httpmock v1.3.1 h1:iUx3whfZWVf3jT01hQTO/Eo5sAYtB2/rqaUuOtpInww=
 github.com/jarcoal/httpmock v1.3.1/go.mod h1:3yb8rc4BI7TCBhFY8ng0gjuLKJNquuDNiPaZjnENuYg=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=

make/test-e2e.mk

@@ -25,22 +25,6 @@ e2e-setup-docker-registry: | kind-cluster $(NEEDS_HELM) $(NEEDS_KUBECTL)
 		-f ./make/config/registry/docker-registry-values.yaml \
 		docker-registry twuni/docker-registry >/dev/null
 
-.PHONY: install-harbor
-e2e-setup-harbor: | kind-cluster $(NEEDS_HELM) $(NEEDS_KUBECTL)
-	$(HELM) repo add harbor https://helm.goharbor.io
-	$(HELM) upgrade \
-		--install \
-		--create-namespace \
-		-n harbor \
-		--wait \
-		--set expose.type=nodePort \
-		--set expose.tls.enabled=false \
-		--set trivy.enabled=false \
-		--set registry.credentials.username="user" \
-		--set registry.credentials.password="password" \
-		--set expose.nodePort.ports.http.nodePort=30443 \
-		harbor harbor/harbor >/dev/null
-
 
 INSTALL_OPTIONS += --set image.repository=$(oci_manager_image_name_development)
 INSTALL_OPTIONS += -f ./make/config/version-checker-values.yaml
@@ -75,16 +59,8 @@ test-e2e-deps: install
 .PHONY: test-e2e
 ## e2e end-to-end tests
 ## @category Testing
-test-e2e: test-e2e-deps | kind-cluster #$(NEEDS_GINKGO) $(NEEDS_KUBECTL)
-# $(GINKGO) \
-# 	--output-dir=$(ARTIFACTS) \
-# 	--focus="$(E2E_FOCUS)" \
-# 	--junit-report=junit-go-e2e.xml \
-# 	$(EXTRA_GINKGO_FLAGS) \
-# 	./test/e2e/ \
-# 	-ldflags $(go_manager_ldflags) \
-# 	-- \
-# 	--istioctl-path $(CURDIR)/$(bin_dir)/scratch/istioctl-$(ISTIO_VERSION) \
-# 	--kubeconfig-path $(CURDIR)/$(kind_kubeconfig) \
-# 	--kubectl-path $(KUBECTL) \
-# 	--runtime-issuance-config-map-name=$(E2E_RUNTIME_CONFIG_MAP_NAME)
+test-e2e: test-e2e-deps | kind-cluster $(NEEDS_GINKGO) $(NEEDS_KUBECTL)
+	$(GINKGO) \
+		-v \
+		--no-color \
+		./test/e2e/

pkg/client/selfhosted/selfhosted.go

@@ -232,13 +232,17 @@ func (c *Client) doRequest(ctx context.Context, url, header string, obj interfac
 	req = req.WithContext(ctx)
 	if len(c.Bearer) > 0 {
 		req.Header.Add("Authorization", "Bearer "+c.Bearer)
+<<<<<<< HEAD
 	} else if c.Username != "" && c.Password != "" {
+=======
+	} else if len(c.Username) > 0 && len(c.Password) > 0 {
+>>>>>>> 8e64777... Add ginkgo e2e tests
 		req.SetBasicAuth(c.Username, c.Password)
 	}
 
 	if len(header) > 0 {
 		req.Header.Set("Accept", header)
-		req.Header.Set("Accept", ociV1Header)
+		req.Header.Add("Accept", ociV1Header)
 	}
 
 	resp, err := c.Do(req)

test/e2e/e2e_test.go

@@ -0,0 +1,15 @@
+package e2e
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	_ "github.com/jetstack/version-checker/test/e2e/suite"
+)
+
+func TestVersionChecker(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "VersionChecker Suite")
+}

test/e2e/manifests/prom2json.yaml

@@ -0,0 +1,14 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: prom2json
+spec:
+  template:
+    spec:
+      containers:
+      - command:
+        - prom2json
+        - http://version-checker.version-checker:8080/metrics
+        image: prom/prom2json
+        name: prom2json
+      restartPolicy: Never

test/e2e/suite/version_checker.go

@@ -0,0 +1,117 @@
+package suite
+
+import (
+	"bytes"
+	"encoding/json"
+	"log"
+	"os/exec"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/itchyny/gojq"
+)
+
+var _ = Describe("version-checker", func() {
+	BeforeEach(func() {
+		cmd := exec.Command("kubectl", "apply", "-f", "./manifests/prom2json.yaml")
+		cmd.Stdout = GinkgoWriter
+		cmd.Stderr = GinkgoWriter
+		Expect(cmd.Run()).NotTo(HaveOccurred())
+		cmd = exec.Command("kubectl", "wait", "--for=condition=Complete", "job", "-ljob-name=prom2json")
+		cmd.Stdout = GinkgoWriter
+		cmd.Stderr = GinkgoWriter
+		Expect(cmd.Run()).NotTo(HaveOccurred())
+	})
+	AfterEach(func() {
+		cmd := exec.Command("kubectl", "delete", "-f", "./manifests/prom2json.yaml")
+		cmd.Stdout = GinkgoWriter
+		cmd.Stderr = GinkgoWriter
+		Expect(cmd.Run()).NotTo(HaveOccurred())
+	})
+
+	When("a Pod is deployed", func() {
+		BeforeEach(func() {
+			cmd := exec.Command("kubectl", "apply", "-f", "./manifests/image-from-reg.yaml")
+			cmd.Stdout = GinkgoWriter
+			cmd.Stderr = GinkgoWriter
+			Expect(cmd.Run()).NotTo(HaveOccurred())
+		})
+		AfterEach(func() {
+			cmd := exec.Command("kubectl", "delete", "-f", "./manifests/image-from-reg.yaml")
+			cmd.Stdout = GinkgoWriter
+			cmd.Stderr = GinkgoWriter
+			Expect(cmd.Run()).NotTo(HaveOccurred())
+		})
+	})
+
+	It("it should get the current version", func() {
+		buf := new(bytes.Buffer)
+		cmd := exec.Command("kubectl", "logs", "-ljob-name=prom2json")
+		cmd.Stdout = buf
+		cmd.Stderr = GinkgoWriter
+		Expect(cmd.Run()).NotTo(HaveOccurred())
+
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .labels.current_version'
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .labels.latest_version'
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .value'
+		query, err := gojq.Parse(".[]|select(.name==\"version_checker_is_latest_version\")| .metrics[] | select(.labels.image==\"docker-registry.registry.svc.cluster.local:5000/my-app\") | .labels.current_version")
+		if err != nil {
+			log.Fatalln(err)
+		}
+		var result []interface{}
+		err = json.Unmarshal(buf.Bytes(), &result)
+		if err != nil {
+			log.Fatalln(err)
+		}
+		iter := query.Run(result)
+		for {
+			v, ok := iter.Next()
+			if !ok {
+				break
+			}
+			if err, ok := v.(error); ok {
+				if err, ok := err.(*gojq.HaltError); ok && err.Value() == nil {
+					break
+				}
+				log.Fatalln(err)
+			}
+			Expect(v).To(Equal("0.0.1"))
+		}
+	})
+
+	It("it should find a newer version", func() {
+		buf := new(bytes.Buffer)
+		cmd := exec.Command("kubectl", "logs", "-ljob-name=prom2json")
+		cmd.Stdout = buf
+		cmd.Stderr = GinkgoWriter
+		Expect(cmd.Run()).NotTo(HaveOccurred())
+
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .labels.current_version'
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .labels.latest_version'
+		//k logs -ljob-name=prom2json | jq '.[]|select(.name=="version_checker_is_latest_version")| .metrics[] | select(.labels.image=="docker-registry.registry.svc.cluster.local:5000/my-app") | .value'
+		query, err := gojq.Parse(".[]|select(.name==\"version_checker_is_latest_version\")| .metrics[] | select(.labels.image==\"docker-registry.registry.svc.cluster.local:5000/my-app\") | .labels.latest_version")
+		if err != nil {
+			log.Fatalln(err)
+		}
+		var result []interface{}
+		err = json.Unmarshal(buf.Bytes(), &result)
+		if err != nil {
+			log.Fatalln(err)
+		}
+		iter := query.Run(result)
+		for {
+			v, ok := iter.Next()
+			if !ok {
+				break
+			}
+			if err, ok := v.(error); ok {
+				if err, ok := err.(*gojq.HaltError); ok && err.Value() == nil {
+					break
+				}
+				log.Fatalln(err)
+			}
+			Expect(v).To(Equal("0.0.2"))
+		}
+	})
+})