7830

Committed 04 Jun 2020 07:05PM UTC coverage: 40.933%. First build

Build # 7830

Build Type

Pull #2084

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/OpenBazaar/openbazaar-go/commit/<a class=hub.com/OpenBazaar/openbazaar-go/commit/<a class="double-link" href="https://git"><a class=hub.com/OpenBazaar/openbazaar-go/commit/<a class="double-link" href="https://git"><a class=hub.com/OpenBazaar/openbazaar-go/commit/<a class="double-link" href="https://git"><a class=hub.com/OpenBazaar/openbazaar-go/commit/52693813fc094ca212dc7fe3562f06c1fce9ff27">52693813f">&lt;a href=&quot;https://github.com/OpenBazaar/openbazaar-go/commit/</a><a class="double-link" href="https://github.com/OpenBazaar/openbazaar-go/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OpenBazaar/openbazaar-go/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OpenBazaar/openbazaar-go/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/OpenBazaar/openbazaar-go/commit/52693813fc094ca212dc7fe3562f06c1fce9ff27">52693813f</a><a href="https://github.com/OpenBazaar/openbazaar-go/commit/52693813fc094ca212dc7fe3562f06c1fce9ff27">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/OpenBazaar/openbazaar-go/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/OpenBazaar/openbazaar-go/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OpenBazaar/openbazaar-go/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OpenBazaar/openbazaar-go/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OpenBazaar/openbazaar-go/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OpenBazaar/openbazaar-go/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/OpenBazaar/openbazaar-go/commit/52693813fc094ca212dc7fe3562f06c1fce9ff27&quot;&gt;52693813f&lt;/a&gt;&lt;a href=&quot;https://github.com/OpenBazaar/openbazaar-go/commit/52693813fc094ca212dc7fe3562f06c1fce9ff27&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/OpenBazaar/openbazaar-go/... (continued)

Pull Request Pull Request #2084: Add Store Name to Email Notifications

Run Details

15 of 15 new or added lines in 2 files covered. (100.0%)

10765 of 26299 relevant lines covered (40.93%)

0.44 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

45.95

/api/notifier.go

package api

import (
        "errors"
        "fmt"
        "net/smtp"
        "strings"

        "github.com/OpenBazaar/openbazaar-go/core"
        "github.com/OpenBazaar/openbazaar-go/repo"
)

// Notification manager intercepts data form 'inChan' which is embedded
// in different parts of the system and retransmits to the 'outChan',
// which is listened by websocket API, while adding specific handling for
// each received object.
type notificationManager struct {
        node *core.OpenBazaarNode
}

func manageNotifications(node *core.OpenBazaarNode, out chan []byte) chan repo.Notifier {
        manager := &notificationManager{node: node}
        nodeBroadcast := make(chan repo.Notifier)
        go func() {
                for {
                        n := <-nodeBroadcast
                        // Fixme: right now this assumes that n is a notification but it should be agnostic
                        // enough to let us send any data to the websocket. You can technically do that by
                        // sending over a []byte as the serialize function ignores []bytes but it's kind of hacky.
                        manager.sendNotification(n)
                        data, err := n.WebsocketData()
                        if err != nil {
                                log.Error("marshal notification:", err)
                                continue
                        }
                        sanitized, err := SanitizeJSON(data)
                        if err != nil {
                                log.Error("sanitize notification:", err)
                                continue
                        }
                        out <- sanitized
                }
        }()
        return nodeBroadcast
}

type notifier interface {
        notify(n repo.Notifier) error
}

// Send notification via all supported notifier mechanisms
func (m *notificationManager) sendNotification(n repo.Notifier) {
        for _, notifier := range m.getNotifiers() {
                if err := notifier.notify(n); err != nil {
                        log.Errorf("Notification failed: %s", err.Error())
                }
        }
}

// Create list of notifiers based on settings data (currently only SMTP is available)
// TODO: should be extended to include new notifiers in the list
func (m *notificationManager) getNotifiers() []notifier {
        settings, err := m.node.Datastore.Settings().Get()
        var notifiers []notifier
        if err != nil {
                return notifiers
        }

        // SMTP notifier
        conf := settings.SMTPSettings

        profile, err := m.node.GetProfile()
        if err != nil {
                return nil
        }
        conf.OpenBazaarName = profile.Name

        if conf != nil && conf.Notifications {
                notifiers = append(notifiers, &smtpNotifier{settings: conf})
        }
        return notifiers
}

// Notifier implementations
type smtpNotifier struct {
        settings *repo.SMTPSettings
}

func (notifier *smtpNotifier) notify(n repo.Notifier) error {
        template := strings.Join([]string{
                "From: %s",
                "To: %s",
                "MIME-Version: 1.0",
                "Content-Type: text/html; charset=UTF-8",
                "Subject: [OpenBazaar - %s] %s\r\n",
                "%s\r\n",
        }, "\r\n")
        head, body, ok := n.GetSMTPTitleAndBody()
        if !ok {
                return nil
        }
        conf := notifier.settings
        data := fmt.Sprintf(template, conf.SenderEmail, conf.RecipientEmail, conf.OpenBazaarName, head, body)
        return sendEmail(notifier.settings, []byte(data))
}

// Send email using PLAIN authentication to the server
func sendEmail(conf *repo.SMTPSettings, body []byte) error {
        hostAndPort := strings.Split(conf.ServerAddress, ":")
        host := conf.ServerAddress
        if len(hostAndPort) == 2 {
                host = hostAndPort[0]
        }
        auth := smtp.PlainAuth("", conf.Username, conf.Password, host)
        recipients := []string{conf.RecipientEmail}
        return smtp.SendMail(conf.ServerAddress, auth, conf.SenderEmail, recipients, body)
}

