Add logfwd.Record.

ericsnowcurrently · ericsnowcurrently · commit aa26d39e09bb · 2016-06-15T16:22:24.000-06:00
diff --git a/logfwd/record.go b/logfwd/record.go
@@ -0,0 +1,124 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+package logfwd
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/juju/errors"
+	"github.com/juju/loggo"
+)
+
+// Record holds all the information for a single log record.
+type Record struct {
+	// Origin describes what created the record.
+	Origin Origin
+
+	// Timestamp is when the record was created.
+	Timestamp time.Time
+
+	// Level is the basic logging level of the record.
+	Level loggo.Level
+
+	// Location describes where the record was created.
+	Location SourceLocation
+
+	// Message is the record's body. It may be empty.
+	Message string
+}
+
+// Validate ensures that the record is correct.
+func (rec Record) Validate() error {
+	if err := rec.Origin.Validate(); err != nil {
+		return errors.Annotate(err, "invalid Origin")
+	}
+
+	if rec.Timestamp.IsZero() {
+		return errors.NewNotValid(nil, "empty Timestamp")
+	}
+
+	// rec.Level may be anything, so we don't check it.
+
+	if err := rec.Location.Validate(); err != nil {
+		return errors.Annotate(err, "invalid Location")
+	}
+
+	// rec.Message may be anything, so we don't check it.
+
+	return nil
+}
+
+// SourceLocation holds all the information about the source code that
+// caused the record to be created.
+type SourceLocation struct {
+	// Module is the source "module" (e.g. package) where the record
+	// originated. This is optional.
+	Module string
+
+	// Filename is the path to the source file. This is required only
+	// if Line is greater than 0.
+	Filename string
+
+	// Line is the line number in the source. It is optional. A negative
+	// value means "not set". So does 0 if Filename is not set. If Line
+	// is greater than 0 then Filename must be set.
+	Line int
+}
+
+// ParseLocation converts the given info into a SourceLocation. The
+// caller is responsible for validating the result.
+func ParseLocation(module, location string) (SourceLocation, error) {
+	loc, err := parseLocation(module, location)
+	if err != nil {
+		return loc, errors.Annotate(err, "failed to parse location")
+	}
+	return loc, nil
+}
+
+func parseLocation(module, location string) (SourceLocation, error) {
+	loc := SourceLocation{
+		Module:   module,
+		Filename: location,
+	}
+	if location != "" {
+		loc.Line = -1
+		pos := strings.LastIndex(location, ":")
+		if pos >= 0 {
+			loc.Filename = location[:pos]
+			lineno, err := strconv.Atoi(location[pos+1:])
+			if err != nil {
+				return SourceLocation{}, errors.Trace(err)
+			}
+			loc.Line = lineno
+		}
+	}
+	return loc, nil
+}
+
+// String returns a string representation of the location.
+func (loc SourceLocation) String() string {
+	if loc.Line < 0 {
+		return loc.Filename
+	}
+	if loc.Line == 0 && loc.Filename == "" {
+		return ""
+	}
+	return fmt.Sprintf("%s:%d", loc.Filename, loc.Line)
+}
+
+// Validate ensures that the location is correct.
+func (loc SourceLocation) Validate() error {
+	// Module may be anything, so there's nothing to check.
+
+	// Filename may be set with no line number set, but not the other
+	// way around.
+	if loc.Line > 0 && loc.Filename == "" {
+		return errors.NewNotValid(nil, "Line set but Filename empty")
+	}
+
+	return nil
+}
diff --git a/logfwd/record_test.go b/logfwd/record_test.go
@@ -0,0 +1,165 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+package logfwd_test
+
+import (
+	"time"
+
+	"github.com/juju/errors"
+	"github.com/juju/loggo"
+	"github.com/juju/testing"
+	jc "github.com/juju/testing/checkers"
+	gc "gopkg.in/check.v1"
+
+	"github.com/juju/juju/logfwd"
+)
+
+type RecordSuite struct {
+	testing.IsolationSuite
+}
+
+var _ = gc.Suite(&RecordSuite{})
+
+func (s *RecordSuite) TestValidateValid(c *gc.C) {
+	rec := validRecord
+
+	err := rec.Validate()
+
+	c.Check(err, jc.ErrorIsNil)
+}
+
+func (s *RecordSuite) TestValidateZero(c *gc.C) {
+	var rec logfwd.Record
+
+	err := rec.Validate()
+
+	c.Check(err, jc.Satisfies, errors.IsNotValid)
+}
+
+func (s *RecordSuite) TestValidateBadOrigin(c *gc.C) {
+	rec := validRecord
+	rec.Origin.Name = "..."
+
+	err := rec.Validate()
+
+	c.Check(err, jc.Satisfies, errors.IsNotValid)
+	c.Check(err, gc.ErrorMatches, `invalid Origin: invalid Name "...": bad user`)
+}
+
+func (s *RecordSuite) TestValidateEmptyTimestamp(c *gc.C) {
+	rec := validRecord
+	rec.Timestamp = time.Time{}
+
+	err := rec.Validate()
+
+	c.Check(err, jc.Satisfies, errors.IsNotValid)
+	c.Check(err, gc.ErrorMatches, `empty Timestamp`)
+}
+
+func (s *RecordSuite) TestValidateBadLocation(c *gc.C) {
+	rec := validRecord
+	rec.Location.Filename = ""
+
+	err := rec.Validate()
+
+	c.Check(err, jc.Satisfies, errors.IsNotValid)
+	c.Check(err, gc.ErrorMatches, `invalid Location: Line set but Filename empty`)
+}
+
+type LocationSuite struct {
+	testing.IsolationSuite
+}
+
+var _ = gc.Suite(&LocationSuite{})
+
+func (s *LocationSuite) TestParseLocationTooLegitToQuit(c *gc.C) {
+	expected := validLocation
+
+	loc, err := logfwd.ParseLocation(expected.Module, expected.String())
+	c.Assert(err, jc.ErrorIsNil)
+
+	c.Check(loc, jc.DeepEquals, expected)
+}
+
+func (s *LocationSuite) TestParseLocationMissingFilename(c *gc.C) {
+	expected := validLocation
+	expected.Filename = ""
+
+	loc, err := logfwd.ParseLocation(expected.Module, ":42")
+	c.Assert(err, jc.ErrorIsNil)
+
+	c.Check(loc, jc.DeepEquals, expected)
+}
+
+func (s *LocationSuite) TestParseLocationBogusFilename(c *gc.C) {
+	expected := validLocation
+	expected.Filename = "..."
+
+	loc, err := logfwd.ParseLocation(expected.Module, "...:42")
+	c.Assert(err, jc.ErrorIsNil)
+
+	c.Check(loc, jc.DeepEquals, expected)
+}
+
+func (s *LocationSuite) TestParseLocationFilenameOnly(c *gc.C) {
+	expected := validLocation
+	expected.Line = -1
+
+	loc, err := logfwd.ParseLocation(expected.Module, expected.Filename)
+	c.Assert(err, jc.ErrorIsNil)
+
+	c.Check(loc, jc.DeepEquals, expected)
+}
+
+func (s *LocationSuite) TestParseLocationMissingLine(c *gc.C) {
+	_, err := logfwd.ParseLocation(validLocation.Module, "spam.go:")
+
+	c.Check(err, gc.ErrorMatches, `failed to parse location: strconv.ParseInt: parsing "": invalid syntax`)
+}
+
+func (s *LocationSuite) TestParseLocationBogusLine(c *gc.C) {
+	_, err := logfwd.ParseLocation(validLocation.Module, "spam.go:xxx")
+
+	c.Check(err, gc.ErrorMatches, `failed to parse location: strconv.ParseInt: parsing "xxx": invalid syntax`)
+}
+
+func (s *LocationSuite) TestValidateValid(c *gc.C) {
+	loc := validLocation
+
+	err := loc.Validate()
+
+	c.Check(err, jc.ErrorIsNil)
+}
+
+func (s *LocationSuite) TestValidateEmpty(c *gc.C) {
+	var loc logfwd.SourceLocation
+
+	err := loc.Validate()
+
+	c.Check(err, jc.ErrorIsNil)
+}
+
+func (s *LocationSuite) TestValidateBadLine(c *gc.C) {
+	loc := validLocation
+	loc.Filename = ""
+
+	err := loc.Validate()
+
+	c.Check(err, jc.Satisfies, errors.IsNotValid)
+	c.Check(err, gc.ErrorMatches, `Line set but Filename empty`)
+}
+
+var validLocation = logfwd.SourceLocation{
+	Module:   "spam",
+	Filename: "eggs.go",
+	Line:     42,
+}
+
+var validRecord = logfwd.Record{
+	Origin:    validOrigin,
+	Timestamp: time.Now(),
+	Level:     loggo.ERROR,
+	Location:  validLocation,
+	Message:   "uh-oh",
+}
