Merge pull request #29 from dweomer/munge-semver-metadata-in-tags

munge plan.status.latestVersion

Author: dweomer

.drone.yml

@@ -11,6 +11,7 @@ steps:
   image: rancher/dapper:v0.4.2
   commands:
   - dapper ci
+  - dapper e2e-sonobuoy
   - dapper e2e-verify
   volumes:
   - name: docker

Makefile

@@ -10,7 +10,7 @@ TARGETS := $(shell ls scripts)
 $(TARGETS): .dapper
 	./.dapper $@
 
-e2e: e2e-verify
+e2e: | e2e-sonobuoy e2e-verify
 
 clean:
 	rm -rvf ./bin ./dist

README.md

@@ -131,7 +131,6 @@ make e2e
 
 This will, via Dapper, stand up a local cluster (using docker-compose) and then run the Sonobuoy plugin against/within it.
 The Sonobuoy results are parsed and a `Status: passed` results in a clean exit, whereas `Status: failed` exits non-zero.
-See [scripts/e2e-results](scripts/e2e-results) called by [scripts/e2e-verify](scripts/e2e-verify).
 
 Alternatively, if you have a working cluster and Sonobuoy installation, provided you've pushed the images (consider building with
 something like `make REPO=dweomer TAG=dev`), then you can run the e2e tests thusly:

e2e/cluster/local/docker-compose.yaml

@@ -19,7 +19,7 @@ services:
     hostname: local-leader
     privileged: true
     ports:
-      - "172.17.0.1:6443:6443" # k3s
+      - "6443:6443" # k3s
     volumes:
       - source: kubeconfig
         target: /etc/rancher/k3s

e2e/framework/channel.go

@@ -0,0 +1,27 @@
+package framework
+
+import (
+	"net"
+	"net/http"
+	"net/http/httptest"
+	"os"
+)
+
+func ChannelServer(location string) *httptest.Server {
+	hostname, err := os.Hostname()
+	if err != nil {
+		Failf("cannot read hostname: %v", err)
+	}
+	server := &httptest.Server{
+		Config: &http.Server{Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Location", location)
+			w.WriteHeader(http.StatusFound)
+		})},
+	}
+	server.Listener, err = net.Listen("tcp", net.JoinHostPort(hostname, "0"))
+	if err != nil {
+		Failf("cannot create tcp listener: %v", err)
+	}
+	server.Start()
+	return server
+}

e2e/framework/framework.go

