Merge pull request #321 from wallrj/320-version-validation

Add validation to only allow Cassandra major version 3

Author: jetstack-bot

Gopkg.lock

@@ -1,4 +1,3 @@
-
 # Gopkg.toml example
 #
 # Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md

Gopkg.toml

@@ -237,3 +237,8 @@ Navigator will add C* nodes, one at a time, until the desired number of nodes is
    and `Best way to add multiple nodes to existing cassandra cluster <https://stackoverflow.com/questions/37283424/best-way-to-add-multiple-nodes-to-existing-cassandra-cluster>`_.
 
 You can look at ``CassandraCluster.Status.NodePools[<nodepoolname>].ReadyReplicas`` to see the current number of healthy C* nodes in each ``nodepool``.
+
+Supported Versions
+------------------
+
+Navigator only supports Cassandra major version 3.

docs/cassandra.rst

@@ -14,3 +14,11 @@ ${CODEGEN_PKG}/generate-internal-groups.sh all \
   navigator:v1alpha1 \
   --output-base "${GOPATH}/src/" \
   --go-header-file ${SCRIPT_ROOT}/hack/boilerplate.go.txt
+
+echo "Generating other deepcopy funcs"
+${GOPATH}/bin/deepcopy-gen \
+         --input-dirs github.com/jetstack/navigator/pkg/api/version \
+         -O zz_generated.deepcopy \
+         --bounding-dirs github.com/jetstack/navigator/pkg/api/version \
+         --output-base "${GOPATH}/src/" \
+         --go-header-file ${SCRIPT_ROOT}/hack/boilerplate.go.txt

hack/update-client-gen.sh

@@ -6,6 +6,7 @@ import (
 	core "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	"github.com/jetstack/navigator/pkg/api/version"
 	"github.com/jetstack/navigator/pkg/apis/navigator/v1alpha1"
 )
 
@@ -129,6 +130,9 @@ func CassandraCluster(c CassandraClusterConfig) *v1alpha1.CassandraCluster {
 			Name:      c.Name,
 			Namespace: c.Namespace,
 		},
+		Spec: v1alpha1.CassandraClusterSpec{
+			Version: *version.New("3.11.2"),
+		},
 	}
 }
 

internal/test/util/generate/generate.go

@@ -2,11 +2,9 @@ package version
 
 import (
 	"encoding/json"
-	"fmt"
 	"strconv"
-	"strings"
 
-	"github.com/coreos/go-semver/semver"
+	semver "github.com/hashicorp/go-version"
 )
 
 // Version represents a Cassandra database server version.
