Add context to all Status funcs

checkers/README.md

@@ -5,7 +5,7 @@ types of dependencies.
 
 If a pre-built checker is not available, you can create your own checkers by
 implementing the `ICheckable` interface (which consists of a single method -
-`Status() (interface{}, error)`).
+`Status(context.Context) (interface{}, error)`).
 
 If you do create a custom-checker - consider opening a PR and adding it to the
 list of built-in checkers.
@@ -44,17 +44,19 @@ The SQL DB checker has implementations for the following interfaces:
 - `SQLExecer`, which encloses `ExecContext` in [`sql.DB`](https://golang.org/pkg/database/sql/#DB.ExecContext), [`sql.Conn`](https://golang.org/pkg/database/sql/#Conn.ExecContext), [`sql.Stmt`](https://golang.org/pkg/database/sql/#Stmt.ExecContext), and [`sql.Tx`](https://golang.org/pkg/database/sql/#Tx.ExecContext)
 
 #### SQLConfig
-The `SQLConfig` struct is required when using the SQL DB health check.  It **must** contain an inplementation of one of either `SQLPinger`, `SQLQueryer`, or `SQLExecer`.
+
+The `SQLConfig` struct is required when using the SQL DB health check. It **must** contain an inplementation of one of either `SQLPinger`, `SQLQueryer`, or `SQLExecer`.
 
 If `SQLQueryer` or `SQLExecer` are implemented, then `Query` must be valid (len > 0).
 
-Additionally, if `SQLQueryer` or `SQLExecer` are implemented, you have the option to also set either the `QueryerResultHandler` or `ExecerResultHandler` functions.  These functions allow you to evaluate the result of a query or exec operation.  If you choose not to implement these yourself, the default handlers are used.
+Additionally, if `SQLQueryer` or `SQLExecer` are implemented, you have the option to also set either the `QueryerResultHandler` or `ExecerResultHandler` functions. These functions allow you to evaluate the result of a query or exec operation. If you choose not to implement these yourself, the default handlers are used.
 
 The default `ExecerResultHandler` is successful if the passed exec operation affected one and only one row.
 
 The default `QueryerResultHandler` is successful if the passed query operation returned one and only one row.
 
 #### SQLPinger
+
 Use the `SQLPinger` interface if your health check is only concerned with your application's database connectivity. All you need to do is set the `Pinger` value in your `SQLConfig`.
 
 ```golang
@@ -80,11 +82,13 @@ Use the `SQLPinger` interface if your health check is only concerned with your a
 ```
 
 #### SQLQueryer
-Use the `SQLQueryer` interface if your health check requires you to read rows from your database.  You can optionally supply a query result handler function.  If you don't supply one, the default function will be used.  The function signature for the handler is:
+
+Use the `SQLQueryer` interface if your health check requires you to read rows from your database. You can optionally supply a query result handler function. If you don't supply one, the default function will be used. The function signature for the handler is:
 
 ```golang
 type SQLQueryerResultHandler func(rows *sql.Rows) (bool, error)
 ```
+
 The default query handler returns true if there was exactly one row in the resultset:
 
 ```golang
@@ -146,7 +150,8 @@ Sample `SQLQueryer` implementation:
 ```
 
 #### SQLExecer
-Use the `SQLExecer` interface if your health check requires you to update or insert to your database.  You can optionally supply an exec result handler function.  If you don't supply one, the default function will be used.  The function signature for the handler is:
+
+Use the `SQLExecer` interface if your health check requires you to update or insert to your database. You can optionally supply an exec result handler function. If you don't supply one, the default function will be used. The function signature for the handler is:
 
 ```golang
 type SQLExecerResultHandler func(result sql.Result) (bool, error)

checkers/disk/disk_usage.go

@@ -1,6 +1,7 @@
 package diskchk
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/shirou/gopsutil/disk"
@@ -10,9 +11,12 @@ import (
 //
 // "Path" is _required_; path to check directory/drive (ex. /home/user)
 // "WarningThreshold" is _required_; set percent (more than 0 and less 100) of free space at specified path,
-//  which triggers warning.
+//
+//	which triggers warning.
+//
 // "CriticalThreshold" is _required_; set percent (more than 0 and less 100) of free space at specified path,
-//  which triggers critical.
+//
+//	which triggers critical.
 type DiskUsageConfig struct {
 	Path              string
 	WarningThreshold  float64
@@ -40,7 +44,7 @@ func NewDiskUsage(cfg *DiskUsageConfig) (*DiskUsage, error) {
 
 // Status is used for performing a diskusage check against a dependency; it satisfies
 // the "ICheckable" interface.
-func (d *DiskUsage) Status() (interface{}, error) {
+func (d *DiskUsage) Status(ctx context.Context) (interface{}, error) {
 	stats, err := disk.Usage(d.Config.Path)
 
 	if err != nil {

checkers/disk/disk_usage_test.go

@@ -1,6 +1,7 @@
 package diskchk
 
 import (
+	"context"
 	"os"
 	"testing"
 
@@ -98,7 +99,7 @@ func TestDiskUsageStatus(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		_, err = du.Status()
+		_, err = du.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("Error getting disk usage"))
 	})
@@ -115,7 +116,7 @@ func TestDiskUsageStatus(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		_, err = du.Status()
+		_, err = du.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("Critical: disk usage too high"))
 	})
@@ -131,7 +132,7 @@ func TestDiskUsageStatus(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		_, err = du.Status()
+		_, err = du.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("Warning: disk usage too high"))
 	})
@@ -147,7 +148,7 @@ func TestDiskUsageStatus(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		_, err = du.Status()
+		_, err = du.Status(context.TODO())
 		Expect(err).To(BeNil())
 	})
 }

checkers/http.go

@@ -2,6 +2,7 @@ package checkers
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -63,7 +64,7 @@ func NewHTTP(cfg *HTTPConfig) (*HTTP, error) {
 
 // Status is used for performing an HTTP check against a dependency; it satisfies
 // the "ICheckable" interface.
-func (h *HTTP) Status() (interface{}, error) {
+func (h *HTTP) Status(ctx context.Context) (interface{}, error) {
 	resp, err := h.do()
 	if err != nil {
 		return nil, err

checkers/http_test.go

@@ -1,6 +1,7 @@
 package checkers
 
 import (
+	"context"
 	"math"
 	"net/http"
 	"net/http/httptest"
@@ -9,6 +10,7 @@ import (
 	"time"
 
 	"fmt"
+
 	. "github.com/onsi/gomega"
 )
 
@@ -164,7 +166,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 		Expect(err).ToNot(HaveOccurred())
 		Expect(data).To(BeNil())
 	})
@@ -179,7 +181,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("unsupported protocol"))
 		Expect(data).To(BeNil())
@@ -201,7 +203,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("does not match expected status code"))
 		Expect(data).To(BeNil())
@@ -225,7 +227,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("does not contain expected content"))
 		Expect(data).To(BeNil())
@@ -249,7 +251,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 		Expect(err).ToNot(HaveOccurred())
 		Expect(data).To(BeNil())
 	})
@@ -277,7 +279,7 @@ func TestHTTPStatus(t *testing.T) {
 		checker, err := NewHTTP(cfg)
 		Expect(err).ToNot(HaveOccurred())
 
-		data, err := checker.Status()
+		data, err := checker.Status(context.TODO())
 
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(ContainSubstring("Unable to read response body to perform content expectancy check"))

checkers/memcache/memcached.go

@@ -2,6 +2,7 @@ package memcachechk
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"net"
 	"net/url"
@@ -83,7 +84,7 @@ func NewMemcached(cfg *MemcachedConfig) (*Memcached, error) {
 	}, nil
 }
 
-func (mc *Memcached) Status() (interface{}, error) {
+func (mc *Memcached) Status(ctx context.Context) (interface{}, error) {
 
 	if mc.Config.Ping {
 		if _, err := net.Dial("tcp", mc.Config.Url); err != nil {

checkers/memcache/memcached_test.go

@@ -1,6 +1,7 @@
 package memcachechk
 
 import (
+	"context"
 	"fmt"
 	"math/rand"
 	"strconv"
@@ -140,10 +141,10 @@ func TestMemcachedStatus(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		_, err = checker.Status()
+		_, err = checker.Status(context.TODO())
 		Expect(err).To(HaveOccurred())
 
-		_, err = checker.Status()
+		_, err = checker.Status(context.TODO())
 		Expect(err.Error()).To(ContainSubstring("Ping failed"))
 	})
 
@@ -162,7 +163,7 @@ func TestMemcachedStatus(t *testing.T) {
 			// Mark server is stoppped
 			server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).To(HaveOccurred())
 			Expect(err.Error()).To(ContainSubstring("Unable to complete set"))
 		})
@@ -180,7 +181,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).ToNot(HaveOccurred())
 
 			val, err := checker.wrapper.GetClient().Get(cfg.Set.Key)
@@ -200,7 +201,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).ToNot(HaveOccurred())
 
 			val, err := checker.wrapper.GetClient().Get(cfg.Set.Key)
@@ -221,7 +222,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).ToNot(HaveOccurred())
 
 			val, err := checker.wrapper.GetClient().Get(cfg.Set.Key)
@@ -243,7 +244,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).To(HaveOccurred())
 
 			Expect(err.Error()).To(ContainSubstring(fmt.Sprintf("Unable to complete get: '%v' not found", cfg.Get.Key)))
@@ -262,7 +263,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).ToNot(HaveOccurred())
 		})
 
@@ -281,7 +282,7 @@ func TestMemcachedStatus(t *testing.T) {
 			// Close the server so the GET fails
 			server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).To(HaveOccurred())
 			Expect(err.Error()).To(ContainSubstring("Unable to complete get"))
 		})
@@ -304,7 +305,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).To(HaveOccurred())
 			Expect(err.Error()).To(ContainSubstring("does not match expected value"))
 		})
@@ -325,7 +326,7 @@ func TestMemcachedStatus(t *testing.T) {
 			}
 			defer server.Close()
 
-			_, err = checker.Status()
+			_, err = checker.Status(context.TODO())
 			Expect(err).ToNot(HaveOccurred())
 		})
 	})

checkers/reachable.go

@@ -1,6 +1,7 @@
 package checkers
 
 import (
+	"context"
 	"net"
 	"net/url"
 	"time"
@@ -87,7 +88,7 @@ func NewReachableChecker(cfg *ReachableConfig) (*ReachableChecker, error) {
 }
 
 // Status checks if the endpoint is reachable
-func (r *ReachableChecker) Status() (interface{}, error) {
+func (r *ReachableChecker) Status(ctx context.Context) (interface{}, error) {
 	// We must provide a port so when a port is not set in the URL provided use
 	// the default port (80)
 	port := r.url.Port()