Release 0.3.0

- regenerate examples/binapi for latest VPP from stable/2001
- add import-prefix flag to set custom prefix (fallbacks to using go list)

Change-Id: Ib09f134cf9662e348be2575448964de2b9e5c1ee
Signed-off-by: Ondrej Fabry <[email protected]>

Author: ondrej-fabry

CHANGELOG.md

@@ -2,10 +2,33 @@
 
 This file lists changes for the GoVPP releases.
 
+<!-- TEMPLATE
+### Fixes
+-
+### Features
+-
+### Other
+-
+-->
+
 ## 0.3.0
-> _in development_
+> _18 March 2020_
 
-// TO BE ADDED
+### Fixes
+- binapi-generator: Fix parsing default meta parameter
+
+### Features
+- api: Improve compatibility checking with new error types:
+  `adapter.UnknownMsgError` and `api.CompatibilityError`
+- api: Added exported function `api.GetRegisteredMessageTypes()`
+  for getting list of all registered message types
+- binapi-generator: Support imports of common types from other packages
+- binapi-generator: Generate `Reset()` method for messages
+- binapi-generator: Compact generated methods
+
+### Other
+- deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
+- regenerate examples/binapi for latest VPP from stable/2001
 
 ## 0.2.0
 > _04 November 2019_
@@ -27,11 +50,3 @@ This file lists changes for the GoVPP releases.
 > _03 July 2019_
 
 The first release that introduces versioning for GoVPP.
-
-### VPP compatibility
-
-| VPP | Status | Notes |
-|---|---|---|
-| 19.08-rc0 | ❕ | preliminary support (`19.08-rc0~478-g2f5f` recommended) |
-| 19.04 | ✔ | latest release (preffered) |
-| 19.01 | ✔ | limited capabilities (dropping soon) |

Makefile

@@ -75,19 +75,25 @@ lint: ## Run code linter
 	@echo "# running linter"
 	@golint ./...
 
+install: install-generator install-proxy ## Install all
+
 install-generator: ## Install binapi-generator
 	@echo "# installing binapi-generator ${VERSION}"
 	$(GO) install ${GO_BUILD_ARGS} ./cmd/binapi-generator
 
-generate: ## Generate code
+install-proxy: ## Install vpp-proxy
+	@echo "# installing vpp-proxy ${VERSION}"
+	$(GO) install ${GO_BUILD_ARGS} ./cmd/vpp-proxy
+
+generate: ## Generate all
 	@echo "# generating code"
 	$(GO) generate -x ./...
 
-generate-binapi: install-generator
+generate-binapi: install-generator ## Generate binapi code
 	@echo "# generating binapi VPP $(VPP_VERSION)"
 	$(GO) generate -x "$(BINAPI_DIR)"
 
-gen-binapi-docker: install-generator
+gen-binapi-docker: install-generator ## Generate binapi code (using Docker)
 	@echo "# generating binapi in docker image ${VPP_IMG}"
 	$(eval cmds := $(shell go generate -n $(BINAPI_DIR) 2>&1 | tr "\n" ";"))
 	docker run -t --rm \
@@ -105,6 +111,7 @@ extras:
 .PHONY: help \
     build cmd examples clean \
 	lint test integration \
-	install-generator generate generate-binapi gen-binapi-docker \
+	install install-generator install-proxy \
+	generate generate-binapi gen-binapi-docker \
 	extras
 

cmd/binapi-generator/generate.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"io"
 	"os/exec"
+	"path"
 	"path/filepath"
 	"sort"
 	"strings"
