terraform-provider-google/google/api_versions_test.go

package google

import (
	"reflect"
	"testing"
)

type ExpectedApiVersions struct {
	Create     ApiVersion
	ReadDelete ApiVersion
	Update     ApiVersion
}

func TestApiVersion(t *testing.T) {
	baseVersion := v1
	betaVersion := v0beta
	maxTestApiVersion := func(versionsInUse map[ApiVersion]struct{}) ApiVersion {
		if _, ok := versionsInUse[betaVersion]; ok {
			return betaVersion
		}
		return baseVersion
	}

	cases := map[string]struct {
		Features         []Feature
		FieldsInSchema   map[string]interface{}
		UpdatedFields    []string
		UpdateOnlyFields []Feature
		ExpectedApiVersions
	}{
		"no beta field": {
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     baseVersion,
			},
		},
		"beta field not set": {
			Features: []Feature{{Version: betaVersion, Item: "beta_field"}},
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     baseVersion,
			},
		},
		"beta field set": {
			Features: []Feature{{Version: betaVersion, Item: "beta_field"}},
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
				"beta_field":   "bar",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     betaVersion,
				ReadDelete: betaVersion,
				Update:     betaVersion,
			},
		},
		"update only beta field": {
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
			},
			UpdatedFields:    []string{"beta_update_field"},
			UpdateOnlyFields: []Feature{{Version: betaVersion, Item: "beta_update_field"}},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     betaVersion,
			},
		},
		"nested beta field not set": {
			Features: []Feature{{Version: betaVersion, Item: "list_field.*.beta_nested_field"}},
			FieldsInSchema: map[string]interface{}{
				"list_field.#":              2,
				"list_field.0.normal_field": "foo",
				"list_field.1.normal_field": "bar",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     baseVersion,
			},
		},
		"nested beta field set": {
			Features: []Feature{{Version: betaVersion, Item: "list_field.*.beta_nested_field"}},
			FieldsInSchema: map[string]interface{}{
				"list_field.#":                   2,
				"list_field.0.normal_field":      "foo",
				"list_field.1.normal_field":      "bar",
				"list_field.1.beta_nested_field": "baz",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     betaVersion,
				ReadDelete: betaVersion,
				Update:     betaVersion,
			},
		},
		"double nested fields set": {
			Features: []Feature{{Version: betaVersion, Item: "list_field.*.nested_list_field.*.beta_nested_field"}},
			FieldsInSchema: map[string]interface{}{
				"list_field.#":                                       1,
				"list_field.0.nested_list_field.#":                   1,
				"list_field.0.nested_list_field.0.beta_nested_field": "foo",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     betaVersion,
				ReadDelete: betaVersion,
				Update:     betaVersion,
			},
		},
		"beta field has default value": {
			Features: []Feature{{Version: betaVersion, Item: "beta_field", DefaultValue: "bar"}},
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
				"beta_field":   "bar",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     baseVersion,
			},
		},
		"beta field is updated to default value": {
			Features: []Feature{{Version: betaVersion, Item: "beta_field", DefaultValue: "bar"}},
			FieldsInSchema: map[string]interface{}{
				"normal_field": "foo",
				"beta_field":   "bar",
			},
			UpdatedFields: []string{"beta_field"},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     betaVersion,
			},
		},
		"nested beta field has default value": {
			Features: []Feature{{Version: betaVersion, Item: "list_field.*.beta_nested_field", DefaultValue: "baz"}},
			FieldsInSchema: map[string]interface{}{
				"list_field.#":                   2,
				"list_field.0.normal_field":      "foo",
				"list_field.1.normal_field":      "bar",
				"list_field.1.beta_nested_field": "baz",
			},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     baseVersion,
			},
		},
		"nested beta field is updated default value": {
			Features: []Feature{{Version: betaVersion, Item: "list_field.*.beta_nested_field", DefaultValue: "baz"}},
			FieldsInSchema: map[string]interface{}{
				"list_field.#":                   2,
				"list_field.0.normal_field":      "foo",
				"list_field.1.normal_field":      "bar",
				"list_field.1.beta_nested_field": "baz",
			},
			UpdatedFields: []string{"list_field.1.beta_nested_field"},
			ExpectedApiVersions: ExpectedApiVersions{
				Create:     baseVersion,
				ReadDelete: baseVersion,
				Update:     betaVersion,
			},
		},
	}

	for tn, tc := range cases {
		// Create
		// All fields with value have HasChange set to true.
		keys := make([]string, 0, len(tc.FieldsInSchema))
		for key := range tc.FieldsInSchema {
			keys = append(keys, key)
		}

		d := &ResourceDataMock{
			FieldsInSchema:      tc.FieldsInSchema,
			FieldsWithHasChange: keys,
		}

		apiVersion := getApiVersion(d, v1, tc.Features, maxTestApiVersion)
		if apiVersion != tc.ExpectedApiVersions.Create {
			t.Errorf("bad: %s, Expected to see version %v for create, got version %v", tn, tc.ExpectedApiVersions.Create, apiVersion)
		}

		// Read/Delete
		// All fields have HasChange set to false.
		d = &ResourceDataMock{
			FieldsInSchema: tc.FieldsInSchema,
		}

		apiVersion = getApiVersion(d, v1, tc.Features, maxTestApiVersion)
		if apiVersion != tc.ExpectedApiVersions.ReadDelete {
			t.Errorf("bad: %s, Expected to see version %v for read/delete, got version %v", tn, tc.ExpectedApiVersions.ReadDelete, apiVersion)
		}

		// Update
		// Only fields defined as updated in the test case have HasChange set to true.
		d = &ResourceDataMock{
			FieldsInSchema:      tc.FieldsInSchema,
			FieldsWithHasChange: tc.UpdatedFields,
		}

		apiVersion = getApiVersionUpdate(d, v1, tc.Features, tc.UpdateOnlyFields, maxTestApiVersion)
		if apiVersion != tc.ExpectedApiVersions.Update {
			t.Errorf("bad: %s, Expected to see version %v for update, got version %v", tn, tc.ExpectedApiVersions.Update, apiVersion)
		}
	}
}

