add more static analysis tool during tests

Author: zaibon

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
       uses: actions/checkout@v1
 
     - name: Test
-      run: go test -v ./...
-
-    - name: Build
-      run: make
+      run: |
+        export PATH=/home/runner/go/bin:$PATH
+        make test
+      

Makefile

@@ -2,6 +2,53 @@ all: client server
 
 BUILD_FLAGS = -ldflags '-extldflags "-fno-PIC -static"' -buildmode pie -tags 'osusergo netgo static_build'
 
+
+getdeps:
+	@echo "Installing golint" && go get -u golang.org/x/lint/golint
+	@echo "Installing gocyclo" && go get -u github.com/fzipp/gocyclo
+	@echo "Installing deadcode" && go get -u github.com/remyoudompheng/go-misc/deadcode
+	@echo "Installing misspell" && go get -u github.com/client9/misspell/cmd/misspell
+	@echo "Installing ineffassign" && go get -u github.com/gordonklaus/ineffassign
+
+verifiers: vet fmt lint cyclo spelling static #deadcode
+
+vet:
+	@echo "Running $@"
+	@go vet -atomic -bool -copylocks -nilfunc -printf -rangeloops -unreachable -unsafeptr -unusedresult ./...
+
+fmt:
+	@echo "Running $@"
+	@gofmt -d .
+
+lint:
+	@echo "Running $@"
+	@${GOPATH}/bin/golint -set_exit_status $(shell go list ./... | grep -v stubs)
+
+ineffassign:
+	@echo "Running $@"
+	@${GOPATH}/bin/ineffassign .
+
+cyclo:
+	@echo "Running $@"
+	@${GOPATH}/bin/gocyclo -over 100 .
+
+deadcode:
+	@echo "Running $@"
+	@${GOPATH}/bin/deadcode -test $(shell go list ./...) || true
+
+spelling:
+	@${GOPATH}/bin/misspell -i monitord -error `find .`
+
+static:
+	go run honnef.co/go/tools/cmd/staticcheck -- ./...
+
+# Builds minio, runs the verifiers then runs the tests.
+check: test
+test: verifiers build
+	go test -v ./...
+
+build: server client
+
 server:
 	mkdir -p bin
 	cd cmds/server && go build $(BUILD_FLAGS) -o ../../bin/trs

client.go

