Add io/fs#FS Driver #471

source/iofs/README.md

@@ -0,0 +1,38 @@
+# iofs
+
+Driver with file system interface (`io/fs#FS`) supported from Go 1.16.
+
+This Driver cannot be used with versions below Go 1.15.
+
+## Usage
+
+Directory embedding example
+
+```go
+package main
+
+import (
+	"embed"
+	"log"
+
+	"github.com/golang-migrate/migrate/v4"
+	_ "github.com/golang-migrate/migrate/v4/database/postgres"
+	"github.com/golang-migrate/migrate/v4/source/iofs"
+)
+
+//go:embed migrations
+var fs embed.FS
+
+func main() {
+	d, err := iofs.WithInstance(fs, "migrations")
+	if err != nil {
+		log.Fatal(err)
+	}
+	m, err := migrate.NewWithSourceInstance("iofs", d, "postgres://postgres@localhost/postgres?sslmode=disable")
+	if err != nil {
+		log.Fatal(err)
+	}
+	err = m.Up()
+	// ...
+}
+```

source/iofs/iofs.go

@@ -0,0 +1,36 @@
+// +build go1.16
+
+package iofs
+
+import (
+	"errors"
+	"fmt"
+	"io/fs"
+	"net/http"
+
+	"github.com/golang-migrate/migrate/v4/source"
+	"github.com/golang-migrate/migrate/v4/source/httpfs"
+)
+
+func init() {
+	source.Register("iofs", &Iofs{})
+}
+
+// Iofs is a source driver for io/fs#FS.
+type Iofs struct {
+	httpfs.PartialDriver
+}
+
+// Open by url does not supported with Iofs.
+func (i *Iofs) Open(url string) (source.Driver, error) {
+	return nil, errors.New("iofs driver does not support open by url")
+}
+
+// WithInstance wraps io/fs#FS as source.Driver.
+func WithInstance(fsys fs.FS, path string) (source.Driver, error) {
+	var i Iofs
+	if err := i.Init(http.FS(fsys), path); err != nil {
+		return nil, fmt.Errorf("failed to init driver with path %s: %w", path, err)
+	}
+	return &i, nil
+}

source/iofs/iofs_test.go

@@ -0,0 +1,31 @@
+// +build go1.16
+
+package iofs_test
+
+import (
+	"embed"
+	"testing"
+
+	"github.com/golang-migrate/migrate/v4/source/iofs"
+	st "github.com/golang-migrate/migrate/v4/source/testing"
+)
+
+//go:embed testdata
+var fs embed.FS
+
+func Test(t *testing.T) {
+	d, err := iofs.WithInstance(fs, "testdata")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	st.Test(t, d)
+}
+
+func TestOpen(t *testing.T) {
+	i := new(iofs.Iofs)
+	_, err := i.Open("")
+	if err == nil {
+		t.Fatal("iofs driver does not support open by url")
+	}
+}

source/iofs/testdata/1_foobar.down.sql

@@ -0,0 +1 @@
+1 down

source/iofs/testdata/1_foobar.up.sql

@@ -0,0 +1 @@
+1 up

source/iofs/testdata/3_foobar.up.sql

@@ -0,0 +1 @@
+3 up

source/iofs/testdata/4_foobar.down.sql

@@ -0,0 +1 @@
+4 down

source/iofs/testdata/4_foobar.up.sql

@@ -0,0 +1 @@
+4 up

source/iofs/testdata/5_foobar.down.sql

@@ -0,0 +1 @@
+5 down

source/iofs/testdata/7_foobar.down.sql

@@ -0,0 +1 @@
+7 down

source/iofs/testdata/7_foobar.up.sql

@@ -0,0 +1 @@
+7 up