@@ -2,10 +2,6 @@ package framework
 
 import (
 	"fmt"
-	"net"
-	"net/http"
-	"net/http/httptest"
-	"os"
 	"strings"
 	"time"
 
@@ -46,8 +42,6 @@ type Client struct {
 
 	controllerDeployment     *appsv1.Deployment
 	controllerServiceAccount *corev1.ServiceAccount
-
-	channelServer *httptest.Server
 }
 
 func New(name string, opt ...Option) *Client {
@@ -90,10 +84,6 @@ func (c *Client) NewPlan(name, image string, command []string, args ...string) *
 	return plan
 }
 
-func (c *Client) ChannelServerURL() string {
-	return c.channelServer.URL
-}
-
 func (c *Client) CreatePlan(plan *upgradeapiv1.Plan) (*upgradeapiv1.Plan, error) {
 	return c.UpgradeClientSet.UpgradeV1().Plans(c.Namespace.Name).Create(plan)
 }
@@ -140,36 +130,12 @@ func (c *Client) BeforeEach() {
 	c.beforeFramework()
 	c.Framework.BeforeEach()
 	c.setupController()
-	c.setupChannelServer()
 }
 
 func (c *Client) AfterEach() {
-	c.teardownChannelServer()
 	c.Framework.AfterEach()
 }
 
-func (c *Client) setupChannelServer() {
-	hostname, err := os.Hostname()
-	if err != nil {
-		Failf("cannot read hostname: %v", err)
-	}
-	c.channelServer = &httptest.Server{
-		Config: &http.Server{Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			w.Header().Set("Location", "/local/channel/test")
-			w.WriteHeader(http.StatusFound)
-		})},
-	}
-	c.channelServer.Listener, err = net.Listen("tcp", net.JoinHostPort(hostname, "0"))
-	if err != nil {
-		Failf("cannot create tcp listener: %v", err)
-	}
-	c.channelServer.Start()
-}
-
-func (c *Client) teardownChannelServer() {
-	c.channelServer.Close()
-}
-
 func (c *Client) setupController() {
 	var err error
 	c.controllerServiceAccount, err = c.ClientSet.CoreV1().ServiceAccounts(c.Namespace.Name).Create(&corev1.ServiceAccount{

e2e/suite/plan_resolve_test.go

@@ -0,0 +1,144 @@
+package suite_test
+
+import (
+	"net/http/httptest"
+	"path"
+	"time"
+
+	"github.com/rancher/system-upgrade-controller/e2e/framework"
+	upgradeapiv1 "github.com/rancher/system-upgrade-controller/pkg/apis/upgrade.cattle.io/v1"
+)
+
+var _ = Describe("Upgrade", func() {
+	e2e := framework.New("resolve")
+
+	When("plan missing channel and version", func() {
+		var (
+			err  error
+			plan = e2e.NewPlan("missing-", "", nil)
+		)
+		BeforeEach(func() {
+			plan, err = e2e.CreatePlan(plan)
+			Expect(err).ToNot(HaveOccurred())
+
+			plan, err = e2e.PollPlanCondition(plan.Name, upgradeapiv1.PlanLatestResolved, 2*time.Second, 30*time.Second)
+			Expect(err).ToNot(HaveOccurred())
+		})
+		It("should not resolve", func() {
+			Expect(upgradeapiv1.PlanLatestResolved.MatchesError(plan, "Error", upgradeapiv1.ErrPlanUnresolvable)).To(BeTrue())
+			Expect(plan.Status.LatestVersion).To(BeEmpty())
+			Expect(plan.Status.LatestHash).To(BeEmpty())
+		})
+	})
+
+	When("plan has version", func() {
+		var (
+			err  error
+			plan = e2e.NewPlan("version-", "", nil)
+		)
+		BeforeEach(func() {
+			plan.Spec.Version = "test"
+
+			plan, err = e2e.CreatePlan(plan)
+			Expect(err).ToNot(HaveOccurred())
+
+			plan, err = e2e.PollPlanCondition(plan.Name, upgradeapiv1.PlanLatestResolved, 2*time.Second, 30*time.Second)
+			Expect(err).ToNot(HaveOccurred())
+		})
+		It("should resolve", func() {
+			Expect(upgradeapiv1.PlanLatestResolved.IsTrue(plan)).To(BeTrue())
+			Expect(upgradeapiv1.PlanLatestResolved.GetReason(plan)).To(Equal("Version"))
+			Expect(plan.Status.LatestVersion).To(Equal(plan.Spec.Version))
+			Expect(plan.Status.LatestHash).ToNot(BeEmpty())
+		})
+	})
+
+	When("plan has version with semver+metadata", func() {
+		var (
+			err    error
+			plan   = e2e.NewPlan("version-semver-metadata-", "", nil)
+			semver = "v1.2.3+test"
+		)
+		BeforeEach(func() {
+			plan.Spec.Version = semver
+
+			plan, err = e2e.CreatePlan(plan)
+			Expect(err).ToNot(HaveOccurred())
+
+			plan, err = e2e.PollPlanCondition(plan.Name, upgradeapiv1.PlanLatestResolved, 2*time.Second, 30*time.Second)
+			Expect(err).ToNot(HaveOccurred())
+		})
+		It("should resolve", func() {
+			Expect(upgradeapiv1.PlanLatestResolved.IsTrue(plan)).To(BeTrue())
+			Expect(upgradeapiv1.PlanLatestResolved.GetReason(plan)).To(Equal("Version"))
+			Expect(plan.Status.LatestHash).ToNot(BeEmpty())
+		})
+		It("should munge the semver", func() {
+			Expect(plan.Status.LatestVersion).ToNot(ContainSubstring(`+`))
+		})
+	})
+
+	When("plan has channel", func() {
+		var (
+			err        error
+			plan       = e2e.NewPlan("channel-", "", nil)
+			channelSrv *httptest.Server
+			channelTag = "test"
+		)
+		BeforeEach(func() {
+			channelSrv = framework.ChannelServer(path.Join("/local", channelTag))
+			plan.Spec.Channel = channelSrv.URL
+			Expect(plan.Spec.Channel).ToNot(BeEmpty())
+
+			plan, err = e2e.CreatePlan(plan)
+			Expect(err).ToNot(HaveOccurred())
+
+			plan, err = e2e.PollPlanCondition(plan.Name, upgradeapiv1.PlanLatestResolved, 2*time.Second, 30*time.Second)
+			Expect(err).ToNot(HaveOccurred())
+		})
+		AfterEach(func() {
+			if channelSrv != nil {
+				channelSrv.Close()
+			}
+		})
+		It("should resolve", func() {
+			Expect(upgradeapiv1.PlanLatestResolved.IsTrue(plan)).To(BeTrue())
+			Expect(upgradeapiv1.PlanLatestResolved.GetReason(plan)).To(Equal("Channel"))
+			Expect(plan.Status.LatestVersion).To(Equal(channelTag))
+			Expect(plan.Status.LatestHash).ToNot(BeEmpty())
+		})
+	})
+
+	When("plan has channel with semver+metadata", func() {
+		var (
+			err        error
+			plan       = e2e.NewPlan("channel-semver-metadata-", "", nil)
+			channelSrv *httptest.Server
+			channelTag = "v1.2.3+test"
+		)
+		BeforeEach(func() {
+			channelSrv = framework.ChannelServer(path.Join("/local/test", channelTag))
+			plan.Spec.Channel = channelSrv.URL
+			Expect(plan.Spec.Channel).ToNot(BeEmpty())
+
+			plan, err = e2e.CreatePlan(plan)
+			Expect(err).ToNot(HaveOccurred())
+
+			plan, err = e2e.PollPlanCondition(plan.Name, upgradeapiv1.PlanLatestResolved, 2*time.Second, 30*time.Second)
+			Expect(err).ToNot(HaveOccurred())
+		})
+		AfterEach(func() {
+			if channelSrv != nil {
+				channelSrv.Close()
+			}
+		})
+		It("should resolve", func() {
+			Expect(upgradeapiv1.PlanLatestResolved.IsTrue(plan)).To(BeTrue())
+			Expect(upgradeapiv1.PlanLatestResolved.GetReason(plan)).To(Equal("Channel"))
+			Expect(plan.Status.LatestHash).ToNot(BeEmpty())
+		})
+		It("should munge the semver", func() {
+			Expect(plan.Status.LatestVersion).ToNot(ContainSubstring(`+`))
+		})
+	})
+})

e2e/suite/upgrade_test.go

@@ -8,6 +8,7 @@ import (
 	"os"
 	"path/filepath"
 	"sort"
+	"strings"
 	"time"
 
 	"github.com/rancher/norman/pkg/openapi"
@@ -164,7 +165,7 @@ func RegisterHandlers(ctx context.Context, controllerNamespace, controllerName s
 			}
 			if obj.Spec.Version != "" {
 				resolved.SetError(obj, "Version", nil)
-				obj.Status.LatestVersion = obj.Spec.Version
+				obj.Status.LatestVersion = mungeVersionTag(obj.Spec.Version)
 				return digestPlan(secretsCache, obj)
 			}
 			if resolved.IsTrue(obj) {
@@ -180,7 +181,7 @@ func RegisterHandlers(ctx context.Context, controllerNamespace, controllerName s
 				return status, err
 			}
 			resolved.SetError(obj, "Channel", nil)
-			obj.Status.LatestVersion = latest
+			obj.Status.LatestVersion = mungeVersionTag(latest)
 			return digestPlan(secretsCache, obj)
 		},
 	)
@@ -312,3 +313,7 @@ func selectConcurrentNodeNames(nodeCache corectlv1.NodeCache, plan *upgradeapiv1
 	sort.Strings(selected)
 	return selected, nil
 }
+
+func mungeVersionTag(version string) string {
+	return strings.ReplaceAll(version, `+`, `-`)
+}