Update CI configs to v0.4.7

Update lint scripts and CI configs.

Author: pionbot

.golangci.yml

@@ -3,6 +3,80 @@ linters-settings:
     check-shadowing: true
   misspell:
     locale: US
+  exhaustive:
+    default-signifies-exhaustive: true
+
+linters:
+  enable:
+    - asciicheck       # Simple linter to check that your code does not contain non-ASCII identifiers
+    - bodyclose        # checks whether HTTP response body is closed successfully
+    - deadcode         # Finds unused code
+    - depguard         # Go linter that checks if package imports are in a list of acceptable packages
+    - dogsled          # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
+    - dupl             # Tool for code clone detection
+    - errcheck         # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
+    - exhaustive       # check exhaustiveness of enum switch statements
+    - exportloopref    # checks for pointers to enclosing loop variables
+    - gci              # Gci control golang package import order and make it always deterministic.
+    - gochecknoglobals # Checks that no globals are present in Go code
+    - gochecknoinits   # Checks that no init functions are present in Go code
+    - gocognit         # Computes and checks the cognitive complexity of functions
+    - goconst          # Finds repeated strings that could be replaced by a constant
+    - gocritic         # The most opinionated Go source code linter
+    - godox            # Tool for detection of FIXME, TODO and other comment keywords
+    - goerr113         # Golang linter to check the errors handling expressions
+    - gofmt            # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
+    - gofumpt          # Gofumpt checks whether code was gofumpt-ed.
+    - goheader         # Checks is file header matches to pattern
+    - goimports        # Goimports does everything that gofmt does. Additionally it checks unused imports
+    - golint           # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
+    - gomodguard       # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
+    - goprintffuncname # Checks that printf-like functions are named with `f` at the end
+    - gosec            # Inspects source code for security problems
+    - gosimple         # Linter for Go source code that specializes in simplifying a code
+    - govet            # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+    - ineffassign      # Detects when assignments to existing variables are not used
+    - misspell         # Finds commonly misspelled English words in comments
+    - nakedret         # Finds naked returns in functions greater than a specified function length
+    - noctx            # noctx finds sending http request without context.Context
+    - scopelint        # Scopelint checks for unpinned variables in go programs
+    - staticcheck      # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
+    - structcheck      # Finds unused struct fields
+    - stylecheck       # Stylecheck is a replacement for golint
+    - typecheck        # Like the front-end of a Go compiler, parses and type-checks Go code
+    - unconvert        # Remove unnecessary type conversions
+    - unparam          # Reports unused function parameters
+    - unused           # Checks Go code for unused constants, variables, functions and types
+    - varcheck         # Finds unused global variables and constants
+    - whitespace       # Tool for detection of leading and trailing whitespace
+  disable:
+    - funlen           # Tool for detection of long functions
+    - gocyclo          # Computes and checks the cyclomatic complexity of functions
+    - godot            # Check if comments end in a period
+    - gomnd            # An analyzer to detect magic numbers.
+    - lll              # Reports long lines
+    - maligned         # Tool to detect Go structs that would take less memory if their fields were sorted
+    - nestif           # Reports deeply nested if statements
+    - nlreturn         # nlreturn checks for a new line before return and branch statements to increase code clarity
+    - nolintlint       # Reports ill-formed or insufficient nolint directives
+    - prealloc         # Finds slice declarations that could potentially be preallocated
+    - rowserrcheck     # checks whether Err of rows is checked successfully
+    - sqlclosecheck    # Checks that sql.Rows and sql.Stmt are closed.
+    - testpackage      # linter that makes you use a separate _test package
+    - wsl              # Whitespace Linter - Forces you to use empty lines!
+
+issues:
+  exclude-rules:
+    # Allow complex tests, better to be self contained
+    - path: _test\.go
+      linters:
+        - gocognit
+
+    # Allow complex main function in examples
+    - path: examples
+      text: "of func `main` is high"
+      linters:
+        - gocognit
 
 run:
   skip-dirs-use-default: false

README.md

@@ -91,3 +91,5 @@ Check out the [CONTRIBUTING.md](CONTRIBUTING.md) to join the group of amazing pe
 
 ### License
 MIT License - see [LICENSE.md](LICENSE.md) for full text
+
+

client.go

@@ -18,7 +18,7 @@ import (
 const (
 	defaultRTO        = 200 * time.Millisecond
 	maxRtxCount       = 7              // total 7 requests (Rc)
-	maxDataBufferSize = math.MaxUint16 //message size limit for Chromium
+	maxDataBufferSize = math.MaxUint16 // message size limit for Chromium
 )
 
 //              interval [msec]
@@ -78,7 +78,7 @@ func NewClient(config *ClientConfig) (*Client, error) {
 	log := loggerFactory.NewLogger("turnc")
 
 	if config.Conn == nil {
-		return nil, fmt.Errorf("conn cannot not be nil")
+		return nil, errNilConn
 	}
 
 	if config.Net == nil {
@@ -163,7 +163,7 @@ func (c *Client) WriteTo(data []byte, to net.Addr) (int, error) {
 // to supply incoming data, instead.
 func (c *Client) Listen() error {
 	if err := c.listenTryLock.Lock(); err != nil {
-		return fmt.Errorf("already listening: %s", err.Error())
+		return fmt.Errorf("%w: %s", errAlreadyListening, err.Error())
 	}
 
 	go func() {
@@ -219,7 +219,6 @@ func (c *Client) SendBindingRequestTo(to net.Addr) (net.Addr, error) {
 		return nil, err
 	}
 
-	//return fmt.Sprintf("pkt_size=%d src_addr=%s refl_addr=%s:%d", size, addr, reflAddr.IP, reflAddr.Port), nil
 	return &net.UDPAddr{
 		IP:   reflAddr.IP,
 		Port: reflAddr.Port,
@@ -229,21 +228,21 @@ func (c *Client) SendBindingRequestTo(to net.Addr) (net.Addr, error) {
 // SendBindingRequest sends a new STUN request to the STUN server
 func (c *Client) SendBindingRequest() (net.Addr, error) {
 	if c.stunServ == nil {
-		return nil, fmt.Errorf("STUN server address is not set for the client")
+		return nil, errSTUNServerAddressNotSet
 	}
 	return c.SendBindingRequestTo(c.stunServ)
 }
 
 // Allocate sends a TURN allocation request to the given transport address
 func (c *Client) Allocate() (net.PacketConn, error) {
 	if err := c.allocTryLock.Lock(); err != nil {
-		return nil, fmt.Errorf("only one Allocate() caller is allowed: %s", err.Error())
+		return nil, fmt.Errorf("%w: %s", errOneAllocateOnly, err.Error())
 	}
 	defer c.allocTryLock.Unlock()
 
 	relayedConn := c.relayedUDPConn()
 	if relayedConn != nil {
-		return nil, fmt.Errorf("already allocated at %s", relayedConn.LocalAddr().String())
+		return nil, fmt.Errorf("%w: %s", errAlreadyAllocated, relayedConn.LocalAddr().String())
 	}
 
 	msg, err := stun.Build(
@@ -299,9 +298,9 @@ func (c *Client) Allocate() (net.PacketConn, error) {
 	if res.Type.Class == stun.ClassErrorResponse {
 		var code stun.ErrorCodeAttribute
 		if err = code.GetFrom(res); err == nil {
-			return nil, fmt.Errorf("%s (error %s)", res.Type, code)
+			return nil, fmt.Errorf("%s (error %s)", res.Type, code) //nolint:goerr113
 		}
-		return nil, fmt.Errorf("%s", res.Type)
+		return nil, fmt.Errorf("%s", res.Type) //nolint:goerr113
 	}
 
 	// Getting relayed addresses from response.
@@ -411,7 +410,7 @@ func (c *Client) HandleInbound(data []byte, from net.Addr) (bool, error) {
 		return true, c.handleChannelData(data)
 	case len(c.stunServStr) != 0 && from.String() == c.stunServStr:
 		// received from STUN server but it is not a STUN message
-		return true, fmt.Errorf("non-STUN message from STUN server")
+		return true, errNonSTUNMessage
 	default:
 		// assume, this is an application data
 		c.log.Tracef("non-STUN/TURN packect, unhandled")
@@ -426,11 +425,11 @@ func (c *Client) handleSTUNMessage(data []byte, from net.Addr) error {
 
 	msg := &stun.Message{Raw: raw}
 	if err := msg.Decode(); err != nil {
-		return fmt.Errorf("failed to decode STUN message: %s", err.Error())
+		return fmt.Errorf("%w: %s", errFailedToDecodeSTUN, err.Error())
 	}
 
 	if msg.Type.Class == stun.ClassRequest {
-		return fmt.Errorf("unexpected STUN request message: %s", msg.String())
+		return fmt.Errorf("%w : %s", errUnexpectedSTUNRequestMessage, msg.String())
 	}
 
 	if msg.Type.Class == stun.ClassIndication {
@@ -511,7 +510,7 @@ func (c *Client) handleChannelData(data []byte) error {
 
 	addr, ok := relayedConn.FindAddrByChannelNumber(uint16(chData.Number))
 	if !ok {
-		return fmt.Errorf("binding with channel %d not found", int(chData.Number))
+		return fmt.Errorf("%w: %d", errChannelBindNotFound, int(chData.Number))
 	}
 
 	c.log.Tracef("channel data received from %s (ch=%d)", addr.String(), int(chData.Number))
@@ -533,7 +532,7 @@ func (c *Client) onRtxTimeout(trKey string, nRtx int) {
 		// all retransmisstions failed
 		c.trMap.Delete(trKey)
 		if !tr.WriteResult(client.TransactionResult{
-			Err: fmt.Errorf("all retransmissions for %s failed", trKey),
+			Err: fmt.Errorf("%w %s", errAllRetransmissionsFailed, trKey),
 		}) {
 			c.log.Debug("no listener for transaction")
 		}
@@ -546,7 +545,7 @@ func (c *Client) onRtxTimeout(trKey string, nRtx int) {
 	if err != nil {
 		c.trMap.Delete(trKey)
 		if !tr.WriteResult(client.TransactionResult{
-			Err: fmt.Errorf("failed to retransmit transaction %s", trKey),
+			Err: fmt.Errorf("%w %s", errFailedToRetransmitTransaction, trKey),
 		}) {
 			c.log.Debug("no listener for transaction")
 		}

errors.go

@@ -3,10 +3,23 @@ package turn
 import "errors"
 
 var (
-	errRelayAddressInvalid        = errors.New("turn: RelayAddress must be valid IP to use RelayAddressGeneratorStatic")
-	errNoAvailableConns           = errors.New("turn: PacketConnConfigs and ConnConfigs are empty, unable to proceed")
-	errConnUnset                  = errors.New("turn: PacketConnConfig must have a non-nil Conn")
-	errListenerUnset              = errors.New("turn: ListenerConfig must have a non-nil Listener")
-	errListeningAddressInvalid    = errors.New("turn: RelayAddressGenerator has invalid ListeningAddress")
-	errRelayAddressGeneratorUnset = errors.New("turn: RelayAddressGenerator in RelayConfig is unset")
+	errRelayAddressInvalid           = errors.New("turn: RelayAddress must be valid IP to use RelayAddressGeneratorStatic")
+	errNoAvailableConns              = errors.New("turn: PacketConnConfigs and ConnConfigs are empty, unable to proceed")
+	errConnUnset                     = errors.New("turn: PacketConnConfig must have a non-nil Conn")
+	errListenerUnset                 = errors.New("turn: ListenerConfig must have a non-nil Listener")
+	errListeningAddressInvalid       = errors.New("turn: RelayAddressGenerator has invalid ListeningAddress")
+	errRelayAddressGeneratorUnset    = errors.New("turn: RelayAddressGenerator in RelayConfig is unset")
+	errNilConn                       = errors.New("turn: conn cannot not be nil")
+	errTODO                          = errors.New("turn: TODO")
+	errAlreadyListening              = errors.New("turn: already listening")
+	errFailedToClose                 = errors.New("turn: Server failed to close")
+	errFailedToRetransmitTransaction = errors.New("turn: failed to retransmit transaction")
+	errAllRetransmissionsFailed      = errors.New("all retransmissions failed for")
+	errChannelBindNotFound           = errors.New("no binding found for channel")
+	errSTUNServerAddressNotSet       = errors.New("STUN server address is not set for the client")
+	errOneAllocateOnly               = errors.New("only one Allocate() caller is allowed")
+	errAlreadyAllocated              = errors.New("already allocated")
+	errNonSTUNMessage                = errors.New("non-STUN message from STUN server")
+	errFailedToDecodeSTUN            = errors.New("failed to decode STUN message")
+	errUnexpectedSTUNRequestMessage  = errors.New("unexpected STUN request message")
 )

internal/allocation/allocation.go

@@ -2,7 +2,6 @@
 package allocation
 
 import (
-	"fmt"
 	"net"
 	"sync"
 	"time"
@@ -95,7 +94,7 @@ func (a *Allocation) AddChannelBind(c *ChannelBind, lifetime time.Duration) erro
 	channelByNumber := a.GetChannelByNumber(c.Number)
 
 	if channelByNumber != a.GetChannelByAddr(c.Peer) {
-		return fmt.Errorf("you cannot use the same channel number with different peer")
+		return errSameChannelDifferentPeer
 	}
 
 	// Add or refresh this channel.

internal/allocation/allocation_manager.go

@@ -37,11 +37,11 @@ type Manager struct {
 func NewManager(config ManagerConfig) (*Manager, error) {
 	switch {
 	case config.AllocatePacketConn == nil:
-		return nil, fmt.Errorf("AllocatePacketConn must be set")
+		return nil, errAllocatePacketConnMustBeSet
 	case config.AllocateConn == nil:
-		return nil, fmt.Errorf("AllocateConn must be set")
+		return nil, errAllocateConnMustBeSet
 	case config.LeveledLogger == nil:
-		return nil, fmt.Errorf("LeveledLogger must be set")
+		return nil, errLeveledLoggerMustBeSet
 	}
 
 	return &Manager{
@@ -76,19 +76,19 @@ func (m *Manager) Close() error {
 func (m *Manager) CreateAllocation(fiveTuple *FiveTuple, turnSocket net.PacketConn, requestedPort int, lifetime time.Duration) (*Allocation, error) {
 	switch {
 	case fiveTuple == nil:
-		return nil, fmt.Errorf("allocations must not be created with nil FivTuple")
+		return nil, errNilFiveTuple
 	case fiveTuple.SrcAddr == nil:
-		return nil, fmt.Errorf("allocations must not be created with nil FiveTuple.SrcAddr")
+		return nil, errNilFiveTupleSrcAddr
 	case fiveTuple.DstAddr == nil:
-		return nil, fmt.Errorf("allocations must not be created with nil FiveTuple.DstAddr")
+		return nil, errNilFiveTupleDstAddr
 	case turnSocket == nil:
-		return nil, fmt.Errorf("allocations must not be created with nil turnSocket")
+		return nil, errNilTurnSocket
 	case lifetime == 0:
-		return nil, fmt.Errorf("allocations must not be created with a lifetime of 0")
+		return nil, errLifetimeZero
 	}
 
 	if a := m.GetAllocation(fiveTuple); a != nil {
-		return nil, fmt.Errorf("allocation attempt created with duplicate FiveTuple %v", fiveTuple)
+		return nil, fmt.Errorf("%w: %v", errDupeFiveTuple, fiveTuple)
 	}
 	a := NewAllocation(turnSocket, fiveTuple, m.log)
 
@@ -175,7 +175,7 @@ func (m *Manager) GetRandomEvenPort() (int, error) {
 
 	udpAddr, ok := addr.(*net.UDPAddr)
 	if !ok {
-		return 0, fmt.Errorf("failed to cast net.Addr to *net.UDPAddr")
+		return 0, errFailedToCastUDPAddr
 	} else if err := conn.Close(); err != nil {
 		return 0, err
 	} else if udpAddr.Port%2 == 1 {

internal/allocation/errors.go

@@ -0,0 +1,17 @@
+package allocation
+
+import "errors"
+
+var (
+	errAllocatePacketConnMustBeSet = errors.New("AllocatePacketConn must be set")
+	errAllocateConnMustBeSet       = errors.New("AllocateConn must be set")
+	errLeveledLoggerMustBeSet      = errors.New("LeveledLogger must be set")
+	errSameChannelDifferentPeer    = errors.New("you cannot use the same channel number with different peer")
+	errNilFiveTuple                = errors.New("allocations must not be created with nil FivTuple")
+	errNilFiveTupleSrcAddr         = errors.New("allocations must not be created with nil FiveTuple.SrcAddr")
+	errNilFiveTupleDstAddr         = errors.New("allocations must not be created with nil FiveTuple.DstAddr")
+	errNilTurnSocket               = errors.New("allocations must not be created with nil turnSocket")
+	errLifetimeZero                = errors.New("allocations must not be created with a lifetime of 0")
+	errDupeFiveTuple               = errors.New("allocation attempt created with duplicate FiveTuple")
+	errFailedToCastUDPAddr         = errors.New("failed to cast net.Addr to *net.UDPAddr")
+)