Add various generator improvements

- generate service implementation for modules
- generate conversion maps and String() method for enums
- generate module name and version as constants
- rename Union_data field to XXX_UnionData for consistency
- generate constant GoVppAPIPackageIsVersionN for checking compatibility with API
- add example for using service clients
- add some documentation to socketclient adapter
- cleanup gen.go file used for generating binapi
- regenerate binapi with latest VPP release (19.04.1)
- change global variables Messages into a function AllMessages

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

1 files changed, 30 insertions, 54 deletions

diff --git a/cmd/binapi-generator/main.go b/cmd/binapi-generator/main.go
index faed54f..75926e1 100644
--- a/cmd/binapi-generator/main.go
+++ b/cmd/binapi-generator/main.go
@@ -15,7 +15,7 @@
 package main
 
 import (
-	"bufio"
+	"bytes"
 	"encoding/json"
 	"flag"
 	"fmt"
@@ -33,21 +33,16 @@ var (
 	inputFile          = flag.String("input-file", "", "Input file with VPP API in JSON format.")
 	inputDir           = flag.String("input-dir", ".", "Input directory with VPP API files in JSON format.")
 	outputDir          = flag.String("output-dir", ".", "Output directory where package folders will be generated.")
-	includeAPIVer      = flag.Bool("include-apiver", false, "Include APIVersion constant for each module.")
+	includeAPIVer      = flag.Bool("include-apiver", true, "Include APIVersion constant for each module.")
 	includeComments    = flag.Bool("include-comments", false, "Include JSON API source in comments for each object.")
 	includeBinapiNames = flag.Bool("include-binapi-names", false, "Include binary API names in struct tag.")
+	includeServices    = flag.Bool("include-services", false, "Include service interface with client implementation.")
 	continueOnError    = flag.Bool("continue-onerror", false, "Continue with next file on error.")
 	debug              = flag.Bool("debug", debugMode, "Enable debug mode.")
 )
 
 var debugMode = os.Getenv("DEBUG_BINAPI_GENERATOR") != ""
 
-var log = logrus.Logger{
-	Level:     logrus.InfoLevel,
-	Formatter: &logrus.TextFormatter{},
-	Out:       os.Stdout,
-}
-
 func main() {
 	flag.Parse()
 	if *debug {
@@ -100,49 +95,51 @@ func getInputFiles(inputDir string) (res []string, err error) {
 
 // generateFromFile generates Go package from one input JSON file
 func generateFromFile(inputFile, outputDir string) error {
-	logf("generating from file: %q", inputFile)
-	defer logf("--------------------------------------")
+	logf("generating from file: %s", inputFile)
+	logf("------------------------------------------------------------")
+	defer logf("------------------------------------------------------------")
 
 	ctx, err := getContext(inputFile, outputDir)
 	if err != nil {
 		return err
 	}
 
-	ctx.includeAPIVersionCrc = *includeAPIVer
+	// prepare options
+	ctx.includeAPIVersion = *includeAPIVer
 	ctx.includeComments = *includeComments
 	ctx.includeBinapiNames = *includeBinapiNames
+	ctx.includeServices = *includeServices
 
-	// read input file contents
-	ctx.inputData, err = readFile(inputFile)
+	// read API definition from input file
+	ctx.inputData, err = ioutil.ReadFile(ctx.inputFile)
 	if err != nil {
-		return err
+		return fmt.Errorf("reading input file %s failed: %v", ctx.inputFile, err)
 	}
+
 	// parse JSON data into objects
-	jsonRoot, err := parseJSON(ctx.inputData)
-	if err != nil {
-		return err
+	jsonRoot := new(jsongo.JSONNode)
+	if err := json.Unmarshal(ctx.inputData, jsonRoot); err != nil {
+		return fmt.Errorf("unmarshalling JSON failed: %v", err)
 	}
 	ctx.packageData, err = parsePackage(ctx, jsonRoot)
 	if err != nil {
-		return err
+		return fmt.Errorf("parsing package %s failed: %v", ctx.packageName, err)
+	}
+
+	// generate Go package code
+	var buf bytes.Buffer
+	if err := generatePackage(ctx, &buf); err != nil {
+		return fmt.Errorf("generating code for package %s failed: %v", ctx.packageName, err)
 	}
 
 	// create output directory
 	packageDir := filepath.Dir(ctx.outputFile)
-	if err := os.MkdirAll(packageDir, 0777); err != nil {
-		return fmt.Errorf("creating output directory %q failed: %v", packageDir, err)
+	if err := os.MkdirAll(packageDir, 06); err != nil {
+		return fmt.Errorf("creating output dir %s failed: %v", packageDir, err)
 	}
-	// open output file
-	f, err := os.Create(ctx.outputFile)
-	if err != nil {
-		return fmt.Errorf("creating output file %q failed: %v", ctx.outputFile, err)
-	}
-	defer f.Close()
-
-	// generate Go package code
-	w := bufio.NewWriter(f)
-	if err := generatePackage(ctx, w); err != nil {
-		return err
+	// write generated code to output file
+	if err := ioutil.WriteFile(ctx.outputFile, buf.Bytes(), 0666); err != nil {
+		return fmt.Errorf("writing to output file %s failed: %v", ctx.outputFile, err)
 	}
 
 	// go format the output file (fail probably means the output is not compilable)
@@ -154,35 +151,14 @@ func generateFromFile(inputFile, outputDir string) error {
 	// count number of lines in generated output file
 	cmd = exec.Command("wc", "-l", ctx.outputFile)
 	if output, err := cmd.CombinedOutput(); err != nil {
-		log.Warnf("wc command failed: %v\n%s", err, string(output))
+		logf("wc command failed: %v\n%s", err, string(output))
 	} else {
-		logf("generated lines: %s", output)
+		logf("number of generated lines: %s", output)
 	}
 
 	return nil
 }
 
-// readFile reads content of a file into memory
-func readFile(inputFile string) ([]byte, error) {
-	inputData, err := ioutil.ReadFile(inputFile)
-	if err != nil {
-		return nil, fmt.Errorf("reading data from file failed: %v", err)
-	}
-
-	return inputData, nil
-}
-
-// parseJSON parses a JSON data into an in-memory tree
-func parseJSON(inputData []byte) (*jsongo.JSONNode, error) {
-	root := jsongo.JSONNode{}
-
-	if err := json.Unmarshal(inputData, &root); err != nil {
-		return nil, fmt.Errorf("unmarshalling JSON failed: %v", err)
-	}
-
-	return &root, nil
-}
-
 func logf(f string, v ...interface{}) {
 	if *debug {
 		logrus.Debugf(f, v...)