feat (testdirectory): add WithHost(...) option

Author: jimlambrt

testdirectory/directory.go

@@ -62,6 +62,7 @@ type Directory struct {
 	s      *gldap.Server
 	logger hclog.Logger
 	port   int
+	host   string
 	useTLS bool
 	client *tls.Config
 	server *tls.Config
@@ -101,6 +102,7 @@ func Start(t TestingT, opt ...Option) *Directory {
 		users:              opts.withDefaults.Users,
 		groups:             opts.withDefaults.Groups,
 		port:               opts.withPort,
+		host:               opts.withHost,
 		userDN:             opts.withDefaults.UserDN,
 		groupDN:            opts.withDefaults.GroupDN,
 		allowAnonymousBind: opts.withDefaults.AllowAnonymousBind,
@@ -148,7 +150,7 @@ func Start(t TestingT, opt ...Option) *Directory {
 		d.logger.Debug("not using TLS")
 	}
 	go func() {
-		_ = d.s.Run(fmt.Sprintf(":%d", opts.withPort), connOpts...)
+		_ = d.s.Run(fmt.Sprintf("%s:%d", opts.withHost, opts.withPort), connOpts...)
 	}()
 
 	if v, ok := interface{}(t).(CleanupT); ok {
@@ -737,12 +739,12 @@ func (d *Directory) Conn() *ldap.Conn {
 	err := backoff.Retry(func() error {
 		var connErr error
 		if d.useTLS {
-			if conn, connErr = ldap.DialURL(fmt.Sprintf("ldaps://localhost:%d", d.Port()), ldap.DialWithTLSConfig(d.client)); connErr != nil {
+			if conn, connErr = ldap.DialURL(fmt.Sprintf("ldaps://%s:%d", d.Host(), d.Port()), ldap.DialWithTLSConfig(d.client)); connErr != nil {
 				return retryErrFn(connErr)
 			}
 			return nil
 		}
-		if conn, connErr = ldap.DialURL(fmt.Sprintf("ldap://localhost:%d", d.Port())); connErr != nil {
+		if conn, connErr = ldap.DialURL(fmt.Sprintf("ldap://%s:%d", d.Host(), d.Port())); connErr != nil {
 			return retryErrFn(connErr)
 		}
 		return nil
@@ -777,6 +779,14 @@ func (d *Directory) Port() int {
 	return d.port
 }
 
+// Host returns the host the directory is listening on
+func (d *Directory) Host() string {
+	if v, ok := interface{}(d.t).(HelperT); ok {
+		v.Helper()
+	}
+	return d.host
+}
+
 // ClientCert returns the pem-encoded certificate which can be used by a client
 // for mTLS.
 func (d *Directory) ClientCert() string {

testdirectory/directory_test.go

@@ -33,6 +33,7 @@ func Test_Start(t *testing.T) {
 		td := testdirectory.Start(
 			t,
 			testdirectory.WithPort(t, port),
+			testdirectory.WithHost(t, "127.0.0.1"),
 			testdirectory.WithDefaults(t, &testdirectory.Defaults{Users: testEntries}),
 			testdirectory.WithLogger(t, testLogger),
 			testdirectory.WithNoTLS(t),
@@ -50,6 +51,7 @@ func Test_Start(t *testing.T) {
 		port := testdirectory.FreePort(t)
 		td := testdirectory.Start(
 			t,
+			testdirectory.WithHost(t, "0.0.0.0"),
 			testdirectory.WithPort(t, port),
 			testdirectory.WithDefaults(t, &testdirectory.Defaults{Users: testEntries}),
 			testdirectory.WithLogger(t, testLogger),

testdirectory/options.go

@@ -1,6 +1,8 @@
 package testdirectory
 
 import (
+	"strings"
+
 	"github.com/hashicorp/go-hclog"
 	"github.com/jimlambrt/gldap"
 )
@@ -33,6 +35,7 @@ func applyOpts(opts interface{}, opt ...Option) {
 // options are the set of available options for test functions
 type options struct {
 	withPort                 int
+	withHost                 string
 	withLogger               hclog.Logger
 	withNoTLS                bool
 	withMTLS                 bool
@@ -56,6 +59,7 @@ func defaults(t TestingT) options {
 
 	return options{
 		withLogger: debugLogger,
+		withHost:   "localhost",
 		withDefaults: &Defaults{
 			UserAttr:  DefaultUserAttr,
 			GroupAttr: DefaultGroupAttr,
@@ -172,6 +176,15 @@ func WithPort(t TestingT, port int) Option {
 	}
 }
 
+// WithHost provides an optional hostname for the directory
+func WithHost(t TestingT, host string) Option {
+	return func(o interface{}) {
+		if o, ok := o.(*options); ok {
+			o.withHost = strings.TrimSpace(host)
+		}
+	}
+}
+
 // withFirst provides the option to only find the first match.
 func withFirst(t TestingT) Option {
 	return func(o interface{}) {

testdirectory/testing.go

@@ -151,12 +151,18 @@ func GetTLSConfig(t TestingT, opt ...Option) (s *tls.Config, c *tls.Config) {
 		Bytes: privBytes,
 	})
 	require.NoError(err)
+	opts := getOpts(t, opt...)
+
+	var ipAddrs []net.IP
+	if hostIp := net.ParseIP(opts.withHost); hostIp != nil {
+		ipAddrs = append(ipAddrs, hostIp)
+	}
 
 	cert := &x509.Certificate{
 		SerialNumber:          genSerialNumber(t),
 		Subject:               certSubject,
-		IPAddresses:           []net.IP{net.IPv4(127, 0, 0, 1), net.IPv6loopback},
-		DNSNames:              []string{"localhost"},
+		IPAddresses:           ipAddrs,
+		DNSNames:              []string{opts.withHost},
 		NotBefore:             time.Now(),
 		NotAfter:              time.Now().AddDate(1, 0, 0),
 		SubjectKeyId:          []byte{1, 2, 3, 4, 6},
@@ -178,7 +184,6 @@ func GetTLSConfig(t TestingT, opt ...Option) (s *tls.Config, c *tls.Config) {
 		RootCAs: certpool,
 	}
 
-	opts := getOpts(t, opt...)
 	if opts.withMTLS {
 		// setup mTLS for certs from the ca
 		serverTLSConf.ClientCAs = certpool