Skip to content

chore: get config path from --config only #889

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 1 commit into from
Apr 11, 2023
+19 −84
Merged

chore: get config path from --config only #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 0 additions & 25 deletions internal/boxcli/args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,10 @@ import (
"path/filepath"

"github.com/pkg/errors"
"go.jetpack.io/devbox/internal/boxcli/usererr"
)

// Functions that help parse arguments

// If args empty, defaults to the current directory
// Otherwise grabs the path from the first argument
func configPathFromUser(args []string, flags *configFlags) (string, error) {
if flags.path != "" && len(args) > 0 {
return "", usererr.New(
"Cannot specify devbox.json's path via both --config and the command arguments. " +
"Please use --config only.",
)
}

if flags.path != "" {
return flags.path, nil
}

if len(args) > 0 {
return "", usererr.New(
"devbox <command> <path> is deprecated, use devbox <command> --config <path> instead.",
)
}

// current directory is ""
return "", nil
}

func pathArg(args []string) string {
if len(args) > 0 {
p, err := filepath.Abs(args[0])
Expand Down
19 changes: 8 additions & 11 deletions internal/boxcli/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/pkg/errors"
"github.com/spf13/cobra"

"go.jetpack.io/devbox"
"go.jetpack.io/devbox/internal/cloud"
)
Expand Down Expand Up @@ -43,7 +44,7 @@ func debugCmd() *cobra.Command {
Hidden: true,
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
return runGenerateCmd(cmd, args, flags)
return runGenerateCmd(cmd, flags)
},
}
return command
Expand All @@ -57,7 +58,7 @@ func devcontainerCmd() *cobra.Command {
Long: "Generate Dockerfile and devcontainer.json files necessary to run VSCode in remote container environments.",
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
return runGenerateCmd(cmd, args, flags)
return runGenerateCmd(cmd, flags)
},
}
command.Flags().BoolVarP(
Expand All @@ -73,7 +74,7 @@ func dockerfileCmd() *cobra.Command {
Long: "Generate a Dockerfile that replicates devbox shell. Can be used to run devbox shell environment in an OCI container.",
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
return runGenerateCmd(cmd, args, flags)
return runGenerateCmd(cmd, flags)
},
}
command.Flags().BoolVarP(
Expand All @@ -91,7 +92,7 @@ func direnvCmd() *cobra.Command {
"Requires direnv to be installed.",
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
return runGenerateCmd(cmd, args, flags)
return runGenerateCmd(cmd, flags)
},
}
command.Flags().BoolVarP(
Expand All @@ -109,7 +110,7 @@ func sshConfigCmd() *cobra.Command {
Long: "Check ssh config and if they don't exist, it generates the configs necessary to connect to devbox cloud VMs.",
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
return runGenerateCmd(cmd, args, flags)
return runGenerateCmd(cmd, flags)
},
}
command.Flags().StringVarP(
Expand All @@ -119,7 +120,7 @@ func sshConfigCmd() *cobra.Command {
return command
}

func runGenerateCmd(cmd *cobra.Command, args []string, flags *generateCmdFlags) error {
func runGenerateCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
// ssh-config command is exception and it should run without a config file present
if cmd.Use == "ssh-config" {
_, err := cloud.SSHSetup(flags.githubUsername)
Expand All @@ -129,12 +130,8 @@ func runGenerateCmd(cmd *cobra.Command, args []string, flags *generateCmdFlags)
return nil
}

path, err := configPathFromUser(args, &flags.config)
if err != nil {
return err
}
// Check the directory exists.
box, err := devbox.Open(path, os.Stdout)
box, err := devbox.Open(flags.config.path, os.Stdout)
if err != nil {
return errors.WithStack(err)
}
Expand Down
12 changes: 4 additions & 8 deletions internal/boxcli/plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/pkg/errors"
"github.com/spf13/cobra"

"go.jetpack.io/devbox"
)

Expand All @@ -24,22 +25,17 @@ func planCmd() *cobra.Command {
Short: "Preview the plan used to build your environment",
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
return runPlanCmd(cmd, args, flags)
return runPlanCmd(cmd, flags)
},
}

