Satisfy golint

breaker/README.md

@@ -21,7 +21,7 @@ for {
 	switch result {
 	case nil:
 		// success!
-	case breaker.BreakerOpen:
+	case breaker.ErrBreakerOpen:
 		// our function wasn't run because the breaker was open
 	default:
 		// some other error

breaker/breaker.go

@@ -7,9 +7,9 @@ import (
 	"time"
 )
 
-// BreakerOpen is the error returned from Run() when the function is not executed
+// ErrBreakerOpen is the error returned from Run() when the function is not executed
 // because the breaker is currently open.
-var BreakerOpen = errors.New("circuit breaker is open")
+var ErrBreakerOpen = errors.New("circuit breaker is open")
 
 type state int
 
@@ -43,7 +43,7 @@ func New(errorThreshold, successThreshold int, timeout time.Duration) *Breaker {
 	}
 }
 
-// Run will either return BreakerOpen immediately if the circuit-breaker is
+// Run will either return ErrBreakerOpen immediately if the circuit-breaker is
 // already open, or it will run the given function and pass along its return
 // value. It is safe to call Run concurrently on the same Breaker.
 func (b *Breaker) Run(x func() error) error {
@@ -52,7 +52,7 @@ func (b *Breaker) Run(x func() error) error {
 	b.lock.RUnlock()
 
 	if state == open {
-		return BreakerOpen
+		return ErrBreakerOpen
 	}
 
 	var panicValue interface{}

breaker/breaker_test.go

@@ -6,10 +6,10 @@ import (
 	"time"
 )
 
-var someError = errors.New("someError")
+var errSomeError = errors.New("errSomeError")
 
 func returnsError() error {
-	return someError
+	return errSomeError
 }
 
 func returnsSuccess() error {
@@ -20,7 +20,7 @@ func TestBreakerErrorExpiry(t *testing.T) {
 	breaker := New(2, 1, 1*time.Second)
 
 	for i := 0; i < 5; i++ {
-		if err := breaker.Run(returnsError); err != someError {
+		if err := breaker.Run(returnsError); err != errSomeError {
 			t.Error(err)
 		}
 		time.Sleep(1 * time.Second)
@@ -32,14 +32,14 @@ func TestBreakerStateTransitions(t *testing.T) {
 
 	// three errors opens the breaker
 	for i := 0; i < 3; i++ {
-		if err := breaker.Run(returnsError); err != someError {
+		if err := breaker.Run(returnsError); err != errSomeError {
 			t.Error(err)
 		}
 	}
 
 	// breaker is open
 	for i := 0; i < 5; i++ {
-		if err := breaker.Run(returnsError); err != BreakerOpen {
+		if err := breaker.Run(returnsError); err != ErrBreakerOpen {
 			t.Error(err)
 		}
 	}
@@ -51,11 +51,11 @@ func TestBreakerStateTransitions(t *testing.T) {
 		t.Error(err)
 	}
 	// error works, but re-opens immediately
-	if err := breaker.Run(returnsError); err != someError {
+	if err := breaker.Run(returnsError); err != errSomeError {
 		t.Error(err)
 	}
 	// breaker is open
-	if err := breaker.Run(returnsError); err != BreakerOpen {
+	if err := breaker.Run(returnsError); err != ErrBreakerOpen {
 		t.Error(err)
 	}
 
@@ -68,7 +68,7 @@ func TestBreakerStateTransitions(t *testing.T) {
 		}
 	}
 	// error works
-	if err := breaker.Run(returnsError); err != someError {
+	if err := breaker.Run(returnsError); err != errSomeError {
 		t.Error(err)
 	}
 	// breaker is still closed
@@ -90,7 +90,7 @@ func ExampleBreaker() {
 		switch result {
 		case nil:
 			// success!
-		case BreakerOpen:
+		case ErrBreakerOpen:
 			// our function wasn't run because the breaker was open
 		default:
 			// some other error