Compare commits
7 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0613a3aae8 | ||
|
|
bbd06db2df | ||
|
|
00f30708ac | ||
|
|
333857cb3a | ||
|
|
ee154a2c15 | ||
| e605041fa8 | |||
|
|
0efc1ebc80 |
14 changed files with 497 additions and 51 deletions
75
CLAUDE.md
Normal file
75
CLAUDE.md
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
# CLAUDE.md — go-update
|
||||
|
||||
This file provides guidance to Claude Code when working with the `go-update` package.
|
||||
|
||||
## Package Overview
|
||||
|
||||
`go-update` (`forge.lthn.ai/core/go-update`) is a **self-updater library** for Go applications. It supports updates from GitHub releases and generic HTTP endpoints, with configurable startup behaviour and version channel filtering.
|
||||
|
||||
## Build & Test Commands
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
go test ./...
|
||||
|
||||
# Run tests with coverage
|
||||
go test -cover ./...
|
||||
|
||||
# Run a single test
|
||||
go test -run TestName ./...
|
||||
|
||||
# Generate version.go from package.json
|
||||
go generate ./...
|
||||
|
||||
# Vet and lint
|
||||
go vet ./...
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Update Sources
|
||||
|
||||
| Source | Description |
|
||||
|--------|-------------|
|
||||
| GitHub Releases | Fetches releases via GitHub API, filters by channel (stable/beta/alpha) |
|
||||
| Generic HTTP | Fetches `latest.json` from a base URL with version + download URL |
|
||||
|
||||
### Key Types
|
||||
|
||||
- **`UpdateService`** — Configured service that checks for updates on startup
|
||||
- **`GithubClient`** — Interface for GitHub API interactions (mockable for tests)
|
||||
- **`Release`** / **`ReleaseAsset`** — GitHub release model
|
||||
- **`GenericUpdateInfo`** — HTTP update endpoint model
|
||||
|
||||
### Testable Function Variables
|
||||
|
||||
Core update logic is exposed as `var` function values so tests can replace them:
|
||||
|
||||
- `NewGithubClient` — Factory for GitHub client (replace with mock)
|
||||
- `DoUpdate` — Performs the actual binary update
|
||||
- `CheckForNewerVersion`, `CheckForUpdates`, `CheckOnly` — GitHub update flow
|
||||
- `CheckForUpdatesHTTP`, `CheckOnlyHTTP` — HTTP update flow
|
||||
- `NewAuthenticatedClient` — HTTP client factory (supports `GITHUB_TOKEN`)
|
||||
|
||||
### Error Handling
|
||||
|
||||
All errors **must** use `coreerr.E()` from `forge.lthn.ai/core/go-log`:
|
||||
|
||||
```go
|
||||
import coreerr "forge.lthn.ai/core/go-log"
|
||||
|
||||
return coreerr.E("FunctionName", "what failed", underlyingErr)
|
||||
```
|
||||
|
||||
Never use `fmt.Errorf` or `errors.New`.
|
||||
|
||||
### File I/O
|
||||
|
||||
Use `forge.lthn.ai/core/go-io` for file operations, not `os.ReadFile`/`os.WriteFile`.
|
||||
|
||||
## Coding Standards
|
||||
|
||||
- **UK English** in comments and strings
|
||||
- **Strict types**: All parameters and return types
|
||||
- **Test naming**: `_Good`, `_Bad`, `_Ugly` suffix pattern
|
||||
- **License**: EUPL-1.2
|
||||
|
|
@ -3,32 +3,33 @@ package main
|
|||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
coreio "forge.lthn.ai/core/go-io"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Read package.json
|
||||
data, err := os.ReadFile("package.json")
|
||||
data, err := coreio.Read(coreio.Local, "package.json")
|
||||
if err != nil {
|
||||
fmt.Println("Error reading package.json, skipping version file generation.")
|
||||
os.Exit(0)
|
||||
return
|
||||
}
|
||||
|
||||
// Parse package.json
|
||||
var pkg struct {
|
||||
Version string `json:"version"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &pkg); err != nil {
|
||||
if err := json.Unmarshal([]byte(data), &pkg); err != nil {
|
||||
fmt.Println("Error parsing package.json, skipping version file generation.")
|
||||
os.Exit(0)
|
||||
return
|
||||
}
|
||||
|
||||
// Create the version file
|
||||
content := fmt.Sprintf("package updater\n\n// Generated by go:generate. DO NOT EDIT.\n\nconst PkgVersion = %q\n", pkg.Version)
|
||||
err = os.WriteFile("version.go", []byte(content), 0644)
|
||||
err = coreio.Write(coreio.Local, "version.go", content)
|
||||
if err != nil {
|
||||
fmt.Printf("Error writing version file: %v\n", err)
|
||||
os.Exit(1)
|
||||
return
|
||||
}
|
||||
|
||||
fmt.Println("Generated version.go with version:", pkg.Version)
|
||||
|
|
|
|||
17
cmd.go
17
cmd.go
|
|
@ -45,9 +45,9 @@ Examples:
|
|||
RunE: runUpdate,
|
||||
}
|
||||
|
||||
updateCmd.PersistentFlags().StringVar(&updateChannel, "channel", "stable", "Release channel: stable, beta, alpha, or dev")
|
||||
updateCmd.PersistentFlags().StringVar(&updateChannel, "channel", "stable", "Release channel: stable, beta, alpha, prerelease, or dev")
|
||||
updateCmd.PersistentFlags().BoolVar(&updateForce, "force", false, "Force update even if already on latest version")
|
||||
updateCmd.Flags().BoolVar(&updateCheck, "check", false, "Only check for updates, don't apply")
|
||||
updateCmd.Flags().BoolVar(&updateCheck, "check", false, "Only check for updates, do not apply")
|
||||
updateCmd.Flags().IntVar(&updateWatchPID, "watch-pid", 0, "Internal: watch for parent PID to die then restart")
|
||||
_ = updateCmd.Flags().MarkHidden("watch-pid")
|
||||
|
||||
|
|
@ -55,7 +55,9 @@ Examples:
|
|||
Use: "check",
|
||||
Short: "Check for available updates",
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
previousCheck := updateCheck
|
||||
updateCheck = true
|
||||
defer func() { updateCheck = previousCheck }()
|
||||
return runUpdate(cmd, args)
|
||||
},
|
||||
})
|
||||
|
|
@ -70,24 +72,25 @@ func runUpdate(cmd *cobra.Command, args []string) error {
|
|||
}
|
||||
|
||||
currentVersion := cli.AppVersion
|
||||
normalizedChannel := normaliseGitHubChannel(updateChannel)
|
||||
|
||||
cli.Print("%s %s\n", cli.DimStyle.Render("Current version:"), cli.ValueStyle.Render(currentVersion))
|
||||
cli.Print("%s %s/%s\n", cli.DimStyle.Render("Platform:"), runtime.GOOS, runtime.GOARCH)
|
||||
cli.Print("%s %s\n\n", cli.DimStyle.Render("Channel:"), updateChannel)
|
||||
cli.Print("%s %s\n\n", cli.DimStyle.Render("Channel:"), normalizedChannel)
|
||||
|
||||
// Handle dev channel specially - it's a prerelease tag, not a semver channel
|
||||
if updateChannel == "dev" {
|
||||
if normalizedChannel == "dev" {
|
||||
return handleDevUpdate(currentVersion)
|
||||
}
|
||||
|
||||
// Check for newer version
|
||||
release, updateAvailable, err := CheckForNewerVersion(repoOwner, repoName, updateChannel, true)
|
||||
release, updateAvailable, err := CheckForNewerVersion(repoOwner, repoName, normalizedChannel, true)
|
||||
if err != nil {
|
||||
return cli.Wrap(err, "failed to check for updates")
|
||||
}
|
||||
|
||||
if release == nil {
|
||||
cli.Print("%s No releases found in %s channel\n", cli.WarningStyle.Render("!"), updateChannel)
|
||||
cli.Print("%s No releases found in %s channel\n", cli.WarningStyle.Render("!"), normalizedChannel)
|
||||
return nil
|
||||
}
|
||||
|
||||
|
|
@ -140,7 +143,7 @@ func handleDevUpdate(currentVersion string) error {
|
|||
client := NewGithubClient()
|
||||
|
||||
// Fetch the dev release directly by tag
|
||||
release, err := client.GetLatestRelease(context.TODO(), repoOwner, repoName, "beta")
|
||||
release, err := client.GetLatestRelease(context.Background(), repoOwner, repoName, "beta")
|
||||
if err != nil {
|
||||
// Try fetching the "dev" tag directly
|
||||
return handleDevTagUpdate(currentVersion)
|
||||
|
|
|
|||
|
|
@ -26,9 +26,7 @@ The `CheckOnStartup` field can take one of the following values:
|
|||
|
||||
If you are using the example CLI provided in `cmd/updater`, the following flags are available:
|
||||
|
||||
* `--check-update`: Check for new updates without applying them.
|
||||
* `--do-update`: Perform an update if available.
|
||||
* `--channel`: Set the update channel (e.g., stable, beta, alpha). If not set, it's determined from the current version tag.
|
||||
* `--force-semver-prefix`: Force 'v' prefix on semver tags (default `true`).
|
||||
* `--release-url-format`: A URL format for release assets.
|
||||
* `--pull-request`: Update to a specific pull request (integer ID).
|
||||
* `--check`: Check for new updates without applying them.
|
||||
* `--channel`: Set the update channel (e.g., stable, beta, alpha). Defaults to `stable`.
|
||||
* `--force`: Force update even when already on latest.
|
||||
* `--watch-pid`: Internal flag used during restart after update.
|
||||
|
|
|
|||
|
|
@ -3,8 +3,10 @@ package updater
|
|||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"context"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
coreerr "forge.lthn.ai/core/go-log"
|
||||
)
|
||||
|
|
@ -31,10 +33,16 @@ func GetLatestUpdateFromURL(baseURL string) (*GenericUpdateInfo, error) {
|
|||
if err != nil {
|
||||
return nil, coreerr.E("GetLatestUpdateFromURL", "invalid base URL", err)
|
||||
}
|
||||
// Append latest.json to the path
|
||||
u.Path += "/latest.json"
|
||||
|
||||
resp, err := http.Get(u.String())
|
||||
// Append latest.json to the path
|
||||
u.Path = strings.TrimSuffix(u.Path, "/") + "/latest.json"
|
||||
|
||||
req, err := newAgentRequest(context.Background(), "GET", u.String())
|
||||
if err != nil {
|
||||
return nil, coreerr.E("GetLatestUpdateFromURL", "failed to create update check request", err)
|
||||
}
|
||||
|
||||
resp, err := NewHTTPClient().Do(req)
|
||||
if err != nil {
|
||||
return nil, coreerr.E("GetLatestUpdateFromURL", "failed to fetch latest.json", err)
|
||||
}
|
||||
|
|
|
|||
17
github.go
17
github.go
|
|
@ -52,10 +52,13 @@ var NewAuthenticatedClient = func(ctx context.Context) *http.Client {
|
|||
if token == "" {
|
||||
return http.DefaultClient
|
||||
}
|
||||
|
||||
ts := oauth2.StaticTokenSource(
|
||||
&oauth2.Token{AccessToken: token},
|
||||
)
|
||||
return oauth2.NewClient(ctx, ts)
|
||||
client := oauth2.NewClient(ctx, ts)
|
||||
client.Timeout = defaultHTTPTimeout
|
||||
return client
|
||||
}
|
||||
|
||||
func (g *githubClient) GetPublicRepos(ctx context.Context, userOrOrg string) ([]string, error) {
|
||||
|
|
@ -71,11 +74,10 @@ func (g *githubClient) getPublicReposWithAPIURL(ctx context.Context, apiURL, use
|
|||
if err := ctx.Err(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
req, err := newAgentRequest(ctx, "GET", url)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("User-Agent", "Borg-Data-Collector")
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
|
@ -85,11 +87,10 @@ func (g *githubClient) getPublicReposWithAPIURL(ctx context.Context, apiURL, use
|
|||
_ = resp.Body.Close()
|
||||
// Try organization endpoint
|
||||
url = fmt.Sprintf("%s/orgs/%s/repos", apiURL, userOrOrg)
|
||||
req, err = http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
req, err = newAgentRequest(ctx, "GET", url)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("User-Agent", "Borg-Data-Collector")
|
||||
resp, err = client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
|
@ -143,11 +144,10 @@ func (g *githubClient) GetLatestRelease(ctx context.Context, owner, repo, channe
|
|||
client := NewAuthenticatedClient(ctx)
|
||||
url := fmt.Sprintf("https://api.github.com/repos/%s/%s/releases", owner, repo)
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
req, err := newAgentRequest(ctx, "GET", url)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("User-Agent", "Borg-Data-Collector")
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
|
|
@ -198,11 +198,10 @@ func (g *githubClient) GetReleaseByPullRequest(ctx context.Context, owner, repo
|
|||
client := NewAuthenticatedClient(ctx)
|
||||
url := fmt.Sprintf("https://api.github.com/repos/%s/%s/releases", owner, repo)
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
req, err := newAgentRequest(ctx, "GET", url)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("User-Agent", "Borg-Data-Collector")
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
|
|
|
|||
284
github_internal_test.go
Normal file
284
github_internal_test.go
Normal file
|
|
@ -0,0 +1,284 @@
|
|||
package updater
|
||||
|
||||
import (
|
||||
"runtime"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestFilterReleases_Good(t *testing.T) {
|
||||
releases := []Release{
|
||||
{TagName: "v1.0.0-alpha.1", PreRelease: true},
|
||||
{TagName: "v1.0.0-beta.1", PreRelease: true},
|
||||
{TagName: "v1.0.0", PreRelease: false},
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
channel string
|
||||
wantTag string
|
||||
}{
|
||||
{"stable", "v1.0.0"},
|
||||
{"alpha", "v1.0.0-alpha.1"},
|
||||
{"beta", "v1.0.0-beta.1"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.channel, func(t *testing.T) {
|
||||
got := filterReleases(releases, tt.channel)
|
||||
if got == nil {
|
||||
t.Fatalf("expected release for channel %q, got nil", tt.channel)
|
||||
}
|
||||
if got.TagName != tt.wantTag {
|
||||
t.Errorf("expected tag %q, got %q", tt.wantTag, got.TagName)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterReleases_Bad(t *testing.T) {
|
||||
releases := []Release{
|
||||
{TagName: "v1.0.0", PreRelease: false},
|
||||
}
|
||||
got := filterReleases(releases, "alpha")
|
||||
if got != nil {
|
||||
t.Errorf("expected nil for non-matching channel, got %v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFilterReleases_PreReleaseWithoutLabel(t *testing.T) {
|
||||
releases := []Release{
|
||||
{TagName: "v2.0.0-rc.1", PreRelease: true},
|
||||
}
|
||||
got := filterReleases(releases, "beta")
|
||||
if got == nil {
|
||||
t.Fatal("expected pre-release without alpha/beta label to match beta channel")
|
||||
}
|
||||
if got.TagName != "v2.0.0-rc.1" {
|
||||
t.Errorf("expected tag %q, got %q", "v2.0.0-rc.1", got.TagName)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDetermineChannel_Good(t *testing.T) {
|
||||
tests := []struct {
|
||||
tag string
|
||||
isPreRelease bool
|
||||
want string
|
||||
}{
|
||||
{"v1.0.0", false, "stable"},
|
||||
{"v1.0.0-alpha.1", false, "alpha"},
|
||||
{"v1.0.0-ALPHA.1", false, "alpha"},
|
||||
{"v1.0.0-beta.1", false, "beta"},
|
||||
{"v1.0.0-BETA.1", false, "beta"},
|
||||
{"v1.0.0-rc.1", true, "beta"},
|
||||
{"v1.0.0-rc.1", false, "stable"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.tag, func(t *testing.T) {
|
||||
got := determineChannel(tt.tag, tt.isPreRelease)
|
||||
if got != tt.want {
|
||||
t.Errorf("determineChannel(%q, %v) = %q, want %q", tt.tag, tt.isPreRelease, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckForUpdatesByTag_UsesCurrentVersionChannel(t *testing.T) {
|
||||
originalVersion := Version
|
||||
originalCheckForUpdates := CheckForUpdates
|
||||
defer func() {
|
||||
Version = originalVersion
|
||||
CheckForUpdates = originalCheckForUpdates
|
||||
}()
|
||||
|
||||
var gotChannel string
|
||||
CheckForUpdates = func(owner, repo, channel string, forceSemVerPrefix bool, releaseURLFormat string) error {
|
||||
gotChannel = channel
|
||||
return nil
|
||||
}
|
||||
|
||||
Version = "v2.0.0-rc.1"
|
||||
if err := CheckForUpdatesByTag("owner", "repo"); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if gotChannel != "beta" {
|
||||
t.Fatalf("expected beta channel, got %q", gotChannel)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckOnlyByTag_UsesCurrentVersionChannel(t *testing.T) {
|
||||
originalVersion := Version
|
||||
originalCheckOnly := CheckOnly
|
||||
defer func() {
|
||||
Version = originalVersion
|
||||
CheckOnly = originalCheckOnly
|
||||
}()
|
||||
|
||||
var gotChannel string
|
||||
CheckOnly = func(owner, repo, channel string, forceSemVerPrefix bool, releaseURLFormat string) error {
|
||||
gotChannel = channel
|
||||
return nil
|
||||
}
|
||||
|
||||
Version = "v2.0.0-alpha.1"
|
||||
if err := CheckOnlyByTag("owner", "repo"); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if gotChannel != "alpha" {
|
||||
t.Fatalf("expected alpha channel, got %q", gotChannel)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetDownloadURL_Good(t *testing.T) {
|
||||
osName := runtime.GOOS
|
||||
archName := runtime.GOARCH
|
||||
|
||||
release := &Release{
|
||||
TagName: "v1.2.3",
|
||||
Assets: []ReleaseAsset{
|
||||
{Name: "app-" + osName + "-" + archName, DownloadURL: "https://example.com/full-match"},
|
||||
{Name: "app-" + osName, DownloadURL: "https://example.com/os-only"},
|
||||
},
|
||||
}
|
||||
|
||||
url, err := GetDownloadURL(release, "")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if url != "https://example.com/full-match" {
|
||||
t.Errorf("expected full match URL, got %q", url)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetDownloadURL_OSOnlyFallback(t *testing.T) {
|
||||
osName := runtime.GOOS
|
||||
|
||||
release := &Release{
|
||||
TagName: "v1.2.3",
|
||||
Assets: []ReleaseAsset{
|
||||
{Name: "app-other-other", DownloadURL: "https://example.com/other"},
|
||||
{Name: "app-" + osName + "-other", DownloadURL: "https://example.com/os-only"},
|
||||
},
|
||||
}
|
||||
|
||||
url, err := GetDownloadURL(release, "")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if url != "https://example.com/os-only" {
|
||||
t.Errorf("expected OS-only fallback URL, got %q", url)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetDownloadURL_WithFormat(t *testing.T) {
|
||||
release := &Release{TagName: "v1.2.3"}
|
||||
|
||||
url, err := GetDownloadURL(release, "https://example.com/{tag}/{os}/{arch}")
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
expected := "https://example.com/v1.2.3/" + runtime.GOOS + "/" + runtime.GOARCH
|
||||
if url != expected {
|
||||
t.Errorf("expected %q, got %q", expected, url)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetDownloadURL_Bad(t *testing.T) {
|
||||
// nil release
|
||||
_, err := GetDownloadURL(nil, "")
|
||||
if err == nil {
|
||||
t.Error("expected error for nil release")
|
||||
}
|
||||
|
||||
// No matching assets
|
||||
release := &Release{
|
||||
TagName: "v1.2.3",
|
||||
Assets: []ReleaseAsset{
|
||||
{Name: "app-unknownos-unknownarch", DownloadURL: "https://example.com/other"},
|
||||
},
|
||||
}
|
||||
_, err = GetDownloadURL(release, "")
|
||||
if err == nil {
|
||||
t.Error("expected error when no suitable asset found")
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatVersionForComparison(t *testing.T) {
|
||||
tests := []struct {
|
||||
input string
|
||||
want string
|
||||
}{
|
||||
{"1.0.0", "v1.0.0"},
|
||||
{"v1.0.0", "v1.0.0"},
|
||||
{"", ""},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.input, func(t *testing.T) {
|
||||
got := formatVersionForComparison(tt.input)
|
||||
if got != tt.want {
|
||||
t.Errorf("formatVersionForComparison(%q) = %q, want %q", tt.input, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatVersionForDisplay(t *testing.T) {
|
||||
tests := []struct {
|
||||
version string
|
||||
force bool
|
||||
want string
|
||||
}{
|
||||
{"1.0.0", true, "v1.0.0"},
|
||||
{"v1.0.0", true, "v1.0.0"},
|
||||
{"v1.0.0", false, "1.0.0"},
|
||||
{"1.0.0", false, "1.0.0"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.version+"_force_"+boolStr(tt.force), func(t *testing.T) {
|
||||
got := formatVersionForDisplay(tt.version, tt.force)
|
||||
if got != tt.want {
|
||||
t.Errorf("formatVersionForDisplay(%q, %v) = %q, want %q", tt.version, tt.force, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func boolStr(b bool) string {
|
||||
if b {
|
||||
return "true"
|
||||
}
|
||||
return "false"
|
||||
}
|
||||
|
||||
func TestStartGitHubCheck_UnknownMode(t *testing.T) {
|
||||
s := &UpdateService{
|
||||
config: UpdateServiceConfig{
|
||||
CheckOnStartup: StartupCheckMode(99),
|
||||
},
|
||||
isGitHub: true,
|
||||
owner: "owner",
|
||||
repo: "repo",
|
||||
}
|
||||
err := s.Start()
|
||||
if err == nil {
|
||||
t.Error("expected error for unknown startup check mode")
|
||||
}
|
||||
}
|
||||
|
||||
func TestStartHTTPCheck_UnknownMode(t *testing.T) {
|
||||
s := &UpdateService{
|
||||
config: UpdateServiceConfig{
|
||||
RepoURL: "https://example.com/updates",
|
||||
CheckOnStartup: StartupCheckMode(99),
|
||||
},
|
||||
isGitHub: false,
|
||||
}
|
||||
err := s.Start()
|
||||
if err == nil {
|
||||
t.Error("expected error for unknown startup check mode")
|
||||
}
|
||||
}
|
||||
13
go.mod
13
go.mod
|
|
@ -1,10 +1,11 @@
|
|||
module forge.lthn.ai/core/go-update
|
||||
module dappco.re/go/core/update
|
||||
|
||||
go 1.26.0
|
||||
|
||||
require (
|
||||
forge.lthn.ai/core/cli v0.3.6
|
||||
forge.lthn.ai/core/go-log v0.0.4
|
||||
dappco.re/go/core/cli v0.3.6
|
||||
dappco.re/go/core/io v0.1.5
|
||||
dappco.re/go/core/log v0.0.4
|
||||
github.com/Snider/Borg v0.2.0
|
||||
github.com/minio/selfupdate v0.6.0
|
||||
github.com/spf13/cobra v1.10.2
|
||||
|
|
@ -15,9 +16,9 @@ require (
|
|||
require (
|
||||
aead.dev/minisign v0.3.0 // indirect
|
||||
dario.cat/mergo v1.0.0 // indirect
|
||||
forge.lthn.ai/core/go v0.3.1 // indirect
|
||||
forge.lthn.ai/core/go-i18n v0.1.6 // indirect
|
||||
forge.lthn.ai/core/go-inference v0.1.5 // indirect
|
||||
dappco.re/go/core v0.3.1 // indirect
|
||||
dappco.re/go/core/i18n v0.1.6 // indirect
|
||||
dappco.re/go/core/inference v0.1.5 // indirect
|
||||
github.com/Microsoft/go-winio v0.6.2 // indirect
|
||||
github.com/ProtonMail/go-crypto v1.4.0 // indirect
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
|
||||
|
|
|
|||
2
go.sum
2
go.sum
|
|
@ -11,6 +11,8 @@ forge.lthn.ai/core/go-i18n v0.1.6 h1:Z9h6sEZsgJmWlkkq3ZPZyfgWipeeqN5lDCpzltpamHU
|
|||
forge.lthn.ai/core/go-i18n v0.1.6/go.mod h1:C6CbwdN7sejTx/lbutBPrxm77b8paMHBO6uHVLHOdqQ=
|
||||
forge.lthn.ai/core/go-inference v0.1.5 h1:Az/Euv1DusJQJz/Eca0Ey7sVXQkFLPHW0TBrs9g+Qwg=
|
||||
forge.lthn.ai/core/go-inference v0.1.5/go.mod h1:jfWz+IJX55wAH98+ic6FEqqGB6/P31CHlg7VY7pxREw=
|
||||
forge.lthn.ai/core/go-io v0.1.5 h1:+XJ1YhaGGFLGtcNbPtVlndTjk+pO0Ydi2hRDj5/cHOM=
|
||||
forge.lthn.ai/core/go-io v0.1.5/go.mod h1:FRtXSsi8W+U9vewCU+LBAqqbIj3wjXA4dBdSv3SAtWI=
|
||||
forge.lthn.ai/core/go-log v0.0.4 h1:KTuCEPgFmuM8KJfnyQ8vPOU1Jg654W74h8IJvfQMfv0=
|
||||
forge.lthn.ai/core/go-log v0.0.4/go.mod h1:r14MXKOD3LF/sI8XUJQhRk/SZHBE7jAFVuCfgkXoZPw=
|
||||
github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY=
|
||||
|
|
|
|||
32
http_client.go
Normal file
32
http_client.go
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
package updater
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"time"
|
||||
)
|
||||
|
||||
const defaultHTTPTimeout = 30 * time.Second
|
||||
|
||||
var NewHTTPClient = func() *http.Client {
|
||||
return &http.Client{Timeout: defaultHTTPTimeout}
|
||||
}
|
||||
|
||||
func newAgentRequest(ctx context.Context, method, url string) (*http.Request, error) {
|
||||
req, err := http.NewRequestWithContext(ctx, method, url, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
req.Header.Set("User-Agent", updaterUserAgent())
|
||||
return req, nil
|
||||
}
|
||||
|
||||
func updaterUserAgent() string {
|
||||
version := formatVersionForDisplay(Version, true)
|
||||
if version == "" {
|
||||
version = "unknown"
|
||||
}
|
||||
return fmt.Sprintf("agent-go-update/%s", version)
|
||||
}
|
||||
15
service.go
15
service.go
|
|
@ -30,7 +30,8 @@ type UpdateServiceConfig struct {
|
|||
// repository URL (e.g., "https://github.com/owner/repo") or a base URL
|
||||
// for a generic HTTP update server.
|
||||
RepoURL string
|
||||
// Channel specifies the release channel to track (e.g., "stable", "prerelease").
|
||||
// Channel specifies the release channel to track (e.g., "stable", "beta", or "prerelease").
|
||||
// "prerelease" is normalised to "beta" to match the GitHub release filter.
|
||||
// This is only used for GitHub-based updates.
|
||||
Channel string
|
||||
// CheckOnStartup determines the update behavior when the service starts.
|
||||
|
|
@ -63,6 +64,7 @@ func NewUpdateService(config UpdateServiceConfig) (*UpdateService, error) {
|
|||
var err error
|
||||
|
||||
if isGitHub {
|
||||
config.Channel = normaliseGitHubChannel(config.Channel)
|
||||
owner, repo, err = ParseRepoURL(config.RepoURL)
|
||||
if err != nil {
|
||||
return nil, coreerr.E("NewUpdateService", "failed to parse GitHub repo URL", err)
|
||||
|
|
@ -127,3 +129,14 @@ func ParseRepoURL(repoURL string) (owner string, repo string, err error) {
|
|||
}
|
||||
return parts[0], parts[1], nil
|
||||
}
|
||||
|
||||
func normaliseGitHubChannel(channel string) string {
|
||||
channel = strings.ToLower(strings.TrimSpace(channel))
|
||||
if channel == "" {
|
||||
return "stable"
|
||||
}
|
||||
if channel == "prerelease" {
|
||||
return "beta"
|
||||
}
|
||||
return channel
|
||||
}
|
||||
|
|
|
|||
|
|
@ -12,13 +12,15 @@ func TestNewUpdateService(t *testing.T) {
|
|||
config UpdateServiceConfig
|
||||
expectError bool
|
||||
isGitHub bool
|
||||
wantChannel string
|
||||
}{
|
||||
{
|
||||
name: "Valid GitHub URL",
|
||||
config: UpdateServiceConfig{
|
||||
RepoURL: "https://github.com/owner/repo",
|
||||
},
|
||||
isGitHub: true,
|
||||
isGitHub: true,
|
||||
wantChannel: "stable",
|
||||
},
|
||||
{
|
||||
name: "Valid non-GitHub URL",
|
||||
|
|
@ -27,6 +29,24 @@ func TestNewUpdateService(t *testing.T) {
|
|||
},
|
||||
isGitHub: false,
|
||||
},
|
||||
{
|
||||
name: "GitHub channel is normalised",
|
||||
config: UpdateServiceConfig{
|
||||
RepoURL: "https://github.com/owner/repo",
|
||||
Channel: " Beta ",
|
||||
},
|
||||
isGitHub: true,
|
||||
wantChannel: "beta",
|
||||
},
|
||||
{
|
||||
name: "GitHub prerelease channel maps to beta",
|
||||
config: UpdateServiceConfig{
|
||||
RepoURL: "https://github.com/owner/repo",
|
||||
Channel: " prerelease ",
|
||||
},
|
||||
isGitHub: true,
|
||||
wantChannel: "beta",
|
||||
},
|
||||
{
|
||||
name: "Invalid GitHub URL",
|
||||
config: UpdateServiceConfig{
|
||||
|
|
@ -45,6 +65,9 @@ func TestNewUpdateService(t *testing.T) {
|
|||
if err == nil && service.isGitHub != tc.isGitHub {
|
||||
t.Errorf("Expected isGitHub: %v, got: %v", tc.isGitHub, service.isGitHub)
|
||||
}
|
||||
if err == nil && tc.wantChannel != "" && service.config.Channel != tc.wantChannel {
|
||||
t.Errorf("Expected GitHub channel %q, got %q", tc.wantChannel, service.config.Channel)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
25
updater.go
25
updater.go
|
|
@ -31,17 +31,24 @@ var NewGithubClient = func() GithubClient {
|
|||
// DoUpdate is a variable that holds the function to perform the actual update.
|
||||
// This can be replaced in tests to prevent actual updates.
|
||||
var DoUpdate = func(url string) error {
|
||||
resp, err := http.Get(url)
|
||||
client := NewHTTPClient()
|
||||
req, err := newAgentRequest(context.Background(), "GET", url)
|
||||
if err != nil {
|
||||
return err
|
||||
return coreerr.E("DoUpdate", "failed to create update request", err)
|
||||
}
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return coreerr.E("DoUpdate", "failed to download update", err)
|
||||
}
|
||||
defer func(Body io.ReadCloser) {
|
||||
err := Body.Close()
|
||||
if err != nil {
|
||||
fmt.Printf("failed to close response body: %v\n", err)
|
||||
}
|
||||
_ = Body.Close()
|
||||
}(resp.Body)
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return coreerr.E("DoUpdate", fmt.Sprintf("failed to download update: %s", resp.Status), nil)
|
||||
}
|
||||
|
||||
err = selfupdate.Apply(resp.Body, selfupdate.Options{})
|
||||
if err != nil {
|
||||
if rerr := selfupdate.RollbackError(err); rerr != nil {
|
||||
|
|
@ -49,8 +56,6 @@ var DoUpdate = func(url string) error {
|
|||
}
|
||||
return coreerr.E("DoUpdate", "update failed", err)
|
||||
}
|
||||
|
||||
fmt.Println("Update applied successfully.")
|
||||
return nil
|
||||
}
|
||||
|
||||
|
|
@ -140,14 +145,14 @@ var CheckOnly = func(owner, repo, channel string, forceSemVerPrefix bool, releas
|
|||
// CheckForUpdatesByTag checks for and applies updates from GitHub based on the channel
|
||||
// determined by the current application's version tag (e.g., 'stable' or 'prerelease').
|
||||
var CheckForUpdatesByTag = func(owner, repo string) error {
|
||||
channel := determineChannel(Version, false) // isPreRelease is false for current version
|
||||
channel := determineChannel(Version, semver.Prerelease(formatVersionForComparison(Version)) != "")
|
||||
return CheckForUpdates(owner, repo, channel, true, "")
|
||||
}
|
||||
|
||||
// CheckOnlyByTag checks for updates from GitHub based on the channel determined by the
|
||||
// current version tag, without applying them.
|
||||
var CheckOnlyByTag = func(owner, repo string) error {
|
||||
channel := determineChannel(Version, false) // isPreRelease is false for current version
|
||||
channel := determineChannel(Version, semver.Prerelease(formatVersionForComparison(Version)) != "")
|
||||
return CheckOnly(owner, repo, channel, true, "")
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ import (
|
|||
"net/http"
|
||||
"net/http/httptest"
|
||||
"runtime"
|
||||
|
||||
coreerr "forge.lthn.ai/core/go-log"
|
||||
)
|
||||
|
||||
// mockGithubClient is a mock implementation of the GithubClient interface for testing.
|
||||
|
|
@ -34,7 +36,7 @@ func (m *mockGithubClient) GetPublicRepos(ctx context.Context, userOrOrg string)
|
|||
if m.getPublicRepos != nil {
|
||||
return m.getPublicRepos(ctx, userOrOrg)
|
||||
}
|
||||
return nil, fmt.Errorf("GetPublicRepos not implemented")
|
||||
return nil, coreerr.E("mockGithubClient.GetPublicRepos", "not implemented", nil)
|
||||
}
|
||||
|
||||
func ExampleCheckForNewerVersion() {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue