feat: add module to support Microsoft SQL Server (#1969)

* scaffolding

* adds mssql module

* adds tests for mssql module

* adds documentation for mssql module

* removes stale method from mssql module

* fixes mssql.md formatting

* fixes mssql.md: updates connection String method and fixes typo

* adds EULA method validation tests

* changes method signature to omit passing argument in

* fixes linting issues

* edits container image

* adds to the mssql documentation

* fixes documentation formatting

* docs: fix spaces

* chore: run mod tidy

---------

Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>
Co-authored-by: Manuel de la Peña <mdelapenya@gmail.com>

.github/dependabot.yml

@@ -149,6 +149,13 @@ updates:
         day: sunday
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /modules/mssql
+      schedule:
+        interval: monthly
+        day: sunday
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /modules/mysql
       schedule:

.github/workflows/ci.yml

@@ -106,7 +106,7 @@ jobs:
       matrix:
         go-version: [1.20.x, 1.x]
         platform: [ubuntu-latest, macos-latest]
-        module: [artemis, cassandra, clickhouse, compose, couchbase, elasticsearch, gcloud, k3s, k6, kafka, localstack, mariadb, mongodb, mysql, nats, neo4j, postgres, pulsar, rabbitmq, redis, redpanda, vault]
+        module: [artemis, cassandra, clickhouse, compose, couchbase, elasticsearch, gcloud, k3s, k6, kafka, localstack, mariadb, mongodb, mssql, mysql, nats, neo4j, postgres, pulsar, rabbitmq, redis, redpanda, vault]
         exclude:
           - go-version: 1.20.x
             module: compose

.vscode/.testcontainers-go.code-workspace

@@ -73,6 +73,10 @@
             "name": "module / mongodb",
             "path": "../modules/mongodb"
         },
+        {
+            "name": "module / mssql",
+            "path": "../modules/mssql"
+        },
         {
             "name": "module / mysql",
             "path": "../modules/mysql"

docs/modules/mssql.md

@@ -0,0 +1,72 @@
+# MS SQL Server
+
+Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+## Introduction
+
+The Testcontainers module for MS SQL Server.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the MS SQL Server module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/mssql
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a MS SQL Server container](../../modules/mssql/examples_test.go) inside_block:runMSSQLServerContainer
+<!--/codeinclude-->
+
+!!! warning "EULA Acceptance"
+    Due to licensing restrictions you are required to explicitly accept an End User License Agreement (EULA) for the MS SQL Server container image. This is facilitated through the `WithAcceptEULA` function.
+
+    Please see the [`microsoft-mssql-server` image documentation](https://hub.docker.com/_/microsoft-mssql-server#environment-variables) for a link to the EULA document.
+
+## Module reference
+
+The MS SQL Server module exposes one entrypoint function to create the MS SQL Server container, and this function receives two parameters:
+
+```golang
+func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*MSSQLServerContainer, error)
+```
+
+- `context.Context`, the Go context.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the MS SQL Server container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different MS SQL Server Docker image, you can use `testcontainers.WithImage` with a valid Docker image
+for MS SQL Server. E.g. `testcontainers.WithImage("mcr.microsoft.com/mssql/server:2022-RTM-GDR1-ubuntu-20.04")`.
+
+#### End User License Agreement
+
+Due to licensing restrictions you are required to explicitly accept an EULA for this container image. To do so, you must use the function `mssql.WithAcceptEula()`. Failure to include this will result in the container failing to start.
+
+#### Password
+
+If you need to set a different MS SQL Server password, you can use `mssql.WithPassword` with a valid password for MS SQL Server. E.g. `mssql.WithPassword("SuperStrong@Passw0rd")`.
+
+!!!info
+    If you set a custom password string, it must adhere to the MS SQL Server [Password Policy](https://learn.microsoft.com/en-us/sql/relational-databases/security/password-policy?view=sql-server-ver16).
+
+{% include "../features/common_functional_options.md" %}
+
+### Container Methods
+
+The MS SQL Server container exposes the following methods:
+
+#### ConnectionString
+
+This method returns the connection string to connect to the Microsoft SQL Server container, using the default `1433` port.
+It's possible to pass extra parameters to the connection string, e.g. `encrypt=false` or `TrustServerCertificate=true`, in a variadic way.
+
+```golang
+connectionString, err := container.ConnectionString(ctx, "encrypt=false", "TrustServerCertificate=true")
+```

mkdocs.yml

@@ -75,6 +75,7 @@ nav:
         - modules/localstack.md
         - modules/mariadb.md
         - modules/mongodb.md
+        - modules/mssql.md
         - modules/mysql.md
         - modules/nats.md
         - modules/neo4j.md

modules/mssql/Makefile

@@ -0,0 +1,5 @@
+include ../../commons-test.mk
+
+.PHONY: test
+test:
+	$(MAKE) test-mssql

modules/mssql/examples_test.go

@@ -0,0 +1,43 @@
+package mssql_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/mssql"
+)
+
+func ExampleRunContainer() {
+	// runMSSQLServerContainer {
+	ctx := context.Background()
+
+	password := "SuperStrong@Passw0rd"
+
+	mssqlContainer, err := mssql.RunContainer(ctx,
+		testcontainers.WithImage("mcr.microsoft.com/mssql/server:2022-RTM-GDR1-ubuntu-20.04"),
+		mssql.WithAcceptEULA(),
+		mssql.WithPassword(password),
+	)
+	if err != nil {
+		panic(err)
+	}
+
+	// Clean up the container
+	defer func() {
+		if err := mssqlContainer.Terminate(ctx); err != nil {
+			panic(err)
+		}
+	}()
+	// }
+
+	state, err := mssqlContainer.State(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(state.Running)
+
+	// Output:
+	// true
+}

modules/mssql/go.mod

@@ -0,0 +1,59 @@
+module github.com/testcontainers/testcontainers-go/modules/mssql
+
+go 1.20
+
+require (
+	github.com/microsoft/go-mssqldb v1.6.0
+	github.com/testcontainers/testcontainers-go v0.26.0
+)
+
+require (
+	dario.cat/mergo v1.0.0 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.6.1 // indirect
+	github.com/Microsoft/hcsshim v0.11.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/containerd/containerd v1.7.7 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/cpuguy83/dockercfg v0.3.1 // indirect
+	github.com/docker/distribution v2.8.2+incompatible // indirect
+	github.com/docker/docker v24.0.7+incompatible // indirect
+	github.com/docker/go-connections v0.4.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect
+	github.com/golang-sql/sqlexp v0.1.0 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/uuid v1.4.0 // indirect
+	github.com/klauspost/compress v1.16.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/term v0.5.0 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc5 // indirect
+	github.com/opencontainers/runc v1.1.5 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
+	github.com/shirou/gopsutil/v3 v3.23.11 // indirect
+	github.com/shoenig/go-m1cpu v0.1.6 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
+	golang.org/x/crypto v0.14.0 // indirect
+	golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea // indirect
+	golang.org/x/mod v0.9.0 // indirect
+	golang.org/x/net v0.17.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/tools v0.7.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 // indirect
+	google.golang.org/grpc v1.57.1 // indirect
+	google.golang.org/protobuf v1.30.0 // indirect
+)
+
+replace github.com/testcontainers/testcontainers-go => ../..