func validateSMTPSettings(s repo.SettingsData) error {
        if s.SMTPSettings != nil && s.SMTPSettings.Notifications &&
                (s.SMTPSettings.Password == "" || s.SMTPSettings.Username == "" || s.SMTPSettings.RecipientEmail == "" || s.SMTPSettings.SenderEmail == "" || s.SMTPSettings.ServerAddress == "") {
                return errors.New("SMTP fields must be set if notifications are turned on")
        }
        return nil
}

1	package api
2
3	import (
4	"errors"
5	"fmt"
6	"net/smtp"
7	"strings"
8
9	"github.com/OpenBazaar/openbazaar-go/core"
10	"github.com/OpenBazaar/openbazaar-go/repo"
11	)
12
13	// Notification manager intercepts data form 'inChan' which is embedded
14	// in different parts of the system and retransmits to the 'outChan',
15	// which is listened by websocket API, while adding specific handling for
16	// each received object.
17	type notificationManager struct {
18	node *core.OpenBazaarNode
19	}
20
21	func manageNotifications(node *core.OpenBazaarNode, out chan []byte) chan repo.Notifier {	1✔
22	manager := &notificationManager{node: node}	1✔
23	nodeBroadcast := make(chan repo.Notifier)	1✔
24	go func() {	2✔
25	for {	2✔
26	n := <-nodeBroadcast	1✔
27	// Fixme: right now this assumes that n is a notification but it should be agnostic	1✔
28	// enough to let us send any data to the websocket. You can technically do that by	1✔
29	// sending over a []byte as the serialize function ignores []bytes but it's kind of hacky.	1✔
30	manager.sendNotification(n)	1✔
31	data, err := n.WebsocketData()	1✔
32	if err != nil {	1✔
33	log.Error("marshal notification:", err)	×
34	continue	×
35	}
36	sanitized, err := SanitizeJSON(data)	1✔
37	if err != nil {	1✔
38	log.Error("sanitize notification:", err)	×
39	continue	×
40	}
41	out <- sanitized	1✔
42	}
43	}()
44	return nodeBroadcast	1✔
45	}
46
47	type notifier interface {
48	notify(n repo.Notifier) error
49	}
50
51	// Send notification via all supported notifier mechanisms
52	func (m *notificationManager) sendNotification(n repo.Notifier) {	1✔
53	for _, notifier := range m.getNotifiers() {	1✔
54	if err := notifier.notify(n); err != nil {	×
55	log.Errorf("Notification failed: %s", err.Error())	×
56	}	×
57	}
58	}
59
60	// Create list of notifiers based on settings data (currently only SMTP is available)
61	// TODO: should be extended to include new notifiers in the list
62	func (m *notificationManager) getNotifiers() []notifier {	1✔
63	settings, err := m.node.Datastore.Settings().Get()	1✔
64	var notifiers []notifier	1✔
65	if err != nil {	2✔
66	return notifiers	1✔
67	}	1✔
68
69	// SMTP notifier
70	conf := settings.SMTPSettings	1✔
71		1✔
72	profile, err := m.node.GetProfile()	1✔
73	if err != nil {	2✔
74	return nil	1✔
75	}	1✔
76	conf.OpenBazaarName = profile.Name	×
77		×
78	if conf != nil && conf.Notifications {	×
79	notifiers = append(notifiers, &smtpNotifier{settings: conf})	×
80	}	×
81	return notifiers	×
82	}
83
84	// Notifier implementations
85	type smtpNotifier struct {
86	settings *repo.SMTPSettings
87	}
88
89	func (notifier *smtpNotifier) notify(n repo.Notifier) error {	×
90	template := strings.Join([]string{	×
91	"From: %s",	×
92	"To: %s",	×
93	"MIME-Version: 1.0",	×
94	"Content-Type: text/html; charset=UTF-8",	×
95	"Subject: [OpenBazaar - %s] %s\r\n",	×
96	"%s\r\n",	×
97	}, "\r\n")	×
98	head, body, ok := n.GetSMTPTitleAndBody()	×
99	if !ok {	×
100	return nil	×
101	}	×
102	conf := notifier.settings	×
103	data := fmt.Sprintf(template, conf.SenderEmail, conf.RecipientEmail, conf.OpenBazaarName, head, body)	×
104	return sendEmail(notifier.settings, []byte(data))	×
105	}
106
107	// Send email using PLAIN authentication to the server
108	func sendEmail(conf *repo.SMTPSettings, body []byte) error {	×
109	hostAndPort := strings.Split(conf.ServerAddress, ":")	×
110	host := conf.ServerAddress	×
111	if len(hostAndPort) == 2 {	×
112	host = hostAndPort[0]	×
113	}	×
114	auth := smtp.PlainAuth("", conf.Username, conf.Password, host)	×
115	recipients := []string{conf.RecipientEmail}	×
116	return smtp.SendMail(conf.ServerAddress, auth, conf.SenderEmail, recipients, body)	×
117	}
118
119	func validateSMTPSettings(s repo.SettingsData) error {	1✔
120	if s.SMTPSettings != nil && s.SMTPSettings.Notifications &&	1✔
121	(s.SMTPSettings.Password == "" \|\| s.SMTPSettings.Username == "" \|\| s.SMTPSettings.RecipientEmail == "" \|\| s.SMTPSettings.SenderEmail == "" \|\| s.SMTPSettings.ServerAddress == "") {	1✔
122	return errors.New("SMTP fields must be set if notifications are turned on")	×
123	}	×
124	return nil	1✔
125	}

OpenBazaar / openbazaar-go / 7830

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous