Fix cartridge config behaviour (#149)

Author: kluevandrew

docs/deploy-example-application.md

@@ -1,5 +1,10 @@
 # Deploy example application
 
+## Table of Contents
+
+- [Install or update application using Helm](#install-or-update-application-using-helm)
+- [Work with cartridge config](#work-with-cartridge-config)
+
 This guide provides the instructions how to install the example cartridge application.
 To deploy your own application you'd need to build your own docker image
 via [Cartridge CLI](https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_cli/commands/pack/docker/).
@@ -27,6 +32,11 @@ To install or upgrade the Cartridge App using Helm, run following commands from
     helm upgrade --install tarantool-app tarantool/cartridge --values ./values.yaml -n my-namespace [--create-namespace]
     ```
 
+### Work with cartridge config
+
+- To pass cartridge cluster config fill the `tarantool.config` section in your `values.yaml` file with any valid yaml object.
+- If you need to remove some properties from config you should do it explicit by setting it to `null` value.
+
 ### Useful helm variables
 
 | JSON Path                                                     | Type          | Description                                   |

pkg/reconciliation/steps/cartridge/configure.go

@@ -1,9 +1,9 @@
 package cartridge
 
 import (
-	"github.com/google/go-cmp/cmp"
 	"github.com/tarantool/tarantool-operator/pkg/api"
 	. "github.com/tarantool/tarantool-operator/pkg/reconciliation"
+	"github.com/tarantool/tarantool-operator/pkg/utils"
 	"gopkg.in/yaml.v3"
 )
 
@@ -26,10 +26,10 @@ func (r *ConfigureStep[ConfigType, CtxType, CtrlType]) Reconcile(ctx CtxType, ct
 		return Error(err)
 	}
 
-	if cmp.Equal(actualConfig, desiredConfig) {
-		ctx.GetLogger().Info("Configs are equals do not upload")
+	if utils.IsMapSubset(actualConfig, desiredConfig) {
+		ctx.GetLogger().Info("Nothing to change in config")
 
-		return Error(err)
+		return Complete()
 	}
 
 	err = ctrl.GetTopology().ApplyCartridgeConfig(ctx, ctx.GetLeader(), desiredConfig)

pkg/topology/common.go

@@ -371,16 +371,14 @@ func (r *CommonCartridgeTopology) ApplyCartridgeConfig(ctx context.Context, lead
 	}
 
 	local desiredConfig = ...
-	local actualConfig = cartridge.config_get_readonly()
-	for key, _ in pairs(actualConfig) do
+	local safeConfig = {}
+	for key, value in pairs(desiredConfig) do
 		if not blacklist[key] then
-			if desiredConfig[key] == nil then
-				desiredConfig[key] = box.NULL
-			end
+			safeConfig[key] = value
 		end
 	end
 
-	return cartridge.config_patch_clusterwide(desiredConfig)
+	return cartridge.config_patch_clusterwide(safeConfig)
 `
 
 	var res bool

pkg/utils/cmp.go

@@ -0,0 +1,22 @@
+package utils
+
+import "github.com/google/go-cmp/cmp"
+
+func IsMapSubset(set, subset map[string]any) bool {
+	if len(subset) > len(set) {
+		return false
+	}
+
+	for k, subsetValue := range subset {
+		setValue, found := set[k]
+		if !found {
+			return false
+		}
+
+		if !cmp.Equal(setValue, subsetValue) {
+			return false
+		}
+	}
+
+	return true
+}

pkg/utils/cmp_test.go

@@ -0,0 +1,55 @@
+package utils_test
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/extensions/table"
+	. "github.com/onsi/gomega"
+	"github.com/tarantool/tarantool-operator/pkg/utils"
+)
+
+var _ = Describe("cmp utils unit testing", func() {
+	DescribeTable(
+		"should return true if map is subset of another map",
+		func(set, subset map[string]any) {
+			Expect(utils.IsMapSubset(set, subset)).Should(BeTrue())
+		},
+		Entry("Empty and empty", map[string]any{}, map[string]any{}),
+		Entry("Not empty empty", map[string]any{
+			"key":     map[string]any{"val": 1},
+			"key.yml": "{\"val\": 1}",
+		}, map[string]any{}),
+		Entry("Not empty and not empty", map[string]any{
+			"key":     map[string]any{"val": 1},
+			"key.yml": "{\"val\": 1}",
+		}, map[string]any{
+			"key": map[string]any{"val": 1},
+		}),
+	)
+
+	DescribeTable(
+		"should return false if map is NOT subset of another map",
+		func(set, subset map[string]any) {
+			Expect(utils.IsMapSubset(set, subset)).Should(BeFalse())
+		},
+		Entry("contains changed ket", map[string]any{
+			"key":     map[string]any{"val": 1},
+			"key.yml": "{\"val\": 1}",
+		}, map[string]any{
+			"new_key": map[string]any{"val": 1},
+		}),
+		Entry("contains changed value", map[string]any{
+			"key":     map[string]any{"val": 1},
+			"key.yml": "{\"val\": 1}",
+		}, map[string]any{
+			"key": map[string]any{"val": 2},
+		}),
+
+		Entry("empty contains new entry", map[string]any{
+			"key":     map[string]any{"val": 1},
+			"key.yml": "{\"val\": 1}",
+		}, map[string]any{
+			"key":     map[string]any{"val": 1},
+			"new_key": map[string]any{"val": 2},
+		}),
+	)
+})

pkg/utils/vshard_test.go

@@ -7,7 +7,7 @@ import (
 	"github.com/tarantool/tarantool-operator/pkg/utils"
 )
 
-var _ = Describe("role utils unit testing", func() {
+var _ = Describe("vshard utils unit testing", func() {
 	Describe(`IsVShardRolesEquals function must compare two arrays of roles for equality, respecting the hierarchy and regardless of the order of the elements`,
 		func() {
 			Context("positive cases (equal arrays)", func() {