Skip to content

feat(config): add --no-confirm flag to automatically create config files #42

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

Open
adrianreber wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(config): add --no-confirm flag to automatically create config files #42

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
19 changes: 2 additions & 17 deletions cmd/config-cluster-set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,8 @@ See ochami-config(5) for details on the configuration options.`,
fileToModify = config.UserConfigFile
}

// Ask to create file if it doesn't exist
if create, err := ios.askToCreate(fileToModify); err != nil {
if err != FileExistsError {
log.Logger.Error().Err(err).Msg("error asking to create file")
logHelpError(cmd)
os.Exit(1)
}
} else if create {
if err := createIfNotExists(fileToModify); err != nil {
log.Logger.Error().Err(err).Msg("error creating file")
logHelpError(cmd)
os.Exit(1)
}
} else {
log.Logger.Error().Msg("user declined to create file, not modifying")
os.Exit(0)
}
// Handle file creation based on --no-confirm flag
handleFileCreation(cmd, fileToModify)

// Perform modification
dflt, err := cmd.Flags().GetBool("default")
Expand Down
19 changes: 2 additions & 17 deletions cmd/config-set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,8 @@ See ochami-config(5) for details on the configuration options.`,
os.Exit(1)
}

// Ask to create file if it doesn't exist.
if create, err := ios.askToCreate(fileToModify); err != nil {
if err != FileExistsError {
log.Logger.Error().Err(err).Msg("error asking to create file")
logHelpError(cmd)
os.Exit(1)
}
} else if create {
if err := createIfNotExists(fileToModify); err != nil {
log.Logger.Error().Err(err).Msg("error creating file")
logHelpError(cmd)
os.Exit(1)
}
} else {
log.Logger.Error().Msg("user declined to create file, not modifying")
os.Exit(0)
}
// Handle file creation based on --no-confirm flag
handleFileCreation(cmd, fileToModify)

