Merge pull request #1132 from tylerauerbeck/bindata-to-embed

backend: migrate go-bindata to embed

Author: tormath1

CHANGELOG.md

@@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Postgresql 17.x is now the tested and default version. For existing Kubernetes deployment, you might need to run a manual intervention (see: [charts/nebraska/README.md](https://github.com/flatcar/nebraska/blob/main/charts/nebraska/README.md#upgrade-postgresql))([nebraska#1088](https://github.com/flatcar/nebraska/pull/1088))
 - backend: updated kinvolk references to flatcar ([nebraska#1091](https://github.com/flatcar/nebraska/pull/1091/files))
+- backend: migrate from go-bindata to embed ([nebraska#1132](https://github.com/flatcar/nebraska/pull/1132))
 
 ### Bugfixes
 

backend/.gitignore

@@ -1,6 +1,5 @@
 bin
 coverage.out
-tools/go-bindata
 tools/golangci-lint
 tools/swag
 tools/oapi-codegen

backend/Makefile

@@ -83,9 +83,6 @@ tools: bin/initdb
 bin/initdb:
 	go build -o bin/initdb ./cmd/initdb
 
-tools/go-bindata: go.mod go.sum
-	env GOBIN=$(CURDIR)/tools/ go install github.com/kevinburke/go-bindata/go-bindata@v3.24.0
-
 tools/golangci-lint: go.mod go.sum
 	env GOBIN=$(CURDIR)/tools/ go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.2.1
 
@@ -96,7 +93,7 @@ tools/swag:
 ci: build test-clean-work-tree-backend check-backend-with-container
 
 .PHONY: run-generators
-run-generators: tools/go-bindata
+run-generators:
 	PATH="$(abspath tools):$${PATH}" go generate ./...
 
 bin/nebraska: run-generators

backend/go.mod

@@ -14,7 +14,6 @@ require (
 	github.com/jackc/pgx/v4 v4.18.3
 	github.com/jinzhu/copier v0.4.0
 	github.com/jmoiron/sqlx v1.4.0
-	github.com/kevinburke/go-bindata v3.24.0+incompatible
 	github.com/kinvolk/go-omaha v0.0.2-0.20221206142015-1518a03b832b
 	github.com/knadh/koanf v1.5.0
 	github.com/labstack/echo-contrib v0.17.4

backend/go.sum

@@ -467,8 +467,6 @@ github.com/julz/importas v0.2.0 h1:y+MJN/UdL63QbFJHws9BVC5RpA2iq0kpjrFajTGivjQ=
 github.com/julz/importas v0.2.0/go.mod h1:pThlt589EnCYtMnmhmRYY/qn9lCf/frPOK+WMx3xiJY=
 github.com/karamaru-alpha/copyloopvar v1.2.1 h1:wmZaZYIjnJ0b5UoKDjUHrikcV0zuPyyxI4SVplLd2CI=
 github.com/karamaru-alpha/copyloopvar v1.2.1/go.mod h1:nFmMlFNlClC2BPvNaHMdkirmTJxVCY0lhxBtlfOypMM=
-github.com/kevinburke/go-bindata v3.24.0+incompatible h1:qajFA3D0pH94OTLU4zcCCKCDgR+Zr2cZK/RPJHDdFoY=
-github.com/kevinburke/go-bindata v3.24.0+incompatible/go.mod h1:/pEEZ72flUW2p0yi30bslSp9YqD9pysLxunQDdb2CPM=
 github.com/kinvolk/go-omaha v0.0.2-0.20221206142015-1518a03b832b h1:+D/yo45hVrp5qdcifcHzQAcRWRXIOpxZpk0BW2Z4G1w=
 github.com/kinvolk/go-omaha v0.0.2-0.20221206142015-1518a03b832b/go.mod h1:SAEkKv9dpmCAVA3KxGdlHMoO4VaCAfIZuui57PqGQbg=
 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=

backend/pkg/api/api.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"database/sql"
+	"embed"
 	"errors"
 	"fmt"
 	"os"
@@ -23,14 +24,12 @@ import (
 	"time"
 )
 
-// To re-generate the bindata.go file, use go-bindata from
-// github.com/kevinburke/go-bindata (a fork of the discontinued
-// go-bindata project). Run the following command from the root of the
-// repository:
-//
-//    make bindata
-
-//go:generate go-bindata -mode 0644 -ignore=\.swp -pkg=api -modtime=1 db db/migrations
+var (
+	//go:embed db/*.sql
+	sqlFolder embed.FS
+	//go:embed db/migrations/*.sql
+	migrationsFolder embed.FS
+)
 
 const (
 	defaultDbURL          = "postgres://postgres:nebraska@127.0.0.1:5432/nebraska?sslmode=disable&connect_timeout=10"
@@ -193,19 +192,18 @@ func (api *API) MigrateDown(version string) (int, error) {
 	return count, nil
 }
 
-func migrationAssets() *migrate.AssetMigrationSource {
-	return &migrate.AssetMigrationSource{
-		Asset:    Asset,
-		AssetDir: AssetDir,
-		Dir:      "db/migrations",
+func migrationAssets() *migrate.EmbedFileSystemMigrationSource {
+	return &migrate.EmbedFileSystemMigrationSource{
+		FileSystem: migrationsFolder,
+		Root:       "db/migrations",
 	}
 }
 
 // OptionInitDB will initialize the database during the API instance creation,
 // dropping all existing tables, which will force all migration scripts to be
 // re-executed. Use with caution, this will DESTROY ALL YOUR DATA.
 func OptionInitDB(api *API) error {
-	sqlFile, err := Asset("db/drop_all_tables.sql")
+	sqlFile, err := sqlFolder.ReadFile("db/drop_all_tables.sql")
 	if err != nil {
 		return err
 	}
@@ -239,7 +237,7 @@ func NewForTest(options ...func(*API) error) (*API, error) {
 		return nil, err
 	}
 
-	sqlFile, err := Asset("db/sample_data.sql")
+	sqlFile, err := sqlFolder.ReadFile("db/sample_data.sql")
 	if err != nil {
 		return nil, err
 	}

backend/pkg/api/bindata.go

@@ -4,5 +4,4 @@ package tools
 
 import (
         _ "github.com/golangci/golangci-lint/v2/cmd/golangci-lint"
-	_ "github.com/kevinburke/go-bindata"
 )