Refactor GoVPP

Squashed commit of the following:

commit 348930db31575e9f59b3834d9fec07411f011e05
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:30:13 2018 +0200

    Use debug level for log about different context

commit 9fc963c559cea67a41b85c6cdadc322fb3b1fc7c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:22:03 2018 +0200

    Remove annoying logs and add env vars for debugging

commit fdc9fd624d13feadb602e0d03d58f8a44b7a565f
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:18:47 2018 +0200

    Fix printing unknown VPPApiError

commit 8f968be36a91de4d4a8ea17593ba314f82aa9583
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Tue Aug 14 17:25:10 2018 +0200

    Refactor entire GoVPP

    - fix some cases with inconsistent VPP messages, causing messages
      to be incorrectly identified as event or request
    - simplify API, remove direct access to internal Go channels
    - add module name with message to registration of messages
    - start watching filesystem only when vpe-api file does not exist
    - simplify code in message codec and remove unneeded parts
    - retrieve IDs of all registered messages after connect to VPP
    - define fallback for control ping in core to avoid duplicate registration
    - add SetLogLevel function to set logger level more easily
    - remove lot of unused code

commit 34dd1b7e10ef0324aa8c4e4cc42375bd6021c6cb
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 11:29:54 2018 +0200

    Rename VnetError to VPPApiError

commit c6549d6f77847a1367a12ff47fb716e2955e973a
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 10:23:43 2018 +0200

    Fix examples and regenerate binapi

commit 4612e36b416779771f5efab4fc654c2766d2cb1c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 09:51:22 2018 +0200

    Add parsing and generation for services

commit ac9c5280c5aa27e325f327609e2364cc66f3723f
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Fri Aug 10 14:30:15 2018 +0200

    Fix exit status on error and add continue-onerror flag

commit 9b3f4ef9fc7c8c62037fa107085eae18a8725314
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 15:20:56 2018 +0200

    Return VnetError when Retval != 0

commit 8fd21a907b5e628ec4d2026215b83d15da96c297
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 14:59:05 2018 +0200

    Add all missing errors from api_errno.h

commit 08450f288d3046ebaecf40203174ae342a07f1eb
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 14:29:27 2018 +0200

    Update README

commit d8dced0728dd62243539be741868fb7d9b8de4cc
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:59:59 2018 +0200

    Regenerate vpe in core

commit 254da7592cdbf634cf7aa46ae36ce7bb6d4ee555
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:37:00 2018 +0200

    Add VnetError type for Retvals

commit 4475c1087fb53ab4c788e530bc7fef7cfc89d2cd
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:36:07 2018 +0200

    Add registration API

commit 892a3ea5a2c703e2f7c29331663f6a6fa706bff5
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:30:43 2018 +0200

    Generate registration for messages and check all IDs on connect

commit 389ed03b6e7082260281866c3449d72d72347c99
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:32:41 2018 +0200

    Show error for empty adapter (on Darwin/Windows)

commit ef1ea040d656ade64242432dc5f06810ed8dcde6
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:31:37 2018 +0200

    Improve logged info

commit d4adae3b14ed54c8d693060dd857fa9ba5ec8e06
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:27:48 2018 +0200

    Update examples

commit 63921e1346014701a22639a2611129563bb1eb78
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:02:56 2018 +0200

    Generate unions and fix some issues

    - add comments between sections
    - define structs on single line if it has no fields
    - generate unions with setters/getters for each field
    - fix detection of message type

commit 6ab3e3fa590b245898306a6ffaf32c7721eab60c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 8 15:37:10 2018 +0200

    Refactor binapi-generator

    - split JSON parsing from code generation
    - parse and generate enums
    - parse unions (no generation yet)
    - change output file suffix to '.ba.go'
    - cleanup and simplify code
    - split code into files
    - add flag for debug mode

Change-Id: I58f685e0d4c7a38e9a7b6ea0a1f47792d95d7399
Signed-off-by: Ondrej Fabry <ofabry@cisco.com>

1 files changed, 455 insertions, 0 deletions

