Add option for database migration

[scaccomatto]

Hi All,

I started recently to use TestContainer and I think it's a brilliant solution! Thank you very much to all of you!

I meanly use it to spin up the database (MySql in my case). We are also using "pressly/goose" as migration tool, to manage all the database schema updates. Sinse goose is written in Go, I was wondering if it can be usefull to add a function like "testcontainers.WithMigration" to allow people to manage migration at TestContainer level. Pseudo code could look like this:

func WithMigration(pathFiles string, dialect string, database *sql.DB, migrationCommand string) testcontainers.CustomizeRequestOption {
	return func(req *testcontainers.GenericContainerRequest) error {
		migrationFiles := os.DirFS(pathFiles)
		if err := goose.SetDialect(dialect); err != nil {
			return fmt.Errorf("failed to set dialect. migration failed: %w", err)
		}
		goose.SetBaseFS(migrationFiles)
		var err error
		switch migrationCommand {
		case "up":
			err = goose.Up(database, ".")
			break
		case "down":
			err = goose.Down(database, ".")
			...
		}

		if err != nil {
			return fmt.Errorf("failed to run migration\": %w", err)
		}
		return nil
	}
}

If you think that this could be useful, I'll be happy to open a PR.

[mdelapenya]

Hi @scaccomatto thanks for bringing this idea to the community. I see the value on this, although I'm not sure if we want to distribute the goose dependencies to all our users in the case we added that option to the core.

I'd see it more of a separate module that exposes the functional options satisfying the customiser interface, so that modules can use it. And I think you can explore that idea under your own account and see how it works before contributing it as a tc-go module. Wdyt?

[scaccomatto]

Hi @mdelapenya, thanks for your reply. I didn't think about the dependencies, and you are definitely right. I'll explore the module option and see if it could work. Thanks for the advice.

[mdelapenya]

Never mind! Please let us know when we can check the module, in case you want us to review it. Ping us if needed