- имя раздачи нормализуется на границе разбора: вырожденное `-` (metainfo.NoName) даёт пустое имя, пробельное схлопывается — сентинел больше не доходит ни до контекста распознавания, ни до source_ref, ни до подсказки вывода имени - контракт «на любом пути ошибки приёма результат нулевой» объявлен в ingest и удерживается структурно; три транспорта перестали обещать идентификатор, которого нет, и коррелируют отказ по request_id - scoped-логгер загрузки ставится до вызова внешнего сервиса в семи командах воркера — записи об отказе qBittorrent и метабаз получили download_id и infohash; граница разбора bencode записана в docs/research
343 lines
12 KiB
Go
343 lines
12 KiB
Go
package qbt
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"git.vakhrushev.me/av/jellybit/internal/logctx"
|
|
)
|
|
|
|
// fakeQBittorrent — минимальный стенд WebUI API: требует cookie SID, выдаёт
|
|
// его на /auth/login. Так проверяется и ленивый логин по 403.
|
|
func fakeQBittorrent(t *testing.T, info string) *httptest.Server {
|
|
t.Helper()
|
|
mux := http.NewServeMux()
|
|
|
|
mux.HandleFunc("/api/v2/auth/login", func(w http.ResponseWriter, r *http.Request) {
|
|
_ = r.ParseForm()
|
|
if r.PostForm.Get("username") != "admin" || r.PostForm.Get("password") != "secret" {
|
|
w.WriteHeader(http.StatusForbidden)
|
|
return
|
|
}
|
|
http.SetCookie(w, &http.Cookie{Name: "SID", Value: "token", Path: "/"})
|
|
_, _ = w.Write([]byte("Ok."))
|
|
})
|
|
|
|
authed := func(next http.HandlerFunc) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
if c, err := r.Cookie("SID"); err != nil || c.Value != "token" {
|
|
w.WriteHeader(http.StatusForbidden)
|
|
return
|
|
}
|
|
next(w, r)
|
|
}
|
|
}
|
|
|
|
mux.HandleFunc("/api/v2/torrents/add", authed(func(w http.ResponseWriter, r *http.Request) {
|
|
if err := r.ParseMultipartForm(1 << 20); err != nil {
|
|
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
return
|
|
}
|
|
if r.FormValue("category") != "jellybit" || !strings.Contains(r.FormValue("urls"), "magnet:") {
|
|
w.WriteHeader(http.StatusBadRequest)
|
|
return
|
|
}
|
|
_, _ = w.Write([]byte("Ok."))
|
|
}))
|
|
|
|
mux.HandleFunc("/api/v2/torrents/info", authed(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.URL.Query().Get("category") != "jellybit" {
|
|
w.WriteHeader(http.StatusBadRequest)
|
|
return
|
|
}
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_, _ = w.Write([]byte(info))
|
|
}))
|
|
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
return srv
|
|
}
|
|
|
|
func newClient(t *testing.T, url string) *Client {
|
|
t.Helper()
|
|
c, err := New(Config{URL: url, Username: "admin", Password: "secret"}, nil)
|
|
if err != nil {
|
|
t.Fatalf("New: %v", err)
|
|
}
|
|
return c
|
|
}
|
|
|
|
func TestAddSendsRename(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
rename string
|
|
wantField string
|
|
wantHasKey bool
|
|
}{
|
|
{name: "with rename", rename: "Дюна: Часть вторая (2024)", wantField: "Дюна: Часть вторая (2024)", wantHasKey: true},
|
|
{name: "empty rename omits field", rename: "", wantHasKey: false},
|
|
}
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
var gotField string
|
|
var hasKey bool
|
|
mux := http.NewServeMux()
|
|
mux.HandleFunc("/api/v2/torrents/add", func(w http.ResponseWriter, r *http.Request) {
|
|
if err := r.ParseMultipartForm(1 << 20); err != nil {
|
|
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
return
|
|
}
|
|
_, hasKey = r.MultipartForm.Value["rename"]
|
|
gotField = r.FormValue("rename")
|
|
_, _ = w.Write([]byte("Ok."))
|
|
})
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
|
|
c := newClient(t, srv.URL)
|
|
err := c.Add(context.Background(), AddRequest{
|
|
URLs: []string{"magnet:?xt=urn:btih:541adcff3b6dd5dba7088ea83317d9d6fac331d6"},
|
|
Rename: tc.rename,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("Add: %v", err)
|
|
}
|
|
if hasKey != tc.wantHasKey {
|
|
t.Errorf("наличие поля rename = %v, want %v", hasKey, tc.wantHasKey)
|
|
}
|
|
if gotField != tc.wantField {
|
|
t.Errorf("rename = %q, want %q", gotField, tc.wantField)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestDeleteSendsHashesAndDeleteFiles(t *testing.T) {
|
|
var gotHashes, gotDeleteFiles string
|
|
mux := http.NewServeMux()
|
|
mux.HandleFunc("/api/v2/torrents/delete", func(w http.ResponseWriter, r *http.Request) {
|
|
_ = r.ParseForm()
|
|
gotHashes = r.PostForm.Get("hashes")
|
|
gotDeleteFiles = r.PostForm.Get("deleteFiles")
|
|
_, _ = w.Write([]byte("Ok."))
|
|
})
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
|
|
c := newClient(t, srv.URL)
|
|
err := c.Delete(context.Background(), []string{"aaa", "", "bbb"}, true)
|
|
if err != nil {
|
|
t.Fatalf("Delete: %v", err)
|
|
}
|
|
if gotHashes != "aaa|bbb" { // пустые хеши отфильтрованы, склейка через |
|
|
t.Errorf("hashes = %q, want %q", gotHashes, "aaa|bbb")
|
|
}
|
|
if gotDeleteFiles != "true" {
|
|
t.Errorf("deleteFiles = %q, want true", gotDeleteFiles)
|
|
}
|
|
}
|
|
|
|
func TestRenameTorrentSendsHashAndName(t *testing.T) {
|
|
var gotHash, gotName string
|
|
mux := http.NewServeMux()
|
|
mux.HandleFunc("/api/v2/torrents/rename", func(w http.ResponseWriter, r *http.Request) {
|
|
_ = r.ParseForm()
|
|
gotHash = r.PostForm.Get("hash")
|
|
gotName = r.PostForm.Get("name")
|
|
_, _ = w.Write([]byte("Ok."))
|
|
})
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
|
|
c := newClient(t, srv.URL)
|
|
if err := c.RenameTorrent(context.Background(), "aaa", "Harold and the Purple Crayon (2024)"); err != nil {
|
|
t.Fatalf("RenameTorrent: %v", err)
|
|
}
|
|
if gotHash != "aaa" {
|
|
t.Errorf("hash = %q, want aaa", gotHash)
|
|
}
|
|
if gotName != "Harold and the Purple Crayon (2024)" {
|
|
t.Errorf("name = %q", gotName)
|
|
}
|
|
}
|
|
|
|
func TestRenameTorrentEmptyHashIsError(t *testing.T) {
|
|
c := newClient(t, "http://unused")
|
|
if err := c.RenameTorrent(context.Background(), " ", "x"); err == nil {
|
|
t.Fatal("RenameTorrent with empty hash must error before any request")
|
|
}
|
|
}
|
|
|
|
func TestRenameTorrentNon200IsError(t *testing.T) {
|
|
mux := http.NewServeMux()
|
|
mux.HandleFunc("/api/v2/torrents/rename", func(w http.ResponseWriter, r *http.Request) {
|
|
http.Error(w, "Not Found", http.StatusNotFound)
|
|
})
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
|
|
c := newClient(t, srv.URL)
|
|
if err := c.RenameTorrent(context.Background(), "aaa", "x"); err == nil {
|
|
t.Fatal("RenameTorrent must error on non-200")
|
|
}
|
|
}
|
|
|
|
func TestDeleteNoHashesIsError(t *testing.T) {
|
|
c := newClient(t, "http://unused")
|
|
if err := c.Delete(context.Background(), []string{"", " "}, true); err == nil {
|
|
t.Fatal("Delete with no hashes must error before any request")
|
|
}
|
|
}
|
|
|
|
func TestAddPerformsLazyLogin(t *testing.T) {
|
|
srv := fakeQBittorrent(t, "[]")
|
|
c := newClient(t, srv.URL)
|
|
|
|
// Первый вызов без cookie → сервер вернёт 403 → клиент логинится и повторяет.
|
|
err := c.Add(context.Background(), AddRequest{
|
|
URLs: []string{"magnet:?xt=urn:btih:541adcff3b6dd5dba7088ea83317d9d6fac331d6"},
|
|
Category: "jellybit",
|
|
SavePath: "/srv/media/downloads",
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("Add: %v", err)
|
|
}
|
|
}
|
|
|
|
func TestTorrents(t *testing.T) {
|
|
const body = `[{"hash":"541adcff3b6dd5dba7088ea83317d9d6fac331d6","name":"Dune","state":"uploading","save_path":"/srv/media/downloads","content_path":"/srv/media/downloads/Dune","progress":1.0,"amount_left":0}]`
|
|
srv := fakeQBittorrent(t, body)
|
|
c := newClient(t, srv.URL)
|
|
|
|
ts, err := c.Torrents(context.Background(), "jellybit")
|
|
if err != nil {
|
|
t.Fatalf("Torrents: %v", err)
|
|
}
|
|
if len(ts) != 1 {
|
|
t.Fatalf("torrents = %d, want 1", len(ts))
|
|
}
|
|
got := ts[0]
|
|
if got.Hash != "541adcff3b6dd5dba7088ea83317d9d6fac331d6" || got.State != "uploading" {
|
|
t.Errorf("torrent = %+v", got)
|
|
}
|
|
if got.ContentPath != "/srv/media/downloads/Dune" {
|
|
t.Errorf("content_path = %q", got.ContentPath)
|
|
}
|
|
}
|
|
|
|
func TestLoginFailure(t *testing.T) {
|
|
srv := fakeQBittorrent(t, "[]")
|
|
c, err := New(Config{URL: srv.URL, Username: "admin", Password: "wrong"}, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// 403 → попытка логина с неверным паролем → снова 403 → ошибка.
|
|
if _, err := c.Torrents(context.Background(), "jellybit"); err == nil {
|
|
t.Error("ожидалась ошибка логина")
|
|
}
|
|
}
|
|
|
|
// captureHandler собирает записи журнала для проверки их полей. Свой WithAttrs
|
|
// нужен обязательно: делегированный встроенному хендлеру вернул бы ЕГО, и
|
|
// логгер, собранный через With (а scoped-логгер загрузки собирается именно
|
|
// так), перестал бы захватываться.
|
|
type captureHandler struct {
|
|
attrs []slog.Attr
|
|
records *[]slog.Record
|
|
}
|
|
|
|
func (h *captureHandler) Enabled(context.Context, slog.Level) bool { return true }
|
|
|
|
func (h *captureHandler) Handle(_ context.Context, r slog.Record) error {
|
|
rec := r.Clone()
|
|
rec.AddAttrs(h.attrs...)
|
|
*h.records = append(*h.records, rec)
|
|
return nil
|
|
}
|
|
|
|
func (h *captureHandler) WithAttrs(as []slog.Attr) slog.Handler {
|
|
return &captureHandler{attrs: append(append([]slog.Attr{}, h.attrs...), as...), records: h.records}
|
|
}
|
|
|
|
func (h *captureHandler) WithGroup(string) slog.Handler { return h }
|
|
|
|
// recordFields сплющивает запись в map «ключ → значение как текст».
|
|
func recordFields(r slog.Record) map[string]string {
|
|
out := map[string]string{}
|
|
r.Attrs(func(a slog.Attr) bool {
|
|
out[a.Key] = a.Value.String()
|
|
return true
|
|
})
|
|
return out
|
|
}
|
|
|
|
// Отказ qBittorrent на добавление («Fails.») причины не несёт — единственное,
|
|
// что делает такую запись пригодной для разбора, это корреляция с загрузкой.
|
|
// Инфохэша клиент не знает и знать не должен (разбор источника — единая точка
|
|
// проекта): он берёт scoped-логгер из ctx. Негативная половина: magnet с
|
|
// passkey приватного трекера уходит через это же поле формы, и в журнал он
|
|
// попасть не должен (инвариант «секреты не попадают в логи»).
|
|
func TestAddFailureRecordCarriesScopeAndNoSecret(t *testing.T) {
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.URL.Path == "/api/v2/auth/login" {
|
|
http.SetCookie(w, &http.Cookie{Name: "SID", Value: "token", Path: "/"})
|
|
_, _ = w.Write([]byte("Ok."))
|
|
return
|
|
}
|
|
_, _ = w.Write([]byte("Fails."))
|
|
}))
|
|
defer srv.Close()
|
|
|
|
// Значение низкоэнтропийное намеренно: высокоэнтропийная фикстура «похожего
|
|
// на секрет» вида краснит gitleaks в pre-commit. Различимости хватает —
|
|
// тест ищет вхождение этой строки в полях записи.
|
|
const passkey = "passkey-must-not-reach-the-journal"
|
|
const magnetURL = "magnet:?xt=urn:btih:541adcff3b6dd5dba7088ea83317d9d6fac331d6" +
|
|
"&tr=http%3A%2F%2Ftracker.example%2Fann%3Fpasskey%3D" + passkey
|
|
|
|
var records []slog.Record
|
|
log := slog.New(&captureHandler{records: &records}).
|
|
With("capability", "review", "download_id", "01JB0000000000000000000000", "infohash",
|
|
"541adcff3b6dd5dba7088ea83317d9d6fac331d6")
|
|
ctx := logctx.With(context.Background(), log)
|
|
|
|
err := newClient(t, srv.URL).Add(ctx, AddRequest{URLs: []string{magnetURL}, Category: "jellybit"})
|
|
if err == nil {
|
|
t.Fatal("ожидался отказ добавления")
|
|
}
|
|
|
|
var failure *slog.Record
|
|
for i := range records {
|
|
if records[i].Message == "external call failed" {
|
|
failure = &records[i]
|
|
}
|
|
}
|
|
if failure == nil {
|
|
t.Fatalf("записи об отказе внешнего вызова нет, записей: %d", len(records))
|
|
}
|
|
f := recordFields(*failure)
|
|
if f["download_id"] == "" {
|
|
t.Errorf("в записи нет download_id из scoped-логгера: %v", f)
|
|
}
|
|
if f["infohash"] != "541adcff3b6dd5dba7088ea83317d9d6fac331d6" {
|
|
t.Errorf("infohash = %q, want хеш из scoped-логгера", f["infohash"])
|
|
}
|
|
if f["ext.operation"] != "torrents/add" {
|
|
t.Errorf("ext.operation = %q, want torrents/add", f["ext.operation"])
|
|
}
|
|
// Негативная половина: ни одно поле записи не несёт passkey.
|
|
for k, v := range f {
|
|
if strings.Contains(v, passkey) {
|
|
t.Errorf("passkey утёк в поле %q: %q", k, v)
|
|
}
|
|
}
|
|
if strings.Contains(failure.Message, passkey) {
|
|
t.Errorf("passkey утёк в сообщение записи")
|
|
}
|
|
}
|