Deprecate containertest and mysqltest officially (#277)

containertest now aliases the external package.

Author: sethvargo

containertest/README.md

@@ -1,5 +1,10 @@
 # Mysqltest library
 
+> [!CAUTION]
+>
+> This library is deprecated and will be removed in a future version. Use the
+> standalone version at https://github.com/abcxyz/containertest instead.
+
 ## Introduction
 
 This is a Go library for starting an ephemeral Docker container. It is used to test

containertest/config.go

@@ -15,75 +15,43 @@
 package containertest
 
 import (
-	"log"
+	"github.com/abcxyz/containertest"
 )
 
 // This file implements the "functional options" pattern.
 
-type config struct {
-	killAfterSec   int // This is in integer seconds because that's what Docker takes.
-	service        Service
-	progressLogger TestLogger
-}
-
-// TestLogger allows the caller to optionally provide a custom logger for printing status updates about
-// service startup progress. The default is to use the go "log" package.
-// testing.TB satisfies TestLogger, and is usually what you want to put here.
-type TestLogger interface {
-	Log(args ...any)
-	Logf(format string, args ...any)
-}
-
-func makeDefaultConfig(service Service) *config {
-	return &config{
-		killAfterSec:   10 * 60,
-		service:        service,
-		progressLogger: &stdlibLogger{},
-	}
-}
-
-func buildConfig(service Service, opts ...Option) *config {
-	config := makeDefaultConfig(service)
-	for _, opt := range opts {
-		config = opt(config)
-	}
-	return config
-}
-
-// Option sets a configuration option for this package. Users should not implement these functions,
-// they should use one of the With* functions.
-type Option func(*config) *config
-
-// WithKillAfterSeconds is an option that overrides the default time period after which the docker
-// container will kill itself.
+// TestLogger allows the caller to optionally provide a custom logger for
+// printing status updates about service startup progress. The default is to use
+// the go "log" package. testing.TB satisfies TestLogger, and is usually what
+// you want to put here.
 //
-// Containers might bypass the normal clean shutdown logic if the test terminates abnormally, such
-// as when ctrl-C is pressed during a test. Therefore we instruct the container to kill itself after
-// a while. The duration must be longer than longest test that uses the container. There's no harm in
-// leaving lots of extra time.
-func WithKillAfterSeconds(seconds int) Option {
-	return func(c *config) *config {
-		c.killAfterSec = seconds
-		return c
-	}
-}
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.TestLogger] instead.
+type TestLogger = containertest.TestLogger
 
-// WithLogger overrides the default logger. This logger will receive messages about service startup
-// progress. The default is to use the go "log" package.
-func WithLogger(l TestLogger) Option {
-	return func(c *config) *config {
-		c.progressLogger = l
-		return c
-	}
-}
-
-// stdlibLogger is the default implementation of the TestLogger interface that calls log.Logf.
-type stdlibLogger struct{}
+// Option sets a configuration option for this package. Users should not
+// implement these functions, they should use one of the With* functions.
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.Option] instead.
+type Option = containertest.Option
 
-func (s *stdlibLogger) Logf(fmtStr string, args ...any) {
-	log.Printf(fmtStr, args...)
-}
+// WithKillAfterSeconds is an option that overrides the default time period
+// after which the docker container will kill itself.
+//
+// Containers might bypass the normal clean shutdown logic if the test
+// terminates abnormally, such as when ctrl-C is pressed during a test.
+// Therefore we instruct the container to kill itself after a while. The
+// duration must be longer than longest test that uses the container. There's no
+// harm in leaving lots of extra time.
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.WithKillAfterSeconds] instead.
+var WithKillAfterSeconds = containertest.WithKillAfterSeconds
 
-func (s *stdlibLogger) Log(args ...any) {
-	log.Print(args...)
-}
+// WithLogger overrides the default logger. This logger will receive messages
+// about service startup progress. The default is to use the go "log" package.
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.WithLogger] instead.
+var WithLogger = containertest.WithLogger

containertest/containertest.go

@@ -12,62 +12,34 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package containertest provides an ephemeral container (such as a database) for integration testing.
-// It's designed to be used in code that needs to work inside and outside google.
+// Package containertest provides an ephemeral container (such as a database)
+// for integration testing. It's designed to be used in code that needs to work
+// inside and outside google.
+//
+// Deprecated: Use the standalone [github.com/abcxyz/containertest] package
+// instead.
 package containertest
 
 import (
-	"fmt"
-	"io"
+	"github.com/abcxyz/containertest"
 )
 
 // ConnInfo specifies how connect to the created container.
-type ConnInfo struct {
-	Host string
-
-	// PortMapper maps from container port to host port. Do not use after container is closed.
-	PortMapper func(containerPort string) (hostPort string)
-
-	// io.Closer for closing the connection. Should always be initialized, either
-	// with an actual closer or io.NoopCloser.
-	closer io.Closer
-}
-
-// Close implements io.Closer by passing to internal closer field.
-func (c ConnInfo) Close() error {
-	return fmt.Errorf("error closing container: %w", c.closer.Close())
-}
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.ConnInfo] instead.
+type ConnInfo = containertest.ConnInfo
 
 // Service provides information about what container image should be started and
 // how to know when it has finished stating up.
-type Service interface {
-	// ImageRepository returns the repository for docker image (ex: mysql).
-	ImageRepository() string
-
-	// ImageTag returns the tag for docker image (ex: 5.3).
-	ImageTag() string
-
-	// Environment returns variables to be set in container. Each element is in format of "KEY=VALUE".
-	Environment() []string
-
-	// StartupPorts is the list of ports that must be exposed by container before TestConn is run.
-	StartupPorts() []string
-
-	// TestConn takes a logger and a struct with connection info, and returns nil if app has started.
-	TestConn(progressLogger TestLogger, info *ConnInfo) error
-}
-
-// Start starts a container, or returns an error. On err ConnInfo will be automatically
-// closed and nil will be returned.
-func Start(service Service, opts ...Option) (*ConnInfo, error) {
-	conf := buildConfig(service, opts...)
-	ci, err := start(conf)
-	if err != nil {
-		// The Closer must be called even if there's an error, to clean up the docker container that may
-		// exist.
-		_ = ci.Close()
-		return nil, err
-	}
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.Service] instead.
+type Service = containertest.Service
 
-	return ci, nil
-}
+// Start starts a container, or returns an error. On err ConnInfo will be
+// automatically closed and nil will be returned.
+//
+// Deprecated: This has moved to a new package. Use
+// [github.com/abcxyz/containertest.Start] instead.
+var Start = containertest.Start