Merge pull request #1132 from deis/log-formatting

test(logger): add syslog tests

Author: Matthew Fisher

.gitignore

@@ -24,6 +24,7 @@ pip-log.txt
 .coverage
 .tox
 nosetests.xml
+logger/coverage.out
 
 # Translations
 *.mo

.travis.yml

@@ -18,6 +18,7 @@ before_install:
 install:
   - pip install -r controller/requirements.txt
   - pip install -r controller/dev_requirements.txt coveralls
+  - go get code.google.com/p/go.tools/cmd/cover
 
 before_script:
   - "psql -c 'create database deis_testing;' -U postgres"
@@ -40,6 +41,7 @@ script:
   - make -C controller flake8
   - make -C controller coverage
   - make -C docs
+  - make -C logger test
 
 after_success:
   - cd controller && coveralls

client/deis.py

@@ -566,7 +566,7 @@ def apps_logs(self, args):
         response = self._dispatch('post',
                                   "/api/apps/{}/logs".format(app))
         if response.status_code == requests.codes.ok:  # @UndefinedVariable
-            print(response.json())
+            sys.stdout.write(response.json())
         else:
             raise ResponseError(response)
 

logger/Makefile

@@ -30,7 +30,11 @@ full-clean: clean
 test: test-unit test-functional
 
 test-unit:
-	@echo no unit tests
+	go test -v -cover ./syslog
 
 test-functional:
 	GOPATH=$(CURDIR)/../tests/_vendor:$(GOPATH) go test -v ./tests/...
+
+coverage:
+	go test -coverprofile coverage.out ./syslog
+	go tool cover -html=coverage.out

logger/syslog/filehandler_test.go

@@ -0,0 +1,36 @@
+package syslog
+
+import (
+    "testing"
+    "time"
+)
+
+type TestLogger struct {}
+
+func (tl TestLogger) Print(...interface{}) {}
+func (tl TestLogger) Printf(format string, v ...interface{}) {}
+func (tl TestLogger) Println(...interface{}) {}
+
+func TestNewFileHandler(t *testing.T) {
+    fh := NewFileHandler("", 1, func (m *Message) bool {return true}, true)
+    if fh == nil {
+        t.Errorf("expected filehandler, got nil")
+    }
+}
+
+func TestSetLogger(t *testing.T) {
+    tl := TestLogger{}
+    fh := NewFileHandler("", 1, func (m *Message) bool {return true}, true)
+    fh.SetLogger(tl)
+    if fh.l != tl {
+        t.Errorf("expected the logger to be set")
+    }
+}
+
+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", "", ""})
+    if handle == nil {
+        t.Errorf("expected a handle, got nil")
+    }
+}

logger/syslog/message.go

@@ -36,8 +36,9 @@ func (m *Message) NetSrc() string {
 func (m *Message) String() string {
 	timeLayout := "2006-01-02 15:04:05"
 	return fmt.Sprintf(
-		"%s %s %s %s%s",
-		m.Time.Format(timeLayout), m.Source,
-		m.Hostname, m.Tag, m.Content,
+		"%s %s %s",
+		m.Time.Format(timeLayout),
+		m.Hostname,
+		m.Content,
 	)
 }

logger/syslog/message_test.go

@@ -0,0 +1,80 @@
+package syslog
+
+import (
+    "net"
+    "testing"
+    "time"
+)
+
+func TestMessageNetSrc(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(), "", "", "", "", ""}
+    if m.NetSrc() != "127.0.0.1" {
+        t.Errorf("expected 127.0.0.1, got ", m.NetSrc())
+    }
+
+    udpAddress, err := net.ResolveUDPAddr("udp", "localhost:1234")
+
+    if err != nil {
+        t.Errorf("could not resolve UDP address")
+    }
+
+    m.Source = udpAddress
+    if m.NetSrc() != "127.0.0.1" {
+        t.Errorf("expected 127.0.0.1, got ", m.NetSrc())
+    }
+
+    unixAddress, err := net.ResolveUnixAddr("unix", "/tmp/str")
+
+    if err != nil {
+        t.Errorf("could not resolve unix address")
+    }
+
+    m.Source = unixAddress
+    if m.NetSrc() != "/tmp/str" {
+        t.Errorf("expected /tmp/str, got ", m.NetSrc())
+    }
+
+    unknownAddress, err := net.ResolveIPAddr("ip4", "localhost")
+
+    if err != nil {
+        t.Errorf("could not resolve unknown address")
+    }
+
+    m.Source = unknownAddress
+    if m.NetSrc() != "127.0.0.1" {
+        t.Errorf("expected 127.0.0.1, got ", 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",
+        "",
+        "",
+    }
+
+    timeLayout := "2006-01-02 15:04:05"
+    expectedOutput := m.Time.Format(timeLayout) + " localhost hello world"
+    if m.String() != expectedOutput {
+        t.Errorf("expected '" + expectedOutput + "', got '" + m.String() + "'.")
+    }
+}

logger/syslog/priority_test.go

@@ -0,0 +1,27 @@
+package syslog
+
+import (
+    "testing"
+)
+
+func TestFacilityToString(t *testing.T) {
+    var fac Facility = 100
+    if fac.String() != "unknown" {
+        t.Errorf("facility != unknown; got %s", fac.String())
+    }
+    fac = 20
+    if fac.String() != "local4" {
+        t.Errorf("facility != local4; got %s", fac.String())
+    }
+}
+
+func TestSeverityToString(t *testing.T) {
+    var sev Severity = 100
+    if sev.String() != "unknown" {
+        t.Errorf("severity != unknown; got %s", sev.String())
+    }
+    sev = 5
+    if sev.String() != "notice" {
+        t.Errorf("severity != local4; got %s", sev.String())
+    }
+}