Creating circleci job to just lint and vet code

accumulator.go

@@ -10,6 +10,8 @@ import (
 	"github.com/influxdb/influxdb/client"
 )
 
+// BatchPoints is used to send a batch of data in a single write from telegraf
+// to influx
 type BatchPoints struct {
 	mu sync.Mutex
 
@@ -22,6 +24,7 @@ type BatchPoints struct {
 	Config *ConfiguredPlugin
 }
 
+// Add adds a measurement
 func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]string) {
 	bp.mu.Lock()
 	defer bp.mu.Unlock()
@@ -55,6 +58,7 @@ func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]
 	})
 }
 
+// AddValuesWithTime adds a measurement with a provided timestamp
 func (bp *BatchPoints) AddValuesWithTime(
 	measurement string,
 	values map[string]interface{},

agent.go

@@ -19,8 +19,13 @@ type runningPlugin struct {
 	config *ConfiguredPlugin
 }
 
+// Agent runs telegraf and collects data based on the given config
 type Agent struct {
+
+	// Interval at which to gather information
 	Interval Duration
+
+	// Run in debug mode?
 	Debug    bool
 	Hostname string
 
@@ -31,6 +36,7 @@ type Agent struct {
 	conn *client.Client
 }
 
+// NewAgent returns an Agent struct based off the given Config
 func NewAgent(config *Config) (*Agent, error) {
 	agent := &Agent{Config: config, Interval: Duration{10 * time.Second}}
 
@@ -57,8 +63,9 @@ func NewAgent(config *Config) (*Agent, error) {
 	return agent, nil
 }
 
-func (agent *Agent) Connect() error {
-	config := agent.Config
+// Connect connects to the agent's config URL
+func (a *Agent) Connect() error {
+	config := a.Config
 
 	u, err := url.Parse(config.URL)
 	if err != nil {
@@ -77,11 +84,12 @@ func (agent *Agent) Connect() error {
 		return err
 	}
 
-	agent.conn = c
+	a.conn = c
 
 	return nil
 }
 
+// LoadPlugins loads the agent's plugins
 func (a *Agent) LoadPlugins() ([]string, error) {
 	var names []string
 
@@ -201,10 +209,12 @@ func (a *Agent) crankSeparate(shutdown chan struct{}, plugin *runningPlugin) err
 	}
 }
 
+// TestAllPlugins verifies that we can 'Gather' from all plugins with the
+// default configuration
 func (a *Agent) TestAllPlugins() error {
 	var names []string
 
-	for name, _ := range plugins.Plugins {
+	for name := range plugins.Plugins {
 		names = append(names, name)
 	}
 
@@ -230,6 +240,8 @@ func (a *Agent) TestAllPlugins() error {
 	return nil
 }
 
+// Test verifies that we can 'Gather' from all plugins with their configured
+// Config struct
 func (a *Agent) Test() error {
 	var acc BatchPoints
 
@@ -253,6 +265,7 @@ func (a *Agent) Test() error {
 	return nil
 }
 
+// Run runs the agent daemon, gathering every Interval
 func (a *Agent) Run(shutdown chan struct{}) error {
 	if a.conn == nil {
 		err := a.Connect()

circle.yml

@@ -0,0 +1,17 @@
+dependencies:
+  post:
+    # install golint
+    - go get github.com/golang/lint/golint
+    # install binaries
+    - go install ./...
+
+test:
+  pre:
+    # Vet go code for any potential errors
+    - go vet ./...
+  override:
+    # Enforce that testutil, cmd, and main directory are fully linted
+    - golint .
+    - golint testutil/...
+    - golint cmd/...
+    # TODO run unit tests

cmd/telegraf/telegraf.go

@@ -19,7 +19,9 @@ var fVersion = flag.Bool("version", false, "display the version")
 var fSampleConfig = flag.Bool("sample-config", false, "print out full sample configuration")
 var fPidfile = flag.String("pidfile", "", "file to write our pid to")
 
+// Telegraf version
 var Version = "unreleased"
+// Telegraf commit
 var Commit = ""
 
 func main() {

config.go

@@ -13,10 +13,12 @@ import (
 	"github.com/naoina/toml/ast"
 )
 
+// Duration just wraps time.Duration
 type Duration struct {
 	time.Duration
 }
 
+// UnmarshalTOML parses the duration from the TOML config file
 func (d *Duration) UnmarshalTOML(b []byte) error {
 	dur, err := time.ParseDuration(string(b[1 : len(b)-1]))
 	if err != nil {
@@ -28,6 +30,9 @@ func (d *Duration) UnmarshalTOML(b []byte) error {
 	return nil
 }
 
+// Config specifies the URL/user/password for the database that telegraf
+// will be logging to, as well as all the plugins that the user has
+// specified
 type Config struct {
 	URL       string
 	Username  string
@@ -41,10 +46,12 @@ type Config struct {
 	plugins map[string]*ast.Table
 }
 
+// Plugins returns the configured plugins as a map of name -> plugin toml
 func (c *Config) Plugins() map[string]*ast.Table {
 	return c.plugins
 }
 
+// ConfiguredPlugin containing a name, interval, and drop/pass prefix lists
 type ConfiguredPlugin struct {
 	Name string
 
@@ -54,6 +61,7 @@ type ConfiguredPlugin struct {
 	Interval time.Duration
 }
 
+// ShouldPass returns true if the metric should pass, false if should drop
 func (cp *ConfiguredPlugin) ShouldPass(measurement string) bool {
 	if cp.Pass != nil {
 		for _, pat := range cp.Pass {
@@ -78,6 +86,7 @@ func (cp *ConfiguredPlugin) ShouldPass(measurement string) bool {
 	return true
 }
 
+// ApplyAgent loads the toml config into the given interface
 func (c *Config) ApplyAgent(v interface{}) error {
 	if c.agent != nil {
 		return toml.UnmarshalTable(c.agent, v)
@@ -86,6 +95,9 @@ func (c *Config) ApplyAgent(v interface{}) error {
 	return nil
 }
 
+// ApplyPlugin takes defined plugin names and applies them to the given
+// interface, returning a ConfiguredPlugin object in the end that can
+// be inserted into a runningPlugin by the agent.
 func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, error) {
 	cp := &ConfiguredPlugin{Name: name}
 
@@ -137,10 +149,11 @@ func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, err
 	return cp, nil
 }
 
+// PluginsDeclared returns the name of all plugins declared in the config.
 func (c *Config) PluginsDeclared() []string {
 	var plugins []string
 
-	for name, _ := range c.plugins {
+	for name := range c.plugins {
 		plugins = append(plugins, name)
 	}
 
@@ -149,12 +162,14 @@ func (c *Config) PluginsDeclared() []string {
 	return plugins
 }
 
+// DefaultConfig returns an empty default configuration
 func DefaultConfig() *Config {
 	return &Config{}
 }
 
-var ErrInvalidConfig = errors.New("invalid configuration")
+var errInvalidConfig = errors.New("invalid configuration")
 
+// LoadConfig loads the given config file and returns a *Config pointer
 func LoadConfig(path string) (*Config, error) {
 	data, err := ioutil.ReadFile(path)
 	if err != nil {
@@ -173,7 +188,7 @@ func LoadConfig(path string) (*Config, error) {
 	for name, val := range tbl.Fields {
 		subtbl, ok := val.(*ast.Table)
 		if !ok {
-			return nil, ErrInvalidConfig
+			return nil, errInvalidConfig
 		}
 
 		switch name {
@@ -192,6 +207,8 @@ func LoadConfig(path string) (*Config, error) {
 	return c, nil
 }
 
+// ListTags returns a string of tags specified in the config,
+// line-protocol style
 func (c *Config) ListTags() string {
 	var tags []string
 
@@ -271,12 +288,13 @@ database = "telegraf" # required.
 
 `
 
+// PrintSampleConfig prints the sample config!
 func PrintSampleConfig() {
 	fmt.Printf(header)
 
 	var names []string
 
-	for name, _ := range plugins.Plugins {
+	for name := range plugins.Plugins {
 		names = append(names, name)
 	}
 

plugins/mongodb/mongostat.go

@@ -457,7 +457,7 @@ func NewStatLine(oldStat, newStat ServerStatus, key string, all bool, sampleSecs
 		oldStat.ExtraInfo.PageFaults != nil && newStat.ExtraInfo.PageFaults != nil {
 		returnVal.Faults = diff(*(newStat.ExtraInfo.PageFaults), *(oldStat.ExtraInfo.PageFaults), sampleSecs)
 	}
-	if !returnVal.IsMongos && oldStat.Locks != nil && oldStat.Locks != nil {
+	if !returnVal.IsMongos && oldStat.Locks != nil {
 		globalCheck, hasGlobal := oldStat.Locks["Global"]
 		if hasGlobal && globalCheck.AcquireCount != nil {
 			// This appears to be a 3.0+ server so the data in these fields do *not* refer to

plugins/rethinkdb/rethinkdb_server.go

@@ -118,7 +118,7 @@ func (s *Server) addClusterStats(acc plugins.Accumulator) error {
 	defer cursor.Close()
 	var clusterStats stats
 	if err := cursor.One(&clusterStats); err != nil {
-		return fmt.Errorf("failure to parse cluster stats, $s\n", err.Error())
+		return fmt.Errorf("failure to parse cluster stats, %s\n", err.Error())
 	}
 
 	tags := s.getDefaultTags()
@@ -146,7 +146,7 @@ func (s *Server) addMemberStats(acc plugins.Accumulator) error {
 	defer cursor.Close()
 	var memberStats stats
 	if err := cursor.One(&memberStats); err != nil {
-		return fmt.Errorf("failure to parse member stats, $s\n", err.Error())
+		return fmt.Errorf("failure to parse member stats, %s\n", err.Error())
 	}
 
 	tags := s.getDefaultTags()

plugins/system/ps/disk/disk_test.go

@@ -45,7 +45,7 @@ func TestDisk_io_counters(t *testing.T) {
 		t.Errorf("error %v", err)
 	}
 	if len(ret) == 0 {
-		t.Errorf("ret is empty", ret)
+		t.Errorf("ret is empty: %s", ret)
 	}
 	empty := DiskIOCountersStat{}
 	for part, io := range ret {

testutil/accumulator.go

@@ -6,17 +6,20 @@ import (
 	"time"
 )
 
+// Point defines a single point measurement
 type Point struct {
 	Measurement string
 	Tags        map[string]string
 	Values      map[string]interface{}
 	Time        time.Time
 }
 
+// Accumulator defines a mocked out accumulator
 type Accumulator struct {
 	Points []*Point
 }
 
+// Add adds a measurement point to the accumulator
 func (a *Accumulator) Add(measurement string, value interface{}, tags map[string]string) {
 	if tags == nil {
 		tags = map[string]string{}
@@ -31,6 +34,7 @@ func (a *Accumulator) Add(measurement string, value interface{}, tags map[string
 	)
 }
 
+// AddValuesWithTime adds a measurement point with a specified timestamp.
 func (a *Accumulator) AddValuesWithTime(
 	measurement string,
 	values map[string]interface{},
@@ -48,6 +52,7 @@ func (a *Accumulator) AddValuesWithTime(
 	)
 }
 
+// Get gets the specified measurement point from the accumulator
 func (a *Accumulator) Get(measurement string) (*Point, bool) {
 	for _, p := range a.Points {
 		if p.Measurement == measurement {
@@ -58,6 +63,8 @@ func (a *Accumulator) Get(measurement string) (*Point, bool) {
 	return nil, false
 }
 
+// CheckValue checks that the accumulators point for the given measurement
+// is the same as the given value.
 func (a *Accumulator) CheckValue(measurement string, val interface{}) bool {
 	for _, p := range a.Points {
 		if p.Measurement == measurement {
@@ -68,11 +75,22 @@ func (a *Accumulator) CheckValue(measurement string, val interface{}) bool {
 	return false
 }
 
-func (a *Accumulator) CheckTaggedValue(measurement string, val interface{}, tags map[string]string) bool {
+// CheckTaggedValue calls ValidateTaggedValue
+func (a *Accumulator) CheckTaggedValue(
+	measurement string,
+	val interface{},
+	tags map[string]string,
+) bool {
 	return a.ValidateTaggedValue(measurement, val, tags) == nil
 }
 
-func (a *Accumulator) ValidateTaggedValue(measurement string, val interface{}, tags map[string]string) error {
+// ValidateTaggedValue validates that the given measurement and value exist
+// in the accumulator and with the given tags.
+func (a *Accumulator) ValidateTaggedValue(
+	measurement string,
+	val interface{},
+	tags map[string]string,
+) error {
 	if tags == nil {
 		tags = map[string]string{}
 	}
@@ -83,7 +101,8 @@ func (a *Accumulator) ValidateTaggedValue(measurement string, val interface{}, t
 
 		if p.Measurement == measurement {
 			if p.Values["value"] != val {
-				return fmt.Errorf("%v (%T) != %v (%T)", p.Values["value"], p.Values["value"], val, val)
+				return fmt.Errorf("%v (%T) != %v (%T)",
+					p.Values["value"], p.Values["value"], val, val)
 			}
 			return nil
 		}
@@ -92,10 +111,12 @@ func (a *Accumulator) ValidateTaggedValue(measurement string, val interface{}, t
 	return fmt.Errorf("unknown measurement %s with tags %v", measurement, tags)
 }
 
+// ValidateValue calls ValidateTaggedValue
 func (a *Accumulator) ValidateValue(measurement string, val interface{}) error {
 	return a.ValidateTaggedValue(measurement, val, nil)
 }
 
+// HasIntValue returns true if the measurement has an Int value
 func (a *Accumulator) HasIntValue(measurement string) bool {
 	for _, p := range a.Points {
 		if p.Measurement == measurement {
@@ -107,6 +128,7 @@ func (a *Accumulator) HasIntValue(measurement string) bool {
 	return false
 }
 
+// HasFloatValue returns true if the given measurement has a float value
 func (a *Accumulator) HasFloatValue(measurement string) bool {
 	for _, p := range a.Points {
 		if p.Measurement == measurement {