diff --git a/cmd/binapi-generator/generate_test.go b/cmd/binapi-generator/generate_test.go
new file mode 100644
index 0000000..c1181f0
--- /dev/null
+++ b/cmd/binapi-generator/generate_test.go
@@ -0,0 +1,455 @@
+// Copyright (c) 2017 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 main
+
+import (
+	"os"
+	"testing"
+
+	. "github.com/onsi/gomega"
+)
+
+func TestGetInputFiles(t *testing.T) {
+	RegisterTestingT(t)
+	result, err := getInputFiles("testdata")
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(result).To(HaveLen(5))
+	for _, file := range result {
+		Expect(file).To(BeAnExistingFile())
+	}
+}
+
+func TestGetInputFilesError(t *testing.T) {
+	RegisterTestingT(t)
+	result, err := getInputFiles("nonexisting_directory")
+	Expect(err).Should(HaveOccurred())
+	Expect(result).To(BeNil())
+}
+
+func TestGenerateFromFile(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	// remove directory created during test
+	defer os.RemoveAll(outDir)
+	err := generateFromFile("testdata/acl.api.json", outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	fileInfo, err := os.Stat(outDir + "/acl/acl.go")
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(fileInfo.IsDir()).To(BeFalse())
+	Expect(fileInfo.Name()).To(BeEquivalentTo("acl.go"))
+}
+
+func TestGenerateFromFileInputError(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	err := generateFromFile("testdata/nonexisting.json", outDir)
+	Expect(err).Should(HaveOccurred())
+	Expect(err.Error()).To(ContainSubstring("reading data from file failed"))
+}
+
+func TestGenerateFromFileReadJsonError(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	err := generateFromFile("testdata/input-read-json-error.json", outDir)
+	Expect(err).Should(HaveOccurred())
+	Expect(err.Error()).To(ContainSubstring("JSON unmarshall failed"))
+}
+
+func TestGenerateFromFileGeneratePackageError(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	// generate package throws panic, recover after it
+	defer func() {
+		if recovery := recover(); recovery != nil {
+			t.Logf("Recovered from panic: %v", recovery)
+		}
+		os.RemoveAll(outDir)
+	}()
+	err := generateFromFile("testdata/input-generate-error.json", outDir)
+	Expect(err).Should(HaveOccurred())
+}
+
+func TestGetContext(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	result, err := getContext("testdata/af_packet.api.json", outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(result).ToNot(BeNil())
+	Expect(result.outputFile).To(BeEquivalentTo(outDir + "/af_packet/af_packet.go"))
+}
+
+func TestGetContextNoJsonFile(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	result, err := getContext("testdata/input.txt", outDir)
+	Expect(err).Should(HaveOccurred())
+	Expect(err.Error()).To(ContainSubstring("invalid input file name"))
+	Expect(result).To(BeNil())
+}
+
+func TestGetContextInterfaceJson(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	result, err := getContext("testdata/interface.json", outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(result).ToNot(BeNil())
+	Expect(result.outputFile)
+	Expect(result.outputFile).To(BeEquivalentTo(outDir + "/interfaces/interfaces.go"))
+
+}
+
+func TestReadJson(t *testing.T) {
+	RegisterTestingT(t)
+	inputData, err := readFile("testdata/af_packet.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	result, err := parseJSON(inputData)
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(result).ToNot(BeNil())
+	Expect(result.Len()).To(BeEquivalentTo(5))
+}
+
+func TestReadJsonError(t *testing.T) {
+	RegisterTestingT(t)
+	inputData, err := readFile("testdata/input-read-json-error.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	result, err := parseJSON(inputData)
+	Expect(err).Should(HaveOccurred())
+	Expect(result).To(BeNil())
+}
+
+/*
+func TestGeneratePackage(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/ip.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	testCtx.inputBuff = bytes.NewBuffer(inputData)
+	inFile, _ := parseJSON(inputData)
+	outDir := "test_output_directory"
+	outFile, _ := os.Create(outDir)
+	defer os.RemoveAll(outDir)
+
+	// prepare writer
+	writer := bufio.NewWriter(outFile)
+	Expect(writer.Buffered()).To(BeZero())
+	err = generatePackage(testCtx, writer)
+	Expect(err).ShouldNot(HaveOccurred())
+}
+
+
+func TestGenerateMessageType(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/ip.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	testCtx.inputBuff = bytes.NewBuffer(inputData)
+	inFile, _ := parseJSON(inputData)
+	outDir := "test_output_directory"
+	outFile, _ := os.Create(outDir)
+	defer os.RemoveAll(outDir)
+
+	// prepare writer
+	writer := bufio.NewWriter(outFile)
+
+	types := inFile.Map("types")
+	testCtx.types = map[string]string{
+		"u32": "sw_if_index",
+		"u8":  "weight",
+	}
+	Expect(types.Len()).To(BeEquivalentTo(1))
+	for i := 0; i < types.Len(); i++ {
+		typ := types.At(i)
+		Expect(writer.Buffered()).To(BeZero())
+		err := generateMessage(testCtx, writer, typ, true)
+		Expect(err).ShouldNot(HaveOccurred())
+		Expect(writer.Buffered()).ToNot(BeZero())
+
+	}
+}
+
+func TestGenerateMessageName(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/ip.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	testCtx.inputBuff = bytes.NewBuffer(inputData)
+	inFile, _ := parseJSON(inputData)
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	defer os.RemoveAll(outDir)
+
+	// prepare writer
+	writer := bufio.NewWriter(outFile)
+
+	types := inFile.Map("types")
+	Expect(types.Len()).To(BeEquivalentTo(1))
+	for i := 0; i < types.Len(); i++ {
+		typ := types.At(i)
+		Expect(writer.Buffered()).To(BeZero())
+		err := generateMessage(testCtx, writer, typ, false)
+		Expect(err).ShouldNot(HaveOccurred())
+		Expect(writer.Buffered()).ToNot(BeZero())
+
+	}
+}
+
+func TestGenerateMessageFieldTypes(t *testing.T) {
+	// expected results according to acl.api.json in testdata
+	expectedTypes := []string{
+		"\tIsPermit uint8",
+		"\tIsIpv6 uint8",
+		"\tSrcIPAddr []byte	`struc:\"[16]byte\"`",
+		"\tSrcIPPrefixLen uint8",
+		"\tDstIPAddr []byte	`struc:\"[16]byte\"`",
+		"\tDstIPPrefixLen uint8",
+		"\tProto uint8",
+		"\tSrcportOrIcmptypeFirst uint16",
+		"\tSrcportOrIcmptypeLast uint16",
+		"\tDstportOrIcmpcodeFirst uint16",
+		"\tDstportOrIcmpcodeLast uint16",
+		"\tTCPFlagsMask uint8",
+		"\tTCPFlagsValue uint8"}
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/acl.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	inFile, err := parseJSON(inputData)
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(inFile).ToNot(BeNil())
+
+	// test types
+	types := inFile.Map("types")
+	fields := make([]string, 0)
+	for i := 0; i < types.Len(); i++ {
+		for j := 0; j < types.At(i).Len(); j++ {
+			field := types.At(i).At(j)
+			if field.GetType() == jsongo.TypeArray {
+				err := processMessageField(testCtx, &fields, field, false)
+				Expect(err).ShouldNot(HaveOccurred())
+				Expect(fields[j-1]).To(BeEquivalentTo(expectedTypes[j-1]))
+			}
+		}
+	}
+}
+
+func TestGenerateMessageFieldMessages(t *testing.T) {
+	// expected results according to acl.api.json in testdata
+	expectedFields := []string{"\tMajor uint32", "\tMinor uint32", "\tRetval int32",
+		"\tVpePid uint32", "\tACLIndex uint32", "\tTag []byte	`struc:\"[64]byte\"`",
+		"\tCount uint32"}
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/acl.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	inFile, err := parseJSON(inputData)
+	Expect(err).ShouldNot(HaveOccurred())
+	Expect(inFile).ToNot(BeNil())
+
+	// test message fields
+	messages := inFile.Map("messages")
+	customIndex := 0
+	fields := make([]string, 0)
+	for i := 0; i < messages.Len(); i++ {
+		for j := 0; j < messages.At(i).Len(); j++ {
+			field := messages.At(i).At(j)
+			if field.GetType() == jsongo.TypeArray {
+				specificFieldName := field.At(1).Get().(string)
+				if specificFieldName == "crc" || specificFieldName == "_vl_msg_id" ||
+					specificFieldName == "client_index" || specificFieldName == "context" {
+					continue
+				}
+				err := processMessageField(testCtx, &fields, field, false)
+				Expect(err).ShouldNot(HaveOccurred())
+				Expect(fields[customIndex]).To(BeEquivalentTo(expectedFields[customIndex]))
+				customIndex++
+				if customIndex >= len(expectedFields) {
+					// there is too much fields now for one UT...
+					return
+				}
+			}
+		}
+	}
+}
+
+func TestGeneratePackageHeader(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+
+	// prepare input/output output files
+	inputData, err := readFile("testdata/acl.api.json")
+	Expect(err).ShouldNot(HaveOccurred())
+	inFile, err := parseJSON(inputData)
+	Expect(err).ShouldNot(HaveOccurred())
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	defer os.RemoveAll(outDir)
+	// prepare writer
+	writer := bufio.NewWriter(outFile)
+	Expect(writer.Buffered()).To(BeZero())
+	generateHeader(testCtx, writer, inFile)
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestGenerateMessageCommentType(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+	testCtx.inputBuff = bytes.NewBuffer([]byte("test content"))
+
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	writer := bufio.NewWriter(outFile)
+	defer os.RemoveAll(outDir)
+	Expect(writer.Buffered()).To(BeZero())
+	generateMessageComment(testCtx, writer, "test-struct", "msg-name", true)
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestGenerateMessageCommentMessage(t *testing.T) {
+	RegisterTestingT(t)
+	// prepare context
+	testCtx := new(context)
+	testCtx.packageName = "test-package-name"
+	testCtx.inputBuff = bytes.NewBuffer([]byte("test content"))
+
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	writer := bufio.NewWriter(outFile)
+	defer os.RemoveAll(outDir)
+	Expect(writer.Buffered()).To(BeZero())
+	generateMessageComment(testCtx, writer, "test-struct", "msg-name", false)
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestGenerateMessageNameGetter(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	writer := bufio.NewWriter(outFile)
+	defer os.RemoveAll(outDir)
+	Expect(writer.Buffered()).To(BeZero())
+	generateMessageNameGetter(writer, "test-struct", "msg-name")
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestGenerateTypeNameGetter(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	writer := bufio.NewWriter(outFile)
+	defer os.RemoveAll(outDir)
+	Expect(writer.Buffered()).To(BeZero())
+	generateTypeNameGetter(writer, "test-struct", "msg-name")
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestGenerateCrcGetter(t *testing.T) {
+	RegisterTestingT(t)
+	outDir := "test_output_directory"
+	outFile, err := os.Create(outDir)
+	Expect(err).ShouldNot(HaveOccurred())
+	writer := bufio.NewWriter(outFile)
+	defer os.RemoveAll(outDir)
+	Expect(writer.Buffered()).To(BeZero())
+	generateCrcGetter(writer, "test-struct", "msg-name")
+	Expect(writer.Buffered()).ToNot(BeZero())
+}
+
+func TestTranslateVppType(t *testing.T) {
+	RegisterTestingT(t)
+	context := new(context)
+	typesToTranslate := []string{"u8", "i8", "u16", "i16", "u32", "i32", "u64", "i64", "f64"}
+	expected := []string{"uint8", "int8", "uint16", "int16", "uint32", "int32", "uint64", "int64", "float64"}
+	var translated []string
+	for _, value := range typesToTranslate {
+		translated = append(translated, convertToGoType(context, value, false))
+	}
+	for index, value := range expected {
+		Expect(value).To(BeEquivalentTo(translated[index]))
+	}
+
+}
+
+func TestTranslateVppTypeArray(t *testing.T) {
+	RegisterTestingT(t)
+	context := new(context)
+	translated := convertToGoType(context, "u8", true)
+	Expect(translated).To(BeEquivalentTo("byte"))
+}
+
+func TestTranslateVppUnknownType(t *testing.T) {
+	defer func() {
+		if recovery := recover(); recovery != nil {
+			t.Logf("Recovered from panic: %v", recovery)
+		}
+	}()
+	context := new(context)
+	convertToGoType(context, "?", false)
+}
+
+func TestCamelCase(t *testing.T) {
+	RegisterTestingT(t)
+	// test camel case functionality
+	expected := "allYourBaseAreBelongToUs"
+	result := camelCaseName("all_your_base_are_belong_to_us")
+	Expect(expected).To(BeEquivalentTo(result))
+	// test underscore
+	expected = "_"
+	result = camelCaseName(expected)
+	Expect(expected).To(BeEquivalentTo(result))
+	// test all lower
+	expected = "lower"
+	result = camelCaseName(expected)
+	Expect(expected).To(BeEquivalentTo(result))
+}
+
+func TestCommonInitialisms(t *testing.T) {
+	RegisterTestingT(t)
+
+	for key, value := range commonInitialisms {
+		Expect(value).ShouldNot(BeFalse())
+		Expect(key).ShouldNot(BeEmpty())
+	}
+}
+*/