func TestSetOmittedFields(t *testing.T) {
	type Inner struct {
		InnerNotOmitted string   `json:"notOmitted"`
		InnerOmitted    []string `json:"-"`
	}
	type InputOuter struct {
		NotOmitted      string   `json:"notOmitted"`
		Omitted         []string `json:"-"`
		Struct          Inner
		Pointer         *Inner
		StructSlice     []Inner
		PointerSlice    []*Inner
		Unset           *Inner
		OnlyInInputType *Inner
	}
	type OutputOuter struct {
		NotOmitted       string   `json:"notOmitted"`
		Omitted          []string `json:"-"`
		Struct           Inner
		Pointer          *Inner
		StructSlice      []Inner
		PointerSlice     []*Inner
		Unset            *Inner
		OnlyInOutputType *Inner
	}

	input := &InputOuter{
		NotOmitted: "foo",
		Omitted:    []string{"foo"},
		Struct: Inner{
			InnerNotOmitted: "foo",
			InnerOmitted:    []string{"foo"},
		},
		Pointer: &Inner{
			InnerNotOmitted: "foo",
			InnerOmitted:    []string{"foo"},
		},
		StructSlice: []Inner{
			{
				InnerNotOmitted: "foo",
				InnerOmitted:    []string{"foo"},
			}, {
				InnerNotOmitted: "bar",
				InnerOmitted:    []string{"bar"},
			},
		},
		PointerSlice: []*Inner{
			{
				InnerNotOmitted: "foo",
				InnerOmitted:    []string{"foo"},
			}, {
				InnerNotOmitted: "bar",
				InnerOmitted:    []string{"bar"},
			},
		},
		OnlyInInputType: &Inner{
			InnerNotOmitted: "foo",
			InnerOmitted:    []string{"foo"},
		},
	}
	output := &OutputOuter{}
	Convert(input, output)
	if input.NotOmitted != output.NotOmitted ||
		!reflect.DeepEqual(input.Omitted, output.Omitted) ||
		!reflect.DeepEqual(input.Struct, output.Struct) ||
		!reflect.DeepEqual(input.Pointer, output.Pointer) ||
		!reflect.DeepEqual(input.StructSlice, output.StructSlice) ||
		!reflect.DeepEqual(input.PointerSlice, output.PointerSlice) ||
		!(input.Unset == nil && output.Unset == nil) {
		t.Errorf("Structs were not equivalent after conversion:\nInput:%#v\nOutput: %#v", input, output)
	}
}

type ResourceDataMock struct {
	FieldsInSchema      map[string]interface{}
	FieldsWithHasChange []string
	id                  string
}

func (d *ResourceDataMock) HasChange(key string) bool {
	exists := false
	for _, val := range d.FieldsWithHasChange {
		if key == val {
			exists = true
		}
	}

	return exists
}

func (d *ResourceDataMock) GetOk(key string) (interface{}, bool) {
	for k, v := range d.FieldsInSchema {
		if key == k {
			return v, true
		}
	}

	return nil, false
}

func (d *ResourceDataMock) Set(key string, value interface{}) error {
	d.FieldsInSchema[key] = value
	return nil
}

func (d *ResourceDataMock) SetId(v string) {
	d.id = v
}

func (d *ResourceDataMock) Id() string {
	return d.id
}