forked from grpc-ecosystem/grpc-gateway
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add plugin param 'allow_delete_body' (grpc-ecosystem#280)
* added plugin parameter 'allow_delete_body' to allow REST mappings for legacy services that inapproriately use HTTP DELETE with body * added comment to pubic registy method so lint doesn't complain * added tests for allow_delete_body both on command line/code-gen-req-param parsing and in registry service generation. Required mild refactoring of protoc-gen-swagger cmd line parsing to make testable * fixed copy paste oops on using param vs global flag.Commandline global * kvvar ignores whitespace & empty string Set() input now * removed protoc-gen-swagger pkg_map cmd line flag and KVVar flag.Value impl from utilities pkg
- Loading branch information
Showing
5 changed files
with
288 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "reflect" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestParseReqParam(t *testing.T) { | ||
|
|
||
| f := flag.CommandLine | ||
|
|
||
| // this one must be first - with no leading clearFlags call it | ||
| // verifies our expectation of default values as we reset by | ||
| // clearFlags | ||
| pkgMap := make(map[string]string) | ||
| expected := map[string]string{} | ||
| err := parseReqParam("", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 0: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 0: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(false, "stdin", "", t, 0) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{"google/api/annotations.proto": "github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api"} | ||
| err = parseReqParam("allow_delete_body,file=./foo.pb,import_prefix=/bar/baz,Mgoogle/api/annotations.proto=github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 1: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 1: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(true, "./foo.pb", "/bar/baz", t, 1) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{"google/api/annotations.proto": "github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api"} | ||
| err = parseReqParam("allow_delete_body=true,file=./foo.pb,import_prefix=/bar/baz,Mgoogle/api/annotations.proto=github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 2: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 2: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(true, "./foo.pb", "/bar/baz", t, 2) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{"a/b/c.proto": "github.com/x/y/z", "f/g/h.proto": "github.com/1/2/3/"} | ||
| err = parseReqParam("allow_delete_body=false,Ma/b/c.proto=github.com/x/y/z,Mf/g/h.proto=github.com/1/2/3/", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 3: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 3: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(false, "stdin", "", t, 3) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{} | ||
| err = parseReqParam("", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 4: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 4: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(false, "stdin", "", t, 4) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{} | ||
| err = parseReqParam("unknown_param=17", f, pkgMap) | ||
| if err == nil { | ||
| t.Error("Test 5: expected parse error not returned") | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 5: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(false, "stdin", "", t, 5) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{} | ||
| err = parseReqParam("Mfoo", f, pkgMap) | ||
| if err == nil { | ||
| t.Error("Test 6: expected parse error not returned") | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 6: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(false, "stdin", "", t, 6) | ||
|
|
||
| clearFlags() | ||
| pkgMap = make(map[string]string) | ||
| expected = map[string]string{} | ||
| err = parseReqParam("allow_delete_body,file,import_prefix", f, pkgMap) | ||
| if err != nil { | ||
| t.Errorf("Test 7: unexpected parse error '%v'", err) | ||
| } | ||
| if !reflect.DeepEqual(pkgMap, expected) { | ||
| t.Errorf("Test 7: pkgMap parse error, expected '%v', got '%v'", expected, pkgMap) | ||
| } | ||
| checkFlags(true, "", "", t, 7) | ||
|
|
||
| } | ||
|
|
||
| func checkFlags(allowDeleteV bool, fileV, importPathV string, t *testing.T, tid int) { | ||
| if *importPrefix != importPathV { | ||
| t.Errorf("Test %v: import_prefix misparsed, expected '%v', got '%v'", tid, importPathV, *importPrefix) | ||
| } | ||
| if *file != fileV { | ||
| t.Errorf("Test %v: file misparsed, expected '%v', got '%v'", tid, fileV, *file) | ||
| } | ||
| if *allowDeleteBody != allowDeleteV { | ||
| t.Errorf("Test %v: allow_delete_body misparsed, expected '%v', got '%v'", tid, allowDeleteV, *allowDeleteBody) | ||
| } | ||
| } | ||
|
|
||
| func clearFlags() { | ||
| *importPrefix = "" | ||
| *file = "stdin" | ||
| *allowDeleteBody = false | ||
| } |