Update filestore tests

* Use t.Context() instead of context.Background()
* Use sub-tests for sub-cases when testing List()
* Check path prefix when testing List()

Author: byo

filestore/filestore_test.go

@@ -1,7 +1,6 @@
 package filestore_test
 
 import (
-	"context"
 	"fmt"
 	"io"
 	"io/fs"
@@ -11,7 +10,6 @@ import (
 	"testing"
 
 	"github.com/ipni/storetheindex/filestore"
-	"github.com/ipni/storetheindex/fsutil"
 	"github.com/stretchr/testify/require"
 
 	"github.com/orlangure/gnomock"
@@ -89,7 +87,7 @@ func TestLocal(t *testing.T) {
 		testPut(t, fileStore)
 	})
 
-	require.True(t, fsutil.FileExists(filepath.Join(carDir, fileName)))
+	require.FileExists(t, filepath.Join(carDir, fileName))
 
 	t.Run("test-Local-Head", func(t *testing.T) {
 		testHead(t, fileStore)
@@ -135,42 +133,42 @@ func TestMakeFilestore(t *testing.T) {
 }
 
 func testPut(t *testing.T, fileStore filestore.Interface) {
-	fileInfo, err := fileStore.Put(context.Background(), fileName, strings.NewReader(data))
+	fileInfo, err := fileStore.Put(t.Context(), fileName, strings.NewReader(data))
 	require.NoError(t, err)
 	require.Equal(t, fileName, fileInfo.Path)
 	require.Equal(t, int64(len(data)), fileInfo.Size)
 }
 
 func testHead(t *testing.T, fileStore filestore.Interface) {
 	// Get file that does not exist.
-	fileInfo, err := fileStore.Head(context.Background(), "not-here")
+	fileInfo, err := fileStore.Head(t.Context(), "not-here")
 	require.ErrorIs(t, err, fs.ErrNotExist)
 	require.Nil(t, fileInfo)
 
-	_, err = fileStore.Put(context.Background(), fileName3, strings.NewReader(data))
+	_, err = fileStore.Put(t.Context(), fileName3, strings.NewReader(data))
 	require.NoError(t, err)
 
-	fileInfo, err = fileStore.Head(context.Background(), fileName3)
+	fileInfo, err = fileStore.Head(t.Context(), fileName3)
 	require.NoError(t, err)
 	require.Equal(t, fileName3, fileInfo.Path)
 	require.Equal(t, int64(len(data)), fileInfo.Size)
 	require.False(t, fileInfo.Modified.IsZero())
 
 	// Should get fs.ErrNotExist when looking for subdirectory.
-	_, err = fileStore.Head(context.Background(), subdir)
+	_, err = fileStore.Head(t.Context(), subdir)
 	require.ErrorIs(t, err, fs.ErrNotExist)
 }
 
 func testGet(t *testing.T, fileStore filestore.Interface) {
 	// Get file that does not exist.
-	fileInfo, _, err := fileStore.Get(context.Background(), "not-here")
+	fileInfo, _, err := fileStore.Get(t.Context(), "not-here")
 	require.ErrorIs(t, err, fs.ErrNotExist)
 	require.Nil(t, fileInfo)
 
-	_, err = fileStore.Put(context.Background(), fileName, strings.NewReader(data))
+	_, err = fileStore.Put(t.Context(), fileName, strings.NewReader(data))
 	require.NoError(t, err)
 
-	fileInfo, r, err := fileStore.Get(context.Background(), fileName)
+	fileInfo, r, err := fileStore.Get(t.Context(), fileName)
 	require.NoError(t, err)
 	require.Equal(t, fileName, fileInfo.Path)
 	require.Equal(t, int64(len(data)), fileInfo.Size)
@@ -185,88 +183,106 @@ func testGet(t *testing.T, fileStore filestore.Interface) {
 	require.ErrorIs(t, err, io.EOF)
 	require.NoError(t, r.Close())
 
-	_, err = fileStore.Put(context.Background(), fileName3, strings.NewReader(data3))
+	_, err = fileStore.Put(t.Context(), fileName3, strings.NewReader(data3))
 	require.NoError(t, err)
 
-	_, _, err = fileStore.Get(context.Background(), subdir)
+	_, _, err = fileStore.Get(t.Context(), subdir)
 	require.ErrorIs(t, err, fs.ErrNotExist)
 
-	fileInfo, r, err = fileStore.Get(context.Background(), fileName3)
+	fileInfo, r, err = fileStore.Get(t.Context(), fileName3)
 	require.NoError(t, err)
 	require.NoError(t, r.Close())
 	require.Equal(t, int64(len(data3)), fileInfo.Size)
 }
 
 func testList(t *testing.T, fileStore filestore.Interface) {
 	// List file that does not exist.
-	fileCh, errCh := fileStore.List(context.Background(), "not-here/", false)
+	fileCh, errCh := fileStore.List(t.Context(), "not-here/", false)
 	fileInfo, ok := <-fileCh
 	require.Nil(t, fileInfo)
 	require.False(t, ok)
 	err := <-errCh
 	require.NoError(t, err)
 
-	_, err = fileStore.Put(context.Background(), fileName1, strings.NewReader(data1))
+	_, err = fileStore.Put(t.Context(), fileName1, strings.NewReader(data1))
 	require.NoError(t, err)
 
-	_, err = fileStore.Put(context.Background(), fileName2, strings.NewReader(data2))
+	_, err = fileStore.Put(t.Context(), fileName2, strings.NewReader(data2))
 	require.NoError(t, err)
 
-	_, err = fileStore.Put(context.Background(), fileName3, strings.NewReader(data3))
+	_, err = fileStore.Put(t.Context(), fileName3, strings.NewReader(data3))
 	require.NoError(t, err)
 
-	fileCh, errCh = fileStore.List(context.Background(), "", false)
-	infos := make([]*filestore.File, 0, 3)
-	for fileInfo := range fileCh {
-		infos = append(infos, fileInfo)
-	}
-	err = <-errCh
-	require.NoError(t, err)
-	require.Equal(t, 3, len(infos))
-	expectNames := []string{fileName, fileName1, fileName2}
-	expectSizes := []int64{int64(len(data)), int64(len(data1)), int64(len(data2))}
-	for i := range infos {
-		require.Equal(t, expectNames[i], infos[i].Path)
-		require.Equal(t, expectSizes[i], infos[i].Size)
-		require.False(t, infos[0].Modified.IsZero())
-	}
+	t.Run("list non-recursively", func(t *testing.T) {
+		fileCh, errCh = fileStore.List(t.Context(), "", false)
+		infos := make([]*filestore.File, 0, 3)
+		for fileInfo := range fileCh {
+			infos = append(infos, fileInfo)
+		}
+		err = <-errCh
+		require.NoError(t, err)
+		require.Equal(t, 3, len(infos))
+		expectNames := []string{fileName, fileName1, fileName2}
+		expectSizes := []int64{int64(len(data)), int64(len(data1)), int64(len(data2))}
+		for i := range infos {
+			require.Equal(t, expectNames[i], infos[i].Path)
+			require.Equal(t, expectSizes[i], infos[i].Size)
+			require.False(t, infos[0].Modified.IsZero())
+		}
+	})
 
-	fileCh, errCh = fileStore.List(context.Background(), "", true)
-	infos = infos[:0]
-	for fileInfo := range fileCh {
-		infos = append(infos, fileInfo)
-	}
-	err = <-errCh
-	require.NoError(t, err)
-	require.Equal(t, 4, len(infos))
-	require.Equal(t, fileName3, infos[0].Path)
-	require.Equal(t, int64(len(data3)), infos[0].Size)
-
-	// File specific file.
-	fileCh, errCh = fileStore.List(context.Background(), fileName1, false)
-	infos = infos[:0]
-	for fileInfo := range fileCh {
-		infos = append(infos, fileInfo)
-	}
-	err = <-errCh
-	require.NoError(t, err)
-	require.Equal(t, 1, len(infos))
-	require.Equal(t, fileName1, infos[0].Path)
-
-	// File specific file.
-	fileCh, errCh = fileStore.List(context.Background(), fileName3, false)
-	infos = infos[:0]
-	for fileInfo := range fileCh {
-		infos = append(infos, fileInfo)
-	}
-	err = <-errCh
-	require.NoError(t, err)
-	require.Equal(t, 1, len(infos))
-	require.Equal(t, fileName3, infos[0].Path)
+	t.Run("list recursively", func(t *testing.T) {
+		fileCh, errCh = fileStore.List(t.Context(), "", true)
+		infos := make([]*filestore.File, 0, 3)
+		for fileInfo := range fileCh {
+			infos = append(infos, fileInfo)
+		}
+		err = <-errCh
+		require.NoError(t, err)
+		require.Equal(t, 4, len(infos))
+		require.Equal(t, fileName3, infos[0].Path)
+		require.Equal(t, int64(len(data3)), infos[0].Size)
+	})
+
+	t.Run("specific file", func(t *testing.T) {
+		fileCh, errCh = fileStore.List(t.Context(), fileName1, false)
+		infos := make([]*filestore.File, 0, 3)
+		for fileInfo := range fileCh {
+			infos = append(infos, fileInfo)
+		}
+		err = <-errCh
+		require.NoError(t, err)
+		require.Equal(t, 1, len(infos))
+		require.Equal(t, fileName1, infos[0].Path)
+	})
+
+	t.Run("specific file at a sub-dir", func(t *testing.T) {
+		fileCh, errCh = fileStore.List(t.Context(), fileName3, false)
+		infos := make([]*filestore.File, 0, 3)
+		for fileInfo := range fileCh {
+			infos = append(infos, fileInfo)
+		}
+		err = <-errCh
+		require.NoError(t, err)
+		require.Equal(t, 1, len(infos))
+		require.Equal(t, fileName3, infos[0].Path)
+	})
+
+	t.Run("list files in a sub-folder", func(t *testing.T) {
+		fileCh, errCh = fileStore.List(t.Context(), subdir+"/", false)
+		infos := make([]*filestore.File, 0, 3)
+		for fileInfo := range fileCh {
+			infos = append(infos, fileInfo)
+		}
+		err = <-errCh
+		require.NoError(t, err)
+		require.Equal(t, 1, len(infos))
+		require.Equal(t, fileName3, infos[0].Path)
+	})
 }
 
 func testDelete(t *testing.T, fileStore filestore.Interface) {
-	ctx := context.Background()
+	ctx := t.Context()
 
 	_, err := fileStore.Put(ctx, fileName1, strings.NewReader(data1))
 	require.NoError(t, err)