unixfs.go 26 KB
Newer Older
1
package tests
2 3 4 5

import (
	"bytes"
	"context"
6
	"encoding/hex"
7
	"fmt"
Łukasz Magiera's avatar
Łukasz Magiera committed
8
	"github.com/ipfs/interface-go-ipfs-core/path"
9 10 11
	"io"
	"io/ioutil"
	"math"
12
	"math/rand"
13 14 15 16 17 18
	"os"
	"strconv"
	"strings"
	"sync"
	"testing"

Łukasz Magiera's avatar
Łukasz Magiera committed
19 20
	coreiface "github.com/ipfs/interface-go-ipfs-core"
	"github.com/ipfs/interface-go-ipfs-core/options"
21

Łukasz Magiera's avatar
Łukasz Magiera committed
22 23 24 25 26 27 28
	"github.com/ipfs/go-cid"
	"github.com/ipfs/go-ipfs-files"
	cbor "github.com/ipfs/go-ipld-cbor"
	mdag "github.com/ipfs/go-merkledag"
	"github.com/ipfs/go-unixfs"
	"github.com/ipfs/go-unixfs/importer/helpers"
	mh "github.com/multiformats/go-multihash"
29 30
)

Łukasz Magiera's avatar
Łukasz Magiera committed
31
func (tp *TestSuite) TestUnixfs(t *testing.T) {
32 33 34 35 36 37 38
	tp.hasApi(t, func(api coreiface.CoreAPI) error {
		if api.Unixfs() == nil {
			return apiNotImplemented
		}
		return nil
	})

39 40 41 42 43 44 45 46 47 48 49
	t.Run("TestAdd", tp.TestAdd)
	t.Run("TestAddPinned", tp.TestAddPinned)
	t.Run("TestAddHashOnly", tp.TestAddHashOnly)
	t.Run("TestGetEmptyFile", tp.TestGetEmptyFile)
	t.Run("TestGetDir", tp.TestGetDir)
	t.Run("TestGetNonUnixfs", tp.TestGetNonUnixfs)
	t.Run("TestLs", tp.TestLs)
	t.Run("TestEntriesExpired", tp.TestEntriesExpired)
	t.Run("TestLsEmptyDir", tp.TestLsEmptyDir)
	t.Run("TestLsNonUnixfs", tp.TestLsNonUnixfs)
	t.Run("TestAddCloses", tp.TestAddCloses)
50
	t.Run("TestGetSeek", tp.TestGetSeek)
51
	t.Run("TestGetReadAt", tp.TestGetReadAt)
52 53
}

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
// `echo -n 'hello, world!' | ipfs add`
var hello = "/ipfs/QmQy2Dw4Wk7rdJKjThjYXzfFJNaRKRHhHP5gHHXroJMYxk"
var helloStr = "hello, world!"

// `echo -n | ipfs add`
var emptyFile = "/ipfs/QmbFMke1KXqnYyBBWxB74N4c5SBnJMVAiMNRcGu6x1AwQH"

func strFile(data string) func() files.Node {
	return func() files.Node {
		return files.NewBytesFile([]byte(data))
	}
}

func twoLevelDir() func() files.Node {
	return func() files.Node {
		return files.NewMapDirectory(map[string]files.Node{
			"abc": files.NewMapDirectory(map[string]files.Node{
				"def": files.NewBytesFile([]byte("world")),
			}),

			"bar": files.NewBytesFile([]byte("hello2")),
			"foo": files.NewBytesFile([]byte("hello1")),
		})
	}
}

func flatDir() files.Node {
	return files.NewMapDirectory(map[string]files.Node{
		"bar": files.NewBytesFile([]byte("hello2")),
		"foo": files.NewBytesFile([]byte("hello1")),
	})
}