@@ -23,9 +21,11 @@ import (
 // This also fixes the missing Patch number and stores the version internally as a semver.
 // It also keeps a reference to the original version string so that we can report that in our API.
 // So that the version reported in our API matches the version that an administrator expects.
+//
+// +k8s:deepcopy-gen=true
 type Version struct {
 	versionString string
-	semver        semver.Version
+	semver        *semver.Version
 }
 
 func New(s string) *Version {
@@ -37,10 +37,28 @@ func New(s string) *Version {
 	return v
 }
 
+func (v *Version) set(s string) error {
+	sv, err := semver.NewVersion(s)
+	if err != nil {
+		return err
+	}
+	v.versionString = s
+	v.semver = sv
+	return nil
+}
+
 func (v *Version) Equal(versionB *Version) bool {
 	return v.semver.Equal(versionB.semver)
 }
 
+func (v Version) String() string {
+	return v.versionString
+}
+
+func (v *Version) Semver() *semver.Version {
+	return v.semver
+}
+
 func (v *Version) UnmarshalJSON(data []byte) error {
 	s, err := strconv.Unquote(string(data))
 	if err != nil {
@@ -49,62 +67,20 @@ func (v *Version) UnmarshalJSON(data []byte) error {
 	return v.set(s)
 }
 
-func (v *Version) set(cassVersionString string) error {
-	var versionsTried []string
-	var errorsEncountered []string
-
-	errorWhileParsingOriginalVersion := v.semver.Set(cassVersionString)
-	if errorWhileParsingOriginalVersion == nil {
-		v.versionString = cassVersionString
-		return nil
-	}
-
-	versionsTried = append(versionsTried, cassVersionString)
-	errorsEncountered = append(errorsEncountered, errorWhileParsingOriginalVersion.Error())
-
-	semverString := maybeAddMissingPatchVersion(cassVersionString)
-	if semverString != cassVersionString {
-		errorWhileParsingSemverVersion := v.semver.Set(semverString)
-		if errorWhileParsingSemverVersion == nil {
-			v.versionString = cassVersionString
-			return nil
-		}
-		versionsTried = append(versionsTried, semverString)
-		errorsEncountered = append(errorsEncountered, errorWhileParsingSemverVersion.Error())
-	}
-
-	return fmt.Errorf(
-		"unable to parse Cassandra version as semver. "+
-			"Versions tried: '%s'. "+
-			"Errors encountered: '%s'.",
-		strings.Join(versionsTried, "','"),
-		strings.Join(errorsEncountered, "','"),
-	)
-}
-
 var _ json.Unmarshaler = &Version{}
 
-func maybeAddMissingPatchVersion(v string) string {
-	mmpAndLabels := strings.SplitN(v, "-", 2)
-	mmp := mmpAndLabels[0]
-	mmpParts := strings.SplitN(mmp, ".", 3)
-	if len(mmpParts) == 2 {
-		mmp = mmp + ".0"
-	}
-	mmpAndLabels[0] = mmp
-	return strings.Join(mmpAndLabels, "-")
-}
-
-func (v Version) String() string {
-	return v.versionString
-}
-
 func (v Version) MarshalJSON() ([]byte, error) {
 	return []byte(strconv.Quote(v.String())), nil
 }
 
 var _ json.Marshaler = &Version{}
 
-func (v Version) Semver() string {
-	return v.semver.String()
+// DeepCopy returns a deep-copy of the Version value.
+// If the underlying semver is a nil pointer, assume that the zero value is being copied,
+// and return that.
+func (v Version) DeepCopy() Version {
+	if v.semver == nil {
+		return Version{}
+	}
+	return *New(v.String())
 }

pkg/cassandra/version/version.go renamed to pkg/api/version/version.go

@@ -3,7 +3,7 @@ package version_test
 import (
 	"testing"
 
-	"github.com/jetstack/navigator/pkg/cassandra/version"
+	"github.com/jetstack/navigator/pkg/api/version"
 )
 
 func TestUnmarshalJSON(t *testing.T) {
@@ -21,10 +21,6 @@ func TestUnmarshalJSON(t *testing.T) {
 			s:         `"0.0.x"`,
 			expectErr: true,
 		},
-		"incomplete semver": {
-			s:         `"3"`,
-			expectErr: true,
-		},
 		"cassandra partial invalid semver with labels": {
 			s:         `"X.Y-foo+bar"`,
 			expectErr: true,
@@ -33,6 +29,12 @@ func TestUnmarshalJSON(t *testing.T) {
 			s:         `"X.Y.0-"`,
 			expectErr: true,
 		},
+		// Cassandra versions always include a minor version but Hashicorp
+		// go-version (which we currently use for parsing) doesn't require it.
+		"partial semver": {
+			s: `"3"`,
+			v: version.New("3.0.0"),
+		},
 		"cassandra partial semver": {
 			s: `"3.9"`,
 			v: version.New("3.9.0"),
@@ -91,3 +93,18 @@ func TestUnmarshalJSON(t *testing.T) {
 		)
 	}
 }
+
+func TestDeepCopy(t *testing.T) {
+	t.Run(
+		"zero value",
+		func(t *testing.T) {
+			t.Log(version.Version{}.DeepCopy())
+		},
+	)
+	t.Run(
+		"validated version",
+		func(t *testing.T) {
+			t.Log(version.New("3.11.2").DeepCopy())
+		},
+	)
+}

pkg/cassandra/version/version_test.go renamed to pkg/api/version/version_test.go

@@ -0,0 +1,27 @@
+// +build !ignore_autogenerated
+
+/*
+Copyright 2018 Jetstack Ltd.
+
+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.
+*/
+
+// This file was autogenerated by deepcopy-gen. Do not edit it manually!
+
+package version
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *Version) DeepCopyInto(out *Version) {
+	*out = in.DeepCopy()
+	return
+}

pkg/api/version/zz_generated.deepcopy.go

@@ -6,7 +6,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
-	"github.com/jetstack/navigator/pkg/cassandra/version"
+	"github.com/jetstack/navigator/pkg/api/version"
 )
 
 // In this file we define the outer containing types for the ElasticsearchCluster

pkg/apis/navigator/types.go

@@ -6,7 +6,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
-	"github.com/jetstack/navigator/pkg/cassandra/version"
+	"github.com/jetstack/navigator/pkg/api/version"
 )
 
 const (