Minio

Author: cristianrgreco

docs/modules/minio.md

@@ -1,8 +1,4 @@
-# MinIO Module
-
-[MinIO](https://min.io/) is a high performance object storage solution. It is API compatible with the Amazon S3 cloud storage service and can handle unstructured data such as photos, videos, log files, backups, and container images
-
-
+# MinIO
 
 ## Install
 
@@ -12,10 +8,22 @@ npm install @testcontainers/minio --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [minio](https://www.npmjs.com/package/minio)
+
+        npm install minio
+
+Choose an image from the [container registry](https://hub.docker.com/r/minio/minio) and substitute `IMAGE`.
+
+### Upload a file
+
 <!--codeinclude-->
-[Connect with default credentials:](../../packages/modules/minio/src/minio-container.test.ts) inside_block:connectWithDefaultCredentials
+[](../../packages/modules/minio/src/minio-container.test.ts) inside_block:connectWithDefaultCredentials
 <!--/codeinclude-->
 
+### With credentials
+
 <!--codeinclude-->
-[Connect with custom credentials:](../../packages/modules/minio/src/minio-container.test.ts) inside_block:connectWithCustomCredentials
+[](../../packages/modules/minio/src/minio-container.test.ts) inside_block:connectWithCustomCredentials
 <!--/codeinclude-->

mkdocs.yml

@@ -72,8 +72,8 @@ nav:
       - KurrentDB: modules/kurrentdb.md
       - Localstack: modules/localstack.md
       - MariaDB: modules/mariadb.md
-      - Mockserver: modules/mockserver.md
       - MinIO: modules/minio.md
+      - Mockserver: modules/mockserver.md
       - MongoDB: modules/mongodb.md
       - MSSQLServer: modules/mssqlserver.md
       - MySQL: modules/mysql.md

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

@@ -5,56 +5,50 @@ import { MinioContainer } from "./minio-container";
 const IMAGE = getImage(__dirname);
 
 describe("MinIO", { timeout: 240_000 }, () => {
-  // connectWithDefaultCredentials {
   it("should connect and upload a file", async () => {
+    // connectWithDefaultCredentials {
     await using container = await new MinioContainer(IMAGE).start();
 
-    const minioClient = new minio.Client({
+    const client = new minio.Client({
       endPoint: container.getHost(),
       port: container.getPort(),
       useSSL: false,
       accessKey: "minioadmin",
       secretKey: "minioadmin",
     });
 
-    // Upload dummy test file.
     const testFile = `${__dirname}/dummy-file.txt`;
+    await client.makeBucket("test-bucket");
+    await client.fPutObject("test-bucket", "minio-test-file.txt", testFile);
 
-    await minioClient.makeBucket("test-bucket");
-    await minioClient.fPutObject("test-bucket", "minio-test-file.txt", testFile);
-
-    // Verify upload
-    const objectExists = await minioClient
+    const objectExists = await client
       .statObject("test-bucket", "minio-test-file.txt")
       .then(() => true)
       .catch(() => false);
 
     expect(objectExists).toBeTruthy();
+    // }
   });
-  // }
 
-  // connectWithCustomCredentials {
   it("should work with custom credentials", async () => {
+    // connectWithCustomCredentials {
     await using container = await new MinioContainer(IMAGE)
       .withUsername("AzureDiamond")
       .withPassword("hunter2!")
       .start();
 
-    const minioClient = new minio.Client({
+    const client = new minio.Client({
       endPoint: container.getHost(),
       port: container.getPort(),
       useSSL: false,
       accessKey: "AzureDiamond",
       secretKey: "hunter2!",
     });
 
-    // Create a bucket.
-    await minioClient.makeBucket("test-bucket");
-
-    // Verify bucket.
-    const bucketExits = await minioClient.bucketExists("test-bucket");
+    await client.makeBucket("test-bucket");
 
+    const bucketExits = await client.bucketExists("test-bucket");
     expect(bucketExits).toBeTruthy();
+    // }
   });
-  // }
 });