@@ -10,6 +10,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+// Client connect to a tpc router server and opens a reverse tunnel
 type Client struct {
 	localAddr  string
 	remoteAddr string

cmds/client/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"os/signal"
 	"sync"
+	"syscall"
 	"time"
 
 	"github.com/cenkalti/backoff/v3"
@@ -45,8 +46,8 @@ func main() {
 		backoff := c.Int("backoff")
 		secret := c.String("secret")
 
-		cSig := make(chan os.Signal)
-		signal.Notify(cSig, os.Interrupt, os.Kill)
+		cSig := make(chan os.Signal, 1)
+		signal.Notify(cSig, os.Interrupt, syscall.SIGTERM)
 
 		wg := sync.WaitGroup{}
 		wg.Add(len(remotes))

cmds/server/main.go

@@ -4,7 +4,9 @@ import (
 	"context"
 	"fmt"
 	"os/signal"
+	"syscall"
 
+	"github.com/BurntSushi/toml"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/urfave/cli/v2"
@@ -34,7 +36,8 @@ func readConfig(path string) (tcprouter.Config, error) {
 	}
 	defer f.Close()
 
-	c, err := tcprouter.ParseCfg(f)
+	var c tcprouter.Config
+	_, err = toml.DecodeReader(f, &c)
 	if err != nil {
 		return c, fmt.Errorf("failed to read configuration %w", err)
 	}
@@ -62,10 +65,6 @@ func initStore(backend store.Backend, addr string) (store.Store, error) {
 	)
 }
 
-var (
-	cfgPath string
-)
-
 func main() {
 	app := cli.NewApp()
 	app.Version = "0.0.1"
@@ -111,7 +110,7 @@ func main() {
 		s := tcprouter.NewServer(serverOpts, kv, cfg.Server.Services)
 
 		cSig := make(chan os.Signal, 1)
-		signal.Notify(cSig, os.Interrupt, os.Kill)
+		signal.Notify(cSig, os.Interrupt, syscall.SIGTERM)
 
 		ctx, cancel := context.WithCancel(context.Background())
 		go func() {

config.go

@@ -2,9 +2,7 @@ package tcprouter
 
 import (
 	"fmt"
-	"io"
 
-	"github.com/BurntSushi/toml"
 	"github.com/abronan/valkeyrie/store"
 )
 
@@ -14,10 +12,12 @@ var validBackends = map[string]store.Backend{
 	"etcd":   store.ETCDV3,
 }
 
+// Config hold the server configuration
 type Config struct {
 	Server ServerConfig `toml:"server"`
 }
 
+// ServerConfig configures the server listeners and backend
 type ServerConfig struct {
 	Host        string             `toml:"addr"`
 	Port        uint               `toml:"port"`
@@ -27,17 +27,20 @@ type ServerConfig struct {
 	Services    map[string]Service `toml:"services"`
 }
 
+// Addr returns the listenting address of the server
 func (s ServerConfig) Addr() string {
 	return fmt.Sprintf("%s:%d", s.Host, s.Port)
 }
 
+// Service defines a proxy configuration
 type Service struct {
 	Addr         string `toml:"addr"`
 	ClientSecret string `toml:"clientsecret` // will forward connection to it directly instead of hitting the Addr.
 	TLSPort      int    `toml:"tlsport"`
 	HTTPPort     int    `toml:"httpport"`
 }
 
+// DbBackendConfig define the connection to a backend store
 type DbBackendConfig struct {
 	DbType   string `toml:"type"`
 	Host     string `toml:"addr"`
@@ -49,20 +52,16 @@ type DbBackendConfig struct {
 	//Bucket string `toml:"bucket"`
 }
 
+// Addr returns the listenting address of the server
 func (b DbBackendConfig) Addr() string {
 	return fmt.Sprintf("%s:%d", b.Host, b.Port)
 }
 
+// Backend return the Backend object of the b.DbType
 func (b DbBackendConfig) Backend() store.Backend {
 	backend, ok := validBackends[b.DbType]
 	if !ok {
 		panic(fmt.Sprintf("unsupported backend type '%s'", b.DbType))
 	}
 	return backend
 }
-
-func ParseCfg(r io.Reader) (Config, error) {
-	var conf Config
-	_, err := toml.DecodeReader(r, &conf)
-	return conf, err
-}

examples/client.py

@@ -5,18 +5,16 @@
 
 # Require a certificate from the server. We used a self-signed certificate
 # so here ca_certs must be the server certificate itself.
-ssl_sock = ssl.wrap_socket(s,
-                           ca_certs="server.crt",
-                           cert_reqs=ssl.CERT_REQUIRED)
+ssl_sock = ssl.wrap_socket(s, ca_certs="server.crt", cert_reqs=ssl.CERT_REQUIRED)
 
-ssl_sock.connect(('localhost', 5500))
+ssl_sock.connect(("localhost", 5500))
 # ssl_sock.connect(('localhost', 9092))
 
-ssl_sock.sendall(b'login superadmin password\n')
+ssl_sock.sendall(b"login superadmin password\n")
 
 while True:
     time.sleep(5)
-    ssl_sock.sendall(b'ping null\n')
+    ssl_sock.sendall(b"ping null\n")
     print(ssl_sock.recv(4096))
 
 ssl_sock.close()

examples/main.go

@@ -7,16 +7,8 @@ import (
 
 	"github.com/abronan/valkeyrie"
 	"github.com/abronan/valkeyrie/store"
-	//"github.com/abronan/valkeyrie/store/boltdb"
-	//etcd "github.com/abronan/valkeyrie/store/etcd/v3"
 	"github.com/abronan/valkeyrie/store/redis"
 )
-var validBackends = map[string]store.Backend{
-	"redis": store.REDIS,
-	//"boltdb": store.BOLTDB,
-	//"etcd": store.ETCDV3,
-
-}
 
 func init() {
 
@@ -26,7 +18,7 @@ func init() {
 
 }
 
-type Service struct {
+type service struct {
 	Addr string `json:"addr"`
 	SNI  string `json:"sni"`
 	Name string `json:"bing"`
@@ -37,23 +29,20 @@ func main() {
 	// Initialize a new store with redis
 	kv, err := valkeyrie.NewStore(
 		store.REDIS,
-		[]string{"127.0.0.1:6379" },
+		[]string{"127.0.0.1:6379"},
 		&store.Config{
 			ConnectionTimeout: 10 * time.Second,
 		},
 	)
 	if err != nil {
 		log.Fatal("Cannot create store redis")
 	}
-	google := &Service{Addr:"172.217.19.46:443", SNI:"www.google.com", Name:"google"}
+	google := &service{Addr: "172.217.19.46:443", SNI: "www.google.com", Name: "google"}
 	encGoogle, _ := json.Marshal(google)
-	bing := &Service{Addr:"13.107.21.200:443", SNI:"www.bing.com", Name:"bing"}
+	bing := &service{Addr: "13.107.21.200:443", SNI: "www.bing.com", Name: "bing"}
 	encBing, _ := json.Marshal(bing)
 
 	kv.Put("/tcprouter/service/google", encGoogle, nil)
 	kv.Put("/tcprouter/service/bing", encBing, nil)
 
-
 }
-
-

go.sum

@@ -212,6 +212,7 @@ golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc h1:N3zlSgxkefUH/ecsl37RWTkESTB026kmXzNly8TuZCI=
 golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
 google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8 h1:Nw54tB0rB7hY/N0NQvRW8DG4Yk3Q6T9cu9RcFQDu1tc=
@@ -234,4 +235,5 @@ gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099 h1:XJP7lxbSxWLOMNdBE4B/STaqVy6L73o0knwj2vIlxnw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

handshake.go

@@ -6,6 +6,7 @@ import (
 )
 
 const (
+	// MagicNr is the bytes sent during handshake to identity a tcprouter client connection
 	// TODO: chose a valid magic number
 	MagicNr = 0x1111
 )

server.go

@@ -16,25 +16,30 @@ import (
 	"github.com/abronan/valkeyrie/store"
 )
 
+// ServerOptions hold the configuration of server listeners
 type ServerOptions struct {
 	ListeningAddr           string
 	ListeningTLSPort        uint
 	ListeningHTTPPort       uint
 	ListeningForClientsPort uint
 }
 
+// HTTPAddr returns the HTTP listener address
 func (o ServerOptions) HTTPAddr() string {
 	return fmt.Sprintf("%s:%d", o.ListeningAddr, o.ListeningHTTPPort)
 }
 
+// TLSAddr returns the TLS listener address
 func (o ServerOptions) TLSAddr() string {
 	return fmt.Sprintf("%s:%d", o.ListeningAddr, o.ListeningTLSPort)
 }
 
+// ClientsAddr returns the client listener address
 func (o ServerOptions) ClientsAddr() string {
 	return fmt.Sprintf("%s:%d", o.ListeningAddr, o.ListeningForClientsPort)
 }
 
+//Server is tcp router server
 type Server struct {
 	ServerOptions ServerOptions
 	DbStore       store.Store
@@ -45,9 +50,9 @@ type Server struct {
 	listeners   []net.Listener
 	listenersMU sync.Mutex
 	wg          sync.WaitGroup
-	ctx         context.Context
 }
 
+// NewServer creates a new server
 func NewServer(forwardOptions ServerOptions, store store.Store, services map[string]Service) *Server {
 	if services == nil {
 		services = make(map[string]Service)
@@ -62,6 +67,7 @@ func NewServer(forwardOptions ServerOptions, store store.Store, services map[str
 	}
 }
 
+// Start starts the server and blocks forever
 func (s *Server) Start(ctx context.Context) error {
 
 	s.wg.Add(3)
@@ -139,7 +145,7 @@ func (s *Server) getHost(host string) (Service, error) {
 
 	err = json.Unmarshal(servicePair.Value, &service)
 	if err != nil {
-		return service, fmt.Errorf("Invalid service content")
+		return service, fmt.Errorf("invalid service content")
 	}
 
 	log.Debug().
@@ -242,16 +248,16 @@ func (s *Server) handleHTTPConnection(conn WriteCloser) {
 func (s *Server) handleService(incoming WriteCloser, serverName, peeked string, isTLS bool) error {
 	serverName = strings.ToLower(serverName)
 	service, exists := s.Services[serverName]
-	if exists == false {
+	if !exists {
 		log.Info().Msg("not found in file config, try to load it from db backend")
 		var err error
 		service, err = s.getHost(serverName)
 		exists = err == nil
 	}
 
-	if exists == false {
+	if !exists {
 		service, exists = s.Services["CATCH_ALL"]
-		if exists == false {
+		if !exists {
 			return fmt.Errorf("service doesn't exist: %v and no 'CATCH_ALL' service for request", service)
 		}
 	}