chore: add mysql example (#700)

* chore: bootstrap mysql example module * chore: add test for mysql example module * chore: remove dependency with mysql, delegating it to the example module * chore: bump mysql driver dependency * chore: remove duplicated docs tag
testcontainers · Dec 17, 2022 · bb03057 · bb03057
1 parent 2de9fb8
commit bb03057
Show file tree

Hide file tree

Showing 15 changed files with 1,362 additions and 81 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -36,6 +36,12 @@ updates:
         interval: daily
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /examples/mysql
+      schedule:
+        interval: daily
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /examples/nginx
       schedule:

diff --git a/.github/workflows/mysql-example.yml b/.github/workflows/mysql-example.yml
@@ -0,0 +1,42 @@
+name: Mysql example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-mysql:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/mysql
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/mysql
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/mysql
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-mysql*.xml"
+        if: always()
diff --git a/container_test.go b/container_test.go
@@ -391,7 +391,9 @@ func createTestContainer(t *testing.T, ctx context.Context) int {
 	if err != nil {
 		t.Fatalf("could not start container: %v", err)
 	}
+	// mappedPort {
 	port, err := container.MappedPort(ctx, nginxDefaultPort)
+	// }
 	if err != nil {
 		t.Fatalf("could not get mapped port: %v", err)
 	}

diff --git a/docker_test.go b/docker_test.go
@@ -2,12 +2,10 @@ package testcontainers
 
 import (
 	"context"
-	"database/sql"
 	"errors"
 	"fmt"
 	"log"
 
-	// Import mysql into the scope of this package (required)
 	"io"
 	"math/rand"
 	"net/http"
@@ -18,8 +16,6 @@ import (
 	"testing"
 	"time"
 
-	_ "github.com/go-sql-driver/mysql"
-
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/strslice"
 	"github.com/docker/go-units"
@@ -1047,7 +1043,6 @@ func TestContainerCreationWaitsForLogContextTimeout(t *testing.T) {
 }
 
 func TestContainerCreationWaitsForLog(t *testing.T) {
-	// exposePorts {
 	ctx := context.Background()
 	req := ContainerRequest{
 		Image:        mysqlImage,
@@ -1063,38 +1058,9 @@ func TestContainerCreationWaitsForLog(t *testing.T) {
 		ContainerRequest: req,
 		Started:          true,
 	})
-	// }
 
 	require.NoError(t, err)
 	terminateContainerOnEnd(t, ctx, mysqlC)
-
-	// containerHost {
-	host, _ := mysqlC.Host(ctx)
-	// }
-	// mappedPort {
-	p, _ := mysqlC.MappedPort(ctx, "3306/tcp")
-	port := p.Int()
-	// }
-	connectionString := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?tls=skip-verify",
-		"root", "password", host, port, "database")
-
-	db, err := sql.Open("mysql", connectionString)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer db.Close()
-
-	if err = db.Ping(); err != nil {
-		t.Errorf("error pinging db: %+v\n", err)
-	}
-	_, err = db.Exec("CREATE TABLE IF NOT EXISTS a_table ( \n" +
-		" `col_1` VARCHAR(128) NOT NULL, \n" +
-		" `col_2` VARCHAR(128) NOT NULL, \n" +
-		" PRIMARY KEY (`col_1`, `col_2`) \n" +
-		")")
-	if err != nil {
-		t.Errorf("error creating table: %+v\n", err)
-	}
 }
 
 func Test_BuildContainerFromDockerfile(t *testing.T) {
@@ -1387,11 +1353,13 @@ func TestContainerCreationWaitsForLogAndPortContextTimeout(t *testing.T) {
 
 func TestContainerCreationWaitingForHostPort(t *testing.T) {
 	ctx := context.Background()
+	// exposePorts {
 	req := ContainerRequest{
 		Image:        nginxAlpineImage,
 		ExposedPorts: []string{nginxDefaultPort},
 		WaitingFor:   wait.ForListeningPort(nginxDefaultPort),
 	}
+	// }
 	nginx, err := GenericContainer(ctx, GenericContainerRequest{
 		ProviderType:     providerType,
 		ContainerRequest: req,
@@ -1419,50 +1387,6 @@ func TestContainerCreationWaitingForHostPortWithoutBashThrowsAnError(t *testing.
 	terminateContainerOnEnd(t, ctx, nginx)
 }
 
-func TestContainerCreationWaitsForLogAndPort(t *testing.T) {
-	ctx := context.Background()
-	req := ContainerRequest{
-		Image:        mysqlImage,
-		ExposedPorts: []string{"3306/tcp", "33060/tcp"},
-		Env: map[string]string{
-			"MYSQL_ROOT_PASSWORD": "password",
-			"MYSQL_DATABASE":      "database",
-		},
-		WaitingFor: wait.ForAll(
-			wait.ForLog("port: 3306  MySQL Community Server - GPL"),
-			wait.ForListeningPort("3306/tcp"),
-		),
-	}
-
-	mysqlC, err := GenericContainer(ctx, GenericContainerRequest{
-		ProviderType:     providerType,
-		ContainerRequest: req,
-		Started:          true,
-	})
-
-	require.NoError(t, err)
-	terminateContainerOnEnd(t, ctx, mysqlC)
-
-	// buildingAddresses {
-	host, _ := mysqlC.Host(ctx)
-	p, _ := mysqlC.MappedPort(ctx, "3306/tcp")
-	port := p.Int()
-	connectionString := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?tls=skip-verify",
-		"root", "password", host, port, "database")
-
-	db, err := sql.Open("mysql", connectionString)
-	if err != nil {
-		t.Fatal(err)
-	}
-	// }
-
-	defer db.Close()
-
-	if err = db.Ping(); err != nil {
-		t.Errorf("error pinging db: %+v\n", err)
-	}
-}
-
 func TestCMD(t *testing.T) {
 	/*
 		echo a unique statement to ensure that we
@@ -1808,7 +1732,9 @@ func ExampleContainer_Host() {
 			log.Fatalf("failed to terminate container: %s", err)
 		}
 	}()
+	// containerHost {
 	ip, _ := nginxC.Host(ctx)
+	// }
 	println(ip)
 }
 
@@ -1865,9 +1791,11 @@ func ExampleContainer_MappedPort() {
 			log.Fatalf("failed to terminate container: %s", err)
 		}
 	}()
+	// buildingAddresses {
 	ip, _ := nginxC.Host(ctx)
 	port, _ := nginxC.MappedPort(ctx, "80")
 	_, _ = http.Get(fmt.Sprintf("http://%s:%s", ip, port.Port()))
+	// }
 }
 
 func TestContainerCreationWithBindAndVolume(t *testing.T) {

diff --git a/docs/examples/mysql.md b/docs/examples/mysql.md
@@ -0,0 +1,9 @@
+# Mysql
+
+<!--codeinclude-->
+[Creating a Mysql container](../../examples/mysql/mysql.go)
+<!--/codeinclude-->
+
+<!--codeinclude-->
+[Test for a Mysql container](../../examples/mysql/mysql_test.go)
+<!--/codeinclude-->
diff --git a/docs/features/networking.md b/docs/features/networking.md
@@ -20,7 +20,7 @@ Because there is this layer of indirection, it is necessary to ask Testcontainer
 This can be done using the `MappedPort` function, which takes the original (container) port as an argument:
 
 <!--codeinclude-->
-[Retrieving actual ports at runtime](../../docker_test.go) inside_block:mappedPort
+[Retrieving actual ports at runtime](../../container_test.go) inside_block:mappedPort
 <!--/codeinclude-->
 
 !!! warning

diff --git a/examples/mysql/Makefile b/examples/mysql/Makefile
@@ -0,0 +1,5 @@
+include ../../commons-test.mk
+
+.PHONY: test
+test:
+	$(MAKE) test-mysql