Mssqlserver

Author: cristianrgreco

docs/modules/mssqlserver.md

@@ -1,6 +1,4 @@
-# MS SQL Server Module
-
-[Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server) is a relational database management system developed by Microsoft. It provides a platform for efficiently storing, managing, and retrieving structured data. MSSQL offers features for data storage, retrieval, manipulation, and analysis, making it a key component in various applications ranging from small-scale projects to enterprise-level systems.
+# MSSQL Server
 
 ## Install
 
@@ -10,27 +8,40 @@ npm install @testcontainers/mssqlserver --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [mssql](https://www.npmjs.com/package/mssql)
+
+        npm install mssql
+        npm install @types/mssql
+
+Choose an image from the [container registry](https://mcr.microsoft.com/en-us/artifact/mar/mssql/server) and substitute `IMAGE`.
+
 !!! warning "EULA Acceptance"
-Due to licencing restrictions you are required to accept an EULA for this container image. To indicate that you accept the MS SQL Server image EULA, call the `acceptLicense()` method.
+    Due to licencing restrictions you are required to accept an EULA for this container image. To indicate that you accept the MS SQL Server image EULA, call the `acceptLicense()` method.
 
     Please see the [`microsoft-mssql-server` image documentation](https://hub.docker.com/_/microsoft-mssql-server#environment-variables) for a link to the EULA document.
 
-<!--codeinclude-->
-[Connect and execute query:](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:connect
-<!--/codeinclude-->
+### Execute a query
 
 <!--codeinclude-->
-[Connect and execute query using URI:](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:uriConnect
+[](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:mssqlConnect
 <!--/codeinclude-->
 
+### Connect via URI
+
 <!--codeinclude-->
-[Connect and execute query using a valid custom password:](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:validPassword
+[](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:mssqlUriConnect
 <!--/codeinclude-->
 
+### With password
+
 <!--codeinclude-->
-[Throw error with an invalid password:](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:invalidPassword
+[](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:mssqlValidPassword
 <!--/codeinclude-->
 
+### With different edition
+
 <!--codeinclude-->
-[Use a different edition:](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:expressEdition
+[](../../packages/modules/mssqlserver/src/mssqlserver-container.test.ts) inside_block:mssqlExpressEdition
 <!--/codeinclude-->

packages/modules/mssqlserver/src/mssqlserver-container.test.ts

@@ -5,8 +5,8 @@ import { MSSQLServerContainer } from "./mssqlserver-container";
 const IMAGE = getImage(__dirname);
 
 describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
-  // connect {
   it("should connect and return a query result", async () => {
+    // mssqlConnect {
     await using container = await new MSSQLServerContainer(IMAGE).acceptLicense().start();
 
     const sqlConfig: config = {
@@ -15,27 +15,20 @@ describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
       database: container.getDatabase(),
       server: container.getHost(),
       port: container.getPort(),
-      pool: {
-        max: 1,
-        min: 0,
-        idleTimeoutMillis: 30000,
-      },
-      options: {
-        trustServerCertificate: true,
-      },
+      pool: { max: 1, min: 0, idleTimeoutMillis: 30000 },
+      options: { trustServerCertificate: true },
     };
-
     const connection = await sql.connect(sqlConfig);
 
     const { recordset } = await connection.query`SELECT 1;`;
     expect(recordset).toStrictEqual([{ "": 1 }]);
 
     await connection.close();
+    // }
   });
-  // }
 
-  // uriConnect {
   it("should connect and return a query result with database URI", async () => {
+    // mssqlUriConnect {
     await using container = await new MSSQLServerContainer(IMAGE).acceptLicense().start();
 
     const connectionString = container.getConnectionUri();
@@ -45,12 +38,13 @@ describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
     expect(recordset).toStrictEqual([{ "": 1 }]);
 
     await connection.close();
+    // }
   });
-  // }
 
-  // validPassword {
   it("should connect and return a query result with valid custom password", async () => {
+    // mssqlValidPassword {
     await using container = await new MSSQLServerContainer(IMAGE).acceptLicense().withPassword("I!@M#$eCur3").start();
+    // }
 
     const connectionString = container.getConnectionUri();
     const connection = await sql.connect(connectionString);
@@ -60,24 +54,22 @@ describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
 
     await connection.close();
   });
-  // }
 
-  // invalidPassword {
   it("should throw error with invalid password", async () => {
     const container = new MSSQLServerContainer(IMAGE).acceptLicense().withPassword("password");
     await expect(container.start()).rejects.toThrow(
       Error('Log stream ended and message "/.*Recovery is complete.*/" was not received')
     );
   });
-  // }
 
-  // expressEdition {
   it("should start db with express edition", async () => {
+    // mssqlExpressEdition {
     await using container = await new MSSQLServerContainer(IMAGE)
-      .withWaitForMessage(/.*Attribute synchronization manager initialized*/)
       .acceptLicense()
       .withEnvironment({ MSSQL_PID: "Express" })
+      .withWaitForMessage(/.*Attribute synchronization manager initialized*/)
       .start();
+    // }
 
     const { output, exitCode } = await container.exec([
       "/opt/mssql-tools/bin/sqlcmd",
@@ -94,5 +86,4 @@ describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
     expect(exitCode).toBe(0);
     expect(output).toContain("Express Edition");
   });
-  // }
 });