@@ -53,6 +54,8 @@ type context struct {
 	inputFile  string // input file with VPP API in JSON
 	outputFile string // output file with generated Go package
 
+	importPrefix string // defines import path prefix for importing types
+
 	inputData []byte // contents of the input file
 
 	includeAPIVersion  bool // include constant with API version string
@@ -99,13 +102,16 @@ func newContext(inputFile, outputDir string) (*context, error) {
 }
 
 func generatePackage(ctx *context, w io.Writer) error {
+	logf("----------------------------")
 	logf("generating package %q", ctx.packageName)
+	logf("----------------------------")
 
 	fmt.Fprintln(w, "// Code generated by GoVPP's binapi-generator. DO NOT EDIT.")
 	fmt.Fprintf(w, "// source: %s\n", ctx.inputFile)
 	fmt.Fprintln(w)
 
 	generateHeader(ctx, w)
+	generateImports(ctx, w)
 
 	// generate module desc
 	fmt.Fprintln(w, "const (")
@@ -234,6 +240,9 @@ func generateHeader(ctx *context, w io.Writer) {
 	fmt.Fprintf(w, "package %s\n", ctx.packageName)
 	fmt.Fprintln(w)
 
+}
+
+func generateImports(ctx *context, w io.Writer) {
 	fmt.Fprintln(w, "import (")
 	fmt.Fprintf(w, "\tapi \"%s\"\n", govppApiImportPath)
 	fmt.Fprintf(w, "\tbytes \"%s\"\n", "bytes")
@@ -244,15 +253,18 @@ func generateHeader(ctx *context, w io.Writer) {
 	if len(ctx.packageData.Imports) > 0 {
 		fmt.Fprintln(w)
 		for _, imp := range getImports(ctx) {
-			impPkg := getImportPkg(filepath.Dir(ctx.outputFile), imp)
-			fmt.Fprintf(w, "\t%s \"%s\"\n", imp, strings.TrimSpace(impPkg))
+			importPath := path.Join(ctx.importPrefix, imp)
+			if importPath == "" {
+				importPath = getImportPath(filepath.Dir(ctx.outputFile), imp)
+			}
+			fmt.Fprintf(w, "\t%s \"%s\"\n", imp, strings.TrimSpace(importPath))
 		}
 	}
 	fmt.Fprintln(w, ")")
 	fmt.Fprintln(w)
 }
 
-func getImportPkg(outputDir string, pkg string) string {
+func getImportPath(outputDir string, pkg string) string {
 	absPath, _ := filepath.Abs(filepath.Join(outputDir, "..", pkg))
 	cmd := exec.Command("go", "list", absPath)
 	var errbuf, outbuf bytes.Buffer

cmd/binapi-generator/generate_test.go

@@ -45,7 +45,7 @@ func TestGenerateFromFile(t *testing.T) {
 	outDir := "test_output_directory"
 	// remove directory created during test
 	defer os.RemoveAll(outDir)
-	err := generateFromFile("testdata/acl.api.json", 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())
@@ -56,15 +56,15 @@ func TestGenerateFromFile(t *testing.T) {
 func TestGenerateFromFileInputError(t *testing.T) {
 	RegisterTestingT(t)
 	outDir := "test_output_directory"
-	err := generateFromFile("testdata/nonexisting.json", outDir)
+	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)
+	err := generateFromFile("testdata/input-read-json-error.json", outDir, nil)
 	Expect(err).Should(HaveOccurred())
 	Expect(err.Error()).To(ContainSubstring("invalid input file name"))
 }
@@ -79,7 +79,7 @@ func TestGenerateFromFileGeneratePackageError(t *testing.T) {
 		}
 		os.RemoveAll(outDir)
 	}()
-	err := generateFromFile("testdata/input-generate-error.json", outDir)
+	err := generateFromFile("testdata/input-generate-error.json", outDir, nil)
 	Expect(err).Should(HaveOccurred())
 }
 

cmd/binapi-generator/main.go

@@ -41,6 +41,7 @@ var (
 	includeServices    = flag.Bool("include-services", true, "Include RPC service api and client implementation.")
 	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.")
+	importPrefix       = flag.String("import-prefix", "", "Define import path prefix to be used to import types.")
 
 	continueOnError = flag.Bool("continue-onerror", false, "Continue with next file on error.")
 	debugMode       = flag.Bool("debug", os.Getenv("GOVPP_DEBUG") != "", "Enable debug mode.")
@@ -179,6 +180,7 @@ func generateFromFile(inputFile, outputDir string, typesPkgs []*context) error {
 	ctx.includeComments = *includeComments
 	ctx.includeBinapiNames = *includeBinapiNames
 	ctx.includeServices = *includeServices
+	ctx.importPrefix = *importPrefix
 
 	// read API definition from input file
 	ctx.inputData, err = ioutil.ReadFile(ctx.inputFile)

core/channel_test.go

@@ -103,7 +103,7 @@ func TestRequestReplyMemifDetails(t *testing.T) {
 	// mock reply
 	ctx.mockVpp.MockReply(&memif.MemifDetails{
 		SwIfIndex: 25,
-		IfName:    []byte("memif-name"),
+		IfName:    "memif-name",
 		Role:      0,
 	})