kubo/core/coreiface/tests/pin.go
rifeplight 3f2cc50eb8
Some checks failed
CodeQL / codeql (push) Waiting to run
Docker Check / lint (push) Waiting to run
Docker Check / build (push) Waiting to run
Gateway Conformance / gateway-conformance (push) Waiting to run
Gateway Conformance / gateway-conformance-libp2p-experiment (push) Waiting to run
Go Build / go-build (push) Waiting to run
Go Check / go-check (push) Waiting to run
Go Lint / go-lint (push) Waiting to run
Go Test / go-test (push) Waiting to run
Interop / interop-prep (push) Waiting to run
Interop / helia-interop (push) Blocked by required conditions
Interop / ipfs-webui (push) Blocked by required conditions
Sharness / sharness-test (push) Waiting to run
Spell Check / spellcheck (push) Waiting to run
Migrations / test (macos-latest) (push) Has been cancelled
Migrations / test (ubuntu-latest) (push) Has been cancelled
Migrations / test (windows-latest) (push) Has been cancelled
refactor: replace context.WithCancel with t.Context (#11083)
Signed-off-by: rifeplight <rifeplight@outlook.com>
2025-11-28 16:39:55 +01:00

744 lines
19 KiB
Go

package tests
import (
"context"
"math"
"strings"
"testing"
"github.com/ipfs/boxo/path"
"github.com/ipfs/go-cid"
ipldcbor "github.com/ipfs/go-ipld-cbor"
ipld "github.com/ipfs/go-ipld-format"
iface "github.com/ipfs/kubo/core/coreiface"
opt "github.com/ipfs/kubo/core/coreiface/options"
"github.com/stretchr/testify/require"
)
func (tp *TestSuite) TestPin(t *testing.T) {
tp.hasApi(t, func(api iface.CoreAPI) error {
if api.Pin() == nil {
return errAPINotImplemented
}
return nil
})
t.Run("TestPinAdd", tp.TestPinAdd)
t.Run("TestPinSimple", tp.TestPinSimple)
t.Run("TestPinRecursive", tp.TestPinRecursive)
t.Run("TestPinLsIndirect", tp.TestPinLsIndirect)
t.Run("TestPinLsPrecedence", tp.TestPinLsPrecedence)
t.Run("TestPinIsPinned", tp.TestPinIsPinned)
t.Run("TestPinNames", tp.TestPinNames)
}
func (tp *TestSuite) TestPinAdd(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
p, err := api.Unixfs().Add(ctx, strFile("foo")())
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, p)
if err != nil {
t.Fatal(err)
}
}
func (tp *TestSuite) TestPinSimple(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
p, err := api.Unixfs().Add(ctx, strFile("foo")())
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, p)
if err != nil {
t.Fatal(err)
}
list, err := accPins(ctx, api)
if err != nil {
t.Fatal(err)
}
if len(list) != 1 {
t.Errorf("unexpected pin list len: %d", len(list))
}
if list[0].Path().RootCid().String() != p.RootCid().String() {
t.Error("paths don't match")
}
if list[0].Type() != "recursive" {
t.Error("unexpected pin type")
}
assertIsPinned(t, ctx, api, p, "recursive")
err = api.Pin().Rm(ctx, p)
if err != nil {
t.Fatal(err)
}
list, err = accPins(ctx, api)
if err != nil {
t.Fatal(err)
}
if len(list) != 0 {
t.Errorf("unexpected pin list len: %d", len(list))
}
}
func (tp *TestSuite) TestPinRecursive(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
p0, err := api.Unixfs().Add(ctx, strFile("foo")())
if err != nil {
t.Fatal(err)
}
p1, err := api.Unixfs().Add(ctx, strFile("bar")())
if err != nil {
t.Fatal(err)
}
nd2, err := ipldcbor.FromJSON(strings.NewReader(`{"lnk": {"/": "`+p0.RootCid().String()+`"}}`), math.MaxUint64, -1)
if err != nil {
t.Fatal(err)
}
nd3, err := ipldcbor.FromJSON(strings.NewReader(`{"lnk": {"/": "`+p1.RootCid().String()+`"}}`), math.MaxUint64, -1)
if err != nil {
t.Fatal(err)
}
if err := api.Dag().AddMany(ctx, []ipld.Node{nd2, nd3}); err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(nd2.Cid()))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(nd3.Cid()), opt.Pin.Recursive(false))
if err != nil {
t.Fatal(err)
}
list, err := accPins(ctx, api)
if err != nil {
t.Fatal(err)
}
if len(list) != 3 {
t.Errorf("unexpected pin list len: %d", len(list))
}
list, err = accPins(ctx, api, opt.Pin.Ls.Direct())
if err != nil {
t.Fatal(err)
}
if len(list) != 1 {
t.Errorf("unexpected pin list len: %d", len(list))
}
if list[0].Path().String() != path.FromCid(nd3.Cid()).String() {
t.Errorf("unexpected path, %s != %s", list[0].Path().String(), path.FromCid(nd3.Cid()).String())
}
list, err = accPins(ctx, api, opt.Pin.Ls.Recursive())
if err != nil {
t.Fatal(err)
}
if len(list) != 1 {
t.Errorf("unexpected pin list len: %d", len(list))
}
if list[0].Path().String() != path.FromCid(nd2.Cid()).String() {
t.Errorf("unexpected path, %s != %s", list[0].Path().String(), path.FromCid(nd2.Cid()).String())
}
list, err = accPins(ctx, api, opt.Pin.Ls.Indirect())
if err != nil {
t.Fatal(err)
}
if len(list) != 1 {
t.Errorf("unexpected pin list len: %d", len(list))
}
if list[0].Path().RootCid().String() != p0.RootCid().String() {
t.Errorf("unexpected path, %s != %s", list[0].Path().RootCid().String(), p0.RootCid().String())
}
res, err := api.Pin().Verify(ctx)
if err != nil {
t.Fatal(err)
}
n := 0
for r := range res {
if err := r.Err(); err != nil {
t.Error(err)
}
if !r.Ok() {
t.Error("expected pin to be ok")
}
n++
}
if n != 1 {
t.Errorf("unexpected verify result count: %d", n)
}
// TODO: figure out a way to test verify without touching IpfsNode
/*
err = api.Block().Rm(ctx, p0, opt.Block.Force(true))
if err != nil {
t.Fatal(err)
}
res, err = api.Pin().Verify(ctx)
if err != nil {
t.Fatal(err)
}
n = 0
for r := range res {
if r.Ok() {
t.Error("expected pin to not be ok")
}
if len(r.BadNodes()) != 1 {
t.Fatalf("unexpected badNodes len")
}
if r.BadNodes()[0].Path().Cid().String() != p0.Cid().String() {
t.Error("unexpected badNode path")
}
if r.BadNodes()[0].Err().Error() != "merkledag: not found" {
t.Errorf("unexpected badNode error: %s", r.BadNodes()[0].Err().Error())
}
n++
}
if n != 1 {
t.Errorf("unexpected verify result count: %d", n)
}
*/
}
// TestPinLsIndirect verifies that indirect nodes are listed by pin ls even if a parent node is directly pinned
func (tp *TestSuite) TestPinLsIndirect(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
leaf, parent, grandparent := getThreeChainedNodes(t, ctx, api, "foo")
err = api.Pin().Add(ctx, path.FromCid(grandparent.Cid()))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(parent.Cid()), opt.Pin.Recursive(false))
if err != nil {
t.Fatal(err)
}
assertPinTypes(t, ctx, api, []cidContainer{grandparent}, []cidContainer{parent}, []cidContainer{leaf})
}
// TestPinLsPrecedence verifies the precedence of pins (recursive > direct > indirect)
func (tp *TestSuite) TestPinLsPrecedence(t *testing.T) {
// Testing precedence of recursive, direct and indirect pins
// Results should be recursive > indirect, direct > indirect, and recursive > direct
t.Run("TestPinLsPredenceRecursiveIndirect", tp.TestPinLsPredenceRecursiveIndirect)
t.Run("TestPinLsPrecedenceDirectIndirect", tp.TestPinLsPrecedenceDirectIndirect)
t.Run("TestPinLsPrecedenceRecursiveDirect", tp.TestPinLsPrecedenceRecursiveDirect)
}
func (tp *TestSuite) TestPinLsPredenceRecursiveIndirect(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
// Test recursive > indirect
leaf, parent, grandparent := getThreeChainedNodes(t, ctx, api, "recursive > indirect")
err = api.Pin().Add(ctx, path.FromCid(grandparent.Cid()))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(parent.Cid()))
if err != nil {
t.Fatal(err)
}
assertPinTypes(t, ctx, api, []cidContainer{grandparent, parent}, []cidContainer{}, []cidContainer{leaf})
}
func (tp *TestSuite) TestPinLsPrecedenceDirectIndirect(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
// Test direct > indirect
leaf, parent, grandparent := getThreeChainedNodes(t, ctx, api, "direct > indirect")
err = api.Pin().Add(ctx, path.FromCid(grandparent.Cid()))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(parent.Cid()), opt.Pin.Recursive(false))
if err != nil {
t.Fatal(err)
}
assertPinTypes(t, ctx, api, []cidContainer{grandparent}, []cidContainer{parent}, []cidContainer{leaf})
}
func (tp *TestSuite) TestPinLsPrecedenceRecursiveDirect(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
// Test recursive > direct
leaf, parent, grandparent := getThreeChainedNodes(t, ctx, api, "recursive + direct = error")
err = api.Pin().Add(ctx, path.FromCid(parent.Cid()))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(parent.Cid()), opt.Pin.Recursive(false))
if err == nil {
t.Fatal("expected error directly pinning a recursively pinned node")
}
assertPinTypes(t, ctx, api, []cidContainer{parent}, []cidContainer{}, []cidContainer{leaf})
err = api.Pin().Add(ctx, path.FromCid(grandparent.Cid()), opt.Pin.Recursive(false))
if err != nil {
t.Fatal(err)
}
err = api.Pin().Add(ctx, path.FromCid(grandparent.Cid()))
if err != nil {
t.Fatal(err)
}
assertPinTypes(t, ctx, api, []cidContainer{grandparent, parent}, []cidContainer{}, []cidContainer{leaf})
}
func (tp *TestSuite) TestPinIsPinned(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
if err != nil {
t.Fatal(err)
}
leaf, parent, grandparent := getThreeChainedNodes(t, ctx, api, "foofoo")
assertNotPinned(t, ctx, api, newIPLDPath(t, grandparent.Cid()))
assertNotPinned(t, ctx, api, newIPLDPath(t, parent.Cid()))
assertNotPinned(t, ctx, api, newIPLDPath(t, leaf.Cid()))
err = api.Pin().Add(ctx, newIPLDPath(t, parent.Cid()), opt.Pin.Recursive(true))
if err != nil {
t.Fatal(err)
}
assertNotPinned(t, ctx, api, newIPLDPath(t, grandparent.Cid()))
assertIsPinned(t, ctx, api, newIPLDPath(t, parent.Cid()), "recursive")
assertIsPinned(t, ctx, api, newIPLDPath(t, leaf.Cid()), "indirect")
err = api.Pin().Add(ctx, newIPLDPath(t, grandparent.Cid()), opt.Pin.Recursive(false))
if err != nil {
t.Fatal(err)
}
assertIsPinned(t, ctx, api, newIPLDPath(t, grandparent.Cid()), "direct")
assertIsPinned(t, ctx, api, newIPLDPath(t, parent.Cid()), "recursive")
assertIsPinned(t, ctx, api, newIPLDPath(t, leaf.Cid()), "indirect")
}
type cidContainer interface {
Cid() cid.Cid
}
type immutablePathCidContainer struct {
path.ImmutablePath
}
func (i immutablePathCidContainer) Cid() cid.Cid {
return i.RootCid()
}
func getThreeChainedNodes(t *testing.T, ctx context.Context, api iface.CoreAPI, leafData string) (cidContainer, cidContainer, cidContainer) {
leaf, err := api.Unixfs().Add(ctx, strFile(leafData)())
if err != nil {
t.Fatal(err)
}
parent, err := ipldcbor.FromJSON(strings.NewReader(`{"lnk": {"/": "`+leaf.RootCid().String()+`"}}`), math.MaxUint64, -1)
if err != nil {
t.Fatal(err)
}
grandparent, err := ipldcbor.FromJSON(strings.NewReader(`{"lnk": {"/": "`+parent.Cid().String()+`"}}`), math.MaxUint64, -1)
if err != nil {
t.Fatal(err)
}
if err := api.Dag().AddMany(ctx, []ipld.Node{parent, grandparent}); err != nil {
t.Fatal(err)
}
return immutablePathCidContainer{leaf}, parent, grandparent
}
func assertPinTypes(t *testing.T, ctx context.Context, api iface.CoreAPI, recursive, direct, indirect []cidContainer) {
assertPinLsAllConsistency(t, ctx, api)
list, err := accPins(ctx, api, opt.Pin.Ls.Recursive())
if err != nil {
t.Fatal(err)
}
assertPinCids(t, list, recursive...)
list, err = accPins(ctx, api, opt.Pin.Ls.Direct())
if err != nil {
t.Fatal(err)
}
assertPinCids(t, list, direct...)
list, err = accPins(ctx, api, opt.Pin.Ls.Indirect())
if err != nil {
t.Fatal(err)
}
assertPinCids(t, list, indirect...)
}
// assertPinCids verifies that the pins match the expected cids
func assertPinCids(t *testing.T, pins []iface.Pin, cids ...cidContainer) {
t.Helper()
if expected, actual := len(cids), len(pins); expected != actual {
t.Fatalf("expected pin list to have len %d, was %d", expected, actual)
}
cSet := cid.NewSet()
for _, c := range cids {
cSet.Add(c.Cid())
}
valid := true
for _, p := range pins {
c := p.Path().RootCid()
if cSet.Has(c) {
cSet.Remove(c)
} else {
valid = false
break
}
}
valid = valid && cSet.Len() == 0
if !valid {
pinStrs := make([]string, len(pins))
for i, p := range pins {
pinStrs[i] = p.Path().RootCid().String()
}
pathStrs := make([]string, len(cids))
for i, c := range cids {
pathStrs[i] = c.Cid().String()
}
t.Fatalf("expected: %s \nactual: %s", strings.Join(pathStrs, ", "), strings.Join(pinStrs, ", "))
}
}
// assertPinLsAllConsistency verifies that listing all pins gives the same result as listing the pin types individually
func assertPinLsAllConsistency(t *testing.T, ctx context.Context, api iface.CoreAPI) {
t.Helper()
allPins, err := accPins(ctx, api)
if err != nil {
t.Fatal(err)
}
type pinTypeProps struct {
*cid.Set
opt.PinLsOption
}
all, recursive, direct, indirect := cid.NewSet(), cid.NewSet(), cid.NewSet(), cid.NewSet()
typeMap := map[string]*pinTypeProps{
"recursive": {recursive, opt.Pin.Ls.Recursive()},
"direct": {direct, opt.Pin.Ls.Direct()},
"indirect": {indirect, opt.Pin.Ls.Indirect()},
}
for _, p := range allPins {
if !all.Visit(p.Path().RootCid()) {
t.Fatalf("pin ls returned the same cid multiple times")
}
typeStr := p.Type()
if typeSet, ok := typeMap[p.Type()]; ok {
typeSet.Add(p.Path().RootCid())
} else {
t.Fatalf("unknown pin type: %s", typeStr)
}
}
for typeStr, pinProps := range typeMap {
pins, err := accPins(ctx, api, pinProps.PinLsOption)
if err != nil {
t.Fatal(err)
}
if expected, actual := len(pins), pinProps.Set.Len(); expected != actual {
t.Fatalf("pin ls all has %d pins of type %s, but pin ls for the type has %d", expected, typeStr, actual)
}
for _, p := range pins {
if pinType := p.Type(); pinType != typeStr {
t.Fatalf("returned wrong pin type: expected %s, got %s", typeStr, pinType)
}
if c := p.Path().RootCid(); !pinProps.Has(c) {
t.Fatalf("%s expected to be in pin ls all as type %s", c.String(), typeStr)
}
}
}
}
func assertIsPinned(t *testing.T, ctx context.Context, api iface.CoreAPI, p path.Path, typeStr string) {
t.Helper()
withType, err := opt.Pin.IsPinned.Type(typeStr)
if err != nil {
t.Fatal("unhandled pin type")
}
whyPinned, pinned, err := api.Pin().IsPinned(ctx, p, withType)
if err != nil {
t.Fatal(err)
}
if !pinned {
t.Fatalf("%s expected to be pinned with type %s", p, typeStr)
}
switch typeStr {
case "recursive", "direct":
if typeStr != whyPinned {
t.Fatalf("reason for pinning expected to be %s for %s, got %s", typeStr, p, whyPinned)
}
case "indirect":
if whyPinned == "" {
t.Fatalf("expected to have a pin reason for %s", p)
}
}
}
func (tp *TestSuite) TestPinNames(t *testing.T) {
ctx := t.Context()
api, err := tp.makeAPI(t, ctx)
require.NoError(t, err)
// Create test content
p1, err := api.Unixfs().Add(ctx, strFile("content1")())
require.NoError(t, err)
p2, err := api.Unixfs().Add(ctx, strFile("content2")())
require.NoError(t, err)
p3, err := api.Unixfs().Add(ctx, strFile("content3")())
require.NoError(t, err)
p4, err := api.Unixfs().Add(ctx, strFile("content4")())
require.NoError(t, err)
// Test 1: Pin with name
err = api.Pin().Add(ctx, p1, opt.Pin.Name("test-pin-1"))
require.NoError(t, err, "failed to add pin with name")
// Test 2: Pin without name
err = api.Pin().Add(ctx, p2)
require.NoError(t, err, "failed to add pin without name")
// Test 3: List pins with detailed option to get names
pins := make(chan iface.Pin)
go func() {
err = api.Pin().Ls(ctx, pins, opt.Pin.Ls.Detailed(true))
}()
pinMap := make(map[string]string)
for pin := range pins {
pinMap[pin.Path().String()] = pin.Name()
}
require.NoError(t, err, "failed to list pins with names")
// Verify pin names
name1, ok := pinMap[p1.String()]
require.True(t, ok, "pin for %s not found", p1)
require.Equal(t, "test-pin-1", name1, "unexpected pin name for %s", p1)
name2, ok := pinMap[p2.String()]
require.True(t, ok, "pin for %s not found", p2)
require.Empty(t, name2, "expected empty pin name for %s, got '%s'", p2, name2)
// Test 4: Pin update preserves name
err = api.Pin().Add(ctx, p3, opt.Pin.Name("updatable-pin"))
require.NoError(t, err, "failed to add pin with name for update test")
err = api.Pin().Update(ctx, p3, p4)
require.NoError(t, err, "failed to update pin")
// Verify name was preserved after update
pins2 := make(chan iface.Pin)
go func() {
err = api.Pin().Ls(ctx, pins2, opt.Pin.Ls.Detailed(true))
}()
updatedPinMap := make(map[string]string)
for pin := range pins2 {
updatedPinMap[pin.Path().String()] = pin.Name()
}
require.NoError(t, err, "failed to list pins after update")
// Old pin should not exist
_, oldExists := updatedPinMap[p3.String()]
require.False(t, oldExists, "old pin %s should not exist after update", p3)
// New pin should have the preserved name
name4, ok := updatedPinMap[p4.String()]
require.True(t, ok, "updated pin for %s not found", p4)
require.Equal(t, "updatable-pin", name4, "pin name not preserved after update from %s to %s", p3, p4)
// Test 5: Re-pinning with different name updates the name
err = api.Pin().Add(ctx, p1, opt.Pin.Name("new-name-for-p1"))
require.NoError(t, err, "failed to re-pin with new name")
// Verify name was updated
pins3 := make(chan iface.Pin)
go func() {
err = api.Pin().Ls(ctx, pins3, opt.Pin.Ls.Detailed(true))
}()
repinMap := make(map[string]string)
for pin := range pins3 {
repinMap[pin.Path().String()] = pin.Name()
}
require.NoError(t, err, "failed to list pins after re-pin")
rePinnedName, ok := repinMap[p1.String()]
require.True(t, ok, "re-pinned content %s not found", p1)
require.Equal(t, "new-name-for-p1", rePinnedName, "pin name not updated after re-pinning %s", p1)
// Test 6: Direct pin with name
p5, err := api.Unixfs().Add(ctx, strFile("direct-content")())
require.NoError(t, err)
err = api.Pin().Add(ctx, p5, opt.Pin.Recursive(false), opt.Pin.Name("direct-pin-name"))
require.NoError(t, err, "failed to add direct pin with name")
// Verify direct pin has name
directPins := make(chan iface.Pin)
typeOpt, err := opt.Pin.Ls.Type("direct")
require.NoError(t, err, "failed to create type option")
go func() {
err = api.Pin().Ls(ctx, directPins, typeOpt, opt.Pin.Ls.Detailed(true))
}()
directPinMap := make(map[string]string)
for pin := range directPins {
directPinMap[pin.Path().String()] = pin.Name()
}
require.NoError(t, err, "failed to list direct pins")
directName, ok := directPinMap[p5.String()]
require.True(t, ok, "direct pin %s not found", p5)
require.Equal(t, "direct-pin-name", directName, "unexpected name for direct pin %s", p5)
// Test 7: List without detailed option doesn't return names
pinsNoDetails := make(chan iface.Pin)
go func() {
err = api.Pin().Ls(ctx, pinsNoDetails)
}()
noDetailsMap := make(map[string]string)
for pin := range pinsNoDetails {
noDetailsMap[pin.Path().String()] = pin.Name()
}
require.NoError(t, err, "failed to list pins without detailed option")
// All names should be empty without detailed option
for path, name := range noDetailsMap {
require.Empty(t, name, "expected empty name for %s without detailed option, got '%s'", path, name)
}
}
func assertNotPinned(t *testing.T, ctx context.Context, api iface.CoreAPI, p path.Path) {
t.Helper()
_, pinned, err := api.Pin().IsPinned(ctx, p)
if err != nil {
t.Fatal(err)
}
if pinned {
t.Fatalf("%s expected to not be pinned", p)
}
}
func accPins(ctx context.Context, api iface.CoreAPI, opts ...opt.PinLsOption) ([]iface.Pin, error) {
var err error
pins := make(chan iface.Pin)
go func() {
err = api.Pin().Ls(ctx, pins, opts...)
}()
var results []iface.Pin
for pin := range pins {
results = append(results, pin)
}
if err != nil {
return nil, err
}
return results, nil
}