Add docs for testutils package

GFM-115

core/testutils/README.md

@@ -0,0 +1,15 @@
+# Test utilities
+
+The functionality in this package is exposed both for internal testing as well
+as service testability.
+
+## InMemoryLogger
+
+If you'd like to verify that log messages are logged properly, use the
+`WithInMemoryLogger()` helper which will provider you with a `zap.Logger` you
+can pass into a service and capture recorded messages.
+
+## EnvOverride
+
+If you'd like to override environment variables, use the `EnvOverride()` helper
+and defer the reset to ensure the old value us returned at the end of the test.

core/testutils/doc.go

@@ -0,0 +1,41 @@
+// Copyright (c) 2016 Uber Technologies, Inc.
+//
+// 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.
+
+// Package testutils is the Test utilities.
+//
+// The functionality in this package is exposed both for internal testing as well
+// as service testability.
+//
+//
+// InMemoryLogger
+//
+// If you'd like to verify that log messages are logged properly, use the
+// WithInMemoryLogger() helper which will provider you with a zap.Logger you
+// can pass into a service and capture recorded messages.
+//
+//
+// EnvOverride
+//
+// If you'd like to override environment variables, use the EnvOverride() helper
+// and defer the reset to ensure the old value us returned at the end of the test.
+//
+//
+//
+package testutils

service/testutils/README.md

@@ -0,0 +1,8 @@
+# Service test utilities
+
+## WithService
+
+`WithService` provides a noop service for you to test service lifecycle
+functions if you'd like to perform end-to-end testing of your service. This
+generally isn't necessary from a service-owner perspective, but is used
+internally.

service/testutils/doc.go

@@ -0,0 +1,32 @@
+// Copyright (c) 2016 Uber Technologies, Inc.
+//
+// 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.
+
+// Package testutils is the Service test utilities.
+//
+// WithService
+//
+// WithService provides a noop service for you to test service lifecycle
+// functions if you'd like to perform end-to-end testing of your service. This
+// generally isn't necessary from a service-owner perspective, but is used
+// internally.
+//
+//
+//
+package testutils