impl and tests for upgradeStrategy

Author: Barkha Choithani

README.md

@@ -516,6 +516,7 @@ This table describes the list of available parameters for Helm Chart.
 | `networkPolicy.customRules`      | Placeholder to specify selectors              | `{}`                               |
 | `networkPolicy.ports`      | Ports to which traffic is allowed              | `[8000, 8001, 8002]`                               |
 | `priorityClassName`      | Name of a PriortyClass defined to set pod priority        | `""`                               |
+| `updateStrategy`      | Update strategy for helm chart and app version updates        | `RollingUpdate`                               |
 
 # Known Issues and Limitations
 

charts/templates/statefulset.yaml

@@ -8,6 +8,8 @@ metadata:
 spec:
   serviceName: {{ include "marklogic.headlessServiceName" . }}
   replicas: {{ .Values.replicaCount }}
+  updateStrategy:
+    type: {{ .Values.updateStrategy.type }}
   selector:
     matchLabels:
       {{- include "marklogic.selectorLabels" . | nindent 6 }}

charts/values.yaml

@@ -3,6 +3,10 @@
 # Number of Marklogic nodes
 replicaCount: 1
 
+# update strategy for MarkLogic and Helm chart upgrades
+updateStrategy:  
+    type: RollingUpdate
+
 # Termination Grace Period
 terminationGracePeriod: 120
 

test/e2e/ml_upgrade_test.go

@@ -0,0 +1,99 @@
+package e2e
+
+import (
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/gruntwork-io/terratest/modules/helm"
+	"github.com/gruntwork-io/terratest/modules/k8s"
+	"github.com/gruntwork-io/terratest/modules/random"
+	"github.com/stretchr/testify/assert"
+	"github.com/tidwall/gjson"
+	digestAuth "github.com/xinsnake/go-http-digest-auth-client"
+)
+
+func TestHelmMLupgrade(t *testing.T) {
+	// Path to the helm chart we will test
+	helmChartPath, e := filepath.Abs("../../charts")
+	if e != nil {
+		t.Fatalf(e.Error())
+	}
+	username := "admin"
+	password := "admin"
+
+	namespaceName := "marklogic-" + strings.ToLower(random.UniqueId())
+	kubectlOptions := k8s.NewKubectlOptions("", "", namespaceName)
+	options := &helm.Options{
+		KubectlOptions: kubectlOptions,
+		SetValues: map[string]string{
+			"persistence.enabled": "false",
+			"replicaCount":        "1",
+			"image.repository":    "marklogicdb/marklogic-db",
+			"image.tag":           "latest-10.0",
+			"auth.adminUsername":  username,
+			"auth.adminPassword":  password,
+		},
+	}
+
+	t.Logf("====Creating namespace: " + namespaceName)
+	k8s.CreateNamespace(t, kubectlOptions, namespaceName)
+	defer t.Logf("====Deleting namespace: " + namespaceName)
+	defer k8s.DeleteNamespace(t, kubectlOptions, namespaceName)
+
+	t.Logf("====Installing Helm Chart")
+	releaseName := "test-ml-upgrade"
+	helm.Install(t, options, helmChartPath, releaseName)
+
+	podName := releaseName + "-marklogic-0"
+
+	// wait until second pod is in Ready status
+	k8s.WaitUntilPodAvailable(t, kubectlOptions, podName, 20, 20*time.Second)
+
+	newOptions := &helm.Options{
+		KubectlOptions: kubectlOptions,
+		SetValues: map[string]string{
+			"persistence.enabled":   "false",
+			"image.repository":      "marklogicdb/marklogic-db",
+			"image.tag":             "latest",
+			"logCollection.enabled": "false",
+		},
+	}
+
+	t.Logf("====Upgrading Helm Chart")
+	helm.Upgrade(t, newOptions, helmChartPath, releaseName)
+
+	// Give time to change status of pod from running to terminate during upgrade
+	time.Sleep(10 * time.Second)
+
+	// wait until second pod is in Ready status
+	k8s.WaitUntilPodAvailable(t, kubectlOptions, podName, 15, 30*time.Second)
+
+	tunnel := k8s.NewTunnel(
+		kubectlOptions, k8s.ResourceTypePod, podName, 8002, 8002)
+	defer tunnel.Close()
+	tunnel.ForwardPort(t)
+
+	clusterEndpoint := fmt.Sprintf("http://%s/manage/v2?format=json", tunnel.Endpoint())
+	t.Logf(`Endpoint: %s`, clusterEndpoint)
+
+	getMLversion := digestAuth.NewRequest(username, password, "GET", clusterEndpoint, "")
+
+	resp, err := getMLversion.Execute()
+	if err != nil {
+		t.Fatalf(err.Error())
+	}
+	defer resp.Body.Close()
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		t.Fatalf(err.Error())
+	}
+	mlVersion := gjson.Get(string(body), `local-cluster-default.version`)
+
+	// verify latest MarkLogic version after upgrade
+	assert.Equal(t, mlVersion.Str, "11.0.0")
+
+}

test/template/upgrade_templ_test.go

@@ -0,0 +1,53 @@
+package template_test
+
+import (
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	appsv1 "k8s.io/api/apps/v1"
+
+	"github.com/gruntwork-io/terratest/modules/helm"
+	"github.com/gruntwork-io/terratest/modules/k8s"
+	"github.com/gruntwork-io/terratest/modules/random"
+)
+
+func TestChartTemplateUpgradeStrategy(t *testing.T) {
+	t.Parallel()
+
+	// Path to the helm chart we will test
+	helmChartPath, err := filepath.Abs("../../charts")
+	releaseName := "marklogic-upgrade-test"
+	t.Log(helmChartPath, releaseName)
+	require.NoError(t, err)
+
+	// Set up the namespace; confirm that the template renders the expected value for the namespace.
+	namespaceName := "marklogic-" + strings.ToLower(random.UniqueId())
+	t.Logf("Namespace: %s\n", namespaceName)
+
+	// Setup the args for helm install
+	options := &helm.Options{
+		SetValues: map[string]string{
+			"image.repository":    "marklogicdb/marklogic-db",
+			"image.tag":           "latest",
+			"persistence.enabled": "false",
+			"updateStrategy.type": "RollingUpdate",
+		},
+		KubectlOptions: k8s.NewKubectlOptions("", "", namespaceName),
+	}
+
+	// render the tempate
+	output := helm.RenderTemplate(t, options, helmChartPath, releaseName, []string{"templates/statefulset.yaml"})
+
+	var statefulset appsv1.StatefulSet
+	helm.UnmarshalK8SYaml(t, output, &statefulset)
+
+	// Verify the name and namespace matches
+	require.Equal(t, namespaceName, statefulset.Namespace)
+
+	// Verify the updateStrategy type set for upgrade
+	expectedUpgradeStrategy := "RollingUpdate"
+	actualUpgradeStrategy := statefulset.Spec.UpdateStrategy.Type
+	require.Equal(t, string(actualUpgradeStrategy), expectedUpgradeStrategy)
+}