Merge pull request #19 from upfluence/jl/source-io-fs

x/migration: add NewFSSource

Author: jlevesy

.circleci/config.yml

@@ -0,0 +1 @@
+* @AlexisMontagne @upfluence/golang

.github/CODEOWNERS

@@ -0,0 +1,30 @@
+### What does this PR do?
+
+<!-- A brief description of the context of this pull request and its purpose. -->
+
+Fixes #<!-- enter issue number here -->
+
+### What are the observable changes?
+<!-- This question could be adequate with multiple use cases, for example: -->
+
+<!-- Frontend: explain the feature created / updated, give instructions telling how to see the change in staging -->
+<!-- Performance: what metric should be impacted, link to the right graphana dashboard for exemple -->
+<!-- Bug: a given issue trail on sentry should stop happening -->
+<!-- Feature: Implements X thrift service / Z HTTP REST API added, provide instructions on how leverage your feature from staging or your workstation -->
+
+### Good PR checklist
+
+- [ ] Title makes sense
+- [ ] Is against the correct branch
+- [ ] Only addresses one issue
+- [ ] Properly assigned
+- [ ] Added/updated tests
+- [ ] Added/updated documentation
+- [ ] Properly labeled
+
+### Additional Notes
+
+<!--
+    You can add anything you want here, an explanation on the way you built your implementation,
+    precisions on the origin of the bug, gotchas you need to mention.
+ -->

.github/pull_request_template.md

@@ -0,0 +1,50 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: [ '1.16.x', '1.15.x', '1.14.x' ]
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: tata_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Install Go ${{ matrix.go }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Cache Modules
+        uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-v1-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Run tests
+        run: go test -p 1 -v ./...
+        env:
+          POSTGRES_URL: postgres://postgres:postgres@localhost:5432/tata_test?sslmode=disable

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: reviewdog
+on: [pull_request]
+
+jobs:
+  lint:
+    name: runner / golangci-lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16.x
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: golanci-lint
+        uses: upfluence/action-golangci-lint@master
+        with:
+          github_token: ${{ secrets.github_token }}

.github/workflows/lint.yml

@@ -1,6 +1,6 @@
 module github.com/upfluence/sql
 
-go 1.14
+go 1.16
 
 require (
 	github.com/lib/pq v1.4.0

go.mod

@@ -0,0 +1,41 @@
+// +build go1.16
+
+package migration
+
+import (
+	"io/fs"
+
+	"github.com/upfluence/log"
+)
+
+func MustFSSource(fs fs.FS, logger log.Logger) Source {
+	s, err := NewFSSource(fs, logger)
+
+	if err != nil {
+		panic(err)
+	}
+
+	return s
+}
+
+func NewFSSource(src fs.FS, logger log.Logger) (Source, error) {
+	files, err := fs.ReadDir(src, ".")
+
+	if err != nil {
+		return nil, err
+	}
+
+	vs := make([]string, len(files))
+
+	for i, f := range files {
+		vs[i] = f.Name()
+	}
+
+	return NewStaticSource(
+		vs,
+		func(file string) ([]byte, error) {
+			return fs.ReadFile(src, file)
+		},
+		logger,
+	), nil
+}

x/migration/fs_source.go

@@ -0,0 +1,47 @@
+// +build go1.16
+
+package migration
+
+import (
+	"context"
+	"testing"
+	"testing/fstest"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/upfluence/log"
+)
+
+func TestFSSource(t *testing.T) {
+	var (
+		ctx = context.Background()
+		fs  = fstest.MapFS{
+			"3_final.down.sql":      &fstest.MapFile{Data: []byte("bar")},
+			"2_initial.up.postgres": &fstest.MapFile{Data: []byte("foo")},
+			"3_final.up.sql":        &fstest.MapFile{Data: []byte("bar")},
+		}
+	)
+
+	s, err := NewFSSource(fs, log.NewLogger(log.WithSink(sink{})))
+	require.NoError(t, err)
+
+	m, err := s.First(ctx)
+	require.NoError(t, err)
+
+	assertMigration(t, m, fetchDriver("postgres"), 2, "foo", "")
+	assertMigration(t, m, fetchDriver("sqlite3"), 2, "", "")
+
+	_, id, _ := s.Next(ctx, 2)
+
+	assert.Equal(t, uint(3), id)
+
+	m, _ = s.Get(ctx, id)
+	assertMigration(t, m, fetchDriver("postgres"), 3, "bar", "bar")
+
+	ok, _, _ := s.Prev(ctx, 2)
+	assert.False(t, ok)
+
+	ok, _, err = s.Next(ctx, 3)
+	assert.NoError(t, err)
+	assert.False(t, ok)
+}