Move from toolkit (#1)

* Move protoc-gen-perm files from toolkit without editing

* Update imports from toolkit to protoc-gen-perm

* Update protoc package from atlas.api to perm

* Fix broken unit tests

* Fix grammar errors

* Add dep for dependency management

* Create a .gitignore for the repository

* Add Travis CI

* Update package name in test directory

* Make note about adding protoc-gen-perm to gentool

* Update reference to vendor folder

* Skip test that uses protoc command

Author: ZachEddy

.gitignore

@@ -0,0 +1,8 @@
+vendor
+debug
+*.vscode
+*.idea
+*.DS_Store
+*.bak
+*.log
+*.report

.travis.yml

@@ -0,0 +1,21 @@
+language: go
+
+go:
+  - "1.10"
+
+env:
+  - DEP_VERSION="0.4.1"
+
+before_install:
+  # Download the binary to bin folder in $GOPATH
+  - curl -L -s https://github.com/golang/dep/releases/download/v${DEP_VERSION}/dep-linux-amd64 -o $GOPATH/bin/dep
+  # Make the binary executable
+  - chmod +x $GOPATH/bin/dep
+
+script:
+  - make vendor
+  - make install
+  # NOTE: We will be able to run protoc commands from Travis once
+  # protoc-gen-perm is added to the atlas gentool. For now, we can just run
+  # tests to ensure that everything works as expected.
+  - go test -v ./...

Gopkg.lock

@@ -0,0 +1,38 @@
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/gogo/protobuf"
+  version = "1.1.1"
+
+[[constraint]]
+  name = "github.com/infobloxopen/atlas-app-toolkit"
+  version = "0.10.0"
+
+[prune]
+  go-tests = true
+  unused-packages = true

Gopkg.toml

@@ -0,0 +1,24 @@
+GOPATH ?= $(HOME)/go
+SRCPATH := $(patsubst %/,%,$(GOPATH))/src
+
+default: options 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)" \
+		options/collection_permissions.proto
+
+.PHONY: install
+install:
+	go install
+
+.PHONY: perm-test
+perm-test: ./example/* ./test/*
+	protoc -I. -I${SRCPATH} -I./vendor 	--perm_out="./" example/example.proto
+	go test  ./...
+	
+.PHONY: vendor
+vendor:
+	dep ensure -vendor-only

Makefile

@@ -0,0 +1,42 @@
+
+syntax = "proto3";
+package example;
+
+import "github.com/infobloxopen/protoc-gen-perm/options/collection_permissions.proto";
+import "github.com/infobloxopen/atlas-app-toolkit/query/collection_operators.proto";
+
+message User {
+    string first_name = 2 [(perm.permissions).filters.allow = "MATCH"];
+    string middle_name = 3 [(perm.permissions).disable_sorting = true];
+    string last_name = 4 [(perm.permissions) = {filters: {allow: "EQ"}, disable_sorting: false}];
+    string age = 7 [(perm.permissions).filters.allow = "MATCH"];;
+    int64 height = 15 [(perm.permissions).filters.allow = "GE"];
+    float weight = 16 [(perm.permissions).filters.deny = "LE"];
+    bool OnVacation = 17 [(perm.permissions).disable_sorting = true];
+}
+
+
+message ListRequest {
+    infoblox.api.Filtering filter = 1;
+    infoblox.api.Sorting order_by = 2;
+    infoblox.api.FieldSelection fields = 3;
+    infoblox.api.Pagination paging = 4;
+}
+
+message ReadRequest {
+    infoblox.api.Sorting order_by = 1;
+    infoblox.api.FieldSelection fields = 2;
+    infoblox.api.Pagination paging = 3;
+}
+
+message UserResponse {
+    repeated User data = 1;
+}
+
+service TestService {
+    rpc List (ListRequest) returns (UserResponse) {
+    }
+
+    rpc Read (ReadRequest) returns (UserResponse) {
+    }
+}

example/example.pb.perm.go

@@ -0,0 +1,92 @@
+package example
+
+import (
+	"testing"
+
+	"github.com/infobloxopen/atlas-app-toolkit/query"
+)
+
+func TestFilteringPermissionsValidation(t *testing.T) {
+	data := map[string]string{
+		"first_name==\"Jan\"":      "Operation EQ is not allowed for 'first_name'",
+		"User.first_name!=\"Sam\"": "Operation EQ is not allowed for 'User.first_name'",
+		"first_name~\"Sam.*\"":     "",
+
+		"middle_name==\"Jan\"":       "",
+		"middle_name!=\"Sam\"":       "",
+		"User.middle_name~\"Sam.*\"": "",
+
+		"last_name~\"Jan\"":         "Operation MATCH is not allowed for 'last_name'",
+		"User.last_name!~\"Sam\"":   "Operation MATCH is not allowed for 'User.last_name'",
+		"last_name==\"Sam.*\"":      "",
+		"User.last_name!=\"Sam.*\"": "",
+
+		"age==18":     "Operation EQ is not allowed for 'age'",
+		"age>=18":     "Operation GE is not allowed for 'age'",
+		"User.age<18": "Operation LT is not allowed for 'User.age'",
+
+		"height>=180":     "",
+		"height>180":      "Operation GT is not allowed for 'height'",
+		"User.height<180": "Operation LT is not allowed for 'User.height'",
+	}
+
+	for param, expected := range data {
+		response := ""
+		f, err := query.ParseFiltering(param)
+		if err != nil {
+			t.Fatalf("Invalid filtering data '%s'", param)
+		}
+		resp := Validate(f, nil, "/example.TestService/List")
+		if resp != nil {
+			response = resp.Error()
+		}
+		if expected != response {
+			t.Errorf("Error, for filtering data '%s' expected '%s', got '%s'", param, expected, response)
+		}
+
+	}
+}
+
+func TestFilteringPermissionsValidationForRead(t *testing.T) {
+	data := []string{
+		"first_name==\"Jan\"",
+		"last_name~\"Jan\"",
+		"age==18",
+		"height>=180",
+		"height<180",
+	}
+
+	for _, param := range data {
+		f, err := query.ParseFiltering(param)
+		if err != nil {
+			t.Fatalf("Invalid filtering data '%s'", param)
+		}
+		resp := Validate(f, nil, "/example.TestService/Read")
+		if resp != nil {
+			t.Errorf("Error, for filtering data '%s' got '%s'", param, resp.Error())
+		}
+
+	}
+}
+
+func TestSortingPermissionsValidation(t *testing.T) {
+	data := map[string]string{
+		"first_name, height, middle_name":                "pagination is not allowed for 'middle_name'",
+		"User.first_name, User.height, User.middle_name": "pagination is not allowed for 'User.middle_name'",
+	}
+
+	for param, expected := range data {
+		response := ""
+		p, err := query.ParseSorting(param)
+		if err != nil {
+			t.Fatalf("Invalid paging data '%s'", param)
+		}
+		resp := Validate(nil, p, "/example.TestService/List")
+		if resp != nil {
+			response = resp.Error()
+		}
+		if expected != response {
+			t.Errorf("Error, for paging data '%s' expected '%s', got '%s'", param, expected, response)
+		}
+	}
+}

example/example.proto

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