mirror of
https://github.com/go-gitea/gitea.git
synced 2024-11-23 03:42:15 +08:00
df805d6ed0
Support legacy _links LFS batch response. Fixes #31512. This is backwards-compatible change to the LFS client so that, upon mirroring from an upstream which has a batch api, it can download objects whether the responses contain the `_links` field or its successor the `actions` field. When Gitea must fallback to the legacy `_links` field a logline is emitted at INFO level which looks like this: ``` ...s/lfs/http_client.go:188:performOperation() [I] <LFSPointer ee95d0a27ccdfc7c12516d4f80dcf144a5eaf10d0461d282a7206390635cdbee:160> is using a deprecated batch schema response! ``` I've only run `test-backend` with this code, but added a new test to cover this case. Additionally I have a fork with this change deployed which I've confirmed syncs LFS from Gitea<-Artifactory (which has legacy `_links`) as well as from Gitea<-Gitea (which has the modern `actions`). Signed-off-by: Royce Remer <royceremer@gmail.com>
377 lines
9.1 KiB
Go
377 lines
9.1 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package lfs
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/modules/json"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type RoundTripFunc func(req *http.Request) *http.Response
|
|
|
|
func (f RoundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
return f(req), nil
|
|
}
|
|
|
|
type DummyTransferAdapter struct{}
|
|
|
|
func (a *DummyTransferAdapter) Name() string {
|
|
return "dummy"
|
|
}
|
|
|
|
func (a *DummyTransferAdapter) Download(ctx context.Context, l *Link) (io.ReadCloser, error) {
|
|
return io.NopCloser(bytes.NewBufferString("dummy")), nil
|
|
}
|
|
|
|
func (a *DummyTransferAdapter) Upload(ctx context.Context, l *Link, p Pointer, r io.Reader) error {
|
|
return nil
|
|
}
|
|
|
|
func (a *DummyTransferAdapter) Verify(ctx context.Context, l *Link, p Pointer) error {
|
|
return nil
|
|
}
|
|
|
|
func lfsTestRoundtripHandler(req *http.Request) *http.Response {
|
|
var batchResponse *BatchResponse
|
|
url := req.URL.String()
|
|
|
|
if strings.Contains(url, "status-not-ok") {
|
|
return &http.Response{StatusCode: http.StatusBadRequest}
|
|
} else if strings.Contains(url, "invalid-json-response") {
|
|
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewBufferString("invalid json"))}
|
|
} else if strings.Contains(url, "valid-batch-request-download") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"download": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "legacy-batch-request-download") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Links: map[string]*Link{
|
|
"download": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "valid-batch-request-upload") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"upload": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "response-no-objects") {
|
|
batchResponse = &BatchResponse{Transfer: "dummy"}
|
|
} else if strings.Contains(url, "unknown-transfer-adapter") {
|
|
batchResponse = &BatchResponse{Transfer: "unknown_adapter"}
|
|
} else if strings.Contains(url, "error-in-response-objects") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Error: &ObjectError{
|
|
Code: http.StatusNotFound,
|
|
Message: "Object not found",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "empty-actions-map") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "download-actions-map") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"download": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "upload-actions-map") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"upload": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "verify-actions-map") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"verify": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else if strings.Contains(url, "unknown-actions-map") {
|
|
batchResponse = &BatchResponse{
|
|
Transfer: "dummy",
|
|
Objects: []*ObjectResponse{
|
|
{
|
|
Actions: map[string]*Link{
|
|
"unknown": {},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
} else {
|
|
return nil
|
|
}
|
|
|
|
payload := new(bytes.Buffer)
|
|
json.NewEncoder(payload).Encode(batchResponse)
|
|
|
|
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(payload)}
|
|
}
|
|
|
|
func TestHTTPClientDownload(t *testing.T) {
|
|
p := Pointer{Oid: "fb8f7d8435968c4f82a726a92395be4d16f2f63116caf36c8ad35c60831ab041", Size: 6}
|
|
|
|
hc := &http.Client{Transport: RoundTripFunc(func(req *http.Request) *http.Response {
|
|
assert.Equal(t, "POST", req.Method)
|
|
assert.Equal(t, MediaType, req.Header.Get("Content-type"))
|
|
assert.Equal(t, AcceptHeader, req.Header.Get("Accept"))
|
|
|
|
var batchRequest BatchRequest
|
|
err := json.NewDecoder(req.Body).Decode(&batchRequest)
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, "download", batchRequest.Operation)
|
|
assert.Len(t, batchRequest.Objects, 1)
|
|
assert.Equal(t, p.Oid, batchRequest.Objects[0].Oid)
|
|
assert.Equal(t, p.Size, batchRequest.Objects[0].Size)
|
|
|
|
return lfsTestRoundtripHandler(req)
|
|
})}
|
|
dummy := &DummyTransferAdapter{}
|
|
|
|
cases := []struct {
|
|
endpoint string
|
|
expectederror string
|
|
}{
|
|
// case 0
|
|
{
|
|
endpoint: "https://status-not-ok.io",
|
|
expectederror: io.ErrUnexpectedEOF.Error(),
|
|
},
|
|
// case 1
|
|
{
|
|
endpoint: "https://invalid-json-response.io",
|
|
expectederror: "invalid json",
|
|
},
|
|
// case 2
|
|
{
|
|
endpoint: "https://valid-batch-request-download.io",
|
|
expectederror: "",
|
|
},
|
|
// case 3
|
|
{
|
|
endpoint: "https://response-no-objects.io",
|
|
expectederror: "",
|
|
},
|
|
// case 4
|
|
{
|
|
endpoint: "https://unknown-transfer-adapter.io",
|
|
expectederror: "TransferAdapter not found: ",
|
|
},
|
|
// case 5
|
|
{
|
|
endpoint: "https://error-in-response-objects.io",
|
|
expectederror: "Object not found",
|
|
},
|
|
// case 6
|
|
{
|
|
endpoint: "https://empty-actions-map.io",
|
|
expectederror: "missing action 'download'",
|
|
},
|
|
// case 7
|
|
{
|
|
endpoint: "https://download-actions-map.io",
|
|
expectederror: "",
|
|
},
|
|
// case 8
|
|
{
|
|
endpoint: "https://upload-actions-map.io",
|
|
expectederror: "missing action 'download'",
|
|
},
|
|
// case 9
|
|
{
|
|
endpoint: "https://verify-actions-map.io",
|
|
expectederror: "missing action 'download'",
|
|
},
|
|
// case 10
|
|
{
|
|
endpoint: "https://unknown-actions-map.io",
|
|
expectederror: "missing action 'download'",
|
|
},
|
|
// case 11
|
|
{
|
|
endpoint: "https://legacy-batch-request-download.io",
|
|
expectederror: "",
|
|
},
|
|
}
|
|
|
|
for n, c := range cases {
|
|
client := &HTTPClient{
|
|
client: hc,
|
|
endpoint: c.endpoint,
|
|
transfers: map[string]TransferAdapter{
|
|
"dummy": dummy,
|
|
},
|
|
}
|
|
|
|
err := client.Download(context.Background(), []Pointer{p}, func(p Pointer, content io.ReadCloser, objectError error) error {
|
|
if objectError != nil {
|
|
return objectError
|
|
}
|
|
b, err := io.ReadAll(content)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, []byte("dummy"), b)
|
|
return nil
|
|
})
|
|
if len(c.expectederror) > 0 {
|
|
assert.True(t, strings.Contains(err.Error(), c.expectederror), "case %d: '%s' should contain '%s'", n, err.Error(), c.expectederror)
|
|
} else {
|
|
assert.NoError(t, err, "case %d", n)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestHTTPClientUpload(t *testing.T) {
|
|
p := Pointer{Oid: "fb8f7d8435968c4f82a726a92395be4d16f2f63116caf36c8ad35c60831ab041", Size: 6}
|
|
|
|
hc := &http.Client{Transport: RoundTripFunc(func(req *http.Request) *http.Response {
|
|
assert.Equal(t, "POST", req.Method)
|
|
assert.Equal(t, MediaType, req.Header.Get("Content-type"))
|
|
assert.Equal(t, AcceptHeader, req.Header.Get("Accept"))
|
|
|
|
var batchRequest BatchRequest
|
|
err := json.NewDecoder(req.Body).Decode(&batchRequest)
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, "upload", batchRequest.Operation)
|
|
assert.Len(t, batchRequest.Objects, 1)
|
|
assert.Equal(t, p.Oid, batchRequest.Objects[0].Oid)
|
|
assert.Equal(t, p.Size, batchRequest.Objects[0].Size)
|
|
|
|
return lfsTestRoundtripHandler(req)
|
|
})}
|
|
dummy := &DummyTransferAdapter{}
|
|
|
|
cases := []struct {
|
|
endpoint string
|
|
expectederror string
|
|
}{
|
|
// case 0
|
|
{
|
|
endpoint: "https://status-not-ok.io",
|
|
expectederror: io.ErrUnexpectedEOF.Error(),
|
|
},
|
|
// case 1
|
|
{
|
|
endpoint: "https://invalid-json-response.io",
|
|
expectederror: "invalid json",
|
|
},
|
|
// case 2
|
|
{
|
|
endpoint: "https://valid-batch-request-upload.io",
|
|
expectederror: "",
|
|
},
|
|
// case 3
|
|
{
|
|
endpoint: "https://response-no-objects.io",
|
|
expectederror: "",
|
|
},
|
|
// case 4
|
|
{
|
|
endpoint: "https://unknown-transfer-adapter.io",
|
|
expectederror: "TransferAdapter not found: ",
|
|
},
|
|
// case 5
|
|
{
|
|
endpoint: "https://error-in-response-objects.io",
|
|
expectederror: "Object not found",
|
|
},
|
|
// case 6
|
|
{
|
|
endpoint: "https://empty-actions-map.io",
|
|
expectederror: "",
|
|
},
|
|
// case 7
|
|
{
|
|
endpoint: "https://download-actions-map.io",
|
|
expectederror: "missing action 'upload'",
|
|
},
|
|
// case 8
|
|
{
|
|
endpoint: "https://upload-actions-map.io",
|
|
expectederror: "",
|
|
},
|
|
// case 9
|
|
{
|
|
endpoint: "https://verify-actions-map.io",
|
|
expectederror: "missing action 'upload'",
|
|
},
|
|
// case 10
|
|
{
|
|
endpoint: "https://unknown-actions-map.io",
|
|
expectederror: "missing action 'upload'",
|
|
},
|
|
}
|
|
|
|
for n, c := range cases {
|
|
client := &HTTPClient{
|
|
client: hc,
|
|
endpoint: c.endpoint,
|
|
transfers: map[string]TransferAdapter{
|
|
"dummy": dummy,
|
|
},
|
|
}
|
|
|
|
err := client.Upload(context.Background(), []Pointer{p}, func(p Pointer, objectError error) (io.ReadCloser, error) {
|
|
return io.NopCloser(new(bytes.Buffer)), objectError
|
|
})
|
|
if len(c.expectederror) > 0 {
|
|
assert.True(t, strings.Contains(err.Error(), c.expectederror), "case %d: '%s' should contain '%s'", n, err.Error(), c.expectederror)
|
|
} else {
|
|
assert.NoError(t, err, "case %d", n)
|
|
}
|
|
}
|
|
}
|