MYSQLCLUSTER-4665: Setup release and debug builds

Ndb operator can be now built either in release mode or in debug mode.
The debug mode is meant for development and enables verbose logging and
more panics in the mgmapi module. The mode can be controlled by setting
the WITH_DEBUG environment variable before calling make.

Change-Id: I2450dd6fca7717a7b4b1490ba2c2111f8fad5e9e

Author: lkshminarayanan

Makefile

@@ -10,6 +10,9 @@
 ARCH ?= amd64
 OS   ?= linux
 
+# Set this to 1 or ON to build operator in debug mode
+WITH_DEBUG ?= OFF
+
 # End of configurable variables
 
 .PHONY: all
@@ -32,7 +35,7 @@ manifests: $(INSTALL_ARTIFACT)
 
 .PHONY: build
 build: manifests
-	ARCH=$(ARCH) OS=$(OS) ./hack/build.sh
+	ARCH=$(ARCH) OS=$(OS) WITH_DEBUG=$(WITH_DEBUG) ./hack/build.sh
 
 .PHONY: run
 run:
@@ -57,7 +60,7 @@ e2e-tests-image:
 
 .PHONY: unit-test
 unit-test:
-	go test -v --count=1 ./pkg/...
+	go test -tags debug -v --count=1 ./pkg/...
 
 # Run e2e tests against a local K8s Cluster
 .PHONY: e2e

README.md

@@ -1,9 +1,8 @@
 # ndb-operator
 
-This repository implements a simple controller for watching Ndb resources as
-defined with a CustomResourceDefinition (CRD). 
+The MySQL NDB Operator is a Kubernetes operator for managing a MySQL Cluster setup inside a Kubernetes Cluster.
 
-This is in preview state - mostly prototyping for testing concepts.
+This is in preview state - DO NOT USE FOR PRODUCTION.
 
 ## License
 
@@ -51,6 +50,8 @@ To build the ndb-operator run,
 make build
 ```
 
+By default the operator is built in release mode. It is also possible to build the operator in debug mode by setting WITH_DEBUG environment variable to 1/ON. The debug mode can be more useful during development.
+
 Once the operator is built, a docker image can be built by running,
 
 ```sh

config/debug/build.go

@@ -0,0 +1,27 @@
+// Copyright (c) 2021, Oracle and/or its affiliates.
+//
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+package debug
+
+import (
+	"errors"
+	"fmt"
+)
+
+// Panic panics in debug builds
+func Panic(v interface{}) {
+	if Enabled {
+		panic(v)
+	}
+}
+
+// InternalError panics in a debug build and returns an error in a release build
+func InternalError(v interface{}) error {
+	errMsg := fmt.Sprintf("internal error : %v", v)
+	if Enabled {
+		panic(errMsg)
+	} else {
+		return errors.New(errMsg)
+	}
+}

config/debug/debug.go

@@ -0,0 +1,9 @@
+// Copyright (c) 2021, Oracle and/or its affiliates.
+//
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+// +build debug
+
+package debug
+
+const Enabled = true

config/debug/release.go

@@ -0,0 +1,9 @@
+// Copyright (c) 2021, Oracle and/or its affiliates.
+//
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+// +build !debug
+
+package debug
+
+const Enabled = false

config/version.go

@@ -4,6 +4,8 @@
 
 package config
 
+import "github.com/mysql/ndb-operator/config/debug"
+
 var version string
 var gitCommit string
 
@@ -12,5 +14,10 @@ func GetBuildVersion() string {
 	if version == "" || gitCommit == "" {
 		panic("version or git commit was not set during build")
 	}
-	return version + "-" + gitCommit
+	buildVersion := version + "-" + gitCommit
+	if debug.Enabled {
+		buildVersion += "-debug"
+	}
+
+	return buildVersion
 }

e2e-tests/suites/mysql/custom_cnf.go