flags.config.register(command)
return command
}

func runPlanCmd(cmd *cobra.Command, args []string, flags planCmdFlags) error {
path, err := configPathFromUser(args, &flags.config)
if err != nil {
return err
}

func runPlanCmd(cmd *cobra.Command, flags planCmdFlags) error {
// Check the directory exists.
box, err := devbox.Open(path, cmd.ErrOrStderr())
box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
if err != nil {
return errors.WithStack(err)
}
Expand Down
16 changes: 3 additions & 13 deletions internal/boxcli/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package boxcli

import (
"github.com/spf13/cobra"

"go.jetpack.io/devbox"
"go.jetpack.io/devbox/internal/boxcli/usererr"
"go.jetpack.io/devbox/internal/debug"
Expand Down Expand Up @@ -42,13 +43,7 @@ func runCmd() *cobra.Command {
}

func listScripts(cmd *cobra.Command, flags runCmdFlags) []string {
path, err := configPathFromUser([]string{}, &flags.config)
if err != nil {
debug.Log("failed to get config path from user: %v", err)
return nil
}

box, err := devbox.Open(path, cmd.ErrOrStderr())
box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
if err != nil {
debug.Log("failed to open devbox: %v", err)
return nil
Expand Down Expand Up @@ -78,11 +73,6 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
}

func parseScriptArgs(args []string, flags runCmdFlags) (string, string, []string, error) {
path, err := configPathFromUser([]string{}, &flags.config)
if err != nil {
return "", "", nil, err
}

if len(args) == 0 {
// this should never happen because cobra should prevent it, but it's better to be defensive.
return "", "", nil, usererr.New("no command or script provided")
Expand All @@ -91,5 +81,5 @@ func parseScriptArgs(args []string, flags runCmdFlags) (string, string, []string
script := args[0]
scriptArgs := args[1:]

return path, script, scriptArgs, nil
return flags.config.path, script, scriptArgs, nil
}
31 changes: 4 additions & 27 deletions internal/boxcli/shell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/pkg/errors"
"github.com/spf13/cobra"

"go.jetpack.io/devbox"
"go.jetpack.io/devbox/internal/boxcli/usererr"
)
Expand All @@ -28,7 +29,7 @@ func shellCmd() *cobra.Command {
Args: cobra.NoArgs,
PreRunE: ensureNixInstalled,
RunE: func(cmd *cobra.Command, args []string) error {
return runShellCmd(cmd, args, flags)
return runShellCmd(cmd, flags)
},
}

Expand All @@ -39,13 +40,9 @@ func shellCmd() *cobra.Command {
return command
}

func runShellCmd(cmd *cobra.Command, args []string, flags shellCmdFlags) error {
path, _, err := parseShellArgs(cmd, args, flags)
if err != nil {
return err
}
func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
// Check the directory exists.
box, err := devbox.Open(path, cmd.ErrOrStderr())
box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
if err != nil {
return errors.WithStack(err)
}
Expand All @@ -67,26 +64,6 @@ func runShellCmd(cmd *cobra.Command, args []string, flags shellCmdFlags) error {
return box.Shell(cmd.Context())
}

func parseShellArgs(cmd *cobra.Command, args []string, flags shellCmdFlags) (string, []string, error) {
// TODO: remove code that takes config path from an arguments.
index := cmd.ArgsLenAtDash()
if index < 0 {
configPath, err := configPathFromUser(args, &flags.config)
if err != nil {
return "", nil, err
}
return configPath, []string{}, nil
}

path, err := configPathFromUser(args[:index], &flags.config)
if err != nil {
return "", nil, err
}
cmds := args[index:]

return path, cmds, nil
}

func shellInceptionErrorMsg(cmdPath string) error {
return usererr.New("You are already in an active %[1]s.\nRun `exit` before calling `%[1]s` again."+
" Shell inception is not supported.", cmdPath)
Expand Down