Merge pull request #116 from bitrise-io/feature/serialize-model-fix

EnvsYMLModel -> EnvsSerializeModel ; EnvsSerializeModel.Normalize

cli/add.go

@@ -25,7 +25,7 @@ func envListSizeInBytes(envs []models.EnvironmentItemModel) (int, error) {
 
 func validateEnv(key, value string, envList []models.EnvironmentItemModel) (string, error) {
 	if key == "" {
-		return "", errors.New("Key is not specified, required.")
+		return "", errors.New("Key is not specified, required")
 	}
 
 	configs, err := envman.GetConfigs()

envman/util.go

@@ -121,18 +121,18 @@ func removeDefaults(env *models.EnvironmentItemModel) error {
 	return nil
 }
 
-func generateFormattedYMLForEnvModels(envs []models.EnvironmentItemModel) (models.EnvsYMLModel, error) {
+func generateFormattedYMLForEnvModels(envs []models.EnvironmentItemModel) (models.EnvsSerializeModel, error) {
 	envMapSlice := []models.EnvironmentItemModel{}
 	for _, env := range envs {
 		err := removeDefaults(&env)
 		if err != nil {
-			return models.EnvsYMLModel{}, err
+			return models.EnvsSerializeModel{}, err
 		}
 
 		hasOptions := false
 		opts, err := env.GetOptions()
 		if err != nil {
-			return models.EnvsYMLModel{}, err
+			return models.EnvsSerializeModel{}, err
 		}
 
 		if opts.Title != nil {
@@ -170,7 +170,7 @@ func generateFormattedYMLForEnvModels(envs []models.EnvironmentItemModel) (model
 		envMapSlice = append(envMapSlice, env)
 	}
 
-	return models.EnvsYMLModel{
+	return models.EnvsSerializeModel{
 		Envs: envMapSlice,
 	}, nil
 }
@@ -212,7 +212,7 @@ func InitAtPath(pth string) error {
 
 // ParseEnvsYML ...
 func ParseEnvsYML(bytes []byte) ([]models.EnvironmentItemModel, error) {
-	var envsYML models.EnvsYMLModel
+	var envsYML models.EnvsSerializeModel
 	if err := yaml.Unmarshal(bytes, &envsYML); err != nil {
 		return []models.EnvironmentItemModel{}, err
 	}

models/models.go

@@ -19,9 +19,9 @@ type EnvironmentItemOptionsModel struct {
 // EnvironmentItemModel ...
 type EnvironmentItemModel map[string]interface{}
 
-// EnvsYMLModel ...
-type EnvsYMLModel struct {
-	Envs []EnvironmentItemModel `yaml:"envs"`
+// EnvsSerializeModel ...
+type EnvsSerializeModel struct {
+	Envs []EnvironmentItemModel `json:"envs",yaml:"envs"`
 }
 
 // EnvsJSONListModel ...

models/models_methods.go

@@ -223,6 +223,20 @@ func (env *EnvironmentItemModel) Normalize() error {
 	return nil
 }
 
+// Normalize - if successful this makes the model JSON serializable.
+// Without this, if the object was created with e.g. a YAML parser,
+// the type of `opts` might be map[interface]interface, which is not JSON serializable.
+// After this call it's ensured that the type of objects is map[string]interface,
+// which is JSON serializable.
+func (envsSerializeObj *EnvsSerializeModel) Normalize() error {
+	for _, envObj := range envsSerializeObj.Envs {
+		if err := envObj.Normalize(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // FillMissingDefaults ...
 func (env *EnvironmentItemModel) FillMissingDefaults() error {
 	options, err := env.GetOptions()

models/models_methods_test.go

@@ -3,6 +3,10 @@ package models
 import (
 	"testing"
 
+	yaml "gopkg.in/yaml.v2"
+
+	"encoding/json"
+
 	"github.com/bitrise-io/go-utils/pointers"
 	"github.com/stretchr/testify/require"
 )
@@ -359,3 +363,33 @@ func TestValidate(t *testing.T) {
 	}
 	require.NoError(t, env.Validate())
 }
+
+func Test_EnvsSerializeModel_Normalize(t *testing.T) {
+	yamlContent := `envs:
+- KEY_ONE: first value
+- KEY_TWO: second value, with options
+  opts:
+    is_expand: true
+`
+	var objFromYAML EnvsSerializeModel
+	require.NoError(t, yaml.Unmarshal([]byte(yamlContent), &objFromYAML))
+
+	// the objFromYAML object in this state can't be serialized to JSON directly,
+	// as the YAML parser parses the `opts` into map[interface]interface,
+	// which is not supported by JSON
+	{
+		_, err := json.Marshal(objFromYAML)
+		require.EqualError(t, err, `json: unsupported type: map[interface {}]interface {}`)
+	}
+
+	// now, if we call Normalize on this object, that will convert the map[interface]interface
+	// into map[string]interface, which is JSON serializable
+	require.NoError(t, objFromYAML.Normalize())
+
+	// let's try the serialization again - this time it will work!
+	{
+		jsonContBytes, err := json.Marshal(objFromYAML)
+		require.NoError(t, err)
+		require.Equal(t, `{"envs":[{"KEY_ONE":"first value","opts":{}},{"KEY_TWO":"second value, with options","opts":{"is_expand":true}}]}`, string(jsonContBytes))
+	}
+}