From 8b166270dfd890085dc9523f17ffef2b2f967801 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Wed, 19 Apr 2023 13:50:56 +0200 Subject: [PATCH] Fix capitalization of acronyms like UDP, TCP, STUN --- candidate_test.go | 8 ++++---- errors.go | 2 +- gather.go | 8 ++++---- internal/stun/stun.go | 2 +- stats.go | 2 +- tcp_mux_multi_test.go | 8 ++++---- tcp_mux_test.go | 6 +++--- udp_mux_multi_test.go | 2 +- udp_mux_test.go | 2 +- udp_mux_universal.go | 6 +++--- udp_mux_universal_test.go | 10 +++++----- 11 files changed, 28 insertions(+), 28 deletions(-) diff --git a/candidate_test.go b/candidate_test.go index b6e57ad..d668936 100644 --- a/candidate_test.go +++ b/candidate_test.go @@ -349,10 +349,10 @@ func TestCandidateWriteTo(t *testing.T) { IP: net.IP{127, 0, 0, 1}, Port: 0, }) - require.NoError(t, err, "error creating test tcp listener") + require.NoError(t, err, "error creating test TCP listener") conn, err := net.DialTCP("tcp", nil, listener.Addr().(*net.TCPAddr)) - require.NoError(t, err, "error dialing test tcp conn") + require.NoError(t, err, "error dialing test TCP connection") loggerFactory := logging.NewDefaultLoggerFactory() packetConn := newTCPPacketConn(tcpPacketParams{ @@ -361,7 +361,7 @@ func TestCandidateWriteTo(t *testing.T) { }) err = packetConn.AddConn(conn, nil) - require.NoError(t, err, "error adding test tcp conn to packet conn") + require.NoError(t, err, "error adding test TCP connection to packet connection") c1 := &candidateBase{ conn: packetConn, @@ -378,7 +378,7 @@ func TestCandidateWriteTo(t *testing.T) { assert.NoError(t, err, "writing to open conn") err = packetConn.Close() - require.NoError(t, err, "error closing test tcp conn") + require.NoError(t, err, "error closing test TCP connection") _, err = c1.writeTo([]byte("test"), c2) assert.Error(t, err, "writing to closed conn") diff --git a/errors.go b/errors.go index 6c0a767..eaae591 100644 --- a/errors.go +++ b/errors.go @@ -13,7 +13,7 @@ var ( ErrSchemeType = errors.New("unknown scheme type") // ErrSTUNQuery indicates query arguments are provided in a STUN URL. - ErrSTUNQuery = errors.New("queries not supported in stun address") + ErrSTUNQuery = errors.New("queries not supported in STUN address") // ErrInvalidQuery indicates an malformed query is provided. ErrInvalidQuery = errors.New("invalid query") diff --git a/gather.go b/gather.go index b189a5b..0dfc365 100644 --- a/gather.go +++ b/gather.go @@ -175,14 +175,14 @@ func (a *Agent) gatherCandidatesLocal(ctx context.Context, networkTypes []Networ a.log.Debugf("GetAllConns by ufrag: %s", a.localUfrag) muxConns, err = multi.GetAllConns(a.localUfrag, mappedIP.To4() == nil, ip) if err != nil { - a.log.Warnf("error getting all tcp conns by ufrag: %s %s %s", network, ip, a.localUfrag) + a.log.Warnf("error getting all TCP connections by ufrag: %s %s %s", network, ip, a.localUfrag) continue } } else { a.log.Debugf("GetConn by ufrag: %s", a.localUfrag) conn, err := a.tcpMux.GetConnByUfrag(a.localUfrag, mappedIP.To4() == nil, ip) if err != nil { - a.log.Warnf("error getting tcp conn by ufrag: %s %s %s", network, ip, a.localUfrag) + a.log.Warnf("error getting TCP connections by ufrag: %s %s %s", network, ip, a.localUfrag) continue } muxConns = []net.PacketConn{conn} @@ -399,7 +399,7 @@ func (a *Agent) gatherCandidatesSrflxUDPMux(ctx context.Context, urls []*URL, ne hostPort := fmt.Sprintf("%s:%d", url.Host, url.Port) serverAddr, err := a.net.ResolveUDPAddr(network, hostPort) if err != nil { - a.log.Warnf("failed to resolve stun host: %s: %v", hostPort, err) + a.log.Warnf("failed to resolve STUN host: %s: %v", hostPort, err) return } @@ -461,7 +461,7 @@ func (a *Agent) gatherCandidatesSrflx(ctx context.Context, urls []*URL, networkT hostPort := fmt.Sprintf("%s:%d", url.Host, url.Port) serverAddr, err := a.net.ResolveUDPAddr(network, hostPort) if err != nil { - a.log.Warnf("failed to resolve stun host: %s: %v", hostPort, err) + a.log.Warnf("failed to resolve STUN host: %s: %v", hostPort, err) return } diff --git a/internal/stun/stun.go b/internal/stun/stun.go index 6fce60b..230cf85 100644 --- a/internal/stun/stun.go +++ b/internal/stun/stun.go @@ -18,7 +18,7 @@ var ( errMismatchUsername = errors.New("username mismatch") ) -// GetXORMappedAddr initiates a stun requests to serverAddr using conn, reads the response and returns +// GetXORMappedAddr initiates a STUN requests to serverAddr using conn, reads the response and returns // the XORMappedAddress returned by the STUN server. func GetXORMappedAddr(conn net.PacketConn, serverAddr net.Addr, timeout time.Duration) (*stun.XORMappedAddress, error) { if timeout > 0 { diff --git a/stats.go b/stats.go index fee76a2..9b83bea 100644 --- a/stats.go +++ b/stats.go @@ -167,7 +167,7 @@ type CandidateStats struct { // RelayProtocol is the protocol used by the endpoint to communicate with the // TURN server. This is only present for local candidates. Valid values for - // the TURN URL protocol is one of udp, tcp, or tls. + // the TURN URL protocol is one of UDP, TCP, or TLS. RelayProtocol string // Deleted is true if the candidate has been deleted/freed. For host candidates, diff --git a/tcp_mux_multi_test.go b/tcp_mux_multi_test.go index 644cb17..68e0fb7 100644 --- a/tcp_mux_multi_test.go +++ b/tcp_mux_multi_test.go @@ -64,7 +64,7 @@ func TestMultiTCPMux_Recv(t *testing.T) { _ = pktConn.Close() }() conn, err := net.DialTCP("tcp", nil, pktConn.LocalAddr().(*net.TCPAddr)) - require.NoError(t, err, "error dialing test tcp connection") + require.NoError(t, err, "error dialing test TCP connection") msg := stun.New() msg.Type = stun.MessageType{Method: stun.MethodBinding, Class: stun.ClassRequest} @@ -72,18 +72,18 @@ func TestMultiTCPMux_Recv(t *testing.T) { msg.Encode() n, err := writeStreamingPacket(conn, msg.Raw) - require.NoError(t, err, "error writing tcp stun packet") + require.NoError(t, err, "error writing TCP STUN packet") recv := make([]byte, n) n2, rAddr, err := pktConn.ReadFrom(recv) require.NoError(t, err, "error receiving data") - assert.Equal(t, conn.LocalAddr(), rAddr, "remote tcp address mismatch") + assert.Equal(t, conn.LocalAddr(), rAddr, "remote TCP address mismatch") assert.Equal(t, n, n2, "received byte size mismatch") assert.Equal(t, msg.Raw, recv, "received bytes mismatch") // Check echo response n, err = pktConn.WriteTo(recv, conn.LocalAddr()) - require.NoError(t, err, "error writing echo stun packet") + require.NoError(t, err, "error writing echo STUN packet") recvEcho := make([]byte, n) n3, err := readStreamingPacket(conn, recvEcho) require.NoError(t, err, "error receiving echo data") diff --git a/tcp_mux_test.go b/tcp_mux_test.go index 62ed6c3..7511687 100644 --- a/tcp_mux_test.go +++ b/tcp_mux_test.go @@ -52,7 +52,7 @@ func TestTCPMux_Recv(t *testing.T) { require.NotNil(t, tcpMux.LocalAddr(), "tcpMux.LocalAddr() is nil") conn, err := net.DialTCP("tcp", nil, tcpMux.LocalAddr().(*net.TCPAddr)) - require.NoError(t, err, "error dialing test tcp connection") + require.NoError(t, err, "error dialing test TCP connection") msg := stun.New() msg.Type = stun.MessageType{Method: stun.MethodBinding, Class: stun.ClassRequest} @@ -60,7 +60,7 @@ func TestTCPMux_Recv(t *testing.T) { msg.Encode() n, err := writeStreamingPacket(conn, msg.Raw) - require.NoError(t, err, "error writing tcp stun packet") + require.NoError(t, err, "error writing TCP STUN packet") pktConn, err := tcpMux.GetConnByUfrag("myufrag", false, listener.Addr().(*net.TCPAddr).IP) require.NoError(t, err, "error retrieving muxed connection for ufrag") @@ -77,7 +77,7 @@ func TestTCPMux_Recv(t *testing.T) { // Check echo response n, err = pktConn.WriteTo(recv, conn.LocalAddr()) - require.NoError(t, err, "error writing echo stun packet") + require.NoError(t, err, "error writing echo STUN packet") recvEcho := make([]byte, n) n3, err := readStreamingPacket(conn, recvEcho) require.NoError(t, err, "error receiving echo data") diff --git a/udp_mux_multi_test.go b/udp_mux_multi_test.go index f62dc17..f37617d 100644 --- a/udp_mux_multi_test.go +++ b/udp_mux_multi_test.go @@ -105,7 +105,7 @@ func testMultiUDPMuxConnections(t *testing.T, udpMuxMulti *MultiUDPMuxDefault, u // Try talking with each PacketConn for _, pktConn := range pktConns { remoteConn, err := net.DialUDP(network, nil, pktConn.LocalAddr().(*net.UDPAddr)) - require.NoError(t, err, "error dialing test udp connection") + require.NoError(t, err, "error dialing test UDP connection") testMuxConnectionPair(t, pktConn, remoteConn, ufrag) } } diff --git a/udp_mux_test.go b/udp_mux_test.go index 3fad1cc..cec38d3 100644 --- a/udp_mux_test.go +++ b/udp_mux_test.go @@ -163,7 +163,7 @@ func testMuxConnection(t *testing.T, udpMux *UDPMuxDefault, ufrag string, networ addr = &net.UDPAddr{Port: addr.Port} } remoteConn, err := net.DialUDP(network, nil, addr) - require.NoError(t, err, "error dialing test udp connection") + require.NoError(t, err, "error dialing test UDP connection") testMuxConnectionPair(t, pktConn, remoteConn, ufrag) } diff --git a/udp_mux_universal.go b/udp_mux_universal.go index a117250..07b6a70 100644 --- a/udp_mux_universal.go +++ b/udp_mux_universal.go @@ -188,7 +188,7 @@ func (m *UniversalUDPMuxDefault) GetXORMappedAddr(serverAddr net.Addr, deadline // Otherwise, make a STUN request to discover the address // or wait for already sent request to complete - waitAddrReceived, err := m.sendStun(serverAddr) + waitAddrReceived, err := m.sendSTUN(serverAddr) if err != nil { return nil, fmt.Errorf("%w: %s", errSendSTUNPacket, err) //nolint:errorlint } @@ -209,11 +209,11 @@ func (m *UniversalUDPMuxDefault) GetXORMappedAddr(serverAddr net.Addr, deadline } } -// sendStun sends a STUN request via UDP conn. +// sendSTUN sends a STUN request via UDP conn. // // The returned channel is closed when the STUN response has been received. // Method is safe for concurrent use. -func (m *UniversalUDPMuxDefault) sendStun(serverAddr net.Addr) (chan struct{}, error) { +func (m *UniversalUDPMuxDefault) sendSTUN(serverAddr net.Addr) (chan struct{}, error) { m.mu.Lock() defer m.mu.Unlock() diff --git a/udp_mux_universal_test.go b/udp_mux_universal_test.go index 84bf47e..4536a0d 100644 --- a/udp_mux_universal_test.go +++ b/udp_mux_universal_test.go @@ -52,7 +52,7 @@ func testMuxSrflxConnection(t *testing.T, udpMux *UniversalUDPMuxDefault, ufrag remoteConn, err := net.DialUDP(network, nil, &net.UDPAddr{ Port: udpMux.LocalAddr().(*net.UDPAddr).Port, }) - require.NoError(t, err, "error dialing test udp connection") + require.NoError(t, err, "error dialing test UDP connection") defer func() { _ = remoteConn.Close() }() @@ -73,10 +73,10 @@ func testMuxSrflxConnection(t *testing.T, udpMux *UniversalUDPMuxDefault, ufrag require.Equal(t, address.Port, testXORPort) }() - // Wait until GetXORMappedAddr calls sendStun method + // Wait until GetXORMappedAddr calls sendSTUN method time.Sleep(time.Millisecond) - // Check that mapped address filled correctly after sent stun + // Check that mapped address filled correctly after sent STUN udpMux.mu.Lock() mappedAddr, ok := udpMux.xorMappedMap[remoteConn.LocalAddr().String()] require.True(t, ok) @@ -114,7 +114,7 @@ func testMuxSrflxConnection(t *testing.T, udpMux *UniversalUDPMuxDefault, ufrag require.NotNil(t, address) udpMux.mu.Lock() - // Check mappedAddr is not pending, we didn't send stun twice + // Check mappedAddr is not pending, we didn't send STUN twice require.False(t, mappedAddr.pending()) // Check expiration by TTL @@ -122,7 +122,7 @@ func testMuxSrflxConnection(t *testing.T, udpMux *UniversalUDPMuxDefault, ufrag require.True(t, mappedAddr.expired()) udpMux.mu.Unlock() - // After expire, we send stun request again + // After expire, we send STUN request again // but we not receive response in 5 milliseconds and should get error here address, err = udpMux.GetXORMappedAddr(remoteConn.LocalAddr(), time.Millisecond*5) require.NotNil(t, err)