87
func wrapped(names ...string) func(f files.Node) files.Node {
88
	return func(f files.Node) files.Node {
89 90 91 92 93 94
		for i := range names {
			f = files.NewMapDirectory(map[string]files.Node{
				names[len(names)-i-1]: f,
			})
		}
		return f
95 96 97
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
98
func (tp *TestSuite) TestAdd(t *testing.T) {
99 100
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
101
	api, err := tp.makeAPI(ctx)
102
	if err != nil {
103
		t.Fatal(err)
104 105
	}

106
	p := func(h string) path.Resolved {
107 108 109 110
		c, err := cid.Parse(h)
		if err != nil {
			t.Fatal(err)
		}
Łukasz Magiera's avatar
Łukasz Magiera committed
111
		return path.IpfsPath(c)
112 113
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
	rf, err := ioutil.TempFile(os.TempDir(), "unixfs-add-real")
	if err != nil {
		t.Fatal(err)
	}
	rfp := rf.Name()

	if _, err := rf.Write([]byte(helloStr)); err != nil {
		t.Fatal(err)
	}

	stat, err := rf.Stat()
	if err != nil {
		t.Fatal(err)
	}

	if err := rf.Close(); err != nil {
		t.Fatal(err)
	}
	defer os.Remove(rfp)

	realFile := func() files.Node {
		n, err := files.NewReaderPathFile(rfp, ioutil.NopCloser(strings.NewReader(helloStr)), stat)
		if err != nil {
			t.Fatal(err)
		}
		return n
	}

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
	cases := []struct {
		name   string
		data   func() files.Node
		expect func(files.Node) files.Node

		apiOpts []options.ApiOption

		path string
		err  string

		wrap string

		events []coreiface.AddEvent

		opts []options.UnixfsAddOption
	}{
		// Simple cases
		{
			name: "simpleAdd",
			data: strFile(helloStr),
			path: hello,
			opts: []options.UnixfsAddOption{},
		},
		{
			name: "addEmpty",
			data: strFile(""),
			path: emptyFile,
		},
		// CIDv1 version / rawLeaves
		{
			name: "addCidV1",
			data: strFile(helloStr),
174
			path: "/ipfs/bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa",
175 176 177 178 179
			opts: []options.UnixfsAddOption{options.Unixfs.CidVersion(1)},
		},
		{
			name: "addCidV1NoLeaves",
			data: strFile(helloStr),
180
			path: "/ipfs/bafybeibhbcn7k7o2m6xsqkrlfiokod3nxwe47viteynhruh6uqx7hvkjfu",
181 182 183 184 185 186
			opts: []options.UnixfsAddOption{options.Unixfs.CidVersion(1), options.Unixfs.RawLeaves(false)},
		},
		// Non sha256 hash vs CID
		{
			name: "addCidSha3",
			data: strFile(helloStr),
187
			path: "/ipfs/bafkrmichjflejeh6aren53o7pig7zk3m3vxqcoc2i5dv326k3x6obh7jry",
188 189 190 191 192 193 194 195 196 197 198 199
			opts: []options.UnixfsAddOption{options.Unixfs.Hash(mh.SHA3_256)},
		},
		{
			name: "addCidSha3Cid0",
			data: strFile(helloStr),
			err:  "CIDv0 only supports sha2-256",
			opts: []options.UnixfsAddOption{options.Unixfs.CidVersion(0), options.Unixfs.Hash(mh.SHA3_256)},
		},
		// Inline
		{
			name: "addInline",
			data: strFile(helloStr),
200
			path: "/ipfs/bafyaafikcmeaeeqnnbswy3dpfqqho33snrsccgan",
201 202 203 204 205
			opts: []options.UnixfsAddOption{options.Unixfs.Inline(true)},
		},
		{
			name: "addInlineLimit",
			data: strFile(helloStr),
206
			path: "/ipfs/bafyaafikcmeaeeqnnbswy3dpfqqho33snrsccgan",
207 208 209 210 211
			opts: []options.UnixfsAddOption{options.Unixfs.InlineLimit(32), options.Unixfs.Inline(true)},
		},
		{
			name: "addInlineZero",
			data: strFile(""),
212
			path: "/ipfs/bafkqaaa",
213 214 215 216 217
			opts: []options.UnixfsAddOption{options.Unixfs.InlineLimit(0), options.Unixfs.Inline(true), options.Unixfs.RawLeaves(true)},
		},
		{ //TODO: after coreapi add is used in `ipfs add`, consider making this default for inline
			name: "addInlineRaw",
			data: strFile(helloStr),
218
			path: "/ipfs/bafkqadlimvwgy3zmeb3w64tmmqqq",
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
			opts: []options.UnixfsAddOption{options.Unixfs.InlineLimit(32), options.Unixfs.Inline(true), options.Unixfs.RawLeaves(true)},
		},
		// Chunker / Layout
		{
			name: "addChunks",
			data: strFile(strings.Repeat("aoeuidhtns", 200)),
			path: "/ipfs/QmRo11d4QJrST47aaiGVJYwPhoNA4ihRpJ5WaxBWjWDwbX",
			opts: []options.UnixfsAddOption{options.Unixfs.Chunker("size-4")},
		},
		{
			name: "addChunksTrickle",
			data: strFile(strings.Repeat("aoeuidhtns", 200)),
			path: "/ipfs/QmNNhDGttafX3M1wKWixGre6PrLFGjnoPEDXjBYpTv93HP",
			opts: []options.UnixfsAddOption{options.Unixfs.Chunker("size-4"), options.Unixfs.Layout(options.TrickleLayout)},
		},
		// Local
		{
			name:    "addLocal", // better cases in sharness
			data:    strFile(helloStr),
			path:    hello,
			apiOpts: []options.ApiOption{options.Api.Offline(true)},
		},
		{
			name: "hashOnly", // test (non)fetchability
			data: strFile(helloStr),
			path: hello,
			opts: []options.UnixfsAddOption{options.Unixfs.HashOnly(true)},
		},
		// multi file
		{
249
			name: "simpleDirNoWrap",
250 251 252
			data: flatDir,
			path: "/ipfs/QmRKGpFfR32FVXdvJiHfo4WJ5TDYBsM1P9raAp1p6APWSp",
		},
253 254 255 256 257 258 259 260 261 262 263 264 265
		{
			name:   "simpleDir",
			data:   flatDir,
			wrap:   "t",
			expect: wrapped("t"),
			path:   "/ipfs/Qmc3nGXm1HtUVCmnXLQHvWcNwfdZGpfg2SRm1CxLf7Q2Rm",
		},
		{
			name:   "twoLevelDir",
			data:   twoLevelDir(),
			wrap:   "t",
			expect: wrapped("t"),
			path:   "/ipfs/QmPwsL3T5sWhDmmAWZHAzyjKtMVDS9a11aHNRqb3xoVnmg",
266 267 268 269 270 271 272 273 274 275 276 277 278
		},
		// wrapped
		{
			name: "addWrapped",
			path: "/ipfs/QmVE9rNpj5doj7XHzp5zMUxD7BJgXEqx4pe3xZ3JBReWHE",
			data: func() files.Node {
				return files.NewBytesFile([]byte(helloStr))
			},
			wrap:   "foo",
			expect: wrapped("foo"),
		},
		// hidden
		{
279
			name: "hiddenFilesAdded",
280 281 282 283 284 285 286
			data: func() files.Node {
				return files.NewMapDirectory(map[string]files.Node{
					".bar": files.NewBytesFile([]byte("hello2")),
					"bar":  files.NewBytesFile([]byte("hello2")),
					"foo":  files.NewBytesFile([]byte("hello1")),
				})
			},
287 288 289 290
			wrap:   "t",
			expect: wrapped("t"),
			path:   "/ipfs/QmPXLSBX382vJDLrGakcbrZDkU3grfkjMox7EgSC9KFbtQ",
		},
Łukasz Magiera's avatar
Łukasz Magiera committed
291 292 293 294
		// NoCopy
		{
			name: "simpleNoCopy",
			data: realFile,
295
			path: "/ipfs/bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa",
Łukasz Magiera's avatar
Łukasz Magiera committed
296 297 298 299 300
			opts: []options.UnixfsAddOption{options.Unixfs.Nocopy(true)},
		},
		{
			name: "noCopyNoRaw",
			data: realFile,
301
			path: "/ipfs/bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa",
Łukasz Magiera's avatar
Łukasz Magiera committed
302 303 304
			opts: []options.UnixfsAddOption{options.Unixfs.Nocopy(true), options.Unixfs.RawLeaves(false)},
			err:  "nocopy option requires '--raw-leaves' to be enabled as well",
		},
305 306 307
		{
			name: "noCopyNoPath",
			data: strFile(helloStr),
308
			path: "/ipfs/bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa",
309 310 311
			opts: []options.UnixfsAddOption{options.Unixfs.Nocopy(true)},
			err:  helpers.ErrMissingFsRef.Error(),
		},
312 313 314 315
		// Events / Progress
		{
			name: "simpleAddEvent",
			data: strFile(helloStr),
316
			path: "/ipfs/bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa",
317
			events: []coreiface.AddEvent{
318
				{Name: "bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa", Path: p("bafkreidi4zlleupgp2bvrpxyja5lbvi4mym7hz5bvhyoowby2qp7g2hxfa"), Size: strconv.Itoa(len(helloStr))},
319 320 321 322 323 324 325 326
			},
			opts: []options.UnixfsAddOption{options.Unixfs.RawLeaves(true)},
		},
		{
			name: "silentAddEvent",
			data: twoLevelDir(),
			path: "/ipfs/QmVG2ZYCkV1S4TK8URA3a4RupBF17A8yAr4FqsRDXVJASr",
			events: []coreiface.AddEvent{
327 328
				{Name: "abc", Path: p("QmU7nuGs2djqK99UNsNgEPGh6GV4662p6WtsgccBNGTDxt"), Size: "62"},
				{Name: "", Path: p("QmVG2ZYCkV1S4TK8URA3a4RupBF17A8yAr4FqsRDXVJASr"), Size: "229"},
329 330 331 332 333 334 335 336
			},
			opts: []options.UnixfsAddOption{options.Unixfs.Silent(true)},
		},
		{
			name: "dirAddEvents",
			data: twoLevelDir(),
			path: "/ipfs/QmVG2ZYCkV1S4TK8URA3a4RupBF17A8yAr4FqsRDXVJASr",
			events: []coreiface.AddEvent{
337 338 339 340 341
				{Name: "abc/def", Path: p("QmNyJpQkU1cEkBwMDhDNFstr42q55mqG5GE5Mgwug4xyGk"), Size: "13"},
				{Name: "bar", Path: p("QmS21GuXiRMvJKHos4ZkEmQDmRBqRaF5tQS2CQCu2ne9sY"), Size: "14"},
				{Name: "foo", Path: p("QmfAjGiVpTN56TXi6SBQtstit5BEw3sijKj1Qkxn6EXKzJ"), Size: "14"},
				{Name: "abc", Path: p("QmU7nuGs2djqK99UNsNgEPGh6GV4662p6WtsgccBNGTDxt"), Size: "62"},
				{Name: "", Path: p("QmVG2ZYCkV1S4TK8URA3a4RupBF17A8yAr4FqsRDXVJASr"), Size: "229"},
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
			},
		},
		{
			name: "progress1M",
			data: func() files.Node {
				return files.NewReaderFile(bytes.NewReader(bytes.Repeat([]byte{0}, 1000000)))
			},
			path: "/ipfs/QmXXNNbwe4zzpdMg62ZXvnX1oU7MwSrQ3vAEtuwFKCm1oD",
			events: []coreiface.AddEvent{
				{Name: "", Bytes: 262144},
				{Name: "", Bytes: 524288},
				{Name: "", Bytes: 786432},
				{Name: "", Bytes: 1000000},
				{Name: "QmXXNNbwe4zzpdMg62ZXvnX1oU7MwSrQ3vAEtuwFKCm1oD", Path: p("QmXXNNbwe4zzpdMg62ZXvnX1oU7MwSrQ3vAEtuwFKCm1oD"), Size: "1000256"},
			},
			wrap: "",
			opts: []options.UnixfsAddOption{options.Unixfs.Progress(true)},
		},
	}

	for _, testCase := range cases {
		t.Run(testCase.name, func(t *testing.T) {
			ctx, cancel := context.WithCancel(ctx)
			defer cancel()

			// recursive logic

			data := testCase.data()
			if testCase.wrap != "" {
				data = files.NewMapDirectory(map[string]files.Node{
					testCase.wrap: data,
				})
			}

			// handle events if relevant to test case

			opts := testCase.opts
			eventOut := make(chan interface{})
			var evtWg sync.WaitGroup
			if len(testCase.events) > 0 {
				opts = append(opts, options.Unixfs.Events(eventOut))
				evtWg.Add(1)

				go func() {
					defer evtWg.Done()
					expected := testCase.events

					for evt := range eventOut {
						event, ok := evt.(*coreiface.AddEvent)
						if !ok {
392 393
							t.Error("unexpected event type")
							continue
394 395 396
						}

						if len(expected) < 1 {
397 398
							t.Error("got more events than expected")
							continue
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
						}

						if expected[0].Size != event.Size {
							t.Errorf("Event.Size didn't match, %s != %s", expected[0].Size, event.Size)
						}

						if expected[0].Name != event.Name {
							t.Errorf("Event.Name didn't match, %s != %s", expected[0].Name, event.Name)
						}

						if expected[0].Path != nil && event.Path != nil {
							if expected[0].Path.Cid().String() != event.Path.Cid().String() {
								t.Errorf("Event.Hash didn't match, %s != %s", expected[0].Path, event.Path)
							}
						} else if event.Path != expected[0].Path {
							t.Errorf("Event.Hash didn't match, %s != %s", expected[0].Path, event.Path)
						}
						if expected[0].Bytes != event.Bytes {
							t.Errorf("Event.Bytes didn't match, %d != %d", expected[0].Bytes, event.Bytes)
						}

						expected = expected[1:]
					}

					if len(expected) > 0 {
424
						t.Errorf("%d event(s) didn't arrive", len(expected))
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
					}
				}()
			}

			tapi, err := api.WithOptions(testCase.apiOpts...)
			if err != nil {
				t.Fatal(err)
			}

			// Add!

			p, err := tapi.Unixfs().Add(ctx, data, opts...)
			close(eventOut)
			evtWg.Wait()
			if testCase.err != "" {
				if err == nil {
					t.Fatalf("expected an error: %s", testCase.err)
				}
				if err.Error() != testCase.err {
					t.Fatalf("expected an error: '%s' != '%s'", err.Error(), testCase.err)
				}
				return
			}
			if err != nil {
				t.Fatal(err)
			}

			if p.String() != testCase.path {
				t.Errorf("expected path %s, got: %s", testCase.path, p)
			}

			// compare file structure with Unixfs().Get

			var cmpFile func(origName string, orig files.Node, gotName string, got files.Node)
			cmpFile = func(origName string, orig files.Node, gotName string, got files.Node) {
				_, origDir := orig.(files.Directory)
				_, gotDir := got.(files.Directory)

				if origName != gotName {
					t.Errorf("file name mismatch, orig='%s', got='%s'", origName, gotName)
				}

467 468 469 470
				if origDir != gotDir {
					t.Fatalf("file type mismatch on %s", origName)
				}

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
				if !gotDir {
					defer orig.Close()
					defer got.Close()

					do, err := ioutil.ReadAll(orig.(files.File))
					if err != nil {
						t.Fatal(err)
					}

					dg, err := ioutil.ReadAll(got.(files.File))
					if err != nil {
						t.Fatal(err)
					}

					if !bytes.Equal(do, dg) {
						t.Fatal("data not equal")
					}

					return
				}

				origIt := orig.(files.Directory).Entries()
				gotIt := got.(files.Directory).Entries()

				for {
					if origIt.Next() {
						if !gotIt.Next() {
							t.Fatal("gotIt out of entries before origIt")
						}
					} else {
						if gotIt.Next() {
							t.Fatal("origIt out of entries before gotIt")
						}
						break
					}

					cmpFile(origIt.Name(), origIt.Node(), gotIt.Name(), gotIt.Node())
				}
				if origIt.Err() != nil {
					t.Fatal(origIt.Err())
				}
				if gotIt.Err() != nil {
					t.Fatal(gotIt.Err())
				}
			}

			f, err := tapi.Unixfs().Get(ctx, p)
			if err != nil {
				t.Fatal(err)
			}

			orig := testCase.data()
			if testCase.expect != nil {
				orig = testCase.expect(orig)
			}

			cmpFile("", orig, "", f)
		})
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
532
func (tp *TestSuite) TestAddPinned(t *testing.T) {
533 534
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
535
	api, err := tp.makeAPI(ctx)
536
	if err != nil {
537
		t.Fatal(err)
538 539 540 541
	}

	_, err = api.Unixfs().Add(ctx, strFile(helloStr)(), options.Unixfs.Pin(true))
	if err != nil {
542
		t.Fatal(err)
543 544
	}

545
	pins, err := accPins(api.Pin().Ls(ctx))
546 547 548
	if err != nil {
		t.Fatal(err)
	}
549 550 551 552 553 554 555 556 557
	if len(pins) != 1 {
		t.Fatalf("expected 1 pin, got %d", len(pins))
	}

	if pins[0].Path().String() != "/ipld/QmQy2Dw4Wk7rdJKjThjYXzfFJNaRKRHhHP5gHHXroJMYxk" {
		t.Fatalf("got unexpected pin: %s", pins[0].Path().String())
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
558
func (tp *TestSuite) TestAddHashOnly(t *testing.T) {
559 560
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
561
	api, err := tp.makeAPI(ctx)
562
	if err != nil {
563
		t.Fatal(err)
564 565 566 567
	}

	p, err := api.Unixfs().Add(ctx, strFile(helloStr)(), options.Unixfs.HashOnly(true))
	if err != nil {
568
		t.Fatal(err)
569 570 571 572 573 574 575 576 577 578
	}

	if p.String() != hello {
		t.Errorf("unxepected path: %s", p.String())
	}

	_, err = api.Block().Get(ctx, p)
	if err == nil {
		t.Fatal("expected an error")
	}
579
	if !strings.Contains(err.Error(), "blockservice: key not found") {
580 581 582 583
		t.Errorf("unxepected error: %s", err.Error())
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
584
func (tp *TestSuite) TestGetEmptyFile(t *testing.T) {
585 586
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
587
	api, err := tp.makeAPI(ctx)
588 589 590 591 592 593 594 595 596
	if err != nil {
		t.Fatal(err)
	}

	_, err = api.Unixfs().Add(ctx, files.NewBytesFile([]byte{}))
	if err != nil {
		t.Fatal(err)
	}

597
	emptyFilePath := path.New(emptyFile)
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

	r, err := api.Unixfs().Get(ctx, emptyFilePath)
	if err != nil {
		t.Fatal(err)
	}

	buf := make([]byte, 1) // non-zero so that Read() actually tries to read
	n, err := io.ReadFull(r.(files.File), buf)
	if err != nil && err != io.EOF {
		t.Error(err)
	}
	if !bytes.HasPrefix(buf, []byte{0x00}) {
		t.Fatalf("expected empty data, got [%s] [read=%d]", buf, n)
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
614
func (tp *TestSuite) TestGetDir(t *testing.T) {
615 616
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
617
	api, err := tp.makeAPI(ctx)
618
	if err != nil {
619
		t.Fatal(err)
620 621
	}
	edir := unixfs.EmptyDirNode()
622
	err = api.Dag().Add(ctx, edir)
623
	if err != nil {
624
		t.Fatal(err)
625
	}
Łukasz Magiera's avatar
Łukasz Magiera committed
626
	p := path.IpfsPath(edir.Cid())
627 628 629

	emptyDir, err := api.Object().New(ctx, options.Object.Type("unixfs-dir"))
	if err != nil {
630
		t.Fatal(err)
631 632
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
633
	if p.String() != path.IpfsPath(emptyDir.Cid()).String() {
634 635 636
		t.Fatalf("expected path %s, got: %s", emptyDir.Cid(), p.String())
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
637
	r, err := api.Unixfs().Get(ctx, path.IpfsPath(emptyDir.Cid()))
638
	if err != nil {
639
		t.Fatal(err)
640 641 642 643 644 645 646
	}

	if _, ok := r.(files.Directory); !ok {
		t.Fatalf("expected a directory")
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
647
func (tp *TestSuite) TestGetNonUnixfs(t *testing.T) {
648 649
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
650
	api, err := tp.makeAPI(ctx)
651
	if err != nil {
652
		t.Fatal(err)
653 654 655
	}

	nd := new(mdag.ProtoNode)
656
	err = api.Dag().Add(ctx, nd)
657
	if err != nil {
658
		t.Fatal(err)
659 660
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
661
	_, err = api.Unixfs().Get(ctx, path.IpfsPath(nd.Cid()))
662 663 664 665 666
	if !strings.Contains(err.Error(), "proto: required field") {
		t.Fatalf("expected protobuf error, got: %s", err)
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
667
func (tp *TestSuite) TestLs(t *testing.T) {
668 669
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
670
	api, err := tp.makeAPI(ctx)
671
	if err != nil {
Steven Allen's avatar
Steven Allen committed
672
		t.Fatal(err)
673 674 675 676
	}

	r := strings.NewReader("content-of-file")
	p, err := api.Unixfs().Add(ctx, files.NewMapDirectory(map[string]files.Node{
677 678
		"name-of-file":    files.NewReaderFile(r),
		"name-of-symlink": files.NewLinkFile("/foo/bar", nil),
679 680
	}))
	if err != nil {
Steven Allen's avatar
Steven Allen committed
681
		t.Fatal(err)
682 683
	}

Steven Allen's avatar
Steven Allen committed
684
	entries, err := api.Unixfs().Ls(ctx, p)
685
	if err != nil {
Steven Allen's avatar
Steven Allen committed
686
		t.Fatal(err)
687 688
	}

Steven Allen's avatar
Steven Allen committed
689 690 691
	entry := <-entries
	if entry.Err != nil {
		t.Fatal(entry.Err)
692
	}
Steven Allen's avatar
Steven Allen committed
693
	if entry.Size != 15 {
Steven Allen's avatar
Steven Allen committed
694
		t.Errorf("expected size = 15, got %d", entry.Size)
Łukasz Magiera's avatar
Łukasz Magiera committed
695
	}
Steven Allen's avatar
Steven Allen committed
696
	if entry.Name != "name-of-file" {
Steven Allen's avatar
Steven Allen committed
697 698 699 700
		t.Errorf("expected name = name-of-file, got %s", entry.Name)
	}
	if entry.Type != coreiface.TFile {
		t.Errorf("wrong type %s", entry.Type)
Łukasz Magiera's avatar
Łukasz Magiera committed
701
	}
Steven Allen's avatar
Steven Allen committed
702
	if entry.Cid.String() != "QmX3qQVKxDGz3URVC3861Z3CKtQKGBn6ffXRBBWGMFz9Lr" {
Steven Allen's avatar
Steven Allen committed
703 704 705 706 707 708 709 710 711 712 713 714
		t.Errorf("expected cid = QmX3qQVKxDGz3URVC3861Z3CKtQKGBn6ffXRBBWGMFz9Lr, got %s", entry.Cid)
	}
	entry = <-entries
	if entry.Err != nil {
		t.Fatal(entry.Err)
	}
	if entry.Type != coreiface.TSymlink {
		t.Errorf("wrong type %s", entry.Type)
	}
	if entry.Name != "name-of-symlink" {
		t.Errorf("expected name = name-of-symlink, got %s", entry.Name)
	}
715
	if entry.Target != "/foo/bar" {
Steven Allen's avatar
Steven Allen committed
716 717 718
		t.Errorf("expected symlink target to be /foo/bar, got %s", entry.Target)
	}

Steven Allen's avatar
Steven Allen committed
719
	if l, ok := <-entries; ok {
Łukasz Magiera's avatar
Łukasz Magiera committed
720
		t.Errorf("didn't expect a second link")
721 722 723
		if l.Err != nil {
			t.Error(l.Err)
		}
Łukasz Magiera's avatar
Łukasz Magiera committed
724
	}
725 726
}

Łukasz Magiera's avatar
Łukasz Magiera committed
727
func (tp *TestSuite) TestEntriesExpired(t *testing.T) {
728 729
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
730
	api, err := tp.makeAPI(ctx)
731
	if err != nil {
732
		t.Fatal(err)
733 734 735 736
	}

	r := strings.NewReader("content-of-file")
	p, err := api.Unixfs().Add(ctx, files.NewMapDirectory(map[string]files.Node{
737
		"name-of-file": files.NewReaderFile(r),
738 739
	}))
	if err != nil {
740
		t.Fatal(err)
741 742
	}

743
	ctx, cancel = context.WithCancel(ctx)
744 745 746

	nd, err := api.Unixfs().Get(ctx, p)
	if err != nil {
747
		t.Fatal(err)
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
	}
	cancel()

	it := files.ToDir(nd).Entries()
	if it == nil {
		t.Fatal("it was nil")
	}

	if it.Next() {
		t.Fatal("Next succeeded")
	}

	if it.Err() != context.Canceled {
		t.Fatalf("unexpected error %s", it.Err())
	}

	if it.Next() {
		t.Fatal("Next succeeded")
	}
}

Łukasz Magiera's avatar
Łukasz Magiera committed
769
func (tp *TestSuite) TestLsEmptyDir(t *testing.T) {
770 771
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
772
	api, err := tp.makeAPI(ctx)
773
	if err != nil {
774
		t.Fatal(err)
775 776
	}

777
	_, err = api.Unixfs().Add(ctx, files.NewSliceDirectory([]files.DirEntry{}))
778
	if err != nil {
779
		t.Fatal(err)
780 781 782 783
	}

	emptyDir, err := api.Object().New(ctx, options.Object.Type("unixfs-dir"))
	if err != nil {
784
		t.Fatal(err)
785 786
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
787
	links, err := api.Unixfs().Ls(ctx, path.IpfsPath(emptyDir.Cid()))
788
	if err != nil {
789
		t.Fatal(err)
790 791 792 793 794 795 796 797
	}

	if len(links) != 0 {
		t.Fatalf("expected 0 links, got %d", len(links))
	}
}

// TODO(lgierth) this should test properly, with len(links) > 0
Łukasz Magiera's avatar
Łukasz Magiera committed
798
func (tp *TestSuite) TestLsNonUnixfs(t *testing.T) {
799 800
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
801
	api, err := tp.makeAPI(ctx)
802
	if err != nil {
803
		t.Fatal(err)
804 805 806 807 808 809 810
	}

	nd, err := cbor.WrapObject(map[string]interface{}{"foo": "bar"}, math.MaxUint64, -1)
	if err != nil {
		t.Fatal(err)
	}

811
	err = api.Dag().Add(ctx, nd)
812
	if err != nil {
813
		t.Fatal(err)
814 815
	}

Łukasz Magiera's avatar
Łukasz Magiera committed
816
	links, err := api.Unixfs().Ls(ctx, path.IpfsPath(nd.Cid()))
817
	if err != nil {
818
		t.Fatal(err)
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
	}

	if len(links) != 0 {
		t.Fatalf("expected 0 links, got %d", len(links))
	}
}

type closeTestF struct {
	files.File
	closed bool

	t *testing.T
}

type closeTestD struct {
	files.Directory
	closed bool

	t *testing.T
}

func (f *closeTestD) Close() error {
Steven Allen's avatar
Steven Allen committed
841
	f.t.Helper()
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
	if f.closed {
		f.t.Fatal("already closed")
	}
	f.closed = true
	return nil
}

func (f *closeTestF) Close() error {
	if f.closed {
		f.t.Fatal("already closed")
	}
	f.closed = true
	return nil
}

Łukasz Magiera's avatar
Łukasz Magiera committed
857
func (tp *TestSuite) TestAddCloses(t *testing.T) {
858 859
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
860
	api, err := tp.makeAPI(ctx)
861
	if err != nil {
862
		t.Fatal(err)
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
	}

	n4 := &closeTestF{files.NewBytesFile([]byte("foo")), false, t}
	d3 := &closeTestD{files.NewMapDirectory(map[string]files.Node{
		"sub": n4,
	}), false, t}
	n2 := &closeTestF{files.NewBytesFile([]byte("bar")), false, t}
	n1 := &closeTestF{files.NewBytesFile([]byte("baz")), false, t}
	d0 := &closeTestD{files.NewMapDirectory(map[string]files.Node{
		"a": d3,
		"b": n1,
		"c": n2,
	}), false, t}

	_, err = api.Unixfs().Add(ctx, d0)
	if err != nil {
879
		t.Fatal(err)
880 881 882 883 884 885 886 887 888 889 890 891 892
	}

	for i, n := range []*closeTestF{n1, n2, n4} {
		if !n.closed {
			t.Errorf("file %d not closed!", i)
		}
	}

	for i, n := range []*closeTestD{d0, d3} {
		if !n.closed {
			t.Errorf("dir %d not closed!", i)
		}
	}
893 894
}

Łukasz Magiera's avatar
Łukasz Magiera committed
895
func (tp *TestSuite) TestGetSeek(t *testing.T) {
896 897 898 899
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	api, err := tp.makeAPI(ctx)
	if err != nil {
900
		t.Fatal(err)
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
	}

	dataSize := int64(100000)
	tf := files.NewReaderFile(io.LimitReader(rand.New(rand.NewSource(1403768328)), dataSize))

	p, err := api.Unixfs().Add(ctx, tf, options.Unixfs.Chunker("size-100"))
	if err != nil {
		t.Fatal(err)
	}

	r, err := api.Unixfs().Get(ctx, p)
	if err != nil {
		t.Fatal(err)
	}

	f := files.ToFile(r)
	if f == nil {
		t.Fatal("not a file")
	}

	orig := make([]byte, dataSize)
922
	if _, err := io.ReadFull(f, orig); err != nil {
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
		t.Fatal(err)
	}
	f.Close()

	origR := bytes.NewReader(orig)

	r, err = api.Unixfs().Get(ctx, p)
	if err != nil {
		t.Fatal(err)
	}

	f = files.ToFile(r)
	if f == nil {
		t.Fatal("not a file")
	}

	test := func(offset int64, whence int, read int, expect int64, shouldEof bool) {
		t.Run(fmt.Sprintf("seek%d+%d-r%d-%d", whence, offset, read, expect), func(t *testing.T) {
			n, err := f.Seek(offset, whence)
			if err != nil {
				t.Fatal(err)
			}
			origN, err := origR.Seek(offset, whence)
			if err != nil {
				t.Fatal(err)
			}

			if n != origN {
				t.Fatalf("offsets didn't match, expected %d, got %d", origN, n)
			}

			buf := make([]byte, read)
			origBuf := make([]byte, read)
			origRead, err := origR.Read(origBuf)
			if err != nil {
				t.Fatalf("orig: %s", err)
			}
960
			r, err := io.ReadFull(f, buf)
961
			switch {
962
			case shouldEof && err != nil && err != io.ErrUnexpectedEOF:
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
				fallthrough
			case !shouldEof && err != nil:
				t.Fatalf("f: %s", err)
			case shouldEof:
				_, err := f.Read([]byte{0})
				if err != io.EOF {
					t.Fatal("expected EOF")
				}
				_, err = origR.Read([]byte{0})
				if err != io.EOF {
					t.Fatal("expected EOF (orig)")
				}
			}

			if int64(r) != expect {
				t.Fatal("read wrong amount of data")
			}
			if r != origRead {
				t.Fatal("read different amount of data than bytes.Reader")
			}
			if !bytes.Equal(buf, origBuf) {
984 985
				fmt.Fprintf(os.Stderr, "original:\n%s\n", hex.Dump(origBuf))
				fmt.Fprintf(os.Stderr, "got:\n%s\n", hex.Dump(buf))
986 987 988 989
				t.Fatal("data didn't match")
			}
		})
	}
990

991 992 993 994 995
	test(3, io.SeekCurrent, 10, 10, false)
	test(3, io.SeekCurrent, 10, 10, false)
	test(500, io.SeekCurrent, 10, 10, false)
	test(350, io.SeekStart, 100, 100, false)
	test(-123, io.SeekCurrent, 100, 100, false)
996
	test(0, io.SeekStart, int(dataSize), dataSize, false)
997 998
	test(dataSize-50, io.SeekStart, 100, 50, true)
	test(-5, io.SeekEnd, 100, 5, true)
999
}
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

func (tp *TestSuite) TestGetReadAt(t *testing.T) {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	api, err := tp.makeAPI(ctx)
	if err != nil {
		t.Fatal(err)
	}

	dataSize := int64(100000)
	tf := files.NewReaderFile(io.LimitReader(rand.New(rand.NewSource(1403768328)), dataSize))

	p, err := api.Unixfs().Add(ctx, tf, options.Unixfs.Chunker("size-100"))
	if err != nil {
		t.Fatal(err)
	}

	r, err := api.Unixfs().Get(ctx, p)
	if err != nil {
		t.Fatal(err)
	}

	f, ok := r.(interface {
		files.File
		io.ReaderAt
	})
	if !ok {
		t.Skip("ReaderAt not implemented")
	}

	orig := make([]byte, dataSize)
	if _, err := io.ReadFull(f, orig); err != nil {
		t.Fatal(err)
	}
	f.Close()

	origR := bytes.NewReader(orig)

	r, err = api.Unixfs().Get(ctx, p)
	if err != nil {
		t.Fatal(err)
	}

	test := func(offset int64, read int, expect int64, shouldEof bool) {
		t.Run(fmt.Sprintf("readat%d-r%d-%d", offset, read, expect), func(t *testing.T) {
			origBuf := make([]byte, read)
			origRead, err := origR.ReadAt(origBuf, offset)
			if err != nil && err != io.EOF {
				t.Fatalf("orig: %s", err)
			}
			buf := make([]byte, read)
			r, err := f.ReadAt(buf, offset)
			if shouldEof {
				if err != io.EOF {
					t.Fatal("expected EOF, got: ", err)
				}
			} else if err != nil {
				t.Fatal("got: ", err)
			}

			if int64(r) != expect {
				t.Fatal("read wrong amount of data")
			}
			if r != origRead {
				t.Fatal("read different amount of data than bytes.Reader")
			}
			if !bytes.Equal(buf, origBuf) {
				fmt.Fprintf(os.Stderr, "original:\n%s\n", hex.Dump(origBuf))
				fmt.Fprintf(os.Stderr, "got:\n%s\n", hex.Dump(buf))
				t.Fatal("data didn't match")
			}
		})
	}

	test(3, 10, 10, false)
	test(13, 10, 10, false)
	test(513, 10, 10, false)
	test(350, 100, 100, false)
	test(0, int(dataSize), dataSize, false)
	test(dataSize-50, 100, 50, true)
}