f1820fd104
## Why
OS package remotes (rpm/deb/apk) fetch many small files and benefit from spreading upstream load across mirrors and surviving a mirror outage. A remote may now set a **`mirrorlist`** of additional upstream base URLs. The effective upstream pool is **`[base_url] + mirrorlist`**, which the shared proxy engine load-balances **round-robin** and, on a network error/timeout/5xx, **fails over** to the next mirror before returning an error. Selection happens in the engine, so it works for every provider that reaches upstream.
**Backward compatible:** `base_url` stays a plain string (providers read it unchanged), and a remote with **no mirrorlist behaves exactly as today** (single attempt, same error path).
## How
- `models.Remote.Mirrorlist` (`[]string`, `json:"mirrorlist,omitempty"`) + `UpstreamPool()` = `[base_url] + mirrorlist`.
- `ValidateMirrorlist`: a non-empty mirrorlist is allowed **only** when `repo_type==remote` **and** `package_type ∈ {rpm, deb, alpine}`; each entry must be an http/https URL. Enforced in the v2 create/update handlers (400 otherwise); `base_url` stays required for remotes.
- Persist the mirrorlist in a new additive `mirrorlist TEXT[]` column (`remoteCols`/`scanRemote`/`CreateRemote`/`UpdateRemote`); the `base_url` column is unchanged.
- Engine keeps a per-remote round-robin cursor over the pool; the fetch/head/revalidate upstream calls run in a failover loop that narrows the remote to one selected mirror per attempt. Only network errors and 5xx fail over (404/403/… return as-is). The circuit breaker stays keyed per remote and trips only after all mirrors fail.
## Scope
Round-robin + failover only, restricted to **remote rpm/deb/apk** repos. Least-connections and a per-remote strategy selector are a **follow-up PR**.
## Tests
- Unit: model JSON round-trip + validation gating (rejected on non-rpm/deb/apk and on local, accepted on rpm/deb/apk, bad URL rejected), engine round-robin/failover/no-mirrorlist-unchanged, DB mirrorlist round-trip. `make test` (`go test -race`) green.
- Docker acceptance (`e2e-docker`, `dockere2e` tag, wired into `docker-e2e.sh`): round-robin distribution across two mock upstreams, failover past a dead primary, no-mirrorlist regression, and a **real `dnf` makecache + install** through a two-mirror rpm remote whose `base_url` is dead. All four pass locally.
Reviewed-on: #121
Co-authored-by: unkin-agent <unkin-agent@unkin.net>
Co-committed-by: unkin-agent <unkin-agent@unkin.net>
189 lines
5.6 KiB
Go
189 lines
5.6 KiB
Go
package proxy
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"sync/atomic"
|
|
"testing"
|
|
|
|
"git.unkin.net/unkin/artifactapi/pkg/models"
|
|
)
|
|
|
|
// TestFetchMultiBaseURLRoundRobin drives distinct artifact paths through a
|
|
// remote configured with two upstreams and asserts both receive traffic.
|
|
func TestFetchMultiBaseURLRoundRobin(t *testing.T) {
|
|
requireStack(t)
|
|
ctx := context.Background()
|
|
|
|
var hitsA, hitsB atomic.Int64
|
|
upA := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
hitsA.Add(1)
|
|
w.Write([]byte("A"))
|
|
}))
|
|
defer upA.Close()
|
|
upB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
hitsB.Add(1)
|
|
w.Write([]byte("B"))
|
|
}))
|
|
defer upB.Close()
|
|
|
|
r := seed(t, models.Remote{
|
|
Name: "eng-rr",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: upA.URL,
|
|
Mirrorlist: []string{upB.URL},
|
|
StaleOnError: true,
|
|
})
|
|
p := prov(t, models.PackageGeneric)
|
|
|
|
const n = 10
|
|
for i := 0; i < n; i++ {
|
|
res, err := testEngine.Fetch(ctx, r, fmt.Sprintf("rr-%d.bin", i), p)
|
|
if err != nil {
|
|
t.Fatalf("fetch %d: %v", i, err)
|
|
}
|
|
res.Reader.Close()
|
|
}
|
|
|
|
if hitsA.Load() == 0 || hitsB.Load() == 0 {
|
|
t.Fatalf("round-robin did not spread across both upstreams: A=%d B=%d", hitsA.Load(), hitsB.Load())
|
|
}
|
|
if total := hitsA.Load() + hitsB.Load(); total != n {
|
|
t.Fatalf("expected %d upstream hits total, got %d (A=%d B=%d)", n, total, hitsA.Load(), hitsB.Load())
|
|
}
|
|
}
|
|
|
|
// TestFetchMultiBaseURLFailover asserts that a dead/erroring primary mirror
|
|
// transparently fails over to a healthy secondary, for both a 5xx primary and a
|
|
// network-unreachable primary.
|
|
func TestFetchMultiBaseURLFailover(t *testing.T) {
|
|
requireStack(t)
|
|
ctx := context.Background()
|
|
|
|
var hitsB atomic.Int64
|
|
upB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
hitsB.Add(1)
|
|
w.Write([]byte("served-by-B"))
|
|
}))
|
|
defer upB.Close()
|
|
up500 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusInternalServerError)
|
|
}))
|
|
defer up500.Close()
|
|
|
|
p := prov(t, models.PackageGeneric)
|
|
|
|
// Primary returns 5xx: every request must still succeed via the secondary.
|
|
r5xx := seed(t, models.Remote{
|
|
Name: "eng-failover-5xx",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: up500.URL,
|
|
Mirrorlist: []string{upB.URL},
|
|
})
|
|
for i := 0; i < 6; i++ {
|
|
res, err := testEngine.Fetch(ctx, r5xx, fmt.Sprintf("fo5-%d.bin", i), p)
|
|
if err != nil {
|
|
t.Fatalf("5xx failover fetch %d: %v", i, err)
|
|
}
|
|
if got := readAll(t, res); got != "served-by-B" {
|
|
t.Fatalf("5xx failover fetch %d body=%q, want served-by-B", i, got)
|
|
}
|
|
}
|
|
|
|
// Primary is network-unreachable: failover must still reach the secondary.
|
|
rNet := seed(t, models.Remote{
|
|
Name: "eng-failover-net",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: "http://127.0.0.1:1",
|
|
Mirrorlist: []string{upB.URL},
|
|
})
|
|
res, err := testEngine.Fetch(ctx, rNet, "fonet.bin", p)
|
|
if err != nil {
|
|
t.Fatalf("network failover fetch: %v", err)
|
|
}
|
|
if got := readAll(t, res); got != "served-by-B" {
|
|
t.Fatalf("network failover body=%q, want served-by-B", got)
|
|
}
|
|
if hitsB.Load() == 0 {
|
|
t.Fatal("secondary upstream never served during failover")
|
|
}
|
|
}
|
|
|
|
// TestFetchDefinitiveStatusNoFailover asserts a definitive 404 from the first
|
|
// mirror is returned as-is (not failed over): a missing artifact is not a mirror
|
|
// outage. The remote is fresh so its round-robin cursor starts at index 0.
|
|
func TestFetchDefinitiveStatusNoFailover(t *testing.T) {
|
|
requireStack(t)
|
|
ctx := context.Background()
|
|
|
|
var hitsB atomic.Int64
|
|
up404 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
http.NotFound(w, r)
|
|
}))
|
|
defer up404.Close()
|
|
upB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
hitsB.Add(1)
|
|
w.Write([]byte("B"))
|
|
}))
|
|
defer upB.Close()
|
|
|
|
r := seed(t, models.Remote{
|
|
Name: "eng-no-failover-404",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: up404.URL,
|
|
Mirrorlist: []string{upB.URL},
|
|
})
|
|
_, err := testEngine.Fetch(ctx, r, "missing.bin", prov(t, models.PackageGeneric))
|
|
var pe *ProxyError
|
|
if err == nil || !asProxyError(err, &pe) || pe.Status != http.StatusNotFound {
|
|
t.Fatalf("expected 404 ProxyError without failover, got %v", err)
|
|
}
|
|
if hitsB.Load() != 0 {
|
|
t.Fatalf("404 from primary must not fail over, but secondary was hit %d times", hitsB.Load())
|
|
}
|
|
}
|
|
|
|
// TestFetchSingleBaseURLUnchanged asserts a single-URL remote behaves exactly as
|
|
// before: one healthy URL succeeds, and one dead URL errors with no failover.
|
|
func TestFetchSingleBaseURLUnchanged(t *testing.T) {
|
|
requireStack(t)
|
|
ctx := context.Background()
|
|
|
|
upB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write([]byte("solo"))
|
|
}))
|
|
defer upB.Close()
|
|
|
|
p := prov(t, models.PackageGeneric)
|
|
|
|
rOK := seed(t, models.Remote{
|
|
Name: "eng-solo",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: upB.URL,
|
|
})
|
|
res, err := testEngine.Fetch(ctx, rOK, "solo.bin", p)
|
|
if err != nil {
|
|
t.Fatalf("single-url fetch: %v", err)
|
|
}
|
|
if got := readAll(t, res); got != "solo" {
|
|
t.Fatalf("single-url body=%q, want solo", got)
|
|
}
|
|
|
|
rDead := seed(t, models.Remote{
|
|
Name: "eng-solo-dead",
|
|
PackageType: models.PackageGeneric,
|
|
RepoType: models.RepoTypeRemote,
|
|
BaseURL: "http://127.0.0.1:1",
|
|
})
|
|
if _, err := testEngine.Fetch(ctx, rDead, "x.bin", p); err == nil {
|
|
t.Fatal("single dead upstream should error, not succeed")
|
|
}
|
|
}
|