Add MySQL module

.github/dependabot.yml

@@ -42,12 +42,6 @@ updates:
         interval: monthly
       open-pull-requests-limit: 3
       rebase-strategy: disabled
-    - package-ecosystem: gomod
-      directory: /examples/mysql
-      schedule:
-        interval: monthly
-      open-pull-requests-limit: 3
-      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /examples/nginx
       schedule:
@@ -102,6 +96,12 @@ updates:
         interval: monthly
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /modules/mysql
+      schedule:
+        interval: monthly
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /modules/postgres
       schedule:

.github/workflows/mysql-example.yml → .github/workflows/module-mysql.yml

@@ -1,9 +1,9 @@
-name: Mysql example pipeline
+name: MySQL module pipeline
 
 on: [push, pull_request]
 
 concurrency:
-  group: "${{ github.workflow }}-${{ github.head_ref || github.sha }}"
+  group: ${{ github.workflow }}-${{ github.head_ref || github.sha }}
   cancel-in-progress: true
 
 jobs:
@@ -24,15 +24,15 @@ jobs:
         uses: actions/checkout@v3
 
       - name: modVerify
-        working-directory: ./examples/mysql
+        working-directory: ./modules/mysql
         run: go mod verify
 
       - name: modTidy
-        working-directory: ./examples/mysql
+        working-directory: ./modules/mysql
         run: make tools-tidy
 
       - name: gotestsum
-        working-directory: ./examples/mysql
+        working-directory: ./modules/mysql
         run: make test-unit
 
       - name: Run checker

docs/modules/mysql.md

@@ -0,0 +1,68 @@
+# MySQL
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the MySQL module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/mysql
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a MySQL container](../../modules/mysql/mysql.go)
+<!--/codeinclude-->
+
+## Module Reference
+
+The MySQL module exposes one entrypoint function to create the container, and this function receives two parameters:
+
+```golang
+func StartContainer(ctx context.Context, opts ...Option) (*MySQLContainer, error) {
+```
+
+- `context.Context`, the Go context.
+- `Option`, a variad argument for passing options.
+
+## Container Options
+
+When starting the MySQL container, you can pass options in a variadic way to configure it.
+
+!!!tip
+
+    You can find all the available configuration and environment variables for the MySQL Docker image on [Docker Hub](https://hub.docker.com/_/mysql).
+
+### Set Image
+
+By default, the image used is `mysql:8`.  If you need to use a different image, you can use `WithImage` option.
+
+<!--codeinclude-->
+[Custom Image](../../modules/mysql/mysql_test.go) inside_block:withConfigFile
+<!--/codeinclude-->
+
+### Set username, password and database name
+
+If you need to set a different database, and its credentials, you can use `WithUsername`, `WithPassword`, `WithDatabase`
+options.  By default, the username, the password and the database name is `test`.
+
+<!--codeinclude-->
+[Custom Database initialization](../../modules/mysql/mysql_test.go) inside_block:customInitialization
+<!--/codeinclude-->
+
+### Init Scripts
+
+If you would like to perform DDL or DML operations in the MySQL container, add one or more `*.sql`, `*.sql.gz`, or `*.sh`
+scripts to the container request. Those files will be copied under `/docker-entrypoint-initdb.d`.
+
+<!--codeinclude-->
+[Include init scripts](../../modules/mysql/mysql_test.go) inside_block:withScripts
+<!--/codeinclude-->
+
+### Custom configuration
+
+If you need to set a custom configuration, you can use `WithConfigFile` option.
+
+<!--codeinclude-->
+[Custom MySQL config file](../../modules/mysql/mysql_test.go) inside_block:withConfigFile
+<!--/codeinclude-->

mkdocs.yml

@@ -53,6 +53,7 @@ nav:
         - modules/index.md
         - modules/couchbase.md
         - modules/localstack.md
+        - modules/mysql.md
         - modules/postgres.md
         - modules/pulsar.md
         - modules/vault.md
@@ -64,7 +65,6 @@ nav:
         - examples/datastore.md
         - examples/firestore.md
         - examples/mongodb.md
-        - examples/mysql.md
         - examples/nginx.md
         - examples/pubsub.md
         - examples/redis.md

examples/mysql/go.mod → modules/mysql/go.mod

@@ -1,4 +1,4 @@
-module github.com/testcontainers/testcontainers-go/examples/mysql
+module github.com/testcontainers/testcontainers-go/modules/mysql
 
 go 1.19