Refactoring (#8)

* Remove redundant test

* Major refactoring

* Resolve volatility of generated code

* Fix Identifier name

Author: Daniil Kukharau

.travis.yml

@@ -16,6 +16,6 @@ script:
   - make vendor
   - make install
   # NOTE: We will be able to run protoc commands from Travis once
-  # protoc-gen-atlas-query-perm is added to the atlas gentool. For now, we can just run
+  # protoc-gen-atlas-query-validate is added to the atlas gentool. For now, we can just run
   # tests to ensure that everything works as expected.
   - go test -v ./...

Makefile

@@ -8,16 +8,15 @@ default: options install
 options:
 	protoc -I. -I$(SRCPATH) -I./vendor  \
 		--gogo_out="Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:$(SRCPATH)" \
-		options/collection_permissions.proto
+		options/query_validate.proto
 
 .PHONY: install
 install:
 	go install
 
-.PHONY: perm-test
-perm-test: ./example/* ./test/*
+test: ./example/*
 	echo ${SRCPATH}
-	protoc -I. -I${SRCPATH} -I./vendor -I./vendor/github.com/grpc-ecosystem/grpc-gateway --atlas-query-perm_out=. example/example.proto
+	protoc -I. -I${SRCPATH} -I./vendor -I./vendor/github.com/grpc-ecosystem/grpc-gateway --atlas-query-validate_out=. example/example.proto
 	go test  ./...
 
 .PHONY: vendor

README.md

@@ -1 +1 @@
-# protoc-gen-atlas-query-perm
+# protoc-gen-atlas-query-validate

example/example.pb.atlas.query.perm.go

@@ -3,29 +3,29 @@ syntax = "proto3";
 package example;
 
 import "google/protobuf/wrappers.proto";
-import "github.com/infobloxopen/protoc-gen-atlas-query-perm/options/collection_permissions.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";
 
 message User {
-    string first_name = 1 [(atlas.query.permissions).filters.allow = "MATCH"];
-    float weight = 2 [(atlas.query.permissions).filters.deny = "LE"];
-    bool on_vacation = 3 [(atlas.query.permissions).disable_sorting = true];
-    string speciality = 4 [(atlas.query.permissions) = {filters: {allow: "MATCH"}, disable_sorting: true}];
+    string first_name = 1 [(atlas.query.validate) = {allow: MATCH, allow: EQ}];
+    float weight = 2 [(atlas.query.validate).deny = LE];
+    bool on_vacation = 3 [(atlas.query.validate).disable_sorting = true];
+    string speciality = 4 [(atlas.query.validate) = {allow: MATCH, disable_sorting: true}];
     string comment = 5;
     google.protobuf.StringValue last_name = 6;
-    string id = 7 [(atlas.query.permissions) = {filters: {deny: "ALL"}}];
+    string id = 7 [(atlas.query.validate).deny = ALL];
     repeated string array = 8;
     CustomType custom_type = 9;
-    CustomType custom_type_string = 10 [(atlas.query.permissions) = {filter_type: STRING}];
-    Address home_address = 11 [(atlas.query.permissions) = {enable_nested_fields: true}];
+    CustomType custom_type_string = 10 [(atlas.query.validate) = {filter_type: STRING}];
+    Address home_address = 11 [(atlas.query.validate) = {enable_nested_fields: true}];
     Address work_address = 12;
 }
 
 message CustomType {
 }
 
 message Address {
-    string city = 1 [(atlas.query.permissions) = {filters: {allow: "EQ"}, disable_sorting: true}];
+    string city = 1 [(atlas.query.validate) = {allow: EQ, disable_sorting: true}];
     string country = 2;
 }
 

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

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"github.com/infobloxopen/atlas-app-toolkit/query"
+	"github.com/infobloxopen/protoc-gen-atlas-query-validate/options"
 )
 
 func TestFilteringPermissionsValidation(t *testing.T) {
@@ -12,15 +13,16 @@ func TestFilteringPermissionsValidation(t *testing.T) {
 		Err   bool
 	}{
 		{`first_name~"Sam"`, false},
+		{`first_name=="Sam"`, false},
 		{`weight==1`, false},
 		{`comment=="comment1"`, false},
 		{`speciality~"spec"`, false},
 		{`last_name=="Smith"`, false},
 		{`last_name~"Smith"`, false},
 		{`id=="some_id"`, true},
-		{`first_name=="Sam"`, true},
+		{`first_name<"Sam"`, true},
 		{`weight<=1`, true},
-		{`first_name=="Jan"`, true},
+		{`first_name<"Jan"`, true},
 		{`speciality=="spec"`, true},
 		{`unknown_field=="unk"`, true},
 		{`id=="some_id"`, true},
@@ -38,7 +40,7 @@ func TestFilteringPermissionsValidation(t *testing.T) {
 		if err != nil {
 			t.Fatalf("Invalid filtering data '%s'", test.Query)
 		}
-		err = ExampleValidateQuery(f, nil, "/example.TestService/List")
+		err = options.ValidateFiltering(f, ExampleMessagesRequireQueryValidation["User"])
 		if err != nil {
 			if test.Err == false {
 				t.Errorf("Unexpected error for %s query: %s", test.Query, err)
@@ -74,7 +76,7 @@ func TestSortingPermissionsValidation(t *testing.T) {
 		if err != nil {
 			t.Fatalf("Invalid sorting data '%s'", test.Query)
 		}
-		err = ExampleValidateQuery(nil, s, "/example.TestService/List")
+		err = options.ValidateSorting(s, ExampleMessagesRequireQueryValidation["User"])
 		if err != nil {
 			if test.Err == false {
 				t.Errorf("Unexpected error for %s query: %s", test.Query, err)

example/example.proto

@@ -2,12 +2,12 @@ package main
 
 import (
 	"github.com/gogo/protobuf/vanity/command"
-	"github.com/infobloxopen/protoc-gen-atlas-query-perm/plugin"
+	"github.com/infobloxopen/protoc-gen-atlas-query-validate/plugin"
 )
 
 func main() {
-	plugin := &plugin.PermPlugin{}
-	response := command.GeneratePlugin(command.Read(), plugin, ".pb.atlas.query.perm.go")
+	plugin := &plugin.QueryValidatePlugin{}
+	response := command.GeneratePlugin(command.Read(), plugin, ".pb.atlas.query.validate.go")
 	plugin.CleanFiles(response)
 	command.Write(response)
 }