Adding the API generator

The API generator generates all the boilerplate files the API needs, as described in
https://github.com/kubernetes-csi/csi-proxy/tree/master/client/api#detailed-breakdown-of-generated-files

Added a few tests, though the main test will be checking that auto-generated files are in sync with the rest of the code & proto files; that will be done in automated builds in a future patch (very soon).

Signed-off-by: Jean Rouge <[email protected]>

Author: wk8

client/api/README.md

@@ -204,19 +204,19 @@ service Dummy {
     ...
 }
 ```
-then regenerate the protobuf code, and run `csi-proxy-gen`: it will also mark the version's server (``) and client (``) packages as deprecated.
+then regenerate the protobuf code, and run `csi-proxy-api-gen`: it will also mark the version's server (``) and client (``) packages as deprecated.
 
-For removal, remove the whole `client/api/<api_group_name>/<version>` directory, and run `csi-proxy-gen`, it will remove all references to the removed version.
+For removal, remove the whole `client/api/<api_group_name>/<version>` directory, and run `csi-proxy-api-gen`, it will remove all references to the removed version.
 
 #### An API group
 
-Deprecate and remove all its versions as explained in the previous version; then remove the entire `client/api/<api_group_name>` directory, and run `csi-proxy-gen`, it will remove all references to the removed API group.
+Deprecate and remove all its versions as explained in the previous version; then remove the entire `client/api/<api_group_name>` directory, and run `csi-proxy-api-gen`, it will remove all references to the removed API group.
 
 ## Detailed breakdown of generated files
 
-This section details how `csi-proxy-gen` works, and what files it generates; `csi-proxy-gen` is built on top of [gengo](https://github.com/kubernetes/gengo), and re-uses part of [k8s' code-generator](https://github.com/kubernetes/code-generator), notably to generate conversion functions.
+This section details how `csi-proxy-api-gen` works, and what files it generates; `csi-proxy-api-gen` is built on top of [gengo](https://github.com/kubernetes/gengo), and re-uses part of [k8s' code-generator](https://github.com/kubernetes/code-generator), notably to generate conversion functions.
 
-First, it looks for all API group definitions, which are either subdirectories of `client/api/`, or any go package that contains a `doc.go` file containing a `// +csi-proxy-gen` comment.
+First, it looks for all API group definitions, which are either subdirectories of `client/api/`, or any go package whose `doc.go` file contains a `// +csi-proxy-api-gen` comment.
 
 Then for each API group it finds:
 1. it iterates through each version subpackage, and in each looks for the `<ApiGroupName>Server` interface, and compiles the list of callbacks that the group's `Server` needs to implement as well as the list of top-level `struct`s (`*Request`s and `*Response`s)
@@ -230,9 +230,9 @@ Then for each API group it finds:
     2. it generates missing conversion functions to `internal/server/<api_group_name>/internal/<version>/conversion_generated.go`
     3. it generates `internal/server/<api_group_name>/internal/<version>/server_generated.go`
 6. it generates `internal/server/<api_group_name>/internal/api_group_generated.go` to list all the versioned servers it's just created
-7. and finally, it generates `client/groups/<api_group_name>/<version>/client_generated.go`
+7. and finally, it generates `client/groups/<api_group_name>/<version>/client_generated.go` for each version
 
-When `csi-proxy-gen` has successfully run to completion, [our example API group's go package from earlier](#serverPkgTree) will look something like:
+When `csi-proxy-api-gen` has successfully run to completion, [our example API group's go package from earlier](#serverPkgTree) will look something like:
 ```
 internal/server/<api_group_name>
 ├── api_group_generated.go

client/api/filesystem/v1alpha1/api.pb.go

@@ -14,7 +14,7 @@ service FileSystem {
 }
 
 message PathExistsRequest {
-    // The path to check in the host filesystem.
+    // The path to check in the host file system.
     string path = 1;
 }
 

client/api/filesystem/v1alpha1/api.proto

@@ -80,6 +80,11 @@ func NewVersionOrPanic(name string) Version {
 	return version
 }
 
+// IsValidVersion returns true iff the input is a valid version name.
+func IsValidVersion(name string) bool {
+	return nameRegex.MatchString(name)
+}
+
 func toUint(s, name string) (uint, error) {
 	i, err := strconv.ParseUint(s, 10, 0)
 	if err != nil {

client/apiversion/version.go

@@ -6,5 +6,5 @@ require (
 	github.com/Microsoft/go-winio v0.4.14
 	github.com/golang/protobuf v1.3.2
 	github.com/pkg/errors v0.8.1
-	google.golang.org/grpc v1.23.1
+	google.golang.org/grpc v1.24.0
 )

client/go.mod

@@ -6,7 +6,6 @@ github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDk
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
-github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/protobuf v1.3.2 h1:6nsPYzhq5kReh6QImI3k5qWzO4PEbvbIW2cwSfR/6xs=
 github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
@@ -34,6 +33,6 @@ golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBn
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
 google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8 h1:Nw54tB0rB7hY/N0NQvRW8DG4Yk3Q6T9cu9RcFQDu1tc=
 google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
-google.golang.org/grpc v1.23.1 h1:q4XQuHFC6I28BKZpo6IYyb3mNO+l7lSOxRuYTCiDfXk=
-google.golang.org/grpc v1.23.1/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
+google.golang.org/grpc v1.24.0 h1:vb/1TCsVn3DcJlQ0Gs1yB1pKI6Do2/QNwxdKqmc/b0s=
+google.golang.org/grpc v1.24.0/go.mod h1:XDChyiUovWa60DnaeDeZmSW86xtLtjtZbwvSiRnRtcA=
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=