Merge pull request #1757 from bacongobbler/syslog-parser

fix(logger): properly parse incoming syslog messages

Author: Matthew Fisher

logger/Dockerfile

@@ -1,6 +1,13 @@
 FROM deis/base:latest
 MAINTAINER OpDemand <info@opdemand.com>
 
+# install go dependencies
+RUN apt-get update && apt-get install -yq \
+    git \
+    bzr \
+    mercurial \
+    --no-install-recommends
+
 # install go runtime
 RUN wget -qO- https://storage.googleapis.com/golang/go1.3.1.linux-amd64.tar.gz | tar -C /usr/local -xz
 
@@ -13,12 +20,13 @@ ENV PATH /usr/local/bin:/usr/bin:/bin:/sbin:/usr/local/go/bin
 RUN mkdir -p /var/log/deis
 
 # prepare execution environment
-WORKDIR /app
+WORKDIR /go/src/github.com/deis/deis/logger
 CMD ["/app/bin/boot"]
 EXPOSE 514
 
-ADD . /app
+ADD bin/ /app/bin/
 ADD . /go/src/github.com/deis/deis/logger
 
-# compile the binary
-RUN cd /go/src/github.com/deis/deis/logger/syslogd && go install -v .
+# install dependencies
+RUN go get ./syslog
+RUN go install -v ./syslogd

logger/Makefile

@@ -42,7 +42,7 @@ test-style:
 	-golint .
 
 test-unit: test-style
-	go test -v -cover ./syslog
+	GOPATH=$(CURDIR)/../tests/_vendor:$(GOPATH) go test -v -cover ./syslog
 
 test-functional:
 	GOPATH=$(CURDIR)/../tests/_vendor:$(GOPATH) go test -v -timeout 20m ./tests/...

logger/syslog/filehandler.go

@@ -81,11 +81,6 @@ func (h *FileHandler) checkErr(err error) bool {
 	if err == nil {
 		return false
 	}
-	if h.l == nil {
-		log.Print(h.filename, ": ", err)
-	} else {
-		h.l.Print(h.filename, ": ", err)
-	}
 	return true
 }
 

logger/syslog/filehandler_test.go

@@ -29,7 +29,7 @@ func TestSetLogger(t *testing.T) {
 
 func TestHandle(t *testing.T) {
 	fh := NewFileHandler("/tmp/test", 1, func(m *Message) bool { return true }, true)
-	handle := fh.Handle(&Message{time.Now(), nil, 0, 0, time.Now(), "localhost", "test", "message", "", ""})
+	handle := fh.Handle(&Message{time.Now(), 0, time.Now(), "localhost", "test", "message"})
 	if handle == nil {
 		t.Errorf("expected a handle, got nil")
 	}

logger/syslog/message.go

@@ -2,46 +2,27 @@ package syslog
 
 import (
 	"fmt"
-	"net"
+	"log/syslog"
 	"time"
 )
 
 // Message defines an RFC 3164 syslog message.
 type Message struct {
-	Time      time.Time // time the message was logged
-	Source    net.Addr  // source address of the log message
-	Facility            // facility tag (see type Facility)
-	Severity            // severity tag (see type Severity)
-	Timestamp time.Time // optional
-	Hostname  string    // optional
-	Tag       string    // message tag as defined in RFC 3164
-	Content   string    // message content as defined in RFC 3164
-	Tag1      string    // alternate message tag (white rune as separator)
-	Content1  string    // alternate message content (white rune as separator)
-}
-
-// NetSrc only network part of Source as string (IP for UDP or Name for UDS)
-func (m *Message) NetSrc() string {
-	switch a := m.Source.(type) {
-	case *net.UDPAddr:
-		return a.IP.String()
-	case *net.UnixAddr:
-		return a.Name
-	case *net.TCPAddr:
-		return a.IP.String()
-	}
-	// Unknown type
-	return m.Source.String()
+	Time      time.Time
+	Priority  syslog.Priority
+	Timestamp time.Time
+	Hostname  string
+	Tag       string
+	Content   string
 }
 
 // String returns the Message in a string format. This satisfies the fmt.Stringer
 // interface.
 func (m *Message) String() string {
 	timeLayout := "2006-01-02 15:04:05"
 	return fmt.Sprintf(
-		"%s %s %s%s",
+		"%s %s: %s",
 		m.Time.Format(timeLayout),
-		m.Hostname,
 		m.Tag,
 		m.Content,
 	)

logger/syslog/message_test.go

@@ -1,79 +1,15 @@
 package syslog
 
 import (
-	"net"
 	"testing"
 	"time"
 )
 
-func TestMessageNetSrc(t *testing.T) {
-	tcpAddress, err := net.ResolveTCPAddr("tcp", "localhost:1234")
-
-	if err != nil {
-		t.Error("could not resolve TCP address")
-	}
-
-	m := &Message{time.Now(), tcpAddress, 0, 0, time.Now(), "", "", "", "", ""}
-	if m.NetSrc() != "127.0.0.1" {
-		t.Errorf("expected 127.0.0.1, got %s", m.NetSrc())
-	}
-
-	udpAddress, err := net.ResolveUDPAddr("udp", "localhost:1234")
-
-	if err != nil {
-		t.Error("could not resolve UDP address")
-	}
-
-	m.Source = udpAddress
-	if m.NetSrc() != "127.0.0.1" {
-		t.Errorf("expected 127.0.0.1, got %s", m.NetSrc())
-	}
-
-	unixAddress, err := net.ResolveUnixAddr("unix", "/tmp/str")
-
-	if err != nil {
-		t.Error("could not resolve unix address")
-	}
-
-	m.Source = unixAddress
-	if m.NetSrc() != "/tmp/str" {
-		t.Errorf("expected /tmp/str, got %s", m.NetSrc())
-	}
-
-	unknownAddress, err := net.ResolveIPAddr("ip4", "localhost")
-
-	if err != nil {
-		t.Error("could not resolve unknown address")
-	}
-
-	m.Source = unknownAddress
-	if m.NetSrc() != "127.0.0.1" {
-		t.Errorf("expected 127.0.0.1, got %s", m.NetSrc())
-	}
-}
-
 func TestMessageFormat(t *testing.T) {
-	tcpAddress, err := net.ResolveTCPAddr("tcp", "localhost:1234")
-
-	if err != nil {
-		t.Errorf("could not resolve TCP address")
-	}
-
-	m := &Message{
-		time.Now(),
-		tcpAddress,
-		0,
-		0,
-		time.Now(),
-		"localhost",
-		"TEST",
-		"hello world",
-		"",
-		"",
-	}
+	m := &Message{time.Now(), 34, time.Now(), "localhost", "test", "hello world"}
 
 	timeLayout := "2006-01-02 15:04:05"
-	expectedOutput := m.Time.Format(timeLayout) + " localhost TESThello world"
+	expectedOutput := m.Time.Format(timeLayout) + " test: hello world"
 	if m.String() != expectedOutput {
 		t.Errorf("expected '" + expectedOutput + "', got '" + m.String() + "'.")
 	}