Compare commits

..

No commits in common. "9ca7d24f6a7d9f65c56514c3fa5dd932c6058988" and "d7e0b4856754b41c75d24793cb3efe54377b33ac" have entirely different histories.

4 changed files with 160 additions and 242 deletions

View file

@ -50,7 +50,7 @@ jobs:
check-latest: true check-latest: true
- name: Install sendmail - name: Install sendmail
run: | run: |
sudo apt-get -y update && sudo DEBIAN_FRONTEND=noninteractive apt-get -y install nullmailer && which sendmail sudo apt-get -y update >/dev/null && sudo apt-get -y upgrade >/dev/null && sudo DEBIAN_FRONTEND=noninteractive apt-get -y install nullmailer >/dev/null && which sendmail
- name: Run go test - name: Run go test
if: success() if: success()
run: | run: |

View file

@ -5,15 +5,12 @@
package mail package mail
import ( import (
"crypto/rand"
"errors"
"strings" "strings"
"testing" "testing"
) )
// TestRandomStringSecure tests the randomStringSecure method // TestRandomStringSecure tests the randomStringSecure method
func TestRandomStringSecure(t *testing.T) { func TestRandomStringSecure(t *testing.T) {
t.Run("randomStringSecure with varying length", func(t *testing.T) {
tt := []struct { tt := []struct {
testName string testName string
length int length int
@ -39,47 +36,14 @@ func TestRandomStringSecure(t *testing.T) {
} }
}) })
} }
})
t.Run("randomStringSecure fails on broken rand Reader (first read)", func(t *testing.T) {
defaultRandReader := rand.Reader
t.Cleanup(func() { rand.Reader = defaultRandReader })
rand.Reader = &randReader{failon: 1}
if _, err := randomStringSecure(22); err == nil {
t.Fatalf("expected failure on broken rand Reader")
}
})
t.Run("randomStringSecure fails on broken rand Reader (second read)", func(t *testing.T) {
defaultRandReader := rand.Reader
t.Cleanup(func() { rand.Reader = defaultRandReader })
rand.Reader = &randReader{failon: 0}
if _, err := randomStringSecure(22); err == nil {
t.Fatalf("expected failure on broken rand Reader")
}
})
} }
func BenchmarkGenerator_RandomStringSecure(b *testing.B) { func BenchmarkGenerator_RandomStringSecure(b *testing.B) {
b.ReportAllocs() b.ReportAllocs()
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
_, err := randomStringSecure(10) _, err := randomStringSecure(22)
if err != nil { if err != nil {
b.Errorf("RandomStringFromCharRange() failed: %s", err) b.Errorf("RandomStringFromCharRange() failed: %s", err)
} }
} }
} }
// randReader is type that satisfies the io.Reader interface. It can fail on a specific read
// operations and is therefore useful to test consecutive reads with errors
type randReader struct {
failon uint8
call uint8
}
// Read implements the io.Reader interface for the randReader type
func (r *randReader) Read(p []byte) (int, error) {
if r.call == r.failon {
r.call++
return len(p), nil
}
return 0, errors.New("broken reader")
}

View file

@ -81,7 +81,7 @@ type SendErrReason int
// Returns: // Returns:
// - A string representing the error message. // - A string representing the error message.
func (e *SendError) Error() string { func (e *SendError) Error() string {
if e.Reason > ErrAmbiguous { if e.Reason > 10 {
return "unknown reason" return "unknown reason"
} }
@ -93,7 +93,7 @@ func (e *SendError) Error() string {
errMessage.WriteRune(' ') errMessage.WriteRune(' ')
errMessage.WriteString(e.errlist[i].Error()) errMessage.WriteString(e.errlist[i].Error())
if i != len(e.errlist)-1 { if i != len(e.errlist)-1 {
errMessage.WriteString(",") errMessage.WriteString(", ")
} }
} }
} }

View file

