| 1 |
package router |
| 2 |
|
| 3 |
import ( |
| 4 |
"fmt" |
| 5 |
"log" |
| 6 |
"os" |
| 7 |
"testing" |
| 8 |
|
| 9 |
"github.com/onsi/ginkgo/v2" |
| 10 |
"github.com/onsi/gomega" |
| 11 |
) |
| 12 |
|
| 13 |
const ( |
| 14 |
mockCustomURL = "generic+https://example.com/webhook" |
| 15 |
) |
| 16 |
|
| 17 |
var sr ServiceRouter |
| 18 |
|
| 19 |
var _ = ginkgo.Describe("the router suite", func() { |
| 20 |
ginkgo.BeforeEach(func() { |
| 21 |
sr = ServiceRouter{ |
| 22 |
logger: log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags), |
| 23 |
} |
| 24 |
}) |
| 25 |
|
| 26 |
ginkgo.When("extract service name is given a url", func() { |
| 27 |
ginkgo.It("should extract the protocol/service part", func() { |
| 28 |
url := "slack://rest/of/url" |
| 29 |
serviceName, _, err := sr.ExtractServiceName(url) |
| 30 |
gomega.Expect(err).ToNot(gomega.HaveOccurred()) |
| 31 |
gomega.Expect(serviceName).To(gomega.Equal("slack")) |
| 32 |
}) |
| 33 |
ginkgo.It("should extract the service part when provided in custom form", func() { |
| 34 |
url := "teams+https://rest/of/url" |
| 35 |
serviceName, _, err := sr.ExtractServiceName(url) |
| 36 |
gomega.Expect(err).ToNot(gomega.HaveOccurred()) |
| 37 |
gomega.Expect(serviceName).To(gomega.Equal("teams")) |
| 38 |
}) |
| 39 |
ginkgo.It("should return an error if the protocol/service part is missing", func() { |
| 40 |
url := "://rest/of/url" |
| 41 |
serviceName, _, err := sr.ExtractServiceName(url) |
| 42 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 43 |
gomega.Expect(serviceName).To(gomega.Equal("")) |
| 44 |
}) |
| 45 |
ginkgo.It( |
| 46 |
"should return an error if the protocol/service part is containing invalid letters", |
| 47 |
func() { |
| 48 |
url := "a d://rest/of/url" |
| 49 |
serviceName, _, err := sr.ExtractServiceName(url) |
| 50 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 51 |
gomega.Expect(serviceName).To(gomega.Equal("")) |
| 52 |
}, |
| 53 |
) |
| 54 |
}) |
| 55 |
|
| 56 |
ginkgo.When("initializing a service with a custom URL", func() { |
| 57 |
ginkgo.It("should return an error if the service does not support it", func() { |
| 58 |
service, err := sr.initService("log+https://hybr.is") |
| 59 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 60 |
gomega.Expect(service).To(gomega.BeNil()) |
| 61 |
}) |
| 62 |
}) |
| 63 |
|
| 64 |
ginkgo.Describe("the service map", func() { |
| 65 |
ginkgo.When("resolving implemented services", func() { |
| 66 |
services := (&ServiceRouter{}).ListServices() |
| 67 |
|
| 68 |
for _, scheme := range services { |
| 69 |
ginkgo.It(fmt.Sprintf("should return a Service for '%s'", scheme), func() { |
| 70 |
service, err := newService(scheme) |
| 71 |
|
| 72 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 73 |
gomega.Expect(service).ToNot(gomega.BeNil()) |
| 74 |
}) |
| 75 |
} |
| 76 |
}) |
| 77 |
}) |
| 78 |
|
| 79 |
ginkgo.When("initializing a service with a custom URL", func() { |
| 80 |
ginkgo.It("should return an error if the service does not support it", func() { |
| 81 |
service, err := sr.initService("log+https://hybr.is") |
| 82 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 83 |
gomega.Expect(service).To(gomega.BeNil()) |
| 84 |
}) |
| 85 |
ginkgo.It("should successfully init a service that does support it", func() { |
| 86 |
service, err := sr.initService(mockCustomURL) |
| 87 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 88 |
gomega.Expect(service).NotTo(gomega.BeNil()) |
| 89 |
}) |
| 90 |
}) |
| 91 |
|
| 92 |
ginkgo.When("a message is enqueued", func() { |
| 93 |
ginkgo.It("should be added to the internal queue", func() { |
| 94 |
sr.Enqueue("message body") |
| 95 |
gomega.Expect(sr.queue).ToNot(gomega.BeNil()) |
| 96 |
gomega.Expect(sr.queue).To(gomega.HaveLen(1)) |
| 97 |
}) |
| 98 |
}) |
| 99 |
ginkgo.When("a formatted message is enqueued", func() { |
| 100 |
ginkgo.It("should be added with the specified format", func() { |
| 101 |
sr.Enqueue("message with number %d", 5) |
| 102 |
gomega.Expect(sr.queue).ToNot(gomega.BeNil()) |
| 103 |
gomega.Expect(sr.queue[0]).To(gomega.Equal("message with number 5")) |
| 104 |
}) |
| 105 |
}) |
| 106 |
ginkgo.When("it leaves the scope after flush has been deferred", func() { |
| 107 |
ginkgo.When("it hasn't been assigned a sender", func() { |
| 108 |
ginkgo.It("should not cause a panic", func() { |
| 109 |
defer sr.Flush(nil) |
| 110 |
|
| 111 |
sr.Enqueue("message") |
| 112 |
}) |
| 113 |
}) |
| 114 |
}) |
| 115 |
ginkgo.When("router has not been provided a logger", func() { |
| 116 |
ginkgo.It("should not crash when trying to log", func() { |
| 117 |
router := ServiceRouter{} |
| 118 |
_, err := router.initService(mockCustomURL) |
| 119 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 120 |
}) |
| 121 |
}) |
| 122 |
}) |
| 123 |
|
| 124 |
func ExampleNew() { |
| 125 |
logger := log.New(os.Stdout, "", 0) |
| 126 |
|
| 127 |
sr, err := New(logger, "logger://") |
| 128 |
if err != nil { |
| 129 |
log.Fatalf("could not create router: %s", err) |
| 130 |
} |
| 131 |
|
| 132 |
sr.Send("hello", nil) |
| 133 |
// Output: hello |
| 134 |
} |
| 135 |
|
| 136 |
func ExampleServiceRouter_Enqueue() { |
| 137 |
logger := log.New(os.Stdout, "", 0) |
| 138 |
|
| 139 |
sr, err := New(logger, "logger://") |
| 140 |
if err != nil { |
| 141 |
log.Fatalf("could not create router: %s", err) |
| 142 |
} |
| 143 |
|
| 144 |
defer sr.Flush(nil) |
| 145 |
|
| 146 |
sr.Enqueue("hello") |
| 147 |
sr.Enqueue("world") |
| 148 |
// Output: |
| 149 |
// hello |
| 150 |
// world |
| 151 |
} |
| 152 |
|
| 153 |
func TestRouter(t *testing.T) { |
| 154 |
t.Parallel() |
| 155 |
gomega.RegisterFailHandler(ginkgo.Fail) |
| 156 |
ginkgo.RunSpecs(t, "Router Suite") |
| 157 |
} |