Skip to content

Commit

Permalink
categorize read and write error
Browse files Browse the repository at this point in the history
  • Loading branch information
DarienRaymond committed Oct 24, 2018
1 parent 9e66f31 commit c7f847c
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 21 deletions.
56 changes: 36 additions & 20 deletions common/buf/copy.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,6 @@ type SizeCounter struct {
// CopyOption is an option for copying data.
type CopyOption func(*copyHandler)

// IgnoreReaderError is a CopyOption that ignores errors from reader. Copy will continue in such case.
func IgnoreReaderError() CopyOption {
return func(handler *copyHandler) {
handler.onReadError = append(handler.onReadError, func(err error) error {
return nil
})
}
}

// IgnoreWriterError is a CopyOption that ignores errors from writer. Copy will continue in such case.
func IgnoreWriterError() CopyOption {
return func(handler *copyHandler) {
handler.onWriteError = append(handler.onWriteError, func(err error) error {
return nil
})
}
}

// UpdateActivity is a CopyOption to update activity on each data copy operation.
func UpdateActivity(timer signal.ActivityUpdater) CopyOption {
return func(handler *copyHandler) {
Expand All @@ -81,6 +63,40 @@ func CountSize(sc *SizeCounter) CopyOption {
}
}

type readError struct {
error
}

func (e readError) Error() string {
return e.error.Error()
}

func (e readError) Inner() error {
return e.error
}

func IsReadError(err error) bool {
_, ok := err.(readError)
return ok
}

type writeError struct {
error
}

func (e writeError) Error() string {
return e.error.Error()
}

func (e writeError) Inner() error {
return e.error
}

func IsWriteError(err error) bool {
_, ok := err.(writeError)
return ok
}

func copyInternal(reader Reader, writer Writer, handler *copyHandler) error {
for {
buffer, err := handler.readFrom(reader)
Expand All @@ -90,12 +106,12 @@ func copyInternal(reader Reader, writer Writer, handler *copyHandler) error {
}

if werr := handler.writeTo(writer, buffer); werr != nil {
return werr
return writeError{werr}
}
}

if err != nil {
return err
return readError{err}
}
}
}
Expand Down
54 changes: 54 additions & 0 deletions common/buf/copy_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package buf_test

import (
"crypto/rand"
"testing"

"github.com/golang/mock/gomock"

"v2ray.com/core/common/buf"
"v2ray.com/core/common/errors"
"v2ray.com/core/testing/mocks"
)

func TestReadError(t *testing.T) {
mockCtl := gomock.NewController(t)
defer mockCtl.Finish()

mockReader := mocks.NewReader(mockCtl)
mockReader.EXPECT().Read(gomock.Any()).Return(0, errors.New("error"))

err := buf.Copy(buf.NewReader(mockReader), buf.Discard)
if err == nil {
t.Fatal("expected error, but nil")
}

if !buf.IsReadError(err) {
t.Error("expected to be ReadError, but not")
}

if err.Error() != "error" {
t.Fatal("unexpected error message: ", err.Error())
}
}

func TestWriteError(t *testing.T) {
mockCtl := gomock.NewController(t)
defer mockCtl.Finish()

mockWriter := mocks.NewWriter(mockCtl)
mockWriter.EXPECT().Write(gomock.Any()).Return(0, errors.New("error"))

err := buf.Copy(buf.NewReader(rand.Reader), buf.NewWriter(mockWriter))
if err == nil {
t.Fatal("expected error, but nil")
}

if !buf.IsWriteError(err) {
t.Error("expected to be WriteError, but not")
}

if err.Error() != "error" {
t.Fatal("unexpected error message: ", err.Error())
}
}
4 changes: 3 additions & 1 deletion common/buf/writer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ func TestBytesWriterReadFrom(t *testing.T) {
writer.SetBuffered(false)
nBytes, err := reader.WriteTo(writer)
assert(nBytes, Equals, int64(size))
assert(err, IsNil)
if err != nil {
t.Fatal("expect success, but actually error: ", err.Error())
}

mb, err := pReader.ReadMultiBuffer()
assert(err, IsNil)
Expand Down
2 changes: 2 additions & 0 deletions mocks.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@ package core

//go:generate go get -u github.com/golang/mock/gomock
//go:generate go install github.com/golang/mock/mockgen

//go:generate mockgen -package mocks -destination testing/mocks/io.go -mock_names Reader=Reader,Writer=Writer io Reader,Writer
//go:generate mockgen -package mocks -destination testing/mocks/dns.go -mock_names Client=DNSClient v2ray.com/core/features/dns Client
//go:generate mockgen -package mocks -destination testing/mocks/proxy.go -mock_names Inbound=ProxyInbound,Outbound=ProxyOutbound v2ray.com/core/proxy Inbound,Outbound
82 changes: 82 additions & 0 deletions testing/mocks/io.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c7f847c

Please sign in to comment.