Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add io/fs#FS Driver #471 #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Nov 18, 2020
Merged

Add io/fs#FS Driver #471 #472

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
489e6d3
Add io/fs#FS Driver #471
johejo Nov 12, 2020
65cbb0f
Refactor iofs.Iofs to be independent of httpfs
johejo Nov 13, 2020
e18e378
Rename Iofs to IoFS, accepts fs.FS and use fs.DirEntry.Info() to undo…
johejo Nov 14, 2020
e9ae08d
fix documents and migration directory for testing
johejo Nov 15, 2020
416f878
Fix iofs.Driver so that it can be used by embedding it like httpfs.Pa…
johejo Nov 15, 2020
45ec3dc
iofs.Driver closes the file system if possible
johejo Nov 15, 2020
3af8acf
Rename receiver
johejo Nov 15, 2020
0e9937b
Refactor file driver to use iofs.Driver
johejo Nov 15, 2020
7fb518d
iofs build constraint is not needed so remove it
johejo Nov 15, 2020
3c0290b
Properly return an error in a corner case
johejo Nov 15, 2020
2cd12a6
Increase golangci-lint timeout
johejo Nov 15, 2020
ca6628d
Fix example code
johejo Nov 15, 2020
58e9837
Revert "Increase golangci-lint timeout"
johejo Nov 17, 2020
321662e
unexport driver, add iofs.PartialDriver, remove type alias from file …
johejo Nov 17, 2020
02da3b6
do not panic in Open, return error
johejo Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix documents and migration directory for testing
  • Loading branch information
@johejo
johejo committed Nov 15, 2020
commit e9ae08da0c5abc15d567294012205073e92e35d5
37 changes: 1 addition & 36 deletions source/iofs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,3 @@
# iofs

Driver with file system interface (`io/fs#FS`) supported from Go 1.16.

This Driver cannot be used with Go versions 1.15 and below.

## 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()
// ...
}
```
https://pkg.go.dev/github.com/golang-migrate/migrate/v4/source/iofs
10 changes: 10 additions & 0 deletions source/iofs/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/*
Package iofs provides the Go 1.16+ io/fs#FS driver.
It can accept various file systems (like embed.FS, archive/zip#Reader) implementing io/fs#FS.
This driver cannot be used with Go versions 1.15 and below.
Also, Opening with a URL scheme is not supported.
*/
package iofs
28 changes: 28 additions & 0 deletions source/iofs/example_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// +build go1.16

package iofs_test

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 testdata/migrations/*.sql
var fs embed.FS

func Example() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for using executable examples!

d, err := iofs.WithInstance(fs, "testdata/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()
// ...
}
7 changes: 3 additions & 4 deletions source/iofs/iofs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ import (
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")
//go:embed testdata/migrations/*.sql
var fs embed.FS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just curious--how did this even work?

Per the golang docs:

The //go:embed directive can be used with both exported and unexported variables, depending on whether the package wants to make the data available to other packages. It can only be used with global variables at package scope, not with local variables.

To me this looks like a local variable, not a global variable at package scope... What am I missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Local variables were still supported when implementing this PR.
golang/go#43216
It is a remnant of that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, thank you!

d, err := iofs.WithInstance(fs, "testdata/migrations")
if err != nil {
t.Fatal(err)
}
Expand Down
0 source/iofs/testdata/1_foobar.down.sql → ...ofs/testdata/migrations/1_foobar.down.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/1_foobar.up.sql → .../iofs/testdata/migrations/1_foobar.up.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/3_foobar.up.sql → .../iofs/testdata/migrations/3_foobar.up.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/4_foobar.down.sql → ...ofs/testdata/migrations/4_foobar.down.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/4_foobar.up.sql → .../iofs/testdata/migrations/4_foobar.up.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/5_foobar.down.sql → ...ofs/testdata/migrations/5_foobar.down.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/7_foobar.down.sql → ...ofs/testdata/migrations/7_foobar.down.sql
View file
Open in desktop
File renamed without changes.
0 source/iofs/testdata/7_foobar.up.sql → .../iofs/testdata/migrations/7_foobar.up.sql
View file
Open in desktop
File renamed without changes.