dapr
/
components-contrib
mirror of https://github.com/dapr/components-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add priority option in SMTP binding. It will allow select email priority (#1018) 

* binding smtp add priority option

* binding SMTP add priority: fix lint

* binding SMTP add priority: added a priority metadata support

* binding SMTP add priority: lowest and hight priority as const

* binding SMTP add priority: handle error on unquote req.Data

* binding SMTP add priority: lowest and hight priority as const (msg error)

Co-authored-by: Artur Souza <artursouza.ms@outlook.com>
This commit is contained in:
Javier Vela 2021-08-04 19:39:20 +02:00 committed by GitHub
parent 7496adf110
commit 71c5b2088c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 207 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
bindings/smtp/smtp.go
View File

@ -16,6 +16,12 @@ import (
"gopkg.in/gomail.v2"
)
const (
defaultPriority = 3
lowestPriority = 1
highestPriority = 5
)
// Mailer allows sending of emails using the Simple Mail Transfer Protocol
type Mailer struct {
metadata Metadata
@ -34,6 +40,7 @@ type Metadata struct {
EmailCC string `json:"emailCC"`
EmailBCC string `json:"emailBCC"`
Subject string `json:"subject"`
Priority int `json:"priority"`
}
// NewSMTP returns a new smtp binding instance
@ -61,7 +68,10 @@ func (s *Mailer) Operations() []bindings.OperationKind {
// Invoke sends an email message
func (s *Mailer) Invoke(req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
// Merge config metadata with request metadata
metadata := s.metadata.mergeWithRequestMetadata(req)
metadata, err := s.metadata.mergeWithRequestMetadata(req)
if err != nil {
return nil, err
}
if metadata.EmailFrom == "" {
return nil, fmt.Errorf("smtp binding error: emailFrom property not supplied in configuration- or request-metadata")
}
@ -79,7 +89,11 @@ func (s *Mailer) Invoke(req *bindings.InvokeRequest) (*bindings.InvokeResponse,
msg.SetHeader("CC", metadata.EmailCC)
msg.SetHeader("BCC", metadata.EmailBCC)
msg.SetHeader("Subject", metadata.Subject)
body, _ := strconv.Unquote(string(req.Data))
msg.SetHeader("X-priority", strconv.Itoa(metadata.Priority))
body, err := strconv.Unquote(string(req.Data))
if err != nil {
return nil, fmt.Errorf("smtp binding error: can't unquote data field %w", err)
}
msg.SetBody("text/html", body)
// Send message
@ -132,12 +146,17 @@ func (s *Mailer) parseMetadata(meta bindings.Metadata) (Metadata, error) {
smtpMeta.EmailBCC = meta.Properties["emailBCC"]
smtpMeta.EmailFrom = meta.Properties["emailFrom"]
smtpMeta.Subject = meta.Properties["subject"]
err = smtpMeta.parsePriority(meta.Properties["priority"])
if err != nil {
return smtpMeta, err
}
return smtpMeta, nil
}
// Helper to merge config and request metadata
func (metadata Metadata) mergeWithRequestMetadata(req *bindings.InvokeRequest) Metadata {
func (metadata Metadata) mergeWithRequestMetadata(req *bindings.InvokeRequest) (Metadata, error) {
merged := metadata
if emailFrom := req.Metadata["emailFrom"]; emailFrom != "" {
@ -160,5 +179,29 @@ func (metadata Metadata) mergeWithRequestMetadata(req *bindings.InvokeRequest) M
merged.Subject = subject
}
return merged
if priority := req.Metadata["priority"]; priority != "" {
err := merged.parsePriority(priority)
if err != nil {
return merged, err
}
}
return merged, nil
}
func (metadata *Metadata) parsePriority(req string) error {
if req == "" {
metadata.Priority = defaultPriority
} else {
priority, err := strconv.Atoi(req)
if err != nil {
return err
}
if priority < lowestPriority || priority > highestPriority {
return fmt.Errorf("smtp binding error: priority value must be between %d (highest) and %d (lowest)", lowestPriority, highestPriority)
}
metadata.Priority = priority
}
return nil
}

162
bindings/smtp/smtp_test.go
View File

@ -16,7 +16,7 @@ import (
func TestParseMetadata(t *testing.T) {
logger := logger.NewLogger("test")
t.Run("Has correct metadata", func(t *testing.T) {
t.Run("Has correct metadata (default priority)", func(t *testing.T) {
m := bindings.Metadata{}
m.Properties = map[string]string{
"host": "mailserver.dapr.io",
@ -43,6 +43,57 @@ func TestParseMetadata(t *testing.T) {
assert.Equal(t, "cc@dapr.io", smtpMeta.EmailCC)
assert.Equal(t, "bcc@dapr.io", smtpMeta.EmailBCC)
assert.Equal(t, "Test email", smtpMeta.Subject)
assert.Equal(t, 3, smtpMeta.Priority)
})
t.Run("Has correct metadata (no default value for priority)", func(t *testing.T) {
m := bindings.Metadata{}
m.Properties = map[string]string{
"host": "mailserver.dapr.io",
"port": "25",
"user": "user@dapr.io",
"password": "P@$$w0rd!",
"skipTLSVerify": "true",
"emailFrom": "from@dapr.io",
"emailTo": "to@dapr.io",
"emailCC": "cc@dapr.io",
"emailBCC": "bcc@dapr.io",
"subject": "Test email",
"priority": "1",
}
r := Mailer{logger: logger}
smtpMeta, err := r.parseMetadata(m)
assert.Nil(t, err)
assert.Equal(t, "mailserver.dapr.io", smtpMeta.Host)
assert.Equal(t, 25, smtpMeta.Port)
assert.Equal(t, "user@dapr.io", smtpMeta.User)
assert.Equal(t, "P@$$w0rd!", smtpMeta.Password)
assert.Equal(t, true, smtpMeta.SkipTLSVerify)
assert.Equal(t, "from@dapr.io", smtpMeta.EmailFrom)
assert.Equal(t, "to@dapr.io", smtpMeta.EmailTo)
assert.Equal(t, "cc@dapr.io", smtpMeta.EmailCC)
assert.Equal(t, "bcc@dapr.io", smtpMeta.EmailBCC)
assert.Equal(t, "Test email", smtpMeta.Subject)
assert.Equal(t, 1, smtpMeta.Priority)
})
t.Run("Incorrrect metadata (invalid priority)", func(t *testing.T) {
m := bindings.Metadata{}
m.Properties = map[string]string{
"host": "mailserver.dapr.io",
"port": "25",
"user": "user@dapr.io",
"password": "P@$$w0rd!",
"skipTLSVerify": "true",
"emailFrom": "from@dapr.io",
"emailTo": "to@dapr.io",
"emailCC": "cc@dapr.io",
"emailBCC": "bcc@dapr.io",
"subject": "Test email",
"priority": "0",
}
r := Mailer{logger: logger}
smtpMeta, err := r.parseMetadata(m)
assert.NotNil(t, smtpMeta)
assert.NotNil(t, err)
})
}
@ -68,9 +119,12 @@ func TestMergeWithRequestMetadata(t *testing.T) {
"emailCC": "req-cc@dapr.io",
"emailBCC": "req-bcc@dapr.io",
"subject": "req-Test email",
"priority": "1",
}
mergedMeta := smtpMeta.mergeWithRequestMetadata(&request)
mergedMeta, err := smtpMeta.mergeWithRequestMetadata(&request)
assert.Nil(t, err)
assert.Equal(t, "mailserver.dapr.io", mergedMeta.Host)
assert.Equal(t, 25, mergedMeta.Port)
@ -82,6 +136,7 @@ func TestMergeWithRequestMetadata(t *testing.T) {
assert.Equal(t, "req-cc@dapr.io", mergedMeta.EmailCC)
assert.Equal(t, "req-bcc@dapr.io", mergedMeta.EmailBCC)
assert.Equal(t, "req-Test email", mergedMeta.Subject)
assert.Equal(t, 1, mergedMeta.Priority)
})
}
@ -98,13 +153,15 @@ func TestMergeWithNoRequestMetadata(t *testing.T) {
EmailCC: "cc@dapr.io",
EmailBCC: "bcc@dapr.io",
Subject: "Test email",
Priority: 1,
}
request := bindings.InvokeRequest{}
request.Metadata = map[string]string{}
mergedMeta := smtpMeta.mergeWithRequestMetadata(&request)
mergedMeta, err := smtpMeta.mergeWithRequestMetadata(&request)
assert.Nil(t, err)
assert.Equal(t, "mailserver.dapr.io", mergedMeta.Host)
assert.Equal(t, 25, mergedMeta.Port)
assert.Equal(t, "user@dapr.io", mergedMeta.User)
@ -115,5 +172,104 @@ func TestMergeWithNoRequestMetadata(t *testing.T) {
assert.Equal(t, "cc@dapr.io", mergedMeta.EmailCC)
assert.Equal(t, "bcc@dapr.io", mergedMeta.EmailBCC)
assert.Equal(t, "Test email", mergedMeta.Subject)
assert.Equal(t, 1, mergedMeta.Priority)
})
}
func TestMergeWithRequestMetadata_invalidPriorityTooHigh(t *testing.T) {
t.Run("Has merged metadata", func(t *testing.T) {
smtpMeta := Metadata{
Host: "mailserver.dapr.io",
Port: 25,
User: "user@dapr.io",
SkipTLSVerify: true,
Password: "P@$$w0rd!",
EmailFrom: "from@dapr.io",
EmailTo: "to@dapr.io",
EmailCC: "cc@dapr.io",
EmailBCC: "bcc@dapr.io",
Subject: "Test email",
Priority: 2,
}
request := bindings.InvokeRequest{}
request.Metadata = map[string]string{
"emailFrom": "req-from@dapr.io",
"emailTo": "req-to@dapr.io",
"emailCC": "req-cc@dapr.io",
"emailBCC": "req-bcc@dapr.io",
"subject": "req-Test email",
"priority": "6",
}
mergedMeta, err := smtpMeta.mergeWithRequestMetadata(&request)
assert.NotNil(t, mergedMeta)
assert.NotNil(t, err)
})
}
func TestMergeWithRequestMetadata_invalidPriorityTooLow(t *testing.T) {
t.Run("Has merged metadata", func(t *testing.T) {
smtpMeta := Metadata{
Host: "mailserver.dapr.io",
Port: 25,
User: "user@dapr.io",
SkipTLSVerify: true,
Password: "P@$$w0rd!",
EmailFrom: "from@dapr.io",
EmailTo: "to@dapr.io",
EmailCC: "cc@dapr.io",
EmailBCC: "bcc@dapr.io",
Subject: "Test email",
Priority: 2,
}
request := bindings.InvokeRequest{}
request.Metadata = map[string]string{
"emailFrom": "req-from@dapr.io",
"emailTo": "req-to@dapr.io",
"emailCC": "req-cc@dapr.io",
"emailBCC": "req-bcc@dapr.io",
"subject": "req-Test email",
"priority": "0",
}
mergedMeta, err := smtpMeta.mergeWithRequestMetadata(&request)
assert.NotNil(t, mergedMeta)
assert.NotNil(t, err)
})
}
func TestMergeWithRequestMetadata_invalidPriorityNotNumber(t *testing.T) {
t.Run("Has merged metadata", func(t *testing.T) {
smtpMeta := Metadata{
Host: "mailserver.dapr.io",
Port: 25,
User: "user@dapr.io",
SkipTLSVerify: true,
Password: "P@$$w0rd!",
EmailFrom: "from@dapr.io",
EmailTo: "to@dapr.io",
EmailCC: "cc@dapr.io",
EmailBCC: "bcc@dapr.io",
Subject: "Test email",
}
request := bindings.InvokeRequest{}
request.Metadata = map[string]string{
"emailFrom": "req-from@dapr.io",
"emailTo": "req-to@dapr.io",
"emailCC": "req-cc@dapr.io",
"emailBCC": "req-bcc@dapr.io",
"subject": "req-Test email",
"priority": "NoNumber",
}
mergedMeta, err := smtpMeta.mergeWithRequestMetadata(&request)
assert.NotNil(t, mergedMeta)
assert.NotNil(t, err)
})
}

2
docs/developing-component.md
View File

@ -74,7 +74,7 @@ cp ./dist/darwin_amd64/debug/daprd ~/.dapr/bin
> Linux Debuggable Binary: ./dist/linux_amd64/debug/daprd
> Windows Debuggable Binary: .\dist\windows_amd64\debug\daprd
7. Prepare your test app (e.g. kafka sample app: https://github.com/dapr/quickstarts/tree/master/bindings/nodeapp/)
8. Create yaml for bindings in './components' under app’s directory (e.g. kafka example : https://github.com/dapr/quickstarts/blob/master/bindings/nodeapp/components/kafka_bindings.yaml)
8. Create yaml for bindings in './components' under app’s directory (e.g. kafka example : https://github.com/dapr/quickstarts/blob/master/bindings/components/kafka_bindings.yaml)
9. Run your test app using dapr cli
10. Make sure your component is loaded successfully in daprd log