File: convert_test.go

package info (click to toggle)
golang-github-containers-buildah 1.39.3%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,724 kB
  • sloc: sh: 2,398; makefile: 236; perl: 187; asm: 16; awk: 12; ansic: 1
file content (166 lines) | stat: -rw-r--r-- 6,160 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
package config

import (
	"reflect"
	"slices"
	"strconv"
	"testing"

	"github.com/containers/image/v5/manifest"
	dockerclient "github.com/fsouza/go-dockerclient"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// fillAllFields recursively fills in 1 or "1" for every field in the passed-in
// structure, and that slices and maps have at least one value in them.
func fillAllFields[pStruct any](t *testing.T, st pStruct) {
	v := reflect.ValueOf(st)
	if v.Kind() == reflect.Pointer {
		v = reflect.Indirect(v)
	}
	fillAllValueFields(t, v)
}

func fillAllValueFields(t *testing.T, v reflect.Value) {
	fields := reflect.VisibleFields(v.Type())
	for _, field := range fields {
		if field.Anonymous {
			// all right, fine, keep your secrets
			continue
		}
		f := v.FieldByName(field.Name)
		var keyType, elemType reflect.Type
		if field.Type.Kind() == reflect.Map {
			keyType = field.Type.Key()
		}
		switch field.Type.Kind() {
		case reflect.Array, reflect.Chan, reflect.Map, reflect.Pointer, reflect.Slice:
			elemType = field.Type.Elem()
		}
		fillValue(t, f, field.Name, field.Type.Kind(), keyType, elemType)
	}
}

func fillValue(t *testing.T, value reflect.Value, name string, kind reflect.Kind, keyType, elemType reflect.Type) {
	switch kind {
	case reflect.Invalid,
		reflect.Array, reflect.Chan, reflect.Func, reflect.Interface, reflect.UnsafePointer,
		reflect.Float32, reflect.Float64,
		reflect.Complex64, reflect.Complex128:
		require.NotEqualf(t, kind, kind, "unhandled %s field %s: tests require updating", kind, name)
	case reflect.Bool:
		value.SetBool(true)
	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
		value.SetInt(1)
	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
		value.SetUint(1)
	case reflect.Map:
		if value.IsNil() {
			value.Set(reflect.MakeMap(value.Type()))
		}
		keyPtr := reflect.New(keyType)
		key := reflect.Indirect(keyPtr)
		fillValue(t, key, name, keyType.Kind(), nil, nil)
		elemPtr := reflect.New(elemType)
		elem := reflect.Indirect(elemPtr)
		fillValue(t, elem, name, elemType.Kind(), nil, nil)
		value.SetMapIndex(key, reflect.Indirect(elem))
	case reflect.Slice:
		vPtr := reflect.New(elemType)
		v := reflect.Indirect(vPtr)
		fillValue(t, v, name, elemType.Kind(), nil, nil)
		value.Set(reflect.Append(reflect.MakeSlice(value.Type(), 0, 1), v))
	case reflect.String:
		value.SetString("1")
	case reflect.Struct:
		fillAllValueFields(t, value)
	case reflect.Pointer:
		p := reflect.New(elemType)
		fillValue(t, reflect.Indirect(p), name, elemType.Kind(), nil, nil)
		value.Set(p)
	}
}

// checkAllFields recursively checks that every field not listed in allowZeroed
// is not set to its zero value, that every slice is not empty, and that every
// map has at least one entry.  It makes an additional exception for structs
// which have no defined fields.
func checkAllFields[pStruct any](t *testing.T, st pStruct, allowZeroed []string) {
	v := reflect.ValueOf(st)
	if v.Kind() == reflect.Pointer {
		v = reflect.Indirect(v)
	}
	checkAllValueFields(t, v, "", allowZeroed)
}

func checkAllValueFields(t *testing.T, v reflect.Value, name string, allowedToBeZero []string) {
	fields := reflect.VisibleFields(v.Type())
	for _, field := range fields {
		if field.Anonymous {
			// all right, fine, keep your secrets
			continue
		}
		fieldName := field.Name
		if name != "" {
			fieldName = name + "." + field.Name
		}
		if slices.Contains(allowedToBeZero, fieldName) {
			continue
		}
		f := v.FieldByName(field.Name)
		var elemType reflect.Type
		switch field.Type.Kind() {
		case reflect.Array, reflect.Chan, reflect.Map, reflect.Pointer, reflect.Slice:
			elemType = field.Type.Elem()
		}
		checkValue(t, f, fieldName, field.Type.Kind(), elemType, allowedToBeZero)
	}
}

func checkValue(t *testing.T, value reflect.Value, name string, kind reflect.Kind, elemType reflect.Type, allowedToBeZero []string) {
	if kind != reflect.Invalid {
		switch kind {
		case reflect.Map:
			assert.Falsef(t, value.IsZero(), "map field %s not set when it was not already expected to be left unpopulated by conversion", name)
			keys := value.MapKeys()
			for i := 0; i < len(keys); i++ {
				v := value.MapIndex(keys[i])
				checkValue(t, v, name+"{"+keys[i].String()+"}", elemType.Kind(), nil, allowedToBeZero)
			}
		case reflect.Slice:
			assert.Falsef(t, value.IsZero(), "slice field %s not set when it was not already expected to be left unpopulated by conversion", name)
			for i := 0; i < value.Len(); i++ {
				v := value.Index(i)
				checkValue(t, v, name+"["+strconv.Itoa(i)+"]", elemType.Kind(), nil, allowedToBeZero)
			}
		case reflect.Struct:
			if fields := reflect.VisibleFields(value.Type()); len(fields) != 0 {
				// structs which are defined with no fields are okay
				assert.Falsef(t, value.IsZero(), "slice field %s not set when it was not already expected to be left unpopulated by conversion", name)
			}
			checkAllValueFields(t, value, name, allowedToBeZero)
		case reflect.Pointer:
			assert.Falsef(t, value.IsZero(), "pointer field %s not set when it was not already expected to be left unpopulated by conversion", name)
			checkValue(t, reflect.Indirect(value), name, elemType.Kind(), nil, allowedToBeZero)
		}
	}
}

func TestGoDockerclientConfigFromSchema2Config(t *testing.T) {
	var input manifest.Schema2Config
	fillAllFields(t, &input)
	output := GoDockerclientConfigFromSchema2Config(&input)
	// make exceptions for fields in "output" which have no corresponding field in "input"
	notInSchema2Config := []string{"CPUSet", "CPUShares", "DNS", "Memory", "KernelMemory", "MemorySwap", "MemoryReservation", "Mounts", "PortSpecs", "PublishService", "SecurityOpts", "VolumeDriver", "VolumesFrom"}
	checkAllFields(t, output, notInSchema2Config)
}

func TestSchema2ConfigFromGoDockerclientConfig(t *testing.T) {
	var input dockerclient.Config
	fillAllFields(t, &input)
	output := Schema2ConfigFromGoDockerclientConfig(&input)
	// make exceptions for fields in "output" which have no corresponding field in "input"
	notInDockerConfig := []string{}
	checkAllFields(t, output, notInDockerConfig)
}