-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Seeding command was added - Some small refactoring of migrate command and usage functions implementation in init function (sic!).
- Loading branch information
1 parent
c06ef6e
commit 5727050
Showing
3 changed files
with
178 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,37 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "errors" | ||
| ) | ||
|
|
||
| type CommandContextKey string | ||
|
|
||
| const ( | ||
| CommandContextCfgKeyOverall CommandContextKey = "cfg" | ||
| CommandContextCfgKeyDB = CommandContextCfgKeyOverall + ".db" | ||
| CommandContextCfgKeyLog = CommandContextCfgKeyOverall + ".log" | ||
| CommandContextCfgKeyAppInfo = CommandContextCfgKeyOverall + ".appInfo" | ||
| CommandContextCfgKeyStage = CommandContextCfgKeyOverall + ".stage" | ||
| CommandContextCfgKey CommandContextKey = "cfg" | ||
| CommandContextCfgKeyDB = CommandContextCfgKey + ".db" | ||
| CommandContextCfgKeyLog = CommandContextCfgKey + ".log" | ||
| CommandContextCfgKeyAppInfo = CommandContextCfgKey + ".appInfo" | ||
| CommandContextCfgKeyStage = CommandContextCfgKey + ".stage" | ||
| ) | ||
|
|
||
| const ( | ||
| CommandContextObjectKey CommandContextKey = "obj" | ||
| CommandContextObjectKeySeeder = CommandContextObjectKey + ".seeder" | ||
| CommandContextObjectKeyConfig = CommandContextObjectKey + ".config" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrNoMethodFound = errors.New("seed method is not exists") | ||
| ErrSeedIsDisabled = errors.New("seed method is disabled in config") | ||
| ErrBadContextValue = errors.New("context value is empty or has wrong type") | ||
| ) | ||
|
|
||
| // nolint: gochecknoinits // 🤷 | ||
| func init() { | ||
| MigrateCmd.SetUsageFunc(migrateUsage) | ||
| SeedCmd.SetUsageFunc(seedUsage) | ||
|
|
||
| SeedCmd.AddCommand(seedRunCmd) | ||
| SeedCmd.AddCommand(seedRunAllCmd) | ||
| SeedCmd.AddCommand(seedListCmd) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| log "github.com/spacetab-io/logs-go/v2" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| type SeedsInterface interface { | ||
| GetMethods() map[string]SeedInterface | ||
| GetMethod(name string) (SeedInterface, error) | ||
| SeedsList() []string | ||
| } | ||
|
|
||
| type SeedInterface interface { | ||
| Enabled() bool | ||
| Name() string | ||
| Seed() error | ||
| } | ||
|
|
||
| // SeedCmd is a database seeding wrapper command. | ||
| var ( | ||
| SeedCmd = &cobra.Command{ | ||
| Use: "seed", | ||
| Short: "Database seeding command", | ||
| ValidArgs: []string{"run", "run-all", "list"}, | ||
| Args: cobra.MinimumNArgs(1), | ||
| } | ||
| seedListCmd = &cobra.Command{ | ||
| Use: "list", | ||
| RunE: seedList, | ||
| } | ||
| seedRunAllCmd = &cobra.Command{ | ||
| Use: "run-all", | ||
| RunE: seedRunAll, | ||
| } | ||
| seedRunCmd = &cobra.Command{ | ||
| Use: "run", | ||
| Args: cobra.MinimumNArgs(1), | ||
| RunE: seedRun, | ||
| } | ||
| ) | ||
|
|
||
| // seedUsage shows seed command usage. | ||
| // Add it to SeedCmd like SeedCmd.SetUsageFunc(seedUsage). | ||
| func seedUsage(cmd *cobra.Command) error { | ||
| w := cmd.OutOrStderr() | ||
| if _, err := w.Write([]byte(fmt.Sprintf(`Usage: | ||
| %s %s [args] | ||
| Args: | ||
| run runs concreete seed | ||
| run-all applies all seeds | ||
| list shows available seeds list | ||
| `, cmd.Parent().Name(), cmd.Name()))); err != nil { | ||
| return fmt.Errorf("seedUsage err: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func seedList(cmd *cobra.Command, _ []string) error { | ||
| s, err := getAppSeeder(cmd.Context()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cmd.Printf("Available seed list:\n %s\n", strings.Join(s.SeedsList(), "\n ")) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func seedRun(cmd *cobra.Command, args []string) error { | ||
| s, err := getAppSeeder(cmd.Context()) | ||
| if err != nil { | ||
| return fmt.Errorf("seedRun getAppSeeder() error: %w", err) | ||
| } | ||
|
|
||
| log.Trace().Strs("seeds", args).Msg("Running seeder...") | ||
|
|
||
| // Execute only the given method names | ||
| for _, item := range args { | ||
| seed, err := s.GetMethod(item) | ||
| if err != nil { | ||
| return fmt.Errorf("seedRun GetMethod error: %w", err) | ||
| } | ||
|
|
||
| if err := seed.Seed(); err != nil { | ||
| return fmt.Errorf("seedRun seed.Seed error: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Execute all seeders if no method name is given. | ||
| func seedRunAll(cmd *cobra.Command, _ []string) error { | ||
| s, err := getAppSeeder(cmd.Context()) | ||
| if err != nil { | ||
| return fmt.Errorf("seedRunAll getAppSeeder() error: %w", err) | ||
| } | ||
|
|
||
| log.Trace().Msg("Running all seeder...") | ||
|
|
||
| // We are looping over the method on a Seeder struct | ||
| for _, seed := range s.GetMethods() { | ||
| // Get the method in the current iteration | ||
| // Execute seeder | ||
| if err := seed.Seed(); err != nil { | ||
| return fmt.Errorf("seedRunAll seed.Seed() error: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func getAppSeeder(ctx context.Context) (SeedsInterface, error) { | ||
| s, ok := ctx.Value(CommandContextObjectKeySeeder).(SeedsInterface) | ||
| if !ok { | ||
| return nil, fmt.Errorf("%w: app seed (cfg.appInfo)", ErrBadContextValue) | ||
| } | ||
|
|
||
| return s, nil | ||
| } |