@@ -10,13 +10,19 @@ import (
 	clientset "k8s.io/client-go/kubernetes"
 	"k8s.io/kubernetes/test/e2e/framework"
 
+	"github.com/mysql/ndb-operator/pkg/apis/ndbcontroller/v1alpha1"
+	"github.com/mysql/ndb-operator/pkg/helpers/testutils"
+
 	"github.com/mysql/ndb-operator/e2e-tests/utils/mysql"
 	"github.com/mysql/ndb-operator/e2e-tests/utils/ndbtest"
+	secretutils "github.com/mysql/ndb-operator/e2e-tests/utils/secret"
 )
 
 var _ = ndbtest.DescribeFeature("MySQL Custom cnf", func() {
 	var ns string
 	var c clientset.Interface
+	var ndbName, mysqlRootSecretName string
+	var testNdb *v1alpha1.NdbCluster
 
 	ginkgo.BeforeEach(func() {
 		ginkgo.By("extracting values from framework")
@@ -36,32 +42,46 @@ var _ = ndbtest.DescribeFeature("MySQL Custom cnf", func() {
 	ginkgo.When("a custom cnf property is specified for MySQL Server", func() {
 
 		ginkgo.BeforeEach(func() {
-			ndbtest.KubectlApplyNdbYaml(c, ns, "docs/examples", "example-ndb-cnf")
+			ndbName = "ndb-custom-cnf-test"
+			mysqlRootSecretName = ndbName + "-root-secret"
+			// create the secret first
+			secretutils.CreateSecretForMySQLRootAccount(c, mysqlRootSecretName, ns)
+			// create the Ndb resource
+			testNdb = testutils.NewTestNdb(ns, ndbName, 2)
+			testNdb.Spec.Mysqld.RootPasswordSecretName = mysqlRootSecretName
+			testNdb.Spec.Mysqld.MyCnf = "[mysqld]\nmax-user-connections=42\nlog-bin=ON"
+			ndbtest.KubectlApplyNdbObj(c, testNdb)
 		})
 
 		ginkgo.AfterEach(func() {
-			ndbtest.KubectlDeleteNdbYaml(c, ns, "example-ndb", "docs/examples", "example-ndb-cnf")
+			// cleanup
+			ndbtest.KubectlDeleteNdbObj(c, testNdb)
+			// drop the secret
+			secretutils.DeleteSecret(c, mysqlRootSecretName, ns)
 		})
 
 		ginkgo.It("should start the server with those values as the defaults", func() {
-			db := mysql.Connect(c, ns, "example-ndb", "performance_schema")
+			db := mysql.Connect(c, ns, ndbName, "performance_schema")
 
-			ginkgo.By("verifying that max_user_connections is properly set in server")
-			row := db.QueryRow(
-				"select variable_value from global_variables where variable_name = 'max_user_connections';")
-			var value int
-			framework.ExpectNoError(row.Scan(&value),
-				"querying for max_user_connections returned an error")
-			gomega.Expect(value).To(gomega.Equal(42),
-				"max_user_connections had an unexpected value")
+			ginkgo.By("verifying that max_user_connections is properly set in server", func() {
+				row := db.QueryRow(
+					"select variable_value from global_variables where variable_name = 'max_user_connections';")
+				var value int
+				framework.ExpectNoError(row.Scan(&value),
+					"querying for max_user_connections returned an error")
+				gomega.Expect(value).To(gomega.Equal(42),
+					"max_user_connections had an unexpected value")
+			})
 
-			ginkgo.By("verifying that the defaults doesn't override the value set by the operator")
-			row = db.QueryRow(
-				"select variable_value from global_variables where variable_name = 'ndb_extra_logging';")
-			framework.ExpectNoError(row.Scan(&value),
-				"querying for ndb_extra_logging returned an error")
-			gomega.Expect(value).To(gomega.Equal(99),
-				"ndb_extra_logging had an unexpected value")
+			ginkgo.By("verifying that the defaults doesn't override the value set by the operator", func() {
+				row := db.QueryRow(
+					"select variable_value from global_variables where variable_name = 'log_bin';")
+				var value string
+				framework.ExpectNoError(row.Scan(&value),
+					"querying for log_bin returned an error")
+				gomega.Expect(value).To(gomega.Or(gomega.Equal("OFF")),
+					"log_bin has an unexpected value")
+			})
 		})
 	})
 })

hack/build.sh

@@ -10,15 +10,24 @@ set -o nounset
 # Required env variables :
 # ARCH - target golang architecture
 # OS   - target golang OS
+# WITH_DEBUG - enable ndb operator debug build mode
 
 PKG=$(go list -m)
 VERSION=$(cat VERSION)
 
+BUILD_TAGS=
+if [ "${WITH_DEBUG}" = "1" ] || [ "${WITH_DEBUG}" = "ON" ]; then
+  BUILD_TAGS="debug"
+else
+  BUILD_TAGS="release"
+fi
+
 echo "Building ndb operator..."
 echo "arch:     ${ARCH}"
 echo "os:       ${OS}"
 echo "version:  ${VERSION}"
 echo "pkg:      ${PKG}"
+echo "build:    ${BUILD_TAGS}"
 
 export CGO_ENABLED=0
 export GOARCH="${ARCH}"
@@ -34,4 +43,5 @@ go build                    \
     -v                      \
     -o "${BINARIES}"        \
     -ldflags  "${LDFLAGS}"  \
+    -tags "${BUILD_TAGS}"   \
     ./...

pkg/controllers/controller_test.go

@@ -491,9 +491,4 @@ func TestCreatesCluster(t *testing.T) {
 	//f.expectUpdateNdbStatusAction(ns, ndb)
 
 	f.run(getKey(ndb, t))
-
-	// run again;
-	// only error allowed is "connection refused" as mgmd is not running
-	expectedErrors := []string{"connection refused"}
-	f.runController(getKey(ndb, t), true, expectedErrors)
 }

pkg/mgmapi/clusterstatus.go

@@ -4,7 +4,10 @@
 
 package mgmapi
 
-import "sort"
+import (
+	"github.com/mysql/ndb-operator/config/debug"
+	"sort"
+)
 
 // NodeTypeEnum identifies the node type used in NodeStatus object
 // there are more types defined in c-code, but they are not used here
@@ -28,7 +31,8 @@ func (t NodeTypeEnum) toString() string {
 	case NodeTypeAPI:
 		return "API"
 	default:
-		panic("unrecognized node type")
+		debug.Panic("unrecognized node type")
+		return ""
 	}
 }
 
@@ -74,7 +78,7 @@ func (ns *NodeStatus) setNodeTypeFromTLA(TLA string) {
 	case "API":
 		ns.NodeType = NodeTypeAPI
 	default:
-		panic("unsupported node type : " + TLA)
+		debug.Panic("unsupported node type : " + TLA)
 	}
 }
 
@@ -144,7 +148,8 @@ func (cs ClusterStatus) GetNodesGroupedByNodegroup() [][]int {
 		}
 		if !node.IsConnected {
 			// data node not connected
-			panic("should be called only when the cluster is healthy")
+			debug.Panic("should be called only when the cluster is healthy")
+			return nil
 		}
 		nodegroup := node.NodeGroup
 		if nodegroup == 65536 || nodegroup == -256 {

pkg/mgmapi/config_reader.go

@@ -7,6 +7,7 @@ package mgmapi
 import (
 	"encoding/base64"
 	"encoding/binary"
+	"github.com/mysql/ndb-operator/config/debug"
 )
 
 type configValue interface{}
@@ -29,7 +30,8 @@ func getNewConfigReader(base64EncodedData string) *configReader {
 	// decode the string
 	decodedData, err := base64.StdEncoding.DecodeString(base64EncodedData)
 	if err != nil {
-		panic("failed to decode config string : " + err.Error())
+		debug.Panic("failed to decode config string : " + err.Error())
+		return nil
 	}
 
 	return &configReader{data: decodedData}
@@ -44,11 +46,11 @@ func (cr *configReader) readUint32() uint32 {
 
 // readString reads a string from the data at the current offset
 func (cr *configReader) readString() string {
-	// Extract the length of the string first - null character
-	// is present at the end and should not be read.
-	strLen := cr.readUint32() - 1
-	//
-	s := string(cr.data[cr.offset : cr.offset+strLen])
+	// Extract the length of the string
+	strLen := cr.readUint32()
+	// Extract the string.
+	// Null character is present at the end and should not be read.
+	s := string(cr.data[cr.offset : cr.offset+strLen-1])
 	// update offset
 	strLen = strLen + ((4 - (strLen & 3)) & 3)
 	cr.offset += strLen
@@ -97,6 +99,8 @@ func (cr *configReader) readEntry() (uint32, configValue) {
 		{
 			value = cr.readString()
 		}
+	default:
+		debug.Panic("unsupported keyType in readEntry()")
 	}
 
 	return key, value
@@ -172,10 +176,11 @@ func (cr *configReader) readEntryFromSection(
 	// Node Section
 	sectionNodeId := configValues[nodeCfgNodeId]
 	if sectionNodeId == nil {
-		panic("nodeId not found in section")
+		debug.Panic("nodeId not found in section")
+		return true
 	}
 
-	if nodeIdFilter != 0 && nodeIdFilter != sectionNodeId {
+	if nodeIdFilter != 0 && nodeIdFilter != sectionNodeId.(uint32) {
 		// Caller not interested in this node
 		return false
 	}
@@ -220,9 +225,10 @@ func (cr *configReader) readConfig(sectionTypeFilter cfgSectionType, fromNodeId,
 
 	cr.totalLengthInWords = cr.readUint32()
 	cr.version = cr.readUint32()
-	// panic if the version is not what we expect
+	// configReader can handle only version 2
 	if cr.version != 2 {
-		panic("unexpected version in get config reply")
+		debug.Panic("unexpected version in get config reply")
+		return nil
 	}
 
 	cr.numOfDefaultSections = cr.readUint32()
@@ -264,7 +270,8 @@ func (cr *configReader) readConfig(sectionTypeFilter cfgSectionType, fromNodeId,
 	}
 
 	// control should never reach here if the method is used right
-	panic("failed to find the desired config key")
+	debug.Panic("failed to find the desired config key")
+	return nil
 }
 
 // readConfigFromBase64EncodedData extracts and returns the config value
@@ -273,5 +280,9 @@ func readConfigFromBase64EncodedData(
 	base64EncodedData string, sectionTypeFilter cfgSectionType, fromNodeId, configKey uint32) configValue {
 	// create a config reader and read the data
 	cr := getNewConfigReader(base64EncodedData)
+	if cr == nil {
+		return nil
+	}
+
 	return cr.readConfig(sectionTypeFilter, fromNodeId, configKey)
 }