flatfs_test.go 20.7 KB
Newer Older
Tommi Virtanen's avatar
Tommi Virtanen committed
1 2 3
package flatfs_test

import (
Jeromy's avatar
Jeromy committed
4
	"encoding/base32"
5
	"fmt"
Tommi Virtanen's avatar
Tommi Virtanen committed
6
	"io/ioutil"
7
	"math"
8
	"math/rand"
Tommi Virtanen's avatar
Tommi Virtanen committed
9 10
	"os"
	"path/filepath"
11
	"runtime"
12 13
	"strings"
	"sync"
Tommi Virtanen's avatar
Tommi Virtanen committed
14
	"testing"
15
	"time"
Tommi Virtanen's avatar
Tommi Virtanen committed
16

Jeromy's avatar
Jeromy committed
17 18 19
	"github.com/ipfs/go-datastore"
	"github.com/ipfs/go-datastore/query"
	dstest "github.com/ipfs/go-datastore/test"
20

Jakub Sztandera's avatar
Jakub Sztandera committed
21
	"github.com/ipfs/go-ds-flatfs"
Tommi Virtanen's avatar
Tommi Virtanen committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
)

func tempdir(t testing.TB) (path string, cleanup func()) {
	path, err := ioutil.TempDir("", "test-datastore-flatfs-")
	if err != nil {
		t.Fatalf("cannot create temp directory: %v", err)
	}

	cleanup = func() {
		if err := os.RemoveAll(path); err != nil {
			t.Errorf("tempdir cleanup failed: %v", err)
		}
	}
	return path, cleanup
}

38 39 40 41
func tryAllShardFuncs(t *testing.T, testFunc func(mkShardFunc, *testing.T)) {
	t.Run("prefix", func(t *testing.T) { testFunc(flatfs.Prefix, t) })
	t.Run("suffix", func(t *testing.T) { testFunc(flatfs.Suffix, t) })
	t.Run("next-to-last", func(t *testing.T) { testFunc(flatfs.NextToLast, t) })
42 43
}

