jandd/cacert-gosigner
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity

Refactor public API tests for protocol

Browse source 
- move tests for public API to protocol_test package
- add tests for context handling of COBSFramer
This commit is contained in:
Jan Dittberner 2022-12-04 19:17:36 +01:00
parent 7852c4d3df
commit 51ca9cc69d
3 changed files with 2156 additions and 1990 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
pkg/protocol/protocol.go
View file

@ -32,7 +32,7 @@ import (
"git.cacert.org/cacert-gosigner/pkg/messages"
)
const CobsDelimiter = 0x00
const COBSDelimiter = 0x00
type Command struct {
Announce *messages.CommandAnnounce
@ -73,9 +73,9 @@ type ClientHandler interface {
var (
errCommandExpected = errors.New("command must not be nil")
errCommandAnnounceExpected = errors.New("command must have an announcement")
errCommandDataExpected = errors.New("command must have data")
errResponseExpected = errors.New("response must not be nil")
ErrCommandAnnounceExpected = errors.New("command must have an announcement")
ErrCommandDataExpected = errors.New("command must have data")
ErrResponseExpected = errors.New("response must not be nil")
ErrResponseAnnounceTimeoutExpired = errors.New("response announce timeout expired")
ErrResponseDataTimeoutExpired = errors.New("response data timeout expired")
@ -133,7 +133,7 @@ func (p *ServerProtocol) Handle(ctx context.Context) error {
return nil
default:
p.logger.Debugf("handling protocol state %s", p.state)
p.logger.WithField("state", p.state).Debug("handling protocol state")
switch p.state {
case cmdAnnounce:
@ -175,7 +175,7 @@ func (p *ServerProtocol) commandAnnounce(ctx context.Context) *Command {
func (p *ServerProtocol) commandData(ctx context.Context, command *Command) error {
if command == nil || command.Announce == nil {
return errCommandAnnounceExpected
return ErrCommandAnnounceExpected
}
err := p.handler.CommandData(ctx, p.in, command)
@ -194,7 +194,7 @@ func (p *ServerProtocol) commandData(ctx context.Context, command *Command) erro
func (p *ServerProtocol) handleCommand(ctx context.Context, command *Command) (*Response, error) {
if command == nil || command.Announce == nil || command.Command == nil {
return nil, errCommandDataExpected
return nil, ErrCommandDataExpected
}
response, err := p.handler.HandleCommand(ctx, command)
@ -213,7 +213,7 @@ func (p *ServerProtocol) handleCommand(ctx context.Context, command *Command) (*
func (p *ServerProtocol) respond(ctx context.Context, response *Response) error {
if response == nil {
return errResponseExpected
return ErrResponseExpected
}
err := p.handler.Respond(ctx, response, p.out)
@ -260,7 +260,7 @@ func (p *ClientProtocol) Handle(ctx context.Context) error {
case <-ctx.Done():
return nil
default:
p.logger.Debugf("handling protocol state %s", p.state)
p.logger.WithField("state", p.state).Debug("handling protocol state")
switch p.state {
case cmdAnnounce:
@ -331,7 +331,7 @@ func (p *ClientProtocol) respAnnounce(ctx context.Context) *Response {
func (p *ClientProtocol) respData(ctx context.Context, response *Response) error {
if response == nil || response.Announce == nil {
return errResponseExpected
return ErrResponseExpected
}
err := p.handler.ResponseData(ctx, p.in, response)
@ -354,7 +354,7 @@ func (p *ClientProtocol) respData(ctx context.Context, response *Response) error
func (p *ClientProtocol) handleResponse(ctx context.Context, response *Response) error {
if response == nil || response.Announce == nil || response.Response == nil {
return errResponseExpected
return ErrResponseExpected
}
err := p.handler.HandleResponse(ctx, response)
@ -404,8 +404,10 @@ type COBSFramer struct {
encoder cobs.Encoder
}
var COBSConfig = cobs.Config{SpecialByte: COBSDelimiter, Delimiter: true, EndingSave: true}
func NewCOBSFramer(logger *logrus.Logger) (*COBSFramer, error) {
encoder, err := cobs.NewEncoder(cobs.Config{SpecialByte: CobsDelimiter, Delimiter: true, EndingSave: true})
encoder, err := cobs.NewEncoder(COBSConfig)
if err != nil {
return nil, fmt.Errorf("could not setup encoder: %w", err)
}
@ -447,7 +449,7 @@ func (c *COBSFramer) ReadFrames(ctx context.Context, reader io.Reader, frameChan
buffer.Write(raw)
for {
data, err = buffer.ReadBytes(CobsDelimiter)
data, err = buffer.ReadBytes(COBSDelimiter)
if err != nil {
if errors.Is(err, io.EOF) {
buffer.Write(data)

2079
pkg/protocol/protocol_it_test.go Normal file
View file

File diff suppressed because it is too large Load diff

2039
pkg/protocol/protocol_test.go
View file

File diff suppressed because it is too large Load diff