Mod: readme

.travis.yml

@@ -8,4 +8,10 @@ env:
 
 script:
   - go fmt ./... && [[ -z `git status -s` ]]
-  - go mod vendor && go test -v client_test.go server_test.go session.go client.go connection.go const.go getty.go server.go options.go logger.go
+  - go mod vendor && go test $(go list ./... | grep -v vendor | grep -v demo) -coverprofile=coverage.txt -covermode=atomic
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+
+notifications:
+  webhooks: https://oapi.dingtalk.com/robot/send?access_token=75f4f1ec3868508aa89e5a5d6f9d342216809df3ebc8a78c8ae8722848e06166
\ No newline at end of file

README.md

@@ -2,9 +2,13 @@
 
  *a netty like asynchronous network I/O library*
 
+[![Build Status](https://travis-ci.org/dubbogo/getty.svg?branch=master)](https://travis-ci.org/dubbogo/getty)
+[![codecov](https://codecov.io/gh/dubbogo/getty/branch/master/graph/badge.svg)](https://codecov.io/gh/dubbogo/getty)
+[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/dubbogo/getty?tab=doc)
+
 ## INTRO
 
-Getty is a asynchronous network I/O library in golang. Getty is based on "ngo" whose author is [sanbit](https://github.com/sanbit). Getty works on tcp/udp/websocket network protocol and supplies [a uniform interface](https://github.com/dubbogo/getty/blob/master/getty.go#L45).
+Getty is a asynchronous network I/O library in golang. Getty works on tcp/udp/websocket network protocol and supplies [a uniform interface](https://github.com/dubbogo/getty/blob/master/getty.go#L45).
 
 In getty there are two goroutines in one connection(session), one reads tcp stream/udp packet/websocket package, the other handles logic process and writes response into network write buffer. If your logic process may take a long time, you should start a new logic process goroutine by yourself in codec.go:(Codec)OnMessage.
 
@@ -12,8 +16,6 @@ You can also handle heartbeat logic in codec.go:(Codec):OnCron. If you use tcp/u
 
 Whatever if you use websocket, you do not need to care about hearbeat request/response because Getty do this task in session.go:(Session)handleLoop by sending/received websocket ping/pong frames. You just need to  check whether the websocket session has been timeout or not in codec.go:(Codec)OnCron by session.go:(Session)GetActive.
 
-You can get code example in https://github.com/AlexStocks/getty-examples.
-
 ## LICENCE
 
 Apache License 2.0

client_test.go

@@ -12,7 +12,7 @@ import (
 )
 
 import (
-	perrors "github.com/pkg/errors"
+	jerrors "github.com/juju/errors"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -63,12 +63,8 @@ func (p Package) String() string {
 func (p Package) Marshal() (*bytes.Buffer, error)           { return nil, nil }
 func (p *Package) Unmarshal(buf *bytes.Buffer) (int, error) { return 0, nil }
 
-var (
-	pkg        Package
-	pkgHandler PackageHandler
-)
-
 func newSessionCallback(session Session, handler *MessageHandler) error {
+	var pkgHandler PackageHandler
 	session.SetName("hello-client-session")
 	session.SetMaxMsgLen(1024)
 	session.SetPkgHandler(&pkgHandler)
@@ -141,7 +137,8 @@ func TestUDPClient(t *testing.T) {
 		conn *net.UDPConn
 	)
 	func() {
-		srcAddr := &net.UDPAddr{IP: net.IPv4zero, Port: 0}
+		ip := net.ParseIP("127.0.0.1")
+		srcAddr := &net.UDPAddr{IP: ip, Port: 0}
 		conn, err = net.ListenUDP("udp", srcAddr)
 		assert.Nil(t, err)
 		assert.NotNil(t, conn)
@@ -149,6 +146,7 @@ func TestUDPClient(t *testing.T) {
 	defer conn.Close()
 
 	addr := conn.LocalAddr()
+	t.Logf("server addr: %v", addr)
 	clt := NewUDPClient(
 		WithServerAddress(addr.String()),
 		WithReconnectInterval(5e8),
@@ -173,7 +171,7 @@ func TestUDPClient(t *testing.T) {
 	err = ss.WritePkg(nil, 0)
 	assert.NotNil(t, err)
 	err = ss.WritePkg([]byte("hello"), 0)
-	assert.NotNil(t, perrors.Cause(err))
+	assert.NotNil(t, jerrors.Cause(err))
 	err = ss.WriteBytes([]byte("hello"))
 	assert.NotNil(t, err)
 	err = ss.WriteBytesArray([]byte("hello"))

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/dubbogo/gost v1.5.2
 	github.com/golang/snappy v0.0.1
 	github.com/gorilla/websocket v1.4.0
+	github.com/juju/errors v0.0.0-20190930114154-d42613fe1ab9
 	github.com/pkg/errors v0.8.1
 	github.com/stretchr/testify v1.5.1
 	go.uber.org/atomic v1.4.0 // indirect

go.sum

@@ -9,6 +9,9 @@ github.com/dubbogo/gost v1.5.2/go.mod h1:pPTjVyoJan3aPxBPNUX0ADkXjPibLo+/Ib0/fAD
 github.com/golang/snappy v0.0.1 h1:Qgr9rKW7uDUkrbSmQeiDsGa8SjGyCOGtuasMWwvp2P4=
 github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
+github.com/juju/errors v0.0.0-20190930114154-d42613fe1ab9 h1:hJix6idebFclqlfZCHE7EUX7uqLCyb70nHNHH1XKGBg=
+github.com/juju/errors v0.0.0-20190930114154-d42613fe1ab9/go.mod h1:W54LbzXuIE0boCoNJfwqpmkKJ1O4TCTZMetAt6jGk7Q=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

options_test.go

+package getty
+
+import (
+	"testing"
+)
+
+import (
+	"github.com/stretchr/testify/assert"
+)
+
+func TestClientOptions(t *testing.T) {
+	addr := "127.0.0.1:0"
+	file := ""
+	clt := newClient(TCP_CLIENT,
+		WithServerAddress(addr),
+		WithReconnectInterval(5e8),
+		WithConnectionNumber(1),
+		WithRootCertificateFile(file),
+	)
+	assert.NotNil(t, clt)
+	assert.Equal(t, clt.endPointType, TCP_CLIENT)
+	assert.True(t, clt.endPointType > 0)
+	assert.NotNil(t, clt.done)
+	assert.NotNil(t, clt.ssMap)
+	assert.Equal(t, clt.addr, addr)
+	assert.NotNil(t, clt.reconnectInterval)
+	assert.NotNil(t, clt.cert)
+	assert.Equal(t, clt.number, 1)
+}
+
+func TestServerOptions(t *testing.T) {
+	addr := "127.0.0.1:0"
+	path := "/test"
+	cert := ""
+	key := "test"
+	srv := newServer(TCP_SERVER,
+		WithLocalAddress(addr),
+		WithWebsocketServerPath(path),
+		WithWebsocketServerCert(cert),
+		WithWebsocketServerPrivateKey(key),
+		WithWebsocketServerRootCert(cert),
+	)
+	assert.NotNil(t, srv)
+	assert.Equal(t, srv.endPointType, TCP_SERVER)
+	assert.True(t, srv.endPointType > 0)
+	assert.NotNil(t, srv.done)
+	assert.Equal(t, srv.addr, addr)
+	assert.Equal(t, srv.path, path)
+	assert.Equal(t, srv.cert, cert)
+	assert.Equal(t, srv.privateKey, key)
+	assert.Equal(t, srv.caCert, cert)
+}