unarr/internal/upgrade/upgrade.go
Deivid Soto 3e0f3a5a64
Some checks failed
Release / release (push) Failing after 0s
Release / docker (push) Has been skipped
Release / virustotal (push) Failing after 0s
feat(cli): upgrade command, rich status, and version cache
- Replace `upgrade` stub with real command (alias for `self-update`)
- Also register `update` as alias: `unarr update` works too
- Rewrite `status` to show full config, disk usage, daemon state, and
  update availability with colored sections
- Add version check cache (1h TTL) so `status` is instant on repeat runs
- Guard against division by zero on empty filesystems
- Guard against negative durations from clock skew
- Guard against stale PID via heartbeat recency check (2 min)
- Add comprehensive test coverage across agent, engine, upgrade, usenet,
  arr, library, mediaserver, and UI packages
- Improve Makefile coverage target to exclude cmd/ glue code
- Fix stream handler resource cleanup and ffprobe error handling
2026-03-31 22:05:43 +02:00

230 lines
6.2 KiB
Go

// Package upgrade implements safe self-update for the unarr binary.
//
// The upgrade process:
// 1. Detect current binary path and verify write permissions
// 2. Download the release archive from GitHub
// 3. Verify SHA256 checksum against checksums.txt
// 4. Extract the binary from the archive
// 5. Smoke test: run the new binary with "version" to confirm it works
// 6. Backup the current binary
// 7. Replace with the new binary (preserving permissions)
// 8. On any failure: rollback from backup
package upgrade
import (
"context"
"fmt"
"log"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"time"
)
const (
githubRepo = "torrentclaw/unarr"
binaryName = "unarr"
smokeTestTO = 5 * time.Second
)
// Result represents the outcome of an upgrade attempt.
type Result struct {
Success bool
OldVersion string
NewVersion string
BackupPath string
Error error
}
// Upgrader handles downloading, verifying, and replacing the CLI binary.
type Upgrader struct {
CurrentVersion string
// OnProgress is called with status messages during the upgrade process.
OnProgress func(msg string)
}
func (u *Upgrader) log(msg string) {
if u.OnProgress != nil {
u.OnProgress(msg)
}
log.Printf("[upgrade] %s", msg)
}
// Execute performs a full upgrade to the target version.
func (u *Upgrader) Execute(ctx context.Context, targetVersion string) Result {
targetVersion = strings.TrimPrefix(targetVersion, "v")
if targetVersion == u.CurrentVersion {
return Result{Success: true, OldVersion: u.CurrentVersion, NewVersion: targetVersion}
}
// 1. Detect current binary path
binPath, err := os.Executable()
if err != nil {
return u.fail("detect binary: %v", err)
}
binPath, err = filepath.EvalSymlinks(binPath)
if err != nil {
return u.fail("resolve symlinks: %v", err)
}
// 2. Check Docker — self-update makes no sense in a container
if isDocker() {
return u.fail("running in Docker — update the container image instead")
}
// 3. Check write permissions
binDir := filepath.Dir(binPath)
if err := checkWritable(binDir); err != nil {
return u.fail("no write permission to %s — run with elevated privileges or move the binary to a user-writable location", binDir)
}
// 4. Download archive
u.log(fmt.Sprintf("Downloading v%s...", targetVersion))
archivePath, err := download(ctx, targetVersion)
if err != nil {
return u.fail("download: %v", err)
}
defer os.Remove(archivePath)
// 5. Verify checksum
u.log("Verifying checksum...")
if err := verifyChecksum(ctx, targetVersion, archivePath); err != nil {
return u.fail("checksum: %v", err)
}
// 6. Extract binary
u.log("Extracting...")
tmpDir, err := os.MkdirTemp("", "unarr-upgrade-*")
if err != nil {
return u.fail("create temp dir: %v", err)
}
defer os.RemoveAll(tmpDir)
newBinPath, err := extractBinary(archivePath, tmpDir)
if err != nil {
return u.fail("extract: %v", err)
}
// 7. Smoke test
u.log("Verifying new binary...")
if err := smokeTest(newBinPath, targetVersion); err != nil {
return u.fail("smoke test: %v", err)
}
// 8. Backup current binary
backupPath := binPath + ".backup"
u.log("Backing up current binary...")
if err := os.Rename(binPath, backupPath); err != nil {
return u.fail("backup: %v", err)
}
// 9. Replace with new binary
u.log("Installing new binary...")
if err := installBinary(newBinPath, binPath); err != nil {
// Rollback
u.log("Install failed, rolling back...")
if rbErr := os.Rename(backupPath, binPath); rbErr != nil {
return u.fail("install failed (%v) AND rollback failed (%v) — manual recovery needed at %s", err, rbErr, backupPath)
}
return u.fail("install (rolled back): %v", err)
}
u.log(fmt.Sprintf("Upgraded %s → %s", u.CurrentVersion, targetVersion))
return Result{
Success: true,
OldVersion: u.CurrentVersion,
NewVersion: targetVersion,
BackupPath: backupPath,
}
}
func (u *Upgrader) fail(format string, args ...any) Result {
err := fmt.Errorf(format, args...)
u.log(fmt.Sprintf("FAILED: %v", err))
return Result{
Success: false,
OldVersion: u.CurrentVersion,
Error: err,
}
}
// CheckLatest fetches the latest version from GitHub API and updates the cache.
func CheckLatest(ctx context.Context) (string, error) {
v, err := fetchLatestVersion(ctx)
if err == nil {
writeCachedVersion(v)
}
return v, err
}
// installBinary copies the new binary to the target path, preserving original permissions.
func installBinary(src, dst string) error {
// Read new binary
data, err := os.ReadFile(src)
if err != nil {
return fmt.Errorf("read new binary: %w", err)
}
// Write to destination with executable permissions
if err := os.WriteFile(dst, data, 0o755); err != nil {
return fmt.Errorf("write binary: %w", err)
}
return nil
}
// smokeTest runs the new binary with "version" and checks the output contains the expected version.
func smokeTest(binPath, expectedVersion string) error {
ctx, cancel := context.WithTimeout(context.Background(), smokeTestTO)
defer cancel()
out, err := exec.CommandContext(ctx, binPath, "version").CombinedOutput()
if err != nil {
return fmt.Errorf("failed to run: %w (output: %s)", err, string(out))
}
output := string(out)
if !strings.Contains(output, expectedVersion) {
return fmt.Errorf("version mismatch: expected %q in output %q", expectedVersion, output)
}
return nil
}
// isDocker returns true if running inside a Docker container.
func isDocker() bool {
if _, err := os.Stat("/.dockerenv"); err == nil {
return true
}
return false
}
// checkWritable verifies the directory is writable by creating and removing a temp file.
func checkWritable(dir string) error {
tmp := filepath.Join(dir, ".unarr-write-test")
f, err := os.Create(tmp)
if err != nil {
return err
}
f.Close()
os.Remove(tmp)
return nil
}
// archiveName returns the expected archive filename for this platform.
func archiveName(version string) string {
ext := "tar.gz"
if runtime.GOOS == "windows" {
ext = "zip"
}
return fmt.Sprintf("%s_%s_%s_%s.%s", binaryName, version, runtime.GOOS, runtime.GOARCH, ext)
}
// releaseURL returns the download URL for a release asset.
func releaseURL(version, filename string) string {
return fmt.Sprintf("https://github.com/%s/releases/download/v%s/%s", githubRepo, version, filename)
}