Skip to content
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

Export main function #646

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −39
Open

Export main function #646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a37e50
export main function
adambjornberg Nov 21, 2023
2641982
update custom goose binary example
adambjornberg Nov 21, 2023
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
4 changes: 4 additions & 0 deletions cmd/goose/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ var (
var version string

func main() {
Main()
}

func Main() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is typically not exported, and I'm not sure I want to allow a dependency on the CLI code. Note, there will be some changes to this coming very soon: #663

I'm curious, what are you trying to do where the goose package isn't sufficient?

Copy link
Author

Choose a reason for hiding this comment

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

hello there!

We want to embed go migrations in the goose binary.
Currently, this is done by implementing a custom CLI interface alongside the migrations, which is a bit annoying.

The laziest way to do it was to simply export the main function, so that is what I did. There are probably better ways to achieve this. The issue you linked looks promising :)

It would be really nice with a GooseCLI function or something that accepted configuration as input.

Copy link
Collaborator

@mfridman mfridman Dec 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Ah, okay I think I understand. You want to use Go migrations but also leverage the default CLI behaviour from goose without re-implementing flags/args logic within your binary code.

I'll need to think about this. The goose.Run set of commands were meant to bridge this gap, although there's still all the configuration, flags and env bits you need to glue together.

Need to think about this, because anything that becomes part of the public API surface we try very hard to keep backwards-compatible. Most CLIs keep this in ./internal/cli since it's only ever used as an executable, but this is a bit of a special case because of the intersection of Go migrations + CLI functionality.

flags.Usage = usage
if err := flags.Parse(os.Args[1:]); err != nil {
log.Fatalf("failed to parse args: %v", err)
Expand Down
42 changes: 3 additions & 39 deletions examples/go-migrations/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,11 @@
package main

import (
"flag"
"log"
"os"

"github.com/pressly/goose/v3"
_ "modernc.org/sqlite"
)

var (
flags = flag.NewFlagSet("goose", flag.ExitOnError)
dir = flags.String("dir", ".", "directory with migration files")
"os"
)

func main() {
flags.Parse(os.Args[1:])
args := flags.Args()

if len(args) < 3 {
flags.Usage()
return
}

dbstring, command := args[1], args[2]

db, err := goose.OpenDBWithDriver("sqlite", dbstring)
if err != nil {
log.Fatalf("goose: failed to open DB: %v\n", err)
}

defer func() {
if err := db.Close(); err != nil {
log.Fatalf("goose: failed to close DB: %v\n", err)
}
}()

arguments := []string{}
if len(args) > 3 {
arguments = append(arguments, args[3:]...)
}

if err := goose.Run(command, db, *dir, arguments...); err != nil {
log.Fatalf("goose %v: %v", command, err)
}
os.Args = append([]string{os.Args[0], "sqlite3"}, os.Args[1:]...)
goose.Main()
}