X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=cmd%2Fbinapi-generator%2Fgenerate_test.go;fp=cmd%2Fbinapi-generator%2Fgenerate_test.go;h=0000000000000000000000000000000000000000;hb=94620e85f0bdbb054af07ce3670fadc1f76cfdf0;hp=4bec874a092be6c18da071a06d2d71c4a6e913f5;hpb=280b1c6c83b676ef4e592f4ecf60cb5b54b6a753;p=govpp.git diff --git a/cmd/binapi-generator/generate_test.go b/cmd/binapi-generator/generate_test.go deleted file mode 100644 index 4bec874..0000000 --- a/cmd/binapi-generator/generate_test.go +++ /dev/null @@ -1,450 +0,0 @@ -// 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 ( - "bufio" - "io/ioutil" - "os" - "testing" - - . "github.com/onsi/gomega" -) - -func TestGetInputFiles(t *testing.T) { - RegisterTestingT(t) - result, err := getInputFiles("testdata", 1) - Expect(err).ShouldNot(HaveOccurred()) - Expect(result).To(HaveLen(3)) - for _, file := range result { - Expect(file).To(BeAnExistingFile()) - } -} - -func TestGetInputFilesError(t *testing.T) { - RegisterTestingT(t) - result, err := getInputFiles("nonexisting_directory", 1) - 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, nil) - Expect(err).ShouldNot(HaveOccurred()) - fileInfo, err := os.Stat(outDir + "/acl/acl.ba.go") - Expect(err).ShouldNot(HaveOccurred()) - Expect(fileInfo.IsDir()).To(BeFalse()) - Expect(fileInfo.Name()).To(BeEquivalentTo("acl.ba.go")) -} - -func TestGenerateFromFileInputError(t *testing.T) { - RegisterTestingT(t) - outDir := "test_output_directory" - err := generateFromFile("testdata/nonexisting.json", outDir, nil) - Expect(err).Should(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("invalid input file name")) -} - -func TestGenerateFromFileReadJsonError(t *testing.T) { - RegisterTestingT(t) - outDir := "test_output_directory" - err := generateFromFile("testdata/input-read-json-error.json", outDir, nil) - Expect(err).Should(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("invalid input file name")) -} - -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, nil) - Expect(err).Should(HaveOccurred()) -} - -func TestGetContext(t *testing.T) { - RegisterTestingT(t) - outDir := "test_output_directory" - result, err := newContext("testdata/af_packet.api.json", outDir) - Expect(err).ShouldNot(HaveOccurred()) - Expect(result).ToNot(BeNil()) - Expect(result.outputFile).To(BeEquivalentTo(outDir + "/af_packet/af_packet.ba.go")) -} - -func TestGetContextNoJsonFile(t *testing.T) { - RegisterTestingT(t) - outDir := "test_output_directory" - result, err := newContext("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 := newContext("testdata/ip.api.json", outDir) - Expect(err).ShouldNot(HaveOccurred()) - Expect(result).ToNot(BeNil()) - Expect(result.outputFile) - Expect(result.outputFile).To(BeEquivalentTo(outDir + "/ip/ip.ba.go")) -} - -func TestReadJson(t *testing.T) { - RegisterTestingT(t) - inputData, err := ioutil.ReadFile("testdata/af_packet.api.json") - Expect(err).ShouldNot(HaveOccurred()) - result, err := parseInputJSON(inputData) - Expect(err).ShouldNot(HaveOccurred()) - Expect(result).ToNot(BeNil()) - Expect(result.Len()).To(BeEquivalentTo(5)) -} - -func TestReadJsonError(t *testing.T) { - RegisterTestingT(t) - inputData, err := ioutil.ReadFile("testdata/input-read-json-error.json") - Expect(err).ShouldNot(HaveOccurred()) - result, err := parseInputJSON(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 := ioutil.ReadFile("testdata/ip.api.json") - Expect(err).ShouldNot(HaveOccurred()) - jsonRoot, err := parseInputJSON(inputData) - Expect(err).ShouldNot(HaveOccurred()) - testCtx.packageData, err = parsePackage(testCtx, jsonRoot) - 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()) - 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 := ioutil.ReadFile("testdata/ip.api.json") - Expect(err).ShouldNot(HaveOccurred()) - jsonRoot, err := parseInputJSON(inputData) - Expect(err).ShouldNot(HaveOccurred()) - outDir := "test_output_directory" - outFile, err := os.Create(outDir) - Expect(err).ShouldNot(HaveOccurred()) - testCtx.packageData, err = parsePackage(testCtx, jsonRoot) - Expect(err).ShouldNot(HaveOccurred()) - defer os.RemoveAll(outDir) - - // prepare writer - writer := bufio.NewWriter(outFile) - - for _, msg := range testCtx.packageData.Messages { - generateMessage(testCtx, writer, &msg) - 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()) - } -} -*/