Skip to content

Commit

Permalink
Add unit testing for IsAWSErr() and IsAWSErrExtended(), prevent missi…
Browse files Browse the repository at this point in the history 
…ng OrigErr() panic

Reference: hashicorp/terraform-provider-aws#10670

This was originally to just add unit testing to match testing added to the Terraform AWS Provider codebase, but discovered and fixed a panic condition in `IsAWSErrExtended()`.

In the future these functions will be updated to support Go 1.13 error wrapping via `errors.As()` so we can easily add error context without losing the error type checking, however this is waiting for github.com/hashicorp/terraform to begin releases via Go 1.13.
  • Loading branch information
@bflad
bflad committed Oct 30, 2019
1 parent 2e45876 commit f9f4a93
Show file tree
Hide file tree
Showing 2 changed files with 348 additions and 1 deletion.
9 changes: 8 additions & 1 deletion awserr.go
View file
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 == ""
}
340 changes: 340 additions & 0 deletions awserr_test.go
View file
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
}{
{
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)
}
})
}
}

0 comments on commit f9f4a93

Please sign in to comment.