1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
package slack_test
import (
"encoding/json"
"fmt"
"log"
"net/http"
"testing"
"time"
websocket "github.com/gorilla/websocket"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/slack-go/slack"
"github.com/slack-go/slack/slacktest"
)
const (
testMessage = "test message"
testToken = "TEST_TOKEN"
)
func TestRTMBeforeEvents(t *testing.T) {
// Set up the test server.
testServer := slacktest.NewTestServer()
go testServer.Start()
// Setup and start the RTM.
api := slack.New(testToken, slack.OptionAPIURL(testServer.GetAPIURL()))
rtm := api.NewRTM()
done := make(chan struct{})
go func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.DisconnectedEvent:
if ev.Intentional {
close(done)
return
}
default:
// t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
go rtm.Disconnect()
go rtm.ManageConnection()
select {
case <-done:
case <-time.After(5 * time.Second):
t.Error("timed out waiting for disconnect")
t.Fail()
}
}
func TestRTMGoodbye(t *testing.T) {
// Set up the test server.
testServer := slacktest.NewTestServer(
func(c slacktest.Customize) {
c.Handle("/ws", slacktest.Websocket(func(conn *websocket.Conn) {
if err := slacktest.RTMServerSendGoodbye(conn); err != nil {
log.Println("failed to send goodbye", err)
}
}))
},
)
go testServer.Start()
// Setup and start the RTM.
api := slack.New(
testToken,
slack.OptionAPIURL(testServer.GetAPIURL()),
)
rtm := api.NewRTM(
slack.RTMOptionPingInterval(100 * time.Millisecond),
)
done := make(chan struct{})
go rtm.ManageConnection()
connected := 0
disconnected := 0
func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.ConnectedEvent:
connected += 1
if connected > 5 {
rtm.Disconnect()
}
case *slack.DisconnectedEvent:
// t.Log("disconnect event received", ev.Intentional, ev.Cause)
if ev.Intentional {
close(done)
return
}
disconnected += 1
default:
// t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
select {
case <-done:
// magic numbers from empirical testing.
assert.Equal(t, connected <= 7, true)
assert.Equal(t, disconnected <= 12, true)
case <-time.After(5 * time.Second):
t.Error("timed out waiting for disconnect")
t.Fail()
}
}
func TestRTMDeadConnection(t *testing.T) {
// Set up the test server.
testServer := slacktest.NewTestServer(
func(c slacktest.Customize) {
c.Handle("/ws", slacktest.Websocket(func(conn *websocket.Conn) {
// closes immediately
}))
},
)
go testServer.Start()
// Setup and start the RTM.
api := slack.New(
testToken,
slack.OptionAPIURL(testServer.GetAPIURL()),
)
rtm := api.NewRTM(
slack.RTMOptionPingInterval(100 * time.Millisecond),
)
go rtm.ManageConnection()
done := make(chan struct{})
connected := 0
disconnected := 0
func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.ConnectedEvent:
connected += 1
if connected > 5 {
rtm.Disconnect()
}
case *slack.DisconnectedEvent:
// t.Log("disconnect event received", ev.Intentional, ev.Cause)
if ev.Intentional {
close(done)
return
}
disconnected += 1
default:
// t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
select {
case <-done:
// magic numbers from empirical testing.
assert.Equal(t, connected <= 7, true)
assert.Equal(t, disconnected <= 7, true)
case <-time.After(5 * time.Second):
t.Error("timed out waiting for disconnect")
t.Fail()
}
}
func TestRTMDisconnect(t *testing.T) {
t.Skip()
// actually connect to slack here w/ an invalid token
api := slack.New(testToken)
rtm := api.NewRTM()
go rtm.ManageConnection()
// Observe incoming messages.
done := make(chan struct{})
connectingReceived := false
disconnectedReceived := false
go func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.InvalidAuthEvent:
t.Log("invalid auth event received")
disconnectedReceived = true
close(done)
case *slack.ConnectingEvent:
connectingReceived = true
case *slack.ConnectedEvent:
t.Error("received connected events on an invalid connection")
t.Fail()
default:
t.Logf("discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
select {
case <-done:
case <-time.After(5 * time.Second):
t.Error("timed out waiting for disconnect")
t.Fail()
}
// Verify that all expected events have been received by the RTM client.
assert.True(t, connectingReceived, "Should have received a connecting event from the RTM instance.")
assert.True(t, disconnectedReceived, "Should have received a disconnected event from the RTM instance.")
}
func TestRTMConnectRateLimit(t *testing.T) {
// Set up the test server.
testServer := slacktest.NewTestServer(
func(c slacktest.Customize) {
c.Handle("/rtm.connect", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Retry-After", "1")
w.WriteHeader(http.StatusTooManyRequests)
}))
},
)
go testServer.Start()
// Setup and start the RTM.
api := slack.New(testToken, slack.OptionAPIURL(testServer.GetAPIURL()))
rtm := api.NewRTM()
go rtm.ManageConnection()
// Observe incoming failures
connectionFailure := make(chan *slack.ConnectionErrorEvent)
go func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.ConnectingEvent:
case *slack.ConnectionErrorEvent:
connectionFailure <- ev
if ev.Attempt > 5 {
rtm.Disconnect()
}
case *slack.DisconnectedEvent:
if ev.Intentional {
close(connectionFailure)
return
}
default:
t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
previous := time.Duration(0)
for ev := range connectionFailure {
assert.True(t, previous <= ev.Backoff, fmt.Sprintf("backoff should increase during rate limits: %v <= %v", previous, ev.Backoff))
previous = ev.Backoff
}
testServer.Stop()
}
func TestRTMSingleConnect(t *testing.T) {
// Set up the test server.
testServer := slacktest.NewTestServer()
go testServer.Start()
// Setup and start the RTM.
api := slack.New(testToken, slack.OptionAPIURL(testServer.GetAPIURL()))
rtm := api.NewRTM()
go rtm.ManageConnection()
// Observe incoming messages.
done := make(chan struct{})
connectingReceived := false
connectedReceived := false
testMessageReceived := false
go func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.ConnectingEvent:
if connectingReceived {
t.Error("Received multiple connecting events.")
t.Fail()
}
connectingReceived = true
case *slack.ConnectedEvent:
if connectedReceived {
t.Error("Received multiple connected events.")
t.Fail()
}
connectedReceived = true
case *slack.MessageEvent:
if ev.Text == testMessage {
testMessageReceived = true
rtm.Disconnect()
}
t.Logf("Discarding message with content %+v", ev)
case *slack.DisconnectedEvent:
if ev.Intentional {
done <- struct{}{}
return
}
default:
t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
// Send a message and sleep for some time to make sure the message can be processed client-side.
testServer.SendDirectMessageToBot(testMessage)
<-done
testServer.Stop()
// Verify that all expected events have been received by the RTM client.
assert.True(t, connectingReceived, "Should have received a connecting event from the RTM instance.")
assert.True(t, connectedReceived, "Should have received a connected event from the RTM instance.")
assert.True(t, testMessageReceived, "Should have received a test message from the server.")
}
func TestRTMUnmappedError(t *testing.T) {
const unmappedEventName = "user_status_changed"
// Set up the test server.
testServer := slacktest.NewTestServer()
go testServer.Start()
// Setup and start the RTM.
api := slack.New(testToken, slack.OptionAPIURL(testServer.GetAPIURL()))
rtm := api.NewRTM()
go rtm.ManageConnection()
// Observe incoming messages.
done := make(chan struct{})
var gotUnmarshallingError *slack.UnmarshallingErrorEvent
go func() {
for msg := range rtm.IncomingEvents {
switch ev := msg.Data.(type) {
case *slack.UnmarshallingErrorEvent:
gotUnmarshallingError = ev
rtm.Disconnect()
case *slack.DisconnectedEvent:
if ev.Intentional {
done <- struct{}{}
return
}
default:
t.Logf("Discarded event of type '%s' with content '%#v'", msg.Type, ev)
}
}
}()
// Send a message and sleep for some time to make sure the message can be processed client-side.
testServer.SendToWebsocket(fixSlackMessage(t, unmappedEventName))
<-done
testServer.Stop()
// Verify that we got the expected error with details
unmappedErr, ok := gotUnmarshallingError.ErrorObj.(*slack.UnmappedError)
require.True(t, ok)
assert.Equal(t, unmappedEventName, unmappedErr.EventType)
}
func fixSlackMessage(t *testing.T, eType string) string {
t.Helper()
m := slack.Message{
Msg: slack.Msg{
Type: eType,
Text: "Fixture Slack message",
Timestamp: fmt.Sprintf("%d", time.Now().Unix()),
},
}
msg, err := json.Marshal(m)
require.NoError(t, err)
return string(msg)
}
|