Enable deeply nested message validation options (#17)

* Enable deeply nested message validation options

* Use latest gentool as base for testing

Author: Calebjh

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.10.0 AS builder
+FROM golang:1.13.0-alpine AS builder
 
 LABEL stage=server-intermediate
 

Makefile

@@ -1,25 +1,36 @@
 GOPATH ?= $(HOME)/go
 SRCPATH := $(patsubst %/,%,$(GOPATH))/src
 
+# configuration for the protobuf gentool
+PROJECT_ROOT := github.com/infobloxopen/protoc-gen-atlas-query-validate
+SRCROOT_ON_HOST      := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+SRCROOT_IN_CONTAINER := /go/src/$(PROJECT_ROOT)
+DOCKERPATH           := /go/src
+DOCKER_RUNNER        := docker run --rm
+DOCKER_RUNNER        += -v $(SRCROOT_ON_HOST):$(SRCROOT_IN_CONTAINER)
+DOCKER_GENERATOR     := infoblox/atlas-gentool:v19.1
+GENERATOR            := $(DOCKER_RUNNER) $(DOCKER_GENERATOR)
+
 default: install
 
 .PHONY: options
 options:
-	protoc -I. -I$(SRCPATH) -I./vendor  \
-		--gogo_out="Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:$(SRCPATH)" \
+	@$(GENERATOR)  \
+		--gogo_out="Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:$(DOCKERPATH)" \
 		options/query_validate.proto
 
 .PHONY: install
 install:
 	go install
 
 .PHONY: example
-example: default
-	protoc -I. -I${SRCPATH} -I./vendor -I./vendor/github.com/grpc-ecosystem/grpc-gateway --atlas-query-validate_out=. example/example.proto
+example: gentool
+	$(DOCKER_RUNNER) infoblox/atlas-gentool:atlas-validate-query-dev \
+	 --atlas-query-validate_out=":$(DOCKERPATH)" example/example.proto
 
 test: example
 	go test  ./...
-	
+
 .PHONY: vendor
 vendor:
 	dep ensure -vendor-only

README.md

@@ -2,7 +2,7 @@
 
 ### Purpose
 
-A [protobuf](https://developers.google.com/protocol-buffers/) compiler plugin 
+A [protobuf](https://developers.google.com/protocol-buffers/) compiler plugin
 designed to simplify validation of [Atlas](https://github.com/infobloxopen/atlas-app-toolkit)
 [gRPC](https://grpc.io/) List [query](https://github.com/infobloxopen/atlas-app-toolkit/blob/master/query/collection_operators.proto) parameters
 by generating .pb.atlas.query.validate.go files with validation rules and functions.
@@ -58,7 +58,7 @@ The following table shows what is allowed for each *value_type*:
 
 |                                     | STRING | NUMBER |
 |-------------------------------------|--------|--------|
-| **Filtering operators**                 | EQ, MATCH, GT, GE, LT, LE, IEQ, IN | EQ, GT, GE, LT, LE, IN | 
+| **Filtering operators**                 | EQ, MATCH, GT, GE, LT, LE, IEQ, IN | EQ, GT, GE, LT, LE, IN |
 | **Filtering value type/condition type** | String, null/StringCondition, NullCondition, StringArray(only for IN)| Number, null/NumberCondition, NullCondition, NumberArray(only for IN)|
 
 The next table shows how *value_type* is computed from a proto field type:
@@ -118,7 +118,7 @@ field-level options in order to support different validation rules for List meth
 bool on_vacation = 3 [(atlas.query.validate).sorting.disable = true];
 ```
 
-* In order to customize the list of allowed filtering operators pass either a set of `(atlas.query.validate).filtering.allow` or 
+* In order to customize the list of allowed filtering operators pass either a set of `(atlas.query.validate).filtering.allow` or
 a set of `(atlas.query.validate).filtering.deny` options.
   - In case of using `(atlas.query.validate).filtering.allow` only specified filtering operators are allowed:
     ```golang
@@ -133,9 +133,17 @@ a set of `(atlas.query.validate).filtering.deny` options.
 CustomType custom_type_string = 10 [(atlas.query.validate) = {value_type: STRING}];
 ```
 * In order to enable filtering/sorting by nested fields set `(atlas.query.validate).enable_nested_fields` option to true
-on the field of a message type.
+on the field of a message type or as message option.
+Note that this overrides any field level settings.
 
 ```golang
+message User {
+  option (atlas.query.message) = {
+    enable_nested_fields: true;
+  };
+  ...
+}
+
 message User {
     Address home_address = 11 [(atlas.query.validate) = {enable_nested_fields: true}];
     Address work_address = 12;
@@ -147,6 +155,27 @@ message Address {
 }
 ```
 
+* You can also specify the maximum nesting depth using the `nested_field_depth_limit`
+option at the message level (the default is second level fields only).
+
+```golang
+message User {
+  option (atlas.query.message) = {
+    enable_nested_fields: true;
+    nested_field_depth_limit: 3;
+  };
+  ...
+}
+```
+
+* Nesting and nested field depth can also be set for the entire code generation
+process as parameters on the protoc command
+
+```sh
+protoc ... \
+ --atlas-query-validate_out="nested_field_depth_limit=3,enable_nested_fields=true:." \
+ example/example.proto
+```
 
 ### Examples
 

example/example.pb.atlas.query.validate.go

@@ -6,8 +6,11 @@ import "google/protobuf/wrappers.proto";
 import "github.com/infobloxopen/protoc-gen-atlas-query-validate/options/query_validate.proto";
 import "github.com/infobloxopen/atlas-app-toolkit/query/collection_operators.proto";
 
+option go_package = "github.com/infobloxopen/protoc-gen-atlas-query-validate/example;example";
+
 message User {
     option (atlas.query.message) = {
+            // enable_nested_fields: true;
             validate: {name: "custom_search", value: {value_type_url: ".example.Address", nested_fields: ["country"]}};
             validate: {name: "custom_search_2", value: {value_type: STRING, filtering: {allow: MATCH, allow: EQ}}};
             validate: {name: "list_of_addresses", value: {value_type_url: ".example.Address", enable_nested_fields: true, field_selection: {disable: false}}};
@@ -22,7 +25,7 @@ message User {
     google.protobuf.StringValue last_name = 6;
     string id = 7 [(atlas.query.validate).filtering.deny = ALL];
     repeated string array = 8;
-    CustomType custom_type = 9;
+    CustomType custom_type = 9 [(atlas.query.validate) = {enable_nested_fields: true}];
     CustomType custom_type_string = 10 [(atlas.query.validate) = {value_type: STRING}];
     Address home_address = 11 [(atlas.query.validate) = {enable_nested_fields: true}];
     Address work_address = 12;
@@ -32,6 +35,8 @@ message User {
 }
 
 message CustomType {
+  CustomType recur = 1;
+  string name = 2;
 }
 
 message Address {
@@ -67,4 +72,3 @@ service TestService {
     rpc Read (ReadRequest) returns (ReadUserResponse) {
     }
 }
-