Initial commit

.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+
+language: go
+go:
+  - "1.11.x"
+  - "1.x"
+env:
+  - GO111MODULE=on
+
+before_install:
+  - go mod download
+  - go get -u golang.org/x/lint/golint
+  - go get github.com/mattn/goveralls
+
+script:
+  - golint ./...
+  - go vet ./...
+  - go test -covermode=count -coverprofile=profile.cov ./...
+  - goveralls -coverprofile=profile.cov -service=travis-ci
+
+notifications:
+  email:
+    on_success: never
+    on_failure: always

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENCE

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Nicholas Wiersma
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1 @@
+include github.com/hamba/make/golang

README.md

@@ -0,0 +1,35 @@
+![Logo](http://svg.wiersma.co.za/github/project?lang=go&title=cmd&tag=Go%20cmd%20helper)
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/hamba/cmd)](https://goreportcard.com/report/github.com/hamba/cmd)
+[![Build Status](https://travis-ci.com/hamba/cmd.svg?branch=master)](https://travis-ci.com/hamba/cmd)
+[![Coverage Status](https://coveralls.io/repos/github/hamba/cmd/badge.svg?branch=master)](https://coveralls.io/github/hamba/cmd?branch=master)
+[![GoDoc](https://godoc.org/github.com/hamba/cmd?status.svg)](https://godoc.org/github.com/hamba/cmd)
+[![GitHub release](https://img.shields.io/github/release/hamba/cmd.svg)](https://github.com/hamba/cmd/releases)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/hamba/cmd/master/LICENSE)
+
+Go cmd helper. 
+
+This provides helpers on top of `github.com/urfave/cli`.
+
+## Overview
+
+Install with:
+
+```shell
+go get github.com/hamba/cmd
+```
+
+## Example
+
+```go
+func yourAction(c *cli.Context) error {
+    ctx, err := cmd.NewContext(c)
+    if err != nil {
+        return err
+    }
+
+    // Run your application here...
+
+    <-cmd.WaitForSignals()
+}
+```

context.go

@@ -0,0 +1,73 @@
+package cmd
+
+import (
+	"io"
+
+	"github.com/hamba/pkg/log"
+	"github.com/hamba/pkg/stats"
+	"gopkg.in/urfave/cli.v1"
+)
+
+// Context represents an application context.
+//
+// Context implements both log.Loggable and stats.Statable.
+type Context struct {
+	*cli.Context
+
+	logger  log.Logger
+	statter stats.Statter
+}
+
+// NewContext creates a new Context from the CLI Context.
+func NewContext(c *cli.Context) (*Context, error) {
+	l, err := NewLogger(c)
+	if err != nil {
+		return nil, err
+	}
+
+	s, err := NewStats(c, l)
+	if err != nil {
+		return nil, err
+	}
+
+	ctx := &Context{
+		Context: c,
+		logger:  l,
+		statter: s,
+	}
+
+	return ctx, nil
+}
+
+// Logger returns the Logger attached to the Context.
+func (c *Context) Logger() log.Logger {
+	return c.logger
+}
+
+// AttachLogger attaches a Logger to the Context.
+func (c *Context) AttachLogger(fn func(l log.Logger) log.Logger) {
+	c.logger = fn(c.logger)
+}
+
+// Statter returns the Statter attached to the Context.
+func (c *Context) Statter() stats.Statter {
+	return c.statter
+}
+
+// AttachStatter attaches a Statter to the Context.
+func (c *Context) AttachStatter(fn func(s stats.Statter) stats.Statter) {
+	c.statter = fn(c.statter)
+}
+
+// Close closes the context.
+func (c *Context) Close() error {
+	if err := c.statter.Close(); err != nil {
+		return err
+	}
+
+	if l, ok := c.logger.(io.Closer); ok {
+		return l.Close()
+	}
+
+	return nil
+}

context_test.go

@@ -0,0 +1,160 @@
+package cmd_test
+
+import (
+	"errors"
+	"flag"
+	"testing"
+	"time"
+
+	"github.com/hamba/cmd"
+	"github.com/hamba/pkg/log"
+	"github.com/hamba/pkg/stats"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	"gopkg.in/urfave/cli.v1"
+)
+
+func TestNewContext(t *testing.T) {
+	c, _ := newTestContext()
+
+	ctx, err := cmd.NewContext(c)
+
+	assert.NoError(t, err)
+	assert.IsType(t, &cmd.Context{}, ctx)
+}
+
+func TestNewContext_LoggerError(t *testing.T) {
+	c, flags := newTestContext()
+	flags.String(cmd.FlagLogLevel, "test", "")
+
+	_, err := cmd.NewContext(c)
+
+	assert.Error(t, err)
+}
+
+func TestNewContext_StatterError(t *testing.T) {
+	c, flags := newTestContext()
+	flags.String(cmd.FlagStatsDSN, "test://", "")
+
+	_, err := cmd.NewContext(c)
+
+	assert.Error(t, err)
+}
+
+func TestContext_Logger(t *testing.T) {
+	l := new(MockLogger)
+	c, _ := newTestContext()
+	ctx, _ := cmd.NewContext(c)
+	ctx.AttachLogger(func(log.Logger) log.Logger { return l })
+
+	assert.Equal(t, l, ctx.Logger())
+}
+
+func TestContext_Statter(t *testing.T) {
+	s := new(MockStats)
+	c, _ := newTestContext()
+	ctx, _ := cmd.NewContext(c)
+	ctx.AttachStatter(func(stats.Statter) stats.Statter { return s })
+
+	assert.Equal(t, s, ctx.Statter())
+}
+
+func TestContext_Close(t *testing.T) {
+	c, _ := newTestContext()
+	ctx, _ := cmd.NewContext(c)
+	ctx.AttachLogger(func(log.Logger) log.Logger { return log.Null })
+	ctx.AttachStatter(func(stats.Statter) stats.Statter { return stats.Null })
+
+	err := ctx.Close()
+
+	assert.NoError(t, err)
+}
+
+func TestContext_CloseErrors(t *testing.T) {
+	tests := []struct {
+		name     string
+		logErr   error
+		statsErr error
+	}{
+		{
+			name:     "No Error",
+			logErr:   nil,
+			statsErr: nil,
+		},
+		{
+			name:     "Logger Error",
+			logErr:   errors.New("test"),
+			statsErr: nil,
+		},
+		{
+			name:     "Stats Error",
+			logErr:   nil,
+			statsErr: errors.New("test"),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			l := new(MockLogger)
+			l.On("Close").Return(tt.logErr)
+
+			s := new(MockStats)
+			s.On("Close").Return(tt.statsErr)
+
+			c, _ := newTestContext()
+			ctx, _ := cmd.NewContext(c)
+			ctx.AttachLogger(func(log.Logger) log.Logger { return l })
+			ctx.AttachStatter(func(stats.Statter) stats.Statter { return s })
+
+			err := ctx.Close()
+
+			if tt.logErr != nil || tt.statsErr != nil {
+				assert.Error(t, err)
+				return
+			}
+
+			assert.NoError(t, err)
+		})
+	}
+}
+
+func newTestContext() (*cli.Context, *flag.FlagSet) {
+	fs := flag.NewFlagSet("test", flag.ContinueOnError)
+	c := cli.NewContext(cli.NewApp(), fs, nil)
+
+	return c, fs
+}
+
+type MockLogger struct {
+	mock.Mock
+}
+
+func (m *MockLogger) Debug(msg string, ctx ...interface{}) {}
+
+func (m *MockLogger) Info(msg string, ctx ...interface{}) {}
+
+func (m *MockLogger) Warn(msg string, ctx ...interface{}) {}
+
+func (m *MockLogger) Error(msg string, ctx ...interface{}) {}
+
+func (m *MockLogger) Crit(msg string, ctx ...interface{}) {}
+
+func (m *MockLogger) Close() error {
+	args := m.Called()
+	return args.Error(0)
+}
+
+type MockStats struct {
+	mock.Mock
+}
+
+func (m *MockStats) Inc(name string, value int64, rate float32, tags ...interface{}) {}
+
+func (m *MockStats) Gauge(name string, value float64, rate float32, tags ...interface{}) {}
+
+func (m *MockStats) Timing(name string, value time.Duration, rate float32, tags ...interface{}) {}
+
+func (m *MockStats) Close() error {
+	args := m.Called()
+	return args.Error(0)
+}