Tommi Virtanen's avatar
Tommi Virtanen committed
44 45 46 47
func TestPutBadValueType(t *testing.T) {
	temp, cleanup := tempdir(t)
	defer cleanup()

48
	fs, err := flatfs.CreateOrOpen(temp, flatfs.Prefix(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
49 50 51
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
52
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
53 54 55 56 57 58 59

	err = fs.Put(datastore.NewKey("quux"), 22)
	if g, e := err, datastore.ErrInvalidType; g != e {
		t.Fatalf("expected ErrInvalidType, got: %v\n", g)
	}
}

60 61 62
type mkShardFunc func(int) *flatfs.ShardIdV1

func testPut(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
63 64 65
	temp, cleanup := tempdir(t)
	defer cleanup()

66
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
67 68 69
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
70
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
71 72 73 74 75 76 77

	err = fs.Put(datastore.NewKey("quux"), []byte("foobar"))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}
}

78
func TestPut(t *testing.T) { tryAllShardFuncs(t, testPut) }
79

80
func testGet(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
81 82 83
	temp, cleanup := tempdir(t)
	defer cleanup()

84
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
85 86 87
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
88
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

	const input = "foobar"
	err = fs.Put(datastore.NewKey("quux"), []byte(input))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	data, err := fs.Get(datastore.NewKey("quux"))
	if err != nil {
		t.Fatalf("Get failed: %v", err)
	}
	buf, ok := data.([]byte)
	if !ok {
		t.Fatalf("expected []byte from Get, got %T: %v", data, data)
	}
	if g, e := string(buf), input; g != e {
		t.Fatalf("Get gave wrong content: %q != %q", g, e)
	}
}

109
func TestGet(t *testing.T) { tryAllShardFuncs(t, testGet) }
110

111
func testPutOverwrite(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
112 113 114
	temp, cleanup := tempdir(t)
	defer cleanup()

115
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
116 117 118
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
119
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

	const (
		loser  = "foobar"
		winner = "xyzzy"
	)
	err = fs.Put(datastore.NewKey("quux"), []byte(loser))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	err = fs.Put(datastore.NewKey("quux"), []byte(winner))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	data, err := fs.Get(datastore.NewKey("quux"))
	if err != nil {
		t.Fatalf("Get failed: %v", err)
	}
	if g, e := string(data.([]byte)), winner; g != e {
		t.Fatalf("Get gave wrong content: %q != %q", g, e)
	}
}

144
func TestPutOverwrite(t *testing.T) { tryAllShardFuncs(t, testPutOverwrite) }
145

146
func testGetNotFoundError(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
147 148 149
	temp, cleanup := tempdir(t)
	defer cleanup()

150
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
151 152 153
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
154
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
155 156 157 158 159 160 161

	_, err = fs.Get(datastore.NewKey("quux"))
	if g, e := err, datastore.ErrNotFound; g != e {
		t.Fatalf("expected ErrNotFound, got: %v\n", g)
	}
}

162
func TestGetNotFoundError(t *testing.T) { tryAllShardFuncs(t, testGetNotFoundError) }
163 164

type params struct {
165
	shard *flatfs.ShardIdV1
Kevin Atkinson's avatar
Kevin Atkinson committed
166 167
	dir   string
	key   string
168 169 170
}

func testStorage(p *params, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
171 172 173
	temp, cleanup := tempdir(t)
	defer cleanup()

174
	target := p.dir + string(os.PathSeparator) + p.key + ".data"
175
	fs, err := flatfs.CreateOrOpen(temp, p.shard, false)
Tommi Virtanen's avatar
Tommi Virtanen committed
176 177 178
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
179
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
180

181
	err = fs.Put(datastore.NewKey(p.key), []byte("foobar"))
Tommi Virtanen's avatar
Tommi Virtanen committed
182 183 184 185
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

186
	fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
187
	seen := false
188
	haveREADME := false
Tommi Virtanen's avatar
Tommi Virtanen committed
189 190 191 192 193 194 195 196 197
	walk := func(absPath string, fi os.FileInfo, err error) error {
		if err != nil {
			return err
		}
		path, err := filepath.Rel(temp, absPath)
		if err != nil {
			return err
		}
		switch path {
198
		case ".", "..", "SHARDING", flatfs.DiskUsageFile:
Tommi Virtanen's avatar
Tommi Virtanen committed
199
			// ignore
Kevin Atkinson's avatar
Kevin Atkinson committed
200
		case "_README":
201 202 203 204 205
			_, err := ioutil.ReadFile(absPath)
			if err != nil {
				t.Error("could not read _README file")
			}
			haveREADME = true
206
		case p.dir:
Tommi Virtanen's avatar
Tommi Virtanen committed
207
			if !fi.IsDir() {
Kevin Atkinson's avatar
Kevin Atkinson committed
208
				t.Errorf("directory is not a file? %v", fi.Mode())
Tommi Virtanen's avatar
Tommi Virtanen committed
209 210 211 212 213 214 215 216
			}
			// we know it's there if we see the file, nothing more to
			// do here
		case target:
			seen = true
			if !fi.Mode().IsRegular() {
				t.Errorf("expected a regular file, mode: %04o", fi.Mode())
			}
217 218 219 220
			if runtime.GOOS != "windows" {
				if g, e := fi.Mode()&os.ModePerm&0007, os.FileMode(0000); g != e {
					t.Errorf("file should not be world accessible: %04o", fi.Mode())
				}
Tommi Virtanen's avatar
Tommi Virtanen committed
221 222 223 224 225 226 227
			}
		default:
			t.Errorf("saw unexpected directory entry: %q %v", path, fi.Mode())
		}
		return nil
	}
	if err := filepath.Walk(temp, walk); err != nil {
228
		t.Fatalf("walk: %v", err)
Tommi Virtanen's avatar
Tommi Virtanen committed
229 230 231 232
	}
	if !seen {
		t.Error("did not see the data file")
	}
233
	if fs.ShardStr() == flatfs.IPFS_DEF_SHARD_STR && !haveREADME {
234
		t.Error("expected _README file")
235
	} else if fs.ShardStr() != flatfs.IPFS_DEF_SHARD_STR && haveREADME {
236 237
		t.Error("did not expect _README file")
	}
Tommi Virtanen's avatar
Tommi Virtanen committed
238
}
Tommi Virtanen's avatar
Tommi Virtanen committed
239

240 241 242
func TestStorage(t *testing.T) {
	t.Run("prefix", func(t *testing.T) {
		testStorage(&params{
243
			shard: flatfs.Prefix(2),
Kevin Atkinson's avatar
Kevin Atkinson committed
244 245
			dir:   "qu",
			key:   "quux",
246 247 248 249
		}, t)
	})
	t.Run("suffix", func(t *testing.T) {
		testStorage(&params{
250
			shard: flatfs.Suffix(2),
Kevin Atkinson's avatar
Kevin Atkinson committed
251 252
			dir:   "ux",
			key:   "quux",
253 254
		}, t)
	})
255 256
	t.Run("next-to-last", func(t *testing.T) {
		testStorage(&params{
257
			shard: flatfs.NextToLast(2),
Kevin Atkinson's avatar
Kevin Atkinson committed
258 259
			dir:   "uu",
			key:   "quux",
260 261
		}, t)
	})
262 263
}

264
func testHasNotFound(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
265 266 267
	temp, cleanup := tempdir(t)
	defer cleanup()

268
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
269 270 271
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
272
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
273 274 275 276 277 278 279 280 281 282

	found, err := fs.Has(datastore.NewKey("quux"))
	if err != nil {
		t.Fatalf("Has fail: %v\n", err)
	}
	if g, e := found, false; g != e {
		t.Fatalf("wrong Has: %v != %v", g, e)
	}
}

283
func TestHasNotFound(t *testing.T) { tryAllShardFuncs(t, testHasNotFound) }
284

285
func testHasFound(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
286 287 288
	temp, cleanup := tempdir(t)
	defer cleanup()

289
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
290 291 292
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
293 294
	defer fs.Close()

Tommi Virtanen's avatar
Tommi Virtanen committed
295 296 297 298 299 300 301 302 303 304 305 306 307
	err = fs.Put(datastore.NewKey("quux"), []byte("foobar"))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	found, err := fs.Has(datastore.NewKey("quux"))
	if err != nil {
		t.Fatalf("Has fail: %v\n", err)
	}
	if g, e := found, true; g != e {
		t.Fatalf("wrong Has: %v != %v", g, e)
	}
}
Tommi Virtanen's avatar
Tommi Virtanen committed
308

309
func TestHasFound(t *testing.T) { tryAllShardFuncs(t, testHasFound) }
310

311
func testDeleteNotFound(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
312 313 314
	temp, cleanup := tempdir(t)
	defer cleanup()

315
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
316 317 318
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
319
	defer fs.Close()
Tommi Virtanen's avatar
Tommi Virtanen committed
320 321 322 323 324 325 326

	err = fs.Delete(datastore.NewKey("quux"))
	if g, e := err, datastore.ErrNotFound; g != e {
		t.Fatalf("expected ErrNotFound, got: %v\n", g)
	}
}

327
func TestDeleteNotFound(t *testing.T) { tryAllShardFuncs(t, testDeleteNotFound) }
328

329
func testDeleteFound(dirFunc mkShardFunc, t *testing.T) {
Tommi Virtanen's avatar
Tommi Virtanen committed
330 331 332
	temp, cleanup := tempdir(t)
	defer cleanup()

333
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Tommi Virtanen's avatar
Tommi Virtanen committed
334 335 336
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
337 338
	defer fs.Close()

Tommi Virtanen's avatar
Tommi Virtanen committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
	err = fs.Put(datastore.NewKey("quux"), []byte("foobar"))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	err = fs.Delete(datastore.NewKey("quux"))
	if err != nil {
		t.Fatalf("Delete fail: %v\n", err)
	}

	// check that it's gone
	_, err = fs.Get(datastore.NewKey("quux"))
	if g, e := err, datastore.ErrNotFound; g != e {
		t.Fatalf("expected Get after Delete to give ErrNotFound, got: %v\n", g)
	}
}
355

356
func TestDeleteFound(t *testing.T) { tryAllShardFuncs(t, testDeleteFound) }
357

358
func testQuerySimple(dirFunc mkShardFunc, t *testing.T) {
359 360 361
	temp, cleanup := tempdir(t)
	defer cleanup()

362
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
363 364 365
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
366 367
	defer fs.Close()

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
	const myKey = "quux"
	err = fs.Put(datastore.NewKey(myKey), []byte("foobar"))
	if err != nil {
		t.Fatalf("Put fail: %v\n", err)
	}

	res, err := fs.Query(query.Query{KeysOnly: true})
	if err != nil {
		t.Fatalf("Query fail: %v\n", err)
	}
	entries, err := res.Rest()
	if err != nil {
		t.Fatalf("Query Results.Rest fail: %v\n", err)
	}
	seen := false
	for _, e := range entries {
		switch e.Key {
		case datastore.NewKey(myKey).String():
			seen = true
		default:
			t.Errorf("saw unexpected key: %q", e.Key)
		}
	}
	if !seen {
		t.Errorf("did not see wanted key %q in %+v", myKey, entries)
	}
}
Jeromy's avatar
Jeromy committed
395

396
func TestQuerySimple(t *testing.T) { tryAllShardFuncs(t, testQuerySimple) }
397

398 399 400 401 402 403 404 405 406
func testDiskUsage(dirFunc mkShardFunc, t *testing.T) {
	temp, cleanup := tempdir(t)
	t.Log(temp)
	defer cleanup()

	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
407
	defer fs.Close()
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447

	time.Sleep(100 * time.Millisecond)
	duNew, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}
	t.Log("duNew:", duNew)

	count := 200
	for i := 0; i < count; i++ {
		k := datastore.NewKey(fmt.Sprintf("test-%d", i))
		v := []byte("10bytes---")
		err = fs.Put(k, v)
		if err != nil {
			t.Fatalf("Put fail: %v\n", err)
		}
	}

	time.Sleep(100 * time.Millisecond)
	duElems, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}
	t.Log("duPostPut:", duElems)

	for i := 0; i < count; i++ {
		k := datastore.NewKey(fmt.Sprintf("test-%d", i))
		err = fs.Delete(k)
		if err != nil {
			t.Fatalf("Delete fail: %v\n", err)
		}
	}

	time.Sleep(100 * time.Millisecond)
	duDelete, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}
	t.Log("duPostDelete:", duDelete)

