diff options
author | Francis Lavoie <lavofr@gmail.com> | 2021-11-08 13:35:46 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-08 11:35:46 -0700 |
commit | 749e55c738bf702b5f1265f85018c450a7b4e3b4 (patch) | |
tree | b2e93a4b87a050e6fdfce0bbea99bda4b67d33f6 /cmd/packagesfuncs.go | |
parent | 24fda7514ddeebf19a1e872343b45ec523eefcba (diff) |
caddycmd: Add `--keep-backup` to upgrade commands (#4387)
* caddycmd: Add `--skip-cleanup` to upgrade commands
This is a partial fix for https://github.com/caddyserver/caddy/issues/4057, making it possible to retain the old build of Caddy, in case something went wrong.
* caddycmd: Fix duplicate error message
The error message "download succeeded, but unable to execute" was repeated, because it was both in the `listModules`/`showVersion` functions and in the calling `upgradeBuild` function. Oversight when this was refactored.
* caddycmd: Implement fix for performing cleanup on Windows
Without this, the cleanup operation would fail with an error message like this:
upgrade: download succeeded, but unable to clean up backup binary: remove C:\caddy\caddy.exe.tmp: Access is denied.
* caddycmd: Rename to `--keep-backup`, simplify build constraints
Diffstat (limited to 'cmd/packagesfuncs.go')
-rw-r--r-- | cmd/packagesfuncs.go | 35 |
1 files changed, 16 insertions, 19 deletions
diff --git a/cmd/packagesfuncs.go b/cmd/packagesfuncs.go index c4f41ea..ca15ea3 100644 --- a/cmd/packagesfuncs.go +++ b/cmd/packagesfuncs.go @@ -31,7 +31,7 @@ import ( "go.uber.org/zap" ) -func cmdUpgrade(_ Flags) (int, error) { +func cmdUpgrade(fl Flags) (int, error) { _, nonstandard, _, err := getModules() if err != nil { return caddy.ExitCodeFailedStartup, fmt.Errorf("unable to enumerate installed plugins: %v", err) @@ -41,7 +41,7 @@ func cmdUpgrade(_ Flags) (int, error) { return caddy.ExitCodeFailedStartup, err } - return upgradeBuild(pluginPkgs) + return upgradeBuild(pluginPkgs, fl) } func cmdAddPackage(fl Flags) (int, error) { @@ -64,7 +64,7 @@ func cmdAddPackage(fl Flags) (int, error) { pluginPkgs[arg] = struct{}{} } - return upgradeBuild(pluginPkgs) + return upgradeBuild(pluginPkgs, fl) } func cmdRemovePackage(fl Flags) (int, error) { @@ -88,10 +88,10 @@ func cmdRemovePackage(fl Flags) (int, error) { delete(pluginPkgs, arg) } - return upgradeBuild(pluginPkgs) + return upgradeBuild(pluginPkgs, fl) } -func upgradeBuild(pluginPkgs map[string]struct{}) (int, error) { +func upgradeBuild(pluginPkgs map[string]struct{}, fl Flags) (int, error) { l := caddy.Log() thisExecPath, err := os.Executable() @@ -152,18 +152,23 @@ func upgradeBuild(pluginPkgs map[string]struct{}) (int, error) { // use the new binary to print out version and module info fmt.Print("\nModule versions:\n\n") if err = listModules(thisExecPath); err != nil { - return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to execute: %v", err) + return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to execute 'caddy list-modules': %v", err) } fmt.Println("\nVersion:") if err = showVersion(thisExecPath); err != nil { - return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to execute: %v", err) + return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to execute 'caddy version': %v", err) } fmt.Println() // clean up the backup file - if err = os.Remove(backupExecPath); err != nil { - return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to clean up backup binary: %v", err) + if !fl.Bool("keep-backup") { + if err = removeCaddyBinary(backupExecPath); err != nil { + return caddy.ExitCodeFailedStartup, fmt.Errorf("download succeeded, but unable to clean up backup binary: %v", err) + } + } else { + l.Info("skipped cleaning up the backup file", zap.String("backup_path", backupExecPath)) } + l.Info("upgrade successful; please restart any running Caddy instances", zap.String("executable", thisExecPath)) return caddy.ExitCodeSuccess, nil @@ -223,22 +228,14 @@ func listModules(path string) error { cmd := exec.Command(path, "list-modules", "--versions", "--skip-standard") cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr - err := cmd.Run() - if err != nil { - return fmt.Errorf("download succeeded, but unable to execute: %v", err) - } - return nil + return cmd.Run() } func showVersion(path string) error { cmd := exec.Command(path, "version") cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr - err := cmd.Run() - if err != nil { - return fmt.Errorf("download succeeded, but unable to execute: %v", err) - } - return nil + return cmd.Run() } func downloadBuild(qs url.Values) (*http.Response, error) { |