// Perform modification
if err := config.ModifyConfig(fileToModify, args[0], args[1]); err != nil {
Expand Down
1 change: 1 addition & 0 deletions cmd/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ See ochami-config(5) for details on the configuration options.`,
func init() {
configCmd.PersistentFlags().Bool("system", false, "modify system config")
configCmd.PersistentFlags().Bool("user", true, "modify user config")
configCmd.PersistentFlags().Bool("no-confirm", false, "create config file and parent directories without confirmation")

rootCmd.AddCommand(configCmd)
}
37 changes: 34 additions & 3 deletions cmd/lib.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,15 @@ func newIOStream(stdin io.Reader, stdout, stderr io.Writer) ioStream {
// askToCreate prompts the user to, if path does not exist, to create a blank
// file at path. If it exists, nil is returned. If the user declines, a
// UserDeclinedError is returned. If an error occurs during creation, an error
// is returned.
func (i ioStream) askToCreate(path string) (bool, error) {
// is returned. If noConfirm is true, it automatically returns true without prompting.
func (i ioStream) askToCreate(path string, noConfirm bool) (bool, error) {
if path == "" {
return false, fmt.Errorf("path cannot be empty")
}
if _, err := os.Stat(path); os.IsNotExist(err) {
if noConfirm {
return true, nil
}
respConfigCreate, err2 := i.loopYesNo(fmt.Sprintf("%s does not exist. Create it?", path))
if err2 != nil {
return false, fmt.Errorf("error fetching user input: %w", err2)
Expand Down Expand Up @@ -116,7 +119,7 @@ func initConfig(cmd *cobra.Command, create bool) error {
if configFile != "" {
if create {
// Try to create config file with default values if it doesn't exist
if cr, err := ios.askToCreate(configFile); err != nil {
if cr, err := ios.askToCreate(configFile, false); err != nil {
// Only return error if error is not one that the file
// already exists.
if !errors.Is(err, FileExistsError) {
Expand Down Expand Up @@ -216,6 +219,34 @@ func createIfNotExists(path string) error {
return nil
}

// handleFileCreation checks if a file should be created based on the --no-confirm flag.
// The flag is passed to askToCreate which handles the logic.
func handleFileCreation(cmd *cobra.Command, fileToModify string) {
noConfirmFlag, err := cmd.Flags().GetBool("no-confirm")
if err != nil {
log.Logger.Error().Err(err).Msg("failed to retrieve \"no-confirm\" flag")
logHelpError(cmd)
os.Exit(1)
}

if create, err := ios.askToCreate(fileToModify, noConfirmFlag); err != nil {
if err != FileExistsError {
log.Logger.Error().Err(err).Msg("error asking to create file")
logHelpError(cmd)
os.Exit(1)
}
} else if create {
if err := createIfNotExists(fileToModify); err != nil {
log.Logger.Error().Err(err).Msg("error creating file")
logHelpError(cmd)
os.Exit(1)
}
} else {
log.Logger.Error().Msg("user declined to create file, not modifying")
os.Exit(0)
}
}

// checkToken takes a pointer to a Cobra command and checks to see if --token
// was set. If not, an error is printed and the program exits.
func checkToken(cmd *cobra.Command) {
Expand Down
33 changes: 29 additions & 4 deletions cmd/lib_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func TestIOStream_askToCreate(t *testing.T) {
errBuf := &bytes.Buffer{}
ios := newIOStream(inBuf, outBuf, errBuf)

got, err := ios.askToCreate("")
got, err := ios.askToCreate("", false)
if got != false {
t.Errorf("askToCreate(\"\") = %v, want false", got)
}
Expand Down Expand Up @@ -49,7 +49,7 @@ func TestIOStream_askToCreate(t *testing.T) {
errBuf := &bytes.Buffer{}
ios := newIOStream(inBuf, outBuf, errBuf)

got, err := ios.askToCreate(f)
got, err := ios.askToCreate(f, false)
if got != false {
t.Errorf("askToCreate(%q) = %v, want false", f, got)
}
Expand All @@ -74,7 +74,7 @@ func TestIOStream_askToCreate(t *testing.T) {
errBuf := &bytes.Buffer{}
ios := newIOStream(inBuf, outBuf, errBuf)

got, err := ios.askToCreate(path)
got, err := ios.askToCreate(path, false)
if got != false {
t.Errorf("askToCreate(%q) decline = %v, want false", path, got)
}
Expand All @@ -100,7 +100,7 @@ func TestIOStream_askToCreate(t *testing.T) {
errBuf := &bytes.Buffer{}
ios := newIOStream(inBuf, outBuf, errBuf)

got, err := ios.askToCreate(path)
got, err := ios.askToCreate(path, false)
if got != true {
t.Errorf("askToCreate(%q) accept = %v, want true", path, got)
}
Expand All @@ -115,6 +115,31 @@ func TestIOStream_askToCreate(t *testing.T) {
t.Errorf("stdout = %q, want empty", outBuf.String())
}
})

t.Run("nonexistent file, no-confirm flag", func(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
path := filepath.Join(tmp, "noexist3")

inBuf := &bytes.Buffer{}
outBuf := &bytes.Buffer{}
errBuf := &bytes.Buffer{}
ios := newIOStream(inBuf, outBuf, errBuf)

got, err := ios.askToCreate(path, true)
if got != true {
t.Errorf("askToCreate(%q) noConfirm = %v, want true", path, got)
}
if err != nil {
t.Errorf("askToCreate(%q) noConfirm error = %v, want nil", path, err)
}
if errBuf.Len() != 0 {
t.Errorf("stderr = %q, want empty (no prompt should be shown)", errBuf.String())
}
if outBuf.Len() != 0 {
t.Errorf("stdout = %q, want empty", outBuf.String())
}
})
}

func TestIOStream_loopYesNo(t *testing.T) {
Expand Down
Loading