448 449 450 451 452
	// Make sure the accuracy value is correct
	if fs.Accuracy() != "initial-exact" {
		t.Errorf("Unexpected value for fs.Accuracy(): %s", fs.Accuracy())
	}

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 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
	fs.Close()
	os.Remove(filepath.Join(temp, flatfs.DiskUsageFile))

	// Make sure size is correctly calculated on re-open
	fs, err = flatfs.Open(temp, false)
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}

	duReopen, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}
	t.Log("duReopen:", duReopen)

	// Checks
	if duNew == 0 {
		t.Error("new datastores should have some size")
	}

	if duElems <= duNew {
		t.Error("size should grow as new elements are added")
	}

	if duElems-duDelete != uint64(count*10) {
		t.Error("size should be reduced exactly as size of objects deleted")
	}

	if duReopen < duNew {
		t.Error("Reopened datastore should not be smaller")
	}
}

func TestDiskUsage(t *testing.T) {
	tryAllShardFuncs(t, testDiskUsage)
}

func TestDiskUsageDoubleCount(t *testing.T) {
	tryAllShardFuncs(t, testDiskUsageDoubleCount)
}

// test that concurrently writing and deleting the same key/value
// does not throw any errors and disk usage does not do
// any double-counting.
func testDiskUsageDoubleCount(dirFunc mkShardFunc, t *testing.T) {
	temp, cleanup := tempdir(t)
	defer cleanup()

	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
505
	defer fs.Close()
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 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577

	var count int
	var wg sync.WaitGroup
	testKey := datastore.NewKey("test")

	put := func() {
		defer wg.Done()
		for i := 0; i < count; i++ {
			v := []byte("10bytes---")
			err := fs.Put(testKey, v)
			if err != nil {
				t.Fatalf("Put fail: %v\n", err)
			}
		}
	}

	del := func() {
		defer wg.Done()
		for i := 0; i < count; i++ {
			err := fs.Delete(testKey)
			if err != nil && !strings.Contains(err.Error(), "key not found") {
				t.Fatalf("Delete fail: %v\n", err)
			}
		}
	}

	// Add one element and then remove it and check disk usage
	// makes sense
	count = 1
	wg.Add(2)
	put()
	du, _ := fs.DiskUsage()
	del()
	du2, _ := fs.DiskUsage()
	if du-10 != du2 {
		t.Error("should have deleted exactly 10 bytes:", du, du2)
	}

	// Add and remove many times at the same time
	count = 200
	wg.Add(4)
	go put()
	go del()
	go put()
	go del()
	wg.Wait()

	du3, _ := fs.DiskUsage()
	has, err := fs.Has(testKey)
	if err != nil {
		t.Fatal(err)
	}

	if has { // put came last
		if du3 != du {
			t.Error("du should be the same as after first put:", du, du3)
		}
	} else { //delete came last
		if du3 != du2 {
			t.Error("du should be the same as after first delete:", du2, du3)
		}
	}
}