@ -6,17 +6,17 @@ package mail
import ( import (
"errors" "errors"
"fmt"
"strings" "strings"
"testing" "testing"
) )
// TestSendError_Error tests the SendError and SendErrReason error handling methods // TestSendError_Error tests the SendError and SendErrReason error handling methods
func TestSendError_Error(t *testing.T) { func TestSendError_Error(t *testing.T) {
t.Run("TestSendError_Error with various reasons", func(t *testing.T) { tl := []struct {
tests := []struct { n string
name string r SendErrReason
reason SendErrReason te bool
isTemp bool
}{ }{
{"ErrGetSender/temp", ErrGetSender, true}, {"ErrGetSender/temp", ErrGetSender, true},
{"ErrGetSender/perm", ErrGetSender, false}, {"ErrGetSender/perm", ErrGetSender, false},
@ -43,173 +43,126 @@ func TestSendError_Error(t *testing.T) {
{"Unknown/temp", 9999, true}, {"Unknown/temp", 9999, true},
{"Unknown/perm", 9999, false}, {"Unknown/perm", 9999, false},
} }
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := returnSendError(tt.reason, tt.isTemp)
if err == nil {
t.Fatalf("error expected, got nil")
}
want := &SendError{Reason: tt.reason, isTemp: tt.isTemp}
if !errors.Is(err, want) {
t.Errorf("error mismatch, expected: %s (temp: %t), got: %s (temp: %t)",
tt.reason, tt.isTemp, want.Error(), want.isTemp)
}
if !strings.Contains(err.Error(), tt.reason.String()) {
t.Errorf("error string mismatch, expected: %s, got: %s",
tt.reason.String(), err.Error())
}
})
}
})
t.Run("TestSendError_Error with multiple errors", func(t *testing.T) {
message := testMessage(t)
err := &SendError{
affectedMsg: message,
errlist: []error{ErrNoRcptAddresses, ErrNoFromAddress},
rcpt: []string{"<toni.tester@domain.tld>", "<tina.tester@domain.tld>"},
Reason: ErrAmbiguous,
}
if !strings.Contains(err.Error(), "ambiguous reason, check Msg.SendError for message specific reasons") {
t.Errorf("error string mismatch, expected: ambiguous reason, check Msg.SendError for message "+
"specific reasons, got: %s", err.Error())
}
if !strings.Contains(err.Error(), "no recipient addresses set, no FROM address set") {
t.Errorf("error string mismatch, expected: no recipient addresses set, no FROM address set, got: %s",
err.Error())
}
if !strings.Contains(err.Error(), "affected recipient(s): <toni.tester@domain.tld>, "+
"<tina.tester@domain.tld>") {
t.Errorf("error string mismatch, expected: affected recipient(s): <toni.tester@domain.tld>, "+
"<tina.tester@domain.tld>, got: %s", err.Error())
}
})
}
func TestSendError_Is(t *testing.T) { for _, tt := range tl {
t.Run("TestSendError_Is errors match", func(t *testing.T) { t.Run(tt.n, func(t *testing.T) {
err1 := returnSendError(ErrAmbiguous, false) if err := returnSendError(tt.r, tt.te); err != nil {
err2 := returnSendError(ErrAmbiguous, false) exp := &SendError{Reason: tt.r, isTemp: tt.te}
if !errors.Is(err1, err2) { if !errors.Is(err, exp) {
t.Error("error mismatch, expected ErrAmbiguous to be equal to ErrAmbiguous") t.Errorf("error mismatch, expected: %s (temp: %t), got: %s (temp: %t)", tt.r, tt.te,
exp.Error(), exp.isTemp)
}
if !strings.Contains(fmt.Sprintf("%s", err), tt.r.String()) {
t.Errorf("error string mismatch, expected: %s, got: %s",
tt.r.String(), fmt.Sprintf("%s", err))
}
} }
}) })
t.Run("TestSendError_Is errors mismatch", func(t *testing.T) {
err1 := returnSendError(ErrAmbiguous, false)
err2 := returnSendError(ErrSMTPMailFrom, false)
if errors.Is(err1, err2) {
t.Error("error mismatch, ErrAmbiguous should not be equal to ErrSMTPMailFrom")
} }
})
t.Run("TestSendError_Is on nil", func(t *testing.T) {
var err *SendError
if err.Is(ErrNoFromAddress) {
t.Error("expected false on nil-senderror")
}
})
} }
func TestSendError_IsTemp(t *testing.T) { func TestSendError_IsTemp(t *testing.T) {
t.Run("TestSendError_IsTemp is true", func(t *testing.T) { var se *SendError
err := returnSendError(ErrAmbiguous, true) err1 := returnSendError(ErrAmbiguous, true)
if err == nil { if !errors.As(err1, &se) {
t.Fatalf("error expected, got nil") t.Errorf("error mismatch, expected error to be of type *SendError")
return
} }
var sendErr *SendError if errors.As(err1, &se) && !se.IsTemp() {
if !errors.As(err, &sendErr) { t.Errorf("error mismatch, expected temporary error")
t.Fatal("error expected to be of type *SendError") return
} }
if !sendErr.IsTemp() { err2 := returnSendError(ErrAmbiguous, false)
t.Errorf("expected temporary error, got: temperr: %t", sendErr.IsTemp()) if !errors.As(err2, &se) {
t.Errorf("error mismatch, expected error to be of type *SendError")
return
} }
}) if errors.As(err2, &se) && se.IsTemp() {
t.Run("TestSendError_IsTemp is false", func(t *testing.T) { t.Errorf("error mismatch, expected non-temporary error")
err := returnSendError(ErrAmbiguous, false) return
if err == nil {
t.Fatalf("error expected, got nil")
} }
var sendErr *SendError }
if !errors.As(err, &sendErr) {
t.Fatal("error expected to be of type *SendError") func TestSendError_IsTempNil(t *testing.T) {
}
if sendErr.IsTemp() {
t.Errorf("expected permanent error, got: temperr: %t", sendErr.IsTemp())
}
})
t.Run("TestSendError_IsTemp is nil", func(t *testing.T) {
var se *SendError var se *SendError
if se.IsTemp() { if se.IsTemp() {
t.Error("expected false on nil-senderror") t.Error("expected false on nil-senderror")
} }
})
} }
func TestSendError_MessageID(t *testing.T) { func TestSendError_MessageID(t *testing.T) {
t.Run("TestSendError_MessageID message ID is set", func(t *testing.T) { var se *SendError
var sendErr *SendError
err := returnSendError(ErrAmbiguous, false) err := returnSendError(ErrAmbiguous, false)
if !errors.As(err, &sendErr) { if !errors.As(err, &se) {
t.Fatal("error mismatch, expected error to be of type *SendError") t.Errorf("error mismatch, expected error to be of type *SendError")
return
} }
if sendErr.MessageID() == "" { if errors.As(err, &se) {
t.Error("sendError expected message-id, but got empty string") if se.MessageID() == "" {
t.Errorf("sendError expected message-id, but got empty string")
} }
if !strings.EqualFold(sendErr.MessageID(), "<this.is.a.message.id>") { if !strings.EqualFold(se.MessageID(), "<this.is.a.message.id>") {
t.Errorf("sendError message-id expected: %s, but got: %s", "<this.is.a.message.id>", t.Errorf("sendError message-id expected: %s, but got: %s", "<this.is.a.message.id>",
sendErr.MessageID()) se.MessageID())
} }
})
t.Run("TestSendError_MessageID message ID is not set", func(t *testing.T) {
var sendErr *SendError
message := testMessage(t)
err := &SendError{
affectedMsg: message,
errlist: []error{ErrNoRcptAddresses},
rcpt: []string{"<toni.tester@domain.tld>", "<tina.tester@domain.tld>"},
Reason: ErrAmbiguous,
} }
if !errors.As(err, &sendErr) { }
t.Fatal("error mismatch, expected error to be of type *SendError")
func TestSendError_MessageIDNil(t *testing.T) {
var se *SendError
if se.MessageID() != "" {
t.Error("expected empty string on nil-senderror")
} }
if sendErr.MessageID() != "" {
t.Errorf("sendError expected empty message-id, got: %s", sendErr.MessageID())
}
})
} }
func TestSendError_Msg(t *testing.T) { func TestSendError_Msg(t *testing.T) {
t.Run("TestSendError_Msg message is set", func(t *testing.T) { var se *SendError
var sendErr *SendError
err := returnSendError(ErrAmbiguous, false) err := returnSendError(ErrAmbiguous, false)
if !errors.As(err, &sendErr) { if !errors.As(err, &se) {
t.Fatal("error mismatch, expected error to be of type *SendError") t.Errorf("error mismatch, expected error to be of type *SendError")
return
} }
msg := sendErr.Msg() if errors.As(err, &se) {
if msg == nil { if se.Msg() == nil {
t.Fatalf("sendError expected msg pointer, but got nil") t.Errorf("sendError expected msg pointer, but got nil")
} }
from := msg.GetFromString() from := se.Msg().GetFromString()
if len(from) == 0 { if len(from) == 0 {
t.Fatal("sendError expected msg from, but got empty string") t.Errorf("sendError expected msg from, but got empty string")
return
} }
if !strings.EqualFold(from[0], "<toni.tester@domain.tld>") { if !strings.EqualFold(from[0], "<toni.tester@domain.tld>") {
t.Errorf("sendError message from expected: %s, but got: %s", "<toni.tester@domain.tld>", t.Errorf("sendError message from expected: %s, but got: %s", "<toni.tester@domain.tld>",
from[0]) from[0])
} }
}) }
t.Run("TestSendError_Msg message is not set", func(t *testing.T) { }
var sendErr *SendError
func TestSendError_MsgNil(t *testing.T) {
var se *SendError
if se.Msg() != nil {
t.Error("expected nil on nil-senderror")
}
}
func TestSendError_IsFail(t *testing.T) {
err1 := returnSendError(ErrAmbiguous, false)
err2 := returnSendError(ErrSMTPMailFrom, false)
if errors.Is(err1, err2) {
t.Errorf("error mismatch, ErrAmbiguous should not be equal to ErrSMTPMailFrom")
}
}
func TestSendError_ErrorMulti(t *testing.T) {
expected := `ambiguous reason, check Msg.SendError for message specific reasons, ` +
`affected recipient(s): <email1@domain.tld>, <email2@domain.tld>`
err := &SendError{ err := &SendError{
errlist: []error{ErrNoRcptAddresses}, Reason: ErrAmbiguous, isTemp: false, affectedMsg: nil,
rcpt: []string{"<toni.tester@domain.tld>", "<tina.tester@domain.tld>"}, rcpt: []string{"<email1@domain.tld>", "<email2@domain.tld>"},
Reason: ErrAmbiguous,
} }
if !errors.As(err, &sendErr) { if err.Error() != expected {
t.Fatal("error mismatch, expected error to be of type *SendError") t.Errorf("error mismatch, expected: %s, got: %s", expected, err.Error())
} }
if sendErr.Msg() != nil {
t.Errorf("sendError expected nil msg pointer, got: %v", sendErr.Msg())
}
})
} }
// returnSendError is a helper method to retunr a SendError with a specific reason // returnSendError is a helper method to retunr a SendError with a specific reason
@ -220,5 +173,6 @@ func returnSendError(r SendErrReason, t bool) error {
message.Subject("This is the subject") message.Subject("This is the subject")
message.SetBodyString(TypeTextPlain, "This is the message body") message.SetBodyString(TypeTextPlain, "This is the message body")
message.SetMessageIDWithValue("this.is.a.message.id") message.SetMessageIDWithValue("this.is.a.message.id")
return &SendError{Reason: r, isTemp: t, affectedMsg: message} return &SendError{Reason: r, isTemp: t, affectedMsg: message}
} }