TestWebsocketsRequired() — gin Function Reference

Architecture documentation for the TestWebsocketsRequired() function in context_test.go from the gin codebase.

Function go GinCore Context

Entity Profile

GinCore→ Context→ TestWebsocketsRequired() — gin Function Reference

Dependency Diagram

graph TD
  4678258b_cca9_e64f_167a_b71adda61b29["TestWebsocketsRequired()"]
  ebe0ae48_a62b_a38f_5bac_5bbbd96fc508["context_test.go"]
  4678258b_cca9_e64f_167a_b71adda61b29 -->|defined in| ebe0ae48_a62b_a38f_5bac_5bbbd96fc508
  style 4678258b_cca9_e64f_167a_b71adda61b29 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

context_test.go lines 2908–2928

func TestWebsocketsRequired(t *testing.T) {
	// Example request from spec: https://tools.ietf.org/html/rfc6455#section-1.2
	c, _ := CreateTestContext(httptest.NewRecorder())
	c.Request, _ = http.NewRequest(http.MethodGet, "/chat", nil)
	c.Request.Header.Set("Host", "server.example.com")
	c.Request.Header.Set("Upgrade", "websocket")
	c.Request.Header.Set("Connection", "Upgrade")
	c.Request.Header.Set("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==")
	c.Request.Header.Set("Origin", "http://example.com")
	c.Request.Header.Set("Sec-WebSocket-Protocol", "chat, superchat")
	c.Request.Header.Set("Sec-WebSocket-Version", "13")

	assert.True(t, c.IsWebsocket())

	// Normal request, no websocket required.
	c, _ = CreateTestContext(httptest.NewRecorder())
	c.Request, _ = http.NewRequest(http.MethodGet, "/chat", nil)
	c.Request.Header.Set("Host", "server.example.com")

	assert.False(t, c.IsWebsocket())
}