aboutsummaryrefslogtreecommitdiffstats
path: root/binapigen/generator_test.go
blob: 8c2046d98602fd115633dcd89b4f8e3e52308cd9 (plain)
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
//  Copyright (c) 2020 Cisco and/or its affiliates.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at:
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

package binapigen

import (
	"bufio"
	"fmt"
	"go.fd.io/govpp/binapigen/vppapi"
	. "github.com/onsi/gomega"
	"os"
	"strings"
	"testing"
)

func TestGoModule(t *testing.T) {
	const expected = "go.fd.io/govpp/binapi"

	impPath, err := resolveImportPath("../binapi")
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	if impPath != expected {
		t.Fatalf("expected: %q, got: %q", expected, impPath)
	}
}

func TestBinapiTypeSizes(t *testing.T) {
	tests := []struct {
		name    string
		input   string
		expsize int
	}{
		{name: "basic1", input: "u8", expsize: 1},
		{name: "basic2", input: "i8", expsize: 1},
		{name: "basic3", input: "u16", expsize: 2},
		{name: "basic4", input: "i32", expsize: 4},
		{name: "string", input: "string", expsize: 1},
		{name: "invalid1", input: "x", expsize: 0},
	}
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			size := getSizeOfBinapiBaseType(test.input, 1)
			if size != test.expsize {
				t.Errorf("expected %d, got %d", test.expsize, size)
			}
		})
	}
}

func TestBinapiUnionSizes(t *testing.T) {
	RegisterTestingT(t)

	// order of the union sizes in file generated from union.api.json
	var sizes = []int{16, 4, 32, 16, 64, 111}

	// remove directory created during test
	defer func() {
		err := os.RemoveAll(testOutputDir)
		Expect(err).ToNot(HaveOccurred())
	}()

	err := GenerateFromFile("vppapi/testdata/union.api.json", Options{OutputDir: testOutputDir})
	Expect(err).ShouldNot(HaveOccurred())

	file, err := os.Open(testOutputDir + "/union/union.ba.go")
	Expect(err).ShouldNot(HaveOccurred())
	defer func() {
		err := file.Close()
		Expect(err).ToNot(HaveOccurred())
	}()

	// the generated line with union size is in format XXX_UnionData [<size>]byte
	// the prefix identifies these lines (the starting tab is important)
	prefix := fmt.Sprintf("\t%s", "XXX_UnionData [")

	index := 0
	scanner := bufio.NewScanner(file)
	for scanner.Scan() {
		if strings.HasPrefix(scanner.Text(), prefix) {
			Expect(scanner.Text()).To(Equal(prefix + fmt.Sprintf("%d]byte", sizes[index])))
			index++
		}
	}
	// ensure all union sizes were found and tested
	Expect(index).To(Equal(len(sizes)))
}

// Typed data used for union size evaluation testing.
type typeTestData struct {
	typ    string
	value  string
	fields []*typeTestData
}

func (t typeTestData) getUnion(name string) *Union {
	return &Union{
		UnionType: vppapi.UnionType{Name: name},
		Fields:    t.getUnionFields(name),
	}
}

func (t typeTestData) getUnionFields(parentName string) (fields []*Field) {
	for i, field := range t.fields {
		var (
			dataType   string
			aliasType  *Alias
			enumType   *Enum
			structType *Struct
			unionType  *Union
		)
		switch field.typ {
		case "alias":
			aliasType = &Alias{AliasType: vppapi.AliasType{Name: fmt.Sprintf("%s_alias_%d", parentName, i), Type: field.value}}
		case "enum":
			enumType = &Enum{EnumType: vppapi.EnumType{Name: fmt.Sprintf("%s_enum_%d", parentName, i), Type: field.value}}
		case "struct":
			structType = &Struct{Fields: field.getUnionFields(fmt.Sprintf("%s_struct_%d", parentName, i))}
		case "union":
			unionType = field.getUnion(parentName)
		default:
			dataType = field.value
		}
		fields = append(fields, &Field{
			Field:      vppapi.Field{Name: fmt.Sprintf("%s_field_%d", parentName, i), Type: dataType},
			TypeAlias:  aliasType,
			TypeEnum:   enumType,
			TypeStruct: structType,
			TypeUnion:  unionType,
		})
	}
	return fields
}