Added unit tests to check config properties and tags

spi/config/configuration.go

@@ -72,7 +72,6 @@ type PostgreSQLConfig struct {
  ReplicationSlot ReplicationSlotConfig `toml:"replicationslot" yaml:"replicationSlot"`
  Transaction TransactionConfig `toml:"transaction" yaml:"transaction"`
  Snapshot SnapshotConfig `toml:"snapshot" yaml:"snapshot"`
- Internal InternalConfig `toml:"internal" yaml:"internal"`
 }
 
 type InternalConfig struct {
@@ -161,7 +160,7 @@ type NatsConfig struct {
 }
 
 type KafkaSaslConfig struct {
- Enabled bool `toml:"user" yaml:"enabled"`
+ Enabled bool `toml:"enabled" yaml:"enabled"`
  User string `toml:"user" yaml:"user"`
  Password string `toml:"password" yaml:"password"`
  Mechanism sarama.SASLMechanism `toml:"mechanism" yaml:"mechanism"`
@@ -265,6 +264,7 @@ type Config struct {
  TimescaleDB TimescaleDBConfig `toml:"timescaledb" yaml:"timescaledb"`
  Logging LoggerConfig `toml:"logging" yaml:"logging"`
  StateStorage StateStorageConfig `toml:"statestorage" yaml:"stateStorage"`
+ Internal InternalConfig `toml:"internal" yaml:"internal"`
  Plugins []string `toml:"plugins" yaml:"plugins"`
 }
 

spi/config/configuration_test.go

@@ -23,6 +23,7 @@ import (
  "os"
  "reflect"
  "runtime"
+ "strings"
  "testing"
 )
 
@@ -326,3 +327,34 @@ postgresql.transaction.window.maxsize = 100000`
  assert.Equal(t, 60, config.PostgreSQL.Transaction.Window.Timeout)
  assert.Equal(t, uint(100000), config.PostgreSQL.Transaction.Window.MaxSize)
 }
+
+func Test_Config_Tags_Match_Between_Yaml_Toml(t *testing.T) {
+ configValue := reflect.ValueOf(Config{})
+
+ var recursiveCheck func(value reflect.Value, path string)
+ recursiveCheck = func(value reflect.Value, path string) {
+ numOfFields := value.NumField()
+ for i := 0; i < numOfFields; i++ {
+ fieldType := value.Type().Field(i)
+
+ toml := fieldType.Tag.Get("toml")
+ yaml := fieldType.Tag.Get("yaml")
+
+ fieldPath := toml
+ if len(path) > 0 {
+ fieldPath = path + "." + fieldPath
+ }
+
+ if strings.ToLower(yaml) != toml {
+ t.Errorf("Yaml and Toml tags aren't matching at path %s: %s != %s", fieldPath, yaml, toml)
+ }
+
+ fieldValue := value.Field(i)
+ if fieldValue.Kind() == reflect.Struct {
+ recursiveCheck(fieldValue, fieldPath)
+ }
+ }
+ }
+
+ recursiveCheck(configValue, "")
+}

spi/config/constants_test.go

@@ -0,0 +1,45 @@
+package config
+
+import (
+ "go/ast"
+ "go/parser"
+ "go/token"
+ "reflect"
+ "strings"
+ "testing"
+)
+
+func Test_Constants_Properties(t *testing.T) {
+ file, err := parser.ParseFile(&token.FileSet{}, "./constants.go", nil, 0)
+ if err != nil {
+ t.Error(err)
+ }
+
+ ast.Walk(&visitor{t: t}, file)
+}
+
+type visitor struct {
+ config Config
+ t *testing.T
+}
+
+func (v *visitor) Visit(node ast.Node) (w ast.Visitor) {
+ if valueSpec, ok := node.(*ast.ValueSpec); ok {
+ name := valueSpec.Names[0].Name
+ literal := valueSpec.Values[0].(*ast.BasicLit)
+
+ element := reflect.ValueOf(v.config)
+ value := literal.Value[1 : len(literal.Value)-1]
+
+ properties := strings.Split(value, ".")
+ for _, property := range properties {
+ if e, ok := findProperty(element, property); ok {
+ element = e
+ } else {
+ v.t.Errorf("Property %s isn't defined in Config", name)
+ break
+ }
+ }
+ }
+ return v
+}