-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding validation for request input and added more UTs. (#12)
Change Log: 1. Added validate() Method and corresponding UTs for all the requests: This method sanity checks the input. 2. Added UTs for error.go module. Also made some methods generic in error.go. 3. Increased codecov coverage from 70% to 80% 4. Moved `plugin.go` from `cli/internal/mock/plugin.go` → `internal/mock/plugin.go` to keep all the mocks in one place. --------- Signed-off-by: Pritesh Bandi <[email protected]> Co-authored-by: Patrick Zheng <[email protected]>
- Loading branch information
1 parent
43178dd
commit 4df400e
Showing
17 changed files
with
565 additions
and
28 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,4 +15,4 @@ coverage: | |
| status: | ||
| project: | ||
| default: | ||
| target: 70% | ||
| target: 80% | ||
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
File renamed without changes.
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,72 @@ | ||
| // Copyright The Notary Project Authors. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package plugin | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestDescribeKeyRequest_Validate(t *testing.T) { | ||
| reqs := []DescribeKeyRequest{ | ||
| getDescribeKeyRequest(ContractVersion, "someKeyId"), | ||
| { | ||
| ContractVersion: ContractVersion, | ||
| KeyID: "someKeyId", | ||
| PluginConfig: map[string]string{"someKey": "someValue"}}, | ||
| } | ||
|
|
||
| for _, req := range reqs { | ||
| if err := req.Validate(); err != nil { | ||
| t.Errorf("VerifySignatureRequest#Validate failed with error: %+v", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestDescribeKeyRequest_Validate_Error(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| req DescribeKeyRequest | ||
| }{ | ||
| {name: "contractVersion", req: getDescribeKeyRequest("", "someKeyId")}, | ||
| {name: "keyId", req: getDescribeKeyRequest(ContractVersion, "")}, | ||
| } | ||
|
|
||
| for _, testcase := range testCases { | ||
| t.Run(testcase.name, func(t *testing.T) { | ||
| if err := testcase.req.Validate(); err != nil { | ||
| expMsg := fmt.Sprintf("{\"errorCode\":\"VALIDATION_ERROR\",\"errorMessage\":\"%s cannot be empty\"}", testcase.name) | ||
| if err.Error() != expMsg { | ||
| t.Errorf("expected error message '%s' but got '%s'", expMsg, err.Error()) | ||
| } | ||
| } else { | ||
| t.Error("DescribeKeyRequest#Validate didn't returned error") | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestDescribeKeyRequest_Command(t *testing.T) { | ||
| req := getDescribeKeyRequest(ContractVersion, "someKeyId") | ||
| if cmd := req.Command(); cmd != CommandDescribeKey { | ||
| t.Errorf("DescribeKeyRequest#Command, expected %s but returned %s", CommandDescribeKey, cmd) | ||
| } | ||
| } | ||
|
|
||
| func getDescribeKeyRequest(cv, kid string) DescribeKeyRequest { | ||
| return DescribeKeyRequest{ | ||
| ContractVersion: cv, | ||
| KeyID: kid, | ||
| } | ||
| } |
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,65 @@ | ||
| // Copyright The Notary Project Authors. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package plugin | ||
|
|
||
| import ( | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestNewError(t *testing.T) { | ||
| msg := "someMSg" | ||
| err := NewError(ErrorCodeValidation, msg) | ||
| if err != nil { | ||
| if ErrorCodeValidation != err.ErrCode { | ||
| t.Errorf("NewError, expected errorCode '%s' but found'%s'", ErrorCodeValidation, err.ErrCode) | ||
| } | ||
|
|
||
| if msg != err.Message { | ||
| t.Errorf("NewError, expected message'%s' but found '%s'", msg, err.Message) | ||
| } | ||
|
|
||
| if err.Metadata != nil { | ||
| t.Errorf("NewError, expected metadata to be nil but found '%s'", err.Metadata) | ||
| } | ||
|
|
||
| expError := "{\"errorCode\":\"VALIDATION_ERROR\",\"errorMessage\":\"someMSg\"}" | ||
| if expError != err.Error() { | ||
| t.Errorf("NewError#Error, expected error to be '%s' but found '%s'", expError, err.Error()) | ||
|
|
||
| } | ||
|
|
||
| } else { | ||
| t.Error("NewError didn't return an error") | ||
| } | ||
| } | ||
|
|
||
| func TestErrorCodes(t *testing.T) { | ||
| testCases := []struct { | ||
| err *Error | ||
| errCode ErrorCode | ||
| }{ | ||
| {err: NewValidationError(""), errCode: ErrorCodeValidation}, | ||
| {err: NewValidationErrorf("%s", ""), errCode: ErrorCodeValidation}, | ||
| {err: NewUnsupportedError(""), errCode: ErrorCodeValidation}, | ||
| {err: NewGenericError(""), errCode: ErrorCodeGeneric}, | ||
| {err: NewGenericErrorf("%s", ""), errCode: ErrorCodeGeneric}, | ||
| {err: NewJSONParsingError(""), errCode: ErrorCodeValidation}, | ||
| {err: NewUnsupportedContractVersionError(""), errCode: ErrorCodeUnsupportedContractVersion}, | ||
| } | ||
| for _, test := range testCases { | ||
| if test.errCode != test.err.ErrCode { | ||
| t.Errorf("Expected errorCode %s but found %s", test.errCode, test.err.ErrCode) | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.