formats refactor

Author: mcuadros

rfc6587_test.go renamed to format/rfc6587_test.go

@@ -1,4 +1,4 @@
-package syslog
+package format
 
 import (
 	"bufio"
@@ -8,11 +8,13 @@ import (
 	"testing"
 )
 
-func TestSingleSplit(t *testing.T) {
+func TestRFC6587_GetSplitFuncSingleSplit(t *testing.T) {
+	f := RFC6587{}
+
 	find := "I am test."
 	buf := strings.NewReader("10 " + find)
 	scanner := bufio.NewScanner(buf)
-	scanner.Split(rfc6587ScannerSplit)
+	scanner.Split(f.GetSplitFunc())
 	if r := scanner.Scan(); !r {
 		t.Error("Expected Scan() to return true, but didn't")
 	}
@@ -21,7 +23,9 @@ func TestSingleSplit(t *testing.T) {
 	}
 }
 
-func TestMultiSplit(t *testing.T) {
+func TestRFC6587_GetSplitFuncMultiSplit(t *testing.T) {
+	f := RFC6587{}
+
 	find := []string{
 		"I am test.",
 		"I am test 2.",
@@ -32,7 +36,7 @@ func TestMultiSplit(t *testing.T) {
 		fmt.Fprintf(buf, "%d %s", len(i), i)
 	}
 	scanner := bufio.NewScanner(buf)
-	scanner.Split(rfc6587ScannerSplit)
+	scanner.Split(f.GetSplitFunc())
 
 	i := 0
 	for scanner.Scan() {
@@ -44,11 +48,14 @@ func TestMultiSplit(t *testing.T) {
 	}
 }
 
-func TestBadSplit(t *testing.T) {
+func TestRFC6587_GetSplitBadSplit(t *testing.T) {
+	f := RFC6587{}
+
 	find := "I am test.2 ab"
 	buf := strings.NewReader("9 " + find)
 	scanner := bufio.NewScanner(buf)
-	scanner.Split(rfc6587ScannerSplit)
+	scanner.Split(f.GetSplitFunc())
+
 	if r := scanner.Scan(); !r {
 		t.Error("Expected Scan() to return true, but didn't")
 	}

server.go

@@ -2,48 +2,39 @@ package syslog
 
 import (
 	"bufio"
-	"bytes"
 	"errors"
 	"net"
-	"strconv"
 	"sync"
-
 	"time"
 
-	"github.com/jeromer/syslogparser"
-	"github.com/jeromer/syslogparser/rfc3164"
-	"github.com/jeromer/syslogparser/rfc5424"
+	"github.com/mcuadros/go-syslog/format"
 )
 
-type Format int
-
-const (
-	RFC3164 Format = 1 + iota // RFC3164: http://www.ietf.org/rfc/rfc3164.txt
-	RFC5424                   // RFC5424: http://www.ietf.org/rfc/rfc5424.txt
-	RFC6587                   // RFC6587: http://www.ietf.org/rfc/rfc6587.txt
+var (
+	RFC3164 = &format.RFC3164{} // RFC3164: http://www.ietf.org/rfc/rfc3164.txt
+	RFC5424 = &format.RFC5424{} // RFC5424: http://www.ietf.org/rfc/rfc5424.txt
+	RFC6587 = &format.RFC6587{} // RFC6587: http://www.ietf.org/rfc/rfc6587.txt
 )
 
 type Server struct {
 	listeners               []*net.TCPListener
 	connections             []net.Conn
 	wait                    sync.WaitGroup
 	doneTcp                 chan bool
-	format                  Format
+	format                  format.Format
 	handler                 Handler
 	lastError               error
 	readTimeoutMilliseconds int64
 }
 
 //NewServer returns a new Server
 func NewServer() *Server {
-	server := new(Server)
-
-	return server
+	return &Server{}
 }
 
 //Sets the syslog format (RFC3164 or RFC5424 or RFC6587)
-func (self *Server) SetFormat(format Format) {
-	self.format = format
+func (self *Server) SetFormat(f format.Format) {
+	self.format = f
 }
 
 //Sets the handler, this handler with receive every syslog entry
@@ -107,7 +98,7 @@ func (self *Server) ListenTCP(addr string) error {
 
 //Starts the server, all the go routines goes to live
 func (self *Server) Boot() error {
-	if self.format == 0 {
+	if self.format == nil {
 		return errors.New("please set a valid format")
 	}
 
@@ -148,43 +139,10 @@ func (self *Server) goAcceptConnection(listener *net.TCPListener) {
 	}(listener)
 }
 
-type TimeoutCloser interface {
-	Close() error
-	SetReadDeadline(t time.Time) error
-}
-
-type ScanCloser struct {
-	*bufio.Scanner
-	closer TimeoutCloser
-}
-
-func rfc6587ScannerSplit(data []byte, atEOF bool) (advance int, token []byte, err error) {
-	if atEOF && len(data) == 0 {
-		return 0, nil, nil
-	}
-
-	if i := bytes.IndexByte(data, ' '); i > 0 {
-		pLength := data[0:i]
-		length, err := strconv.Atoi(string(pLength))
-		if err != nil {
-			return 0, nil, err
-		}
-		end := length + i + 1
-		if len(data) >= end {
-			//Return the frame with the length removed
-			return end, data[i+1 : end], nil
-		}
-	}
-
-	// Request more data
-	return 0, nil, nil
-}
-
 func (self *Server) goScanConnection(connection net.Conn, needClose bool) {
 	scanner := bufio.NewScanner(connection)
-	switch self.format {
-	case RFC6587:
-		scanner.Split(rfc6587ScannerSplit)
+	if sf := self.format.GetSplitFunc(); sf != nil {
+		scanner.Split(sf)
 	}
 
 	var scanCloser *ScanCloser
@@ -229,15 +187,7 @@ func (self *Server) scan(scanCloser *ScanCloser) {
 }
 
 func (self *Server) parser(line []byte) {
-	var parser syslogparser.LogParser
-
-	switch self.format {
-	case RFC3164:
-		parser = self.getParserRFC3164(line)
-	case RFC5424, RFC6587:
-		parser = self.getParserRFC5424(line)
-	}
-
+	parser := self.format.GetParser(line)
 	err := parser.Parse()
 	if err != nil {
 		self.lastError = err
@@ -246,18 +196,6 @@ func (self *Server) parser(line []byte) {
 	go self.handler.Handle(parser.Dump(), int64(len(line)), err)
 }
 
-func (self *Server) getParserRFC3164(line []byte) *rfc3164.Parser {
-	parser := rfc3164.NewParser(line)
-
-	return parser
-}
-
-func (self *Server) getParserRFC5424(line []byte) *rfc5424.Parser {
-	parser := rfc5424.NewParser(line)
-
-	return parser
-}
-
 //Returns the last error
 func (self *Server) GetLastError() error {
 	return self.lastError
@@ -288,3 +226,13 @@ func (self *Server) Kill() error {
 func (self *Server) Wait() {
 	self.wait.Wait()
 }
+
+type TimeoutCloser interface {
+	Close() error
+	SetReadDeadline(t time.Time) error
+}
+
+type ScanCloser struct {
+	*bufio.Scanner
+	closer TimeoutCloser
+}

server_test.go

@@ -48,9 +48,9 @@ func (s *ServerSuite) TestTailFile(c *C) {
 }
 
 type HandlerMock struct {
-	LastLogParts syslogparser.LogParts
+	LastLogParts      syslogparser.LogParts
 	LastMessageLength int64
-	LastError error
+	LastError         error
 }
 
 func (self *HandlerMock) Handle(logParts syslogparser.LogParts, msgLen int64, err error) {