Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add unit testing for IsAWSErr() and IsAWSErrExtended(), prevent missing OrigErr() panic #16

Merged
merged 2 commits into from
Oct 30, 2019
Merged

Add unit testing for IsAWSErr() and IsAWSErrExtended(), prevent missing OrigErr() panic #16

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9f4a93
Add unit testing for IsAWSErr() and IsAWSErrExtended(), prevent missi…
bflad Oct 30, 2019
13bde78
Clarify conditional logic in IsAWSErrExtended()
bflad Oct 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion awserr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,12 @@ func IsAWSErrExtended(err error, code string, message string, origErrMessage str
if !IsAWSErr(err, code, message) {
return false
}
return strings.Contains(err.(awserr.Error).OrigErr().Error(), origErrMessage)

// Ensure OrigErr() is non-nil, to prevent panics
if origErr := err.(awserr.Error).OrigErr(); origErr != nil {
return strings.Contains(origErr.Error(), origErrMessage)
}

// Allow missing OrigErr() with missing origErrMessage
return origErrMessage == ""
aeschright marked this conversation as resolved.
Show resolved Hide resolved
}
340 changes: 340 additions & 0 deletions awserr_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,340 @@
package awsbase

import (
"errors"
"testing"

"github.com/aws/aws-sdk-go/aws/awserr"
)

func TestIsAwsErr(t *testing.T) {
testCases := []struct {
Name string
Err error
Code string
Message string
Expected bool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see Expected set on most of the test cases, are you relying on a default behavior?

Copy link
Contributor Author

@bflad bflad Oct 30, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Go, each type has an associated zero value and for bool it is false. I'm not sure I necessarily have good reference of linters that check for this specifically or documentation for whether or not its idiomatic to rely on zero values in composite literals other than maybe this section of Effective Go. If we'd prefer explicitly writing out Expected: false, in places though, can certainly update this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's consistent so I think this is ok. I have a general preference for explicit defaults -- but I'm still getting used to the Go testing framework, so I'm not going to be pushy about what that should look like.

}{
{
Name: "nil error",
Err: nil,
},
{
Name: "nil error code",
Err: nil,
Code: "test",
},
{
Name: "nil error message",
Err: nil,
Message: "test",
},
{
Name: "nil error code and message",
Err: nil,
Code: "test",
Message: "test",
},
{
Name: "other error",
Err: errors.New("test"),
},
{
Name: "other error code",
Err: errors.New("test"),
Code: "test",
},
{
Name: "other error message",
Err: errors.New("test"),
Message: "test",
},
{
Name: "other error code and message",
Err: errors.New("test"),
Code: "test",
Message: "test",
},
{
Name: "awserr error matching code and no message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Expected: true,
},
{
Name: "awserr error matching code and matching message exact",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "TestMessage",
Expected: true,
},
{
Name: "awserr error matching code and matching message contains",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "Message",
Expected: true,
},
{
Name: "awserr error matching code and non-matching message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "NotMatching",
},
{
Name: "awserr error no code",
Err: awserr.New("TestCode", "TestMessage", nil),
},
{
Name: "awserr error no code and matching message exact",
Err: awserr.New("TestCode", "TestMessage", nil),
Message: "TestMessage",
},
{
Name: "awserr error non-matching code",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "NotMatching",
},
{
Name: "awserr error non-matching code and message exact",
Err: awserr.New("TestCode", "TestMessage", nil),
Message: "TestMessage",
},
}

for _, testCase := range testCases {
t.Run(testCase.Name, func(t *testing.T) {
got := IsAWSErr(testCase.Err, testCase.Code, testCase.Message)

if got != testCase.Expected {
t.Errorf("got %t, expected %t", got, testCase.Expected)
}
})
}
}

func TestIsAwsErrExtended(t *testing.T) {
testCases := []struct {
Name string
Err error
Code string
Message string
ExtendedMessage string
Expected bool
}{
{
Name: "nil error",
Err: nil,
},
{
Name: "nil error code",
Err: nil,
Code: "test",
},
{
Name: "nil error message",
Err: nil,
Message: "test",
},
{
Name: "nil error code and message",
Err: nil,
Code: "test",
Message: "test",
},
{
Name: "nil error code, message, and extended message",
Err: nil,
Code: "test",
Message: "test",
ExtendedMessage: "test",
},
{
Name: "other error",
Err: errors.New("test"),
},
{
Name: "other error code",
Err: errors.New("test"),
Code: "test",
},
{
Name: "other error message",
Err: errors.New("test"),
Message: "test",
},
{
Name: "other error code and message",
Err: errors.New("test"),
Code: "test",
Message: "test",
},
{
Name: "other error code, message, and extended message",
Err: errors.New("test"),
Code: "test",
Message: "test",
ExtendedMessage: "test",
},
{
Name: "awserr non-extended error matching code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Expected: true,
},
{
Name: "awserr non-extended error matching code, no message, and extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
ExtendedMessage: "TestExtendedMessage",
},
{
Name: "awserr non-extended error matching code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "TestMessage",
Expected: true,
},
{
Name: "awserr non-extended error matching code, matching message exact, and extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "TestMessage",
ExtendedMessage: "TestExtendedMessage",
},
{
Name: "awserr non-extended error matching code, matching message contains, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "Message",
Expected: true,
},
{
Name: "awserr non-extended error matching code, matching message contains, and extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "Message",
ExtendedMessage: "Message",
},
{
Name: "awserr non-extended error matching code, non-matching message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "TestCode",
Message: "NotMatching",
},
{
Name: "awserr non-extended error no code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
},
{
Name: "awserr non-extended error no code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Message: "TestMessage",
},
{
Name: "awserr non-extended error non-matching code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", nil),
Code: "NotMatching",
},
{
Name: "awserr non-extended error non-matching code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "NonMatching",
Message: "TestMessage",
},
{
Name: "awserr extended error matching code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Expected: true,
},
{
Name: "awserr extended error matching code, no message, and matching extended message exact",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
ExtendedMessage: "TestExtendedMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, no message, and matching extended message contains",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
ExtendedMessage: "ExtendedMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "TestMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, matching message exact, and matching extended message exact",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "TestMessage",
ExtendedMessage: "TestExtendedMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, matching message exact, and matching extended message contains",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "TestMessage",
ExtendedMessage: "ExtendedMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, matching message contains, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "Message",
Expected: true,
},
{
Name: "awserr extended error matching code, matching message contains, and matching extended message contains",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "Message",
ExtendedMessage: "ExtendedMessage",
Expected: true,
},
{
Name: "awserr extended error matching code, non-matching message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "TestCode",
Message: "NotMatching",
},
{
Name: "awserr extended error no code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
},
{
Name: "awserr extended error no code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Message: "TestMessage",
},
{
Name: "awserr extended error non-matching code, no message, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "NotMatching",
},
{
Name: "awserr extended error non-matching code, matching message exact, and no extended message",
Err: awserr.New("TestCode", "TestMessage", errors.New("TestExtendedMessage")),
Code: "NonMatching",
Message: "TestMessage",
},
}

for _, testCase := range testCases {
t.Run(testCase.Name, func(t *testing.T) {
got := IsAWSErrExtended(testCase.Err, testCase.Code, testCase.Message, testCase.ExtendedMessage)

if got != testCase.Expected {
t.Errorf("got %t, expected %t", got, testCase.Expected)
}
})
}
}