func testDiskUsageBatch(dirFunc mkShardFunc, t *testing.T) {
	temp, cleanup := tempdir(t)
	defer cleanup()

	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
578
	defer fs.Close()
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659

	fsBatch, _ := fs.Batch()

	count := 200
	var wg sync.WaitGroup
	testKeys := []datastore.Key{}
	for i := 0; i < count; i++ {
		k := datastore.NewKey(fmt.Sprintf("test%d", i))
		testKeys = append(testKeys, k)
	}

	put := func() {
		for i := 0; i < count; i++ {
			fsBatch.Put(testKeys[i], []byte("10bytes---"))
		}
	}
	commit := func() {
		defer wg.Done()
		err := fsBatch.Commit()
		if err != nil {
			t.Fatalf("Batch Put fail: %v\n", err)
		}
	}

	del := func() {
		defer wg.Done()
		for _, k := range testKeys {
			err := fs.Delete(k)
			if err != nil && !strings.Contains(err.Error(), "key not found") {
				t.Fatalf("Delete fail: %v\n", err)
			}
		}
	}

	// Put many elements and then delete them and check disk usage
	// makes sense
	wg.Add(2)
	put()
	commit()
	du, _ := fs.DiskUsage()
	del()
	du2, _ := fs.DiskUsage()
	if du-uint64(10*count) != du2 {
		t.Errorf("should have deleted exactly %d bytes: %d %d", 10*count, du, du2)
	}

	// Do deletes while doing putManys concurrently
	wg.Add(2)
	put()
	go commit()
	go del()
	wg.Wait()

	du3, _ := fs.DiskUsage()
	// Now query how many keys we have
	results, err := fs.Query(query.Query{
		KeysOnly: true,
	})
	rest, err := results.Rest()
	if err != nil {
		t.Fatal(err)
	}

	expectedSize := uint64(len(rest) * 10)

	if exp := du2 + expectedSize; exp != du3 {
		t.Error("diskUsage has skewed off from real size:",
			exp, du3)
	}
}

func TestDiskUsageBatch(t *testing.T) { tryAllShardFuncs(t, testDiskUsageBatch) }

func testDiskUsageEstimation(dirFunc mkShardFunc, t *testing.T) {
	temp, cleanup := tempdir(t)
	defer cleanup()

	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
660
	defer fs.Close()
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713

	count := 50000
	for i := 0; i < count; i++ {
		k := datastore.NewKey(fmt.Sprintf("%d-test-%d", i, i))
		v := make([]byte, 1000)
		err = fs.Put(k, v)
		if err != nil {
			t.Fatalf("Put fail: %v\n", err)
		}
	}

	// Delete checkpoint
	fs.Close()
	os.Remove(filepath.Join(temp, flatfs.DiskUsageFile))

	// This will do a full du
	flatfs.DiskUsageFilesAverage = -1
	fs, err = flatfs.Open(temp, false)
	if err != nil {
		t.Fatalf("Open fail: %v\n", err)
	}

	duReopen, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}

	fs.Close()
	os.Remove(filepath.Join(temp, flatfs.DiskUsageFile))

	// This will estimate the size. Since all files are the same
	// length we can use a low file average number.
	flatfs.DiskUsageFilesAverage = 100
	// Make sure size is correctly calculated on re-open
	fs, err = flatfs.Open(temp, false)
	if err != nil {
		t.Fatalf("Open fail: %v\n", err)
	}

	duEst, err := fs.DiskUsage()
	if err != nil {
		t.Fatal(err)
	}

	t.Log("RealDu:", duReopen)
	t.Log("Est:", duEst)

	diff := int(math.Abs(float64(int(duReopen) - int(duEst))))
	maxDiff := int(0.05 * float64(duReopen)) // %5 of actual

	if diff > maxDiff {
		t.Fatal("expected a better estimation within 5%")
	}
714 715 716 717 718

	// Make sure the accuracy value is correct
	if fs.Accuracy() != "initial-approximate" {
		t.Errorf("Unexpected value for fs.Accuracy(): %s", fs.Accuracy())
	}
719 720 721 722
}

func TestDiskUsageEstimation(t *testing.T) { tryAllShardFuncs(t, testDiskUsageEstimation) }

723
func testBatchPut(dirFunc mkShardFunc, t *testing.T) {
Jeromy's avatar
Jeromy committed
724 725 726
	temp, cleanup := tempdir(t)
	defer cleanup()

727
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Jeromy's avatar
Jeromy committed
728 729 730
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
731
	defer fs.Close()
Jeromy's avatar
Jeromy committed
732

Jeromy's avatar
Jeromy committed
733 734
	dstest.RunBatchTest(t, fs)
}
Jeromy's avatar
Jeromy committed
735

736
func TestBatchPut(t *testing.T) { tryAllShardFuncs(t, testBatchPut) }
737

738
func testBatchDelete(dirFunc mkShardFunc, t *testing.T) {
Jeromy's avatar
Jeromy committed
739 740
	temp, cleanup := tempdir(t)
	defer cleanup()
Jeromy's avatar
Jeromy committed
741

742
	fs, err := flatfs.CreateOrOpen(temp, dirFunc(2), false)
Jeromy's avatar
Jeromy committed
743
	if err != nil {
Jeromy's avatar
Jeromy committed
744
		t.Fatalf("New fail: %v\n", err)
Jeromy's avatar
Jeromy committed
745
	}
746
	defer fs.Close()
Jeromy's avatar
Jeromy committed
747

Jeromy's avatar
Jeromy committed
748
	dstest.RunBatchDeleteTest(t, fs)
Jeromy's avatar
Jeromy committed
749 750
}

751
func TestBatchDelete(t *testing.T) { tryAllShardFuncs(t, testBatchDelete) }
752

753 754 755 756
func TestSHARDINGFile(t *testing.T) {
	tempdir, cleanup := tempdir(t)
	defer cleanup()

757
	fun := flatfs.IPFS_DEF_SHARD
758

759
	err := flatfs.Create(tempdir, fun)
760
	if err != nil {
761
		t.Fatalf("Create: %v\n", err)
762 763
	}

764
	fs, err := flatfs.Open(tempdir, false)
765
	if err != nil {
766
		t.Fatalf("Open fail: %v\n", err)
767
	}
768 769
	if fs.ShardStr() != flatfs.IPFS_DEF_SHARD_STR {
		t.Fatalf("Expected '%s' for shard function got '%s'", flatfs.IPFS_DEF_SHARD_STR, fs.ShardStr())
770 771 772
	}
	fs.Close()

773
	fs, err = flatfs.CreateOrOpen(tempdir, fun, false)
774 775 776 777 778
	if err != nil {
		t.Fatalf("Could not reopen repo: %v\n", err)
	}
	fs.Close()

779
	fs, err = flatfs.CreateOrOpen(tempdir, flatfs.Prefix(5), false)
780 781 782 783 784
	if err == nil {
		t.Fatalf("Was able to open repo with incompatible sharding function")
	}
}

785
func TestInvalidPrefix(t *testing.T) {
786
	_, err := flatfs.ParseShardFunc("/bad/prefix/v1/next-to-last/2")
787
	if err == nil {
788
		t.Fatalf("Expected an error while parsing a shard identifier with a bad prefix")
789 790 791
	}
}

792 793 794 795 796 797
func TestNonDatastoreDir(t *testing.T) {
	tempdir, cleanup := tempdir(t)
	defer cleanup()

	ioutil.WriteFile(filepath.Join(tempdir, "afile"), []byte("Some Content"), 0644)

798
	err := flatfs.Create(tempdir, flatfs.NextToLast(2))
799 800 801 802 803
	if err == nil {
		t.Fatalf("Expected an error when creating a datastore in a non-empty directory")
	}
}

804 805 806 807
func TestNoCluster(t *testing.T) {
	tempdir, cleanup := tempdir(t)
	defer cleanup()

808
	fs, err := flatfs.CreateOrOpen(tempdir, flatfs.NextToLast(1), false)
809 810 811
	if err != nil {
		t.Fatalf("New fail: %v\n", err)
	}
812
	defer fs.Close()
813

814
	r := rand.New(rand.NewSource(0))
815
	N := 3200 // should be divisible by 32 so the math works out
816 817 818 819 820 821 822 823 824 825 826
	for i := 0; i < N; i++ {
		blk := make([]byte, 1000)
		r.Read(blk)

		key := "CIQ" + base32.StdEncoding.EncodeToString(blk[:10])
		err := fs.Put(datastore.NewKey(key), blk)
		if err != nil {
			t.Fatalf("Put fail: %v\n", err)
		}
	}

Kevin Atkinson's avatar
Kevin Atkinson committed
827
	fs.Close()
828 829 830 831 832
	dirs, err := ioutil.ReadDir(tempdir)
	if err != nil {
		t.Fatalf("ReadDir fail: %v\n", err)
	}
	idealFilesPerDir := float64(N) / 32.0
833
	tolerance := math.Floor(idealFilesPerDir * 0.25)
834
	count := 0
835
	for _, dir := range dirs {
836 837 838
		if dir.Name() == flatfs.SHARDING_FN ||
			dir.Name() == flatfs.README_FN ||
			dir.Name() == flatfs.DiskUsageFile {
839 840 841
			continue
		}
		count += 1
842 843 844 845 846 847 848 849 850 851
		files, err := ioutil.ReadDir(filepath.Join(tempdir, dir.Name()))
		if err != nil {
			t.Fatalf("ReadDir fail: %v\n", err)
		}
		num := float64(len(files))
		if math.Abs(num-idealFilesPerDir) > tolerance {
			t.Fatalf("Dir %s has %.0f files, expected between %.f and %.f files",
				filepath.Join(tempdir, dir.Name()), num, idealFilesPerDir-tolerance, idealFilesPerDir+tolerance)
		}
	}
852 853 854
	if count != 32 {
		t.Fatalf("Expected 32 directories and one file in %s", tempdir)
	}
855 856
}

Jeromy's avatar
Jeromy committed
857
func BenchmarkConsecutivePut(b *testing.B) {
858
	r := rand.New(rand.NewSource(time.Now().UnixNano()))
Jeromy's avatar
Jeromy committed
859 860 861 862 863 864 865 866 867 868 869 870 871
	var blocks [][]byte
	var keys []datastore.Key
	for i := 0; i < b.N; i++ {
		blk := make([]byte, 256*1024)
		r.Read(blk)
		blocks = append(blocks, blk)

		key := base32.StdEncoding.EncodeToString(blk[:8])
		keys = append(keys, datastore.NewKey(key))
	}
	temp, cleanup := tempdir(b)
	defer cleanup()

872
	fs, err := flatfs.CreateOrOpen(temp, flatfs.Prefix(2), false)
Jeromy's avatar
Jeromy committed
873 874 875
	if err != nil {
		b.Fatalf("New fail: %v\n", err)
	}
876
	defer fs.Close()
Jeromy's avatar
Jeromy committed
877 878 879 880 881 882 883 884 885

	b.ResetTimer()

	for i := 0; i < b.N; i++ {
		err := fs.Put(keys[i], blocks[i])
		if err != nil {
			b.Fatal(err)
		}
	}
886
	b.StopTimer() // avoid counting cleanup
Jeromy's avatar
Jeromy committed
887 888 889
}

func BenchmarkBatchedPut(b *testing.B) {
890
	r := rand.New(rand.NewSource(time.Now().UnixNano()))
Jeromy's avatar
Jeromy committed
891 892 893 894 895 896 897 898 899 900 901 902 903
	var blocks [][]byte
	var keys []datastore.Key
	for i := 0; i < b.N; i++ {
		blk := make([]byte, 256*1024)
		r.Read(blk)
		blocks = append(blocks, blk)

		key := base32.StdEncoding.EncodeToString(blk[:8])
		keys = append(keys, datastore.NewKey(key))
	}
	temp, cleanup := tempdir(b)
	defer cleanup()

904
	fs, err := flatfs.CreateOrOpen(temp, flatfs.Prefix(2), false)
Jeromy's avatar
Jeromy committed
905 906 907
	if err != nil {
		b.Fatalf("New fail: %v\n", err)
	}
908
	defer fs.Close()
Jeromy's avatar
Jeromy committed
909 910 911 912

	b.ResetTimer()

	for i := 0; i < b.N; {
Jeromy's avatar
Jeromy committed
913 914 915 916
		batch, err := fs.Batch()
		if err != nil {
			b.Fatal(err)
		}
Jeromy's avatar
Jeromy committed
917 918 919 920 921 922 923 924 925 926 927 928

		for n := i; i-n < 512 && i < b.N; i++ {
			err := batch.Put(keys[i], blocks[i])
			if err != nil {
				b.Fatal(err)
			}
		}
		err = batch.Commit()
		if err != nil {
			b.Fatal(err)
		}
	}
929
	b.StopTimer() // avoid counting cleanup
Jeromy's avatar
Jeromy committed
930
}