Merge pull request #263 from wallrj/262-cassandra-version-status

Automatic merge from submit-queue.

Report the actual Cassandra Version

* Add a Pilot.Status.Cassandra.Version field.
* Add a nodetool.Version method which queries Cassandra version via JMX / Jolokia.
* A CassandraVersion type that wraps semver.Version in order to add a special case for versions without a patch number.
* Update the Pilot.Status.Cassandra.Version field during calls to Pilot.Sync.
* An E2E test for version reporting.

Fixes: #262 

**Release note**:
```release-note
NONE
```

Author: jetstack-ci-bot

hack/e2e.sh

@@ -38,6 +38,9 @@ source "${SCRIPT_DIR}/libe2e.sh"
 : ${CHART_VALUES:="${SCRIPT_DIR}/testdata/values.yaml"}
 : ${CHART_VALUES_CASSANDRA:="${SCRIPT_DIR}/testdata/values_cassandra.yaml"}
 
+# Save the cluster logs when the script exits (success or failure)
+trap "dump_debug_logs ${PWD}/_artifacts/dump_debug_logs" EXIT
+
 helm delete --purge "${RELEASE_NAME}" || true
 
 function debug_navigator_start() {
@@ -182,7 +185,7 @@ if [[ "test_elasticsearchcluster" = "${TEST_PREFIX}"* ]]; then
     ES_TEST_NS="test-elasticsearchcluster-${TEST_ID}"
     test_elasticsearchcluster "${ES_TEST_NS}"
     if [ "${FAILURE_COUNT}" -gt "0" ]; then
-        fail_and_exit "${ES_TEST_NS}"
+        exit 1
     fi
     kube_delete_namespace_and_wait "${ES_TEST_NS}"
 fi
@@ -223,6 +226,16 @@ function test_cassandracluster() {
         fail_test "Cassandra pilots did not elect a leader"
     fi
 
+    if ! retry TIMEOUT=300 \
+         stdout_equals "${CASS_VERSION}" \
+         kubectl --namespace "${namespace}" \
+         get pilots \
+         --output 'jsonpath={.items[0].status.cassandra.version}'
+    then
+        kubectl --namespace "${namespace}" get pilots -o yaml
+        fail_test "Pilots failed to report the expected version"
+    fi
+
     # Wait 5 minutes for cassandra to start and listen for CQL queries.
     if ! retry TIMEOUT=300 cql_connect \
          "${namespace}" \
@@ -358,9 +371,8 @@ if [[ "test_cassandracluster" = "${TEST_PREFIX}"* ]]; then
     done
 
     test_cassandracluster "${CASS_TEST_NS}"
-    dump_debug_logs "${CASS_TEST_NS}"
     if [ "${FAILURE_COUNT}" -gt "0" ]; then
-        fail_and_exit "${CASS_TEST_NS}"
+        exit 1
     fi
     kube_delete_namespace_and_wait "${CASS_TEST_NS}"
 fi

hack/libe2e.sh

@@ -168,25 +168,18 @@ function stdout_gt() {
 }
 
 function dump_debug_logs() {
-    local namespace="${1}"
-    local output_dir="$(pwd)/_artifacts/${namespace}"
-
+    local output_dir="${1}"
     echo "Dumping cluster state to ${output_dir}"
     mkdir -p "${output_dir}"
     kubectl cluster-info dump \
-            --namespaces "${namespace}" \
+            --all-namespaces \
             --output-directory "${output_dir}" || true
-}
-
-function fail_and_exit() {
-    local namespace="${1}"
-
-    kubectl api-versions
-    kubectl get apiservice -o yaml
 
-    dump_debug_logs "${namespace}"
-
-    exit 1
+    # Some other resources which aren't included in cluster-info dump
+    for kind in apiservice cassandraclusters elasticsearchclusters pilots; do
+        kubectl get "${kind}" --all-namespaces --output json > "${output_dir}/${kind}.json" || true
+    done
+    kubectl api-versions > "${output_dir}/api-versions.txt" || true
 }
 
 function cql_connect() {

hack/testdata/cass-cluster-test.template.yaml

@@ -1,7 +1,7 @@
 apiVersion: "navigator.jetstack.io/v1alpha1"
 kind: "CassandraCluster"
 metadata:
-  name: ${CASS_NAME}
+  name: "${CASS_NAME}"
 spec:
   version: "${CASS_VERSION}"
   cqlPort: ${CASS_CQL_PORT}
@@ -17,11 +17,7 @@ spec:
       size: "5Gi"
       storageClass: "default"
     nodeSelector:
-  image:
-    repository: "cassandra"
-    tag: "3"
-    pullPolicy: "IfNotPresent"
   pilotImage:
-    repository: ${NAVIGATOR_IMAGE_REPOSITORY}/navigator-pilot-cassandra
-    tag: ${NAVIGATOR_IMAGE_TAG}
-    pullPolicy: ${NAVIGATOR_IMAGE_PULLPOLICY}
+    repository: "${NAVIGATOR_IMAGE_REPOSITORY}/navigator-pilot-cassandra"
+    tag: "${NAVIGATOR_IMAGE_TAG}"
+    pullPolicy: "${NAVIGATOR_IMAGE_PULLPOLICY}"

pkg/apis/navigator/types.go

@@ -5,6 +5,8 @@ import (
 	"k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/jetstack/navigator/pkg/cassandra/version"
 )
 
 // In this file we define the outer containing types for the ElasticsearchCluster
@@ -28,7 +30,7 @@ type CassandraClusterSpec struct {
 	NavigatorClusterConfig
 
 	NodePools []CassandraClusterNodePool
-	Version   semver.Version
+	Version   version.Version
 	Image     *ImageSpec
 	CqlPort   int32
 }
@@ -196,6 +198,8 @@ type PilotStatus struct {
 	Conditions         []PilotCondition
 	// Contains status information specific to Elasticsearch Pilots
 	Elasticsearch *ElasticsearchPilotStatus
+	// Contains status information specific to Cassandra Pilots
+	Cassandra *CassandraPilotStatus
 }
 
 type ElasticsearchPilotStatus struct {
@@ -206,6 +210,10 @@ type ElasticsearchPilotStatus struct {
 	Version   semver.Version
 }
 
+type CassandraPilotStatus struct {
+	Version *version.Version
+}
+
 // PilotCondition contains condition information for a Pilot.
 type PilotCondition struct {
 	// Type of the condition, currently ('Ready').

pkg/apis/navigator/v1alpha1/types.go

@@ -5,6 +5,8 @@ import (
 	"k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/jetstack/navigator/pkg/cassandra/version"
 )
 
 const (
@@ -38,7 +40,7 @@ type CassandraClusterSpec struct {
 	CqlPort int32 `json:"cqlPort"`
 
 	// The version of the database to be used for nodes in the cluster.
-	Version semver.Version `json:"version"`
+	Version version.Version `json:"version"`
 }
 
 // CassandraClusterNodePool describes a node pool within a CassandraCluster.
@@ -288,6 +290,8 @@ type PilotStatus struct {
 	Conditions         []PilotCondition `json:"conditions"`
 	// Contains status information specific to Elasticsearch Pilots
 	Elasticsearch *ElasticsearchPilotStatus `json:"elasticsearch,omitempty"`
+	// Contains status information specific to Cassandra Pilots
+	Cassandra *CassandraPilotStatus `json:"cassandra,omitempty"`
 }
 
 type ElasticsearchPilotStatus struct {
@@ -299,6 +303,12 @@ type ElasticsearchPilotStatus struct {
 	Version semver.Version `json:"version,omitempty"`
 }
 
+type CassandraPilotStatus struct {
+	// Version as reported by the Cassandra process.
+	// `nil` indicates that the version is not yet known / not yet reported.
+	Version *version.Version `json:"version,omitempty"`
+}
+
 // PilotCondition contains condition information for a Pilot.
 type PilotCondition struct {
 	// Type of the condition, currently ('Ready').

pkg/apis/navigator/v1alpha1/zz_generated.conversion.go

@@ -22,6 +22,7 @@ package v1alpha1
 
 import (
 	navigator "github.com/jetstack/navigator/pkg/apis/navigator"
+	version "github.com/jetstack/navigator/pkg/cassandra/version"
 	v1 "k8s.io/api/core/v1"
 	conversion "k8s.io/apimachinery/pkg/conversion"
 	runtime "k8s.io/apimachinery/pkg/runtime"
@@ -48,6 +49,8 @@ func RegisterConversions(scheme *runtime.Scheme) error {
 		Convert_navigator_CassandraClusterSpec_To_v1alpha1_CassandraClusterSpec,
 		Convert_v1alpha1_CassandraClusterStatus_To_navigator_CassandraClusterStatus,
 		Convert_navigator_CassandraClusterStatus_To_v1alpha1_CassandraClusterStatus,
+		Convert_v1alpha1_CassandraPilotStatus_To_navigator_CassandraPilotStatus,
+		Convert_navigator_CassandraPilotStatus_To_v1alpha1_CassandraPilotStatus,
 		Convert_v1alpha1_ElasticsearchCluster_To_navigator_ElasticsearchCluster,
 		Convert_navigator_ElasticsearchCluster_To_v1alpha1_ElasticsearchCluster,
 		Convert_v1alpha1_ElasticsearchClusterList_To_navigator_ElasticsearchClusterList,
@@ -265,6 +268,26 @@ func Convert_navigator_CassandraClusterStatus_To_v1alpha1_CassandraClusterStatus
 	return autoConvert_navigator_CassandraClusterStatus_To_v1alpha1_CassandraClusterStatus(in, out, s)
 }
 
+func autoConvert_v1alpha1_CassandraPilotStatus_To_navigator_CassandraPilotStatus(in *CassandraPilotStatus, out *navigator.CassandraPilotStatus, s conversion.Scope) error {
+	out.Version = (*version.Version)(unsafe.Pointer(in.Version))
+	return nil
+}
+
+// Convert_v1alpha1_CassandraPilotStatus_To_navigator_CassandraPilotStatus is an autogenerated conversion function.
+func Convert_v1alpha1_CassandraPilotStatus_To_navigator_CassandraPilotStatus(in *CassandraPilotStatus, out *navigator.CassandraPilotStatus, s conversion.Scope) error {
+	return autoConvert_v1alpha1_CassandraPilotStatus_To_navigator_CassandraPilotStatus(in, out, s)
+}
+
+func autoConvert_navigator_CassandraPilotStatus_To_v1alpha1_CassandraPilotStatus(in *navigator.CassandraPilotStatus, out *CassandraPilotStatus, s conversion.Scope) error {
+	out.Version = (*version.Version)(unsafe.Pointer(in.Version))
+	return nil
+}
+
+// Convert_navigator_CassandraPilotStatus_To_v1alpha1_CassandraPilotStatus is an autogenerated conversion function.
+func Convert_navigator_CassandraPilotStatus_To_v1alpha1_CassandraPilotStatus(in *navigator.CassandraPilotStatus, out *CassandraPilotStatus, s conversion.Scope) error {
+	return autoConvert_navigator_CassandraPilotStatus_To_v1alpha1_CassandraPilotStatus(in, out, s)
+}
+
 func autoConvert_v1alpha1_ElasticsearchCluster_To_navigator_ElasticsearchCluster(in *ElasticsearchCluster, out *navigator.ElasticsearchCluster, s conversion.Scope) error {
 	out.ObjectMeta = in.ObjectMeta
 	if err := Convert_v1alpha1_ElasticsearchClusterSpec_To_navigator_ElasticsearchClusterSpec(&in.Spec, &out.Spec, s); err != nil {
@@ -695,6 +718,7 @@ func autoConvert_v1alpha1_PilotStatus_To_navigator_PilotStatus(in *PilotStatus,
 	out.LastCompletedPhase = navigator.PilotPhase(in.LastCompletedPhase)
 	out.Conditions = *(*[]navigator.PilotCondition)(unsafe.Pointer(&in.Conditions))
 	out.Elasticsearch = (*navigator.ElasticsearchPilotStatus)(unsafe.Pointer(in.Elasticsearch))
+	out.Cassandra = (*navigator.CassandraPilotStatus)(unsafe.Pointer(in.Cassandra))
 	return nil
 }
 
@@ -707,6 +731,7 @@ func autoConvert_navigator_PilotStatus_To_v1alpha1_PilotStatus(in *navigator.Pil
 	out.LastCompletedPhase = PilotPhase(in.LastCompletedPhase)
 	out.Conditions = *(*[]PilotCondition)(unsafe.Pointer(&in.Conditions))
 	out.Elasticsearch = (*ElasticsearchPilotStatus)(unsafe.Pointer(in.Elasticsearch))
+	out.Cassandra = (*CassandraPilotStatus)(unsafe.Pointer(in.Cassandra))
 	return nil
 }
 

pkg/apis/navigator/v1alpha1/zz_generated.deepcopy.go

@@ -21,6 +21,7 @@ limitations under the License.
 package v1alpha1
 
 import (
+	version "github.com/jetstack/navigator/pkg/cassandra/version"
 	runtime "k8s.io/apimachinery/pkg/runtime"
 )
 
@@ -184,6 +185,31 @@ func (in *CassandraClusterStatus) DeepCopy() *CassandraClusterStatus {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *CassandraPilotStatus) DeepCopyInto(out *CassandraPilotStatus) {
+	*out = *in
+	if in.Version != nil {
+		in, out := &in.Version, &out.Version
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(version.Version)
+			**out = **in
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CassandraPilotStatus.
+func (in *CassandraPilotStatus) DeepCopy() *CassandraPilotStatus {
+	if in == nil {
+		return nil
+	}
+	out := new(CassandraPilotStatus)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *ElasticsearchCluster) DeepCopyInto(out *ElasticsearchCluster) {
 	*out = *in
@@ -602,6 +628,15 @@ func (in *PilotStatus) DeepCopyInto(out *PilotStatus) {
 			(*in).DeepCopyInto(*out)
 		}
 	}
+	if in.Cassandra != nil {
+		in, out := &in.Cassandra, &out.Cassandra
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(CassandraPilotStatus)
+			(*in).DeepCopyInto(*out)
+		}
+	}
 	return
 }
 

pkg/apis/navigator/validation/cassandra.go

@@ -66,11 +66,5 @@ func ValidateCassandraClusterSpec(spec *navigator.CassandraClusterSpec, fldPath
 			ValidateImageSpec(spec.Image, fldPath.Child("image"))...,
 		)
 	}
-	if spec.Version.Equal(emptySemver) {
-		allErrs = append(
-			allErrs,
-			field.Required(fldPath.Child("version"), "must be a semver version"),
-		)
-	}
 	return allErrs
 }

pkg/apis/navigator/validation/cassandra_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/jetstack/navigator/pkg/apis/navigator"
 	"github.com/jetstack/navigator/pkg/apis/navigator/validation"
+	"github.com/jetstack/navigator/pkg/cassandra/version"
 )
 
 var (
@@ -16,7 +17,7 @@ var (
 			Namespace: "bar",
 		},
 		Spec: navigator.CassandraClusterSpec{
-			Version: validSemver,
+			Version: *version.New("5.6.2"),
 			Image:   &validImageSpec,
 			NavigatorClusterConfig: validNavigatorClusterConfig,
 		},

pkg/apis/navigator/zz_generated.deepcopy.go

@@ -21,6 +21,7 @@ limitations under the License.
 package navigator
 
 import (
+	version "github.com/jetstack/navigator/pkg/cassandra/version"
 	runtime "k8s.io/apimachinery/pkg/runtime"
 )
 
@@ -184,6 +185,31 @@ func (in *CassandraClusterStatus) DeepCopy() *CassandraClusterStatus {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *CassandraPilotStatus) DeepCopyInto(out *CassandraPilotStatus) {
+	*out = *in
+	if in.Version != nil {
+		in, out := &in.Version, &out.Version
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(version.Version)
+			**out = **in
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CassandraPilotStatus.
+func (in *CassandraPilotStatus) DeepCopy() *CassandraPilotStatus {
+	if in == nil {
+		return nil
+	}
+	out := new(CassandraPilotStatus)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *ElasticsearchCluster) DeepCopyInto(out *ElasticsearchCluster) {
 	*out = *in
@@ -602,6 +628,15 @@ func (in *PilotStatus) DeepCopyInto(out *PilotStatus) {
 			(*in).DeepCopyInto(*out)
 		}
 	}
+	if in.Cassandra != nil {
+		in, out := &in.Cassandra, &out.Cassandra
+		if *in == nil {
+			*out = nil
+		} else {
+			*out = new(CassandraPilotStatus)
+			(*in).DeepCopyInto(*out)
+		}
+	}
 	return
 }