Files
tidb/pkg/objstore/local_test.go

274 lines
7.6 KiB
Go

// Copyright 2020 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package objstore
import (
"context"
"io"
"os"
"path"
"path/filepath"
"runtime"
"testing"
"github.com/pingcap/errors"
"github.com/pingcap/tidb/pkg/objstore/objectio"
"github.com/pingcap/tidb/pkg/objstore/storeapi"
"github.com/stretchr/testify/require"
)
func TestDeleteFile(t *testing.T) {
dir := t.TempDir()
sb, err := ParseBackend("file://"+filepath.ToSlash(dir), &BackendOptions{})
require.NoError(t, err)
store, err := Create(context.TODO(), sb, true)
require.NoError(t, err)
name := "test_delete"
ret, err := store.FileExists(context.Background(), name)
require.NoError(t, err)
require.Equal(t, false, ret)
_, err = store.Create(context.Background(), name, nil)
require.NoError(t, err)
ret, err = store.FileExists(context.Background(), name)
require.NoError(t, err)
require.Equal(t, true, ret)
err = store.DeleteFile(context.Background(), name)
require.NoError(t, err)
ret, err = store.FileExists(context.Background(), name)
require.NoError(t, err)
require.Equal(t, false, ret)
}
func TestWalkDirWithSoftLinkFile(t *testing.T) {
if runtime.GOOS == "windows" {
// skip the test on windows. typically windows users don't have symlink permission.
return
}
dir1 := t.TempDir()
name1 := "test.warehouse.0.sql"
path1 := filepath.Join(dir1, name1)
f1, err := os.Create(path1)
require.NoError(t, err)
data := "/* whatever pragmas */;" +
"INSERT INTO `namespaced`.`table` (columns, more, columns) VALUES (1,-2, 3),\n(4,5., 6);" +
"INSERT `namespaced`.`table` (x,y,z) VALUES (7,8,9);" +
"insert another_table values (10,11e1,12, '(13)', '(', 14, ')');"
_, err = f1.Write([]byte(data))
require.NoError(t, err)
err = f1.Close()
require.NoError(t, err)
dir2 := t.TempDir()
name2 := "test.warehouse.1.sql"
f2, err := os.Create(filepath.Join(dir2, name2))
require.NoError(t, err)
_, err = f2.Write([]byte(data))
require.NoError(t, err)
err = f2.Close()
require.NoError(t, err)
err = os.Symlink(path1, filepath.Join(dir2, name1))
require.NoError(t, err)
sb, err := ParseBackend("file://"+filepath.ToSlash(dir2), &BackendOptions{})
require.NoError(t, err)
store, err := Create(context.TODO(), sb, true)
require.NoError(t, err)
i := 0
names := []string{name1, name2}
err = store.WalkDir(context.TODO(), &storeapi.WalkOption{}, func(path string, size int64) error {
require.Equal(t, names[i], path)
require.Equal(t, int64(len(data)), size)
i++
return nil
})
require.NoError(t, err)
require.Equal(t, 2, i)
names = []string{name2}
i = 0
err = store.WalkDir(context.TODO(), &storeapi.WalkOption{ObjPrefix: "test.warehouse.1"}, func(path string, size int64) error {
require.Equal(t, names[i], path)
require.Equal(t, int64(len(data)), size)
i++
return nil
})
require.NoError(t, err)
require.Equal(t, 1, i)
// test file not exists
exists, err := store.FileExists(context.TODO(), "/123/456")
require.NoError(t, err)
require.False(t, exists)
// test walk nonexistent directory
err = store.WalkDir(context.TODO(), &storeapi.WalkOption{SubDir: "123/456"}, func(path string, size int64) error {
return errors.New("find file")
})
require.NoError(t, err)
// write file to a nonexistent directory
err = store.WriteFile(context.TODO(), "/123/456/789.txt", []byte(data))
require.NoError(t, err)
exists, err = store.FileExists(context.TODO(), "/123/456")
require.NoError(t, err)
require.True(t, exists)
// test walk existent directory
err = store.WalkDir(context.TODO(), &storeapi.WalkOption{SubDir: "123/456"}, func(path string, size int64) error {
if path == "123/456/789.txt" {
return nil
}
return errors.Errorf("find other file: %s", path)
})
require.NoError(t, err)
}
func TestWalkDirSkipSubDir(t *testing.T) {
tempDir := t.TempDir()
require.NoError(t, os.WriteFile(path.Join(tempDir, "test1.txt"), []byte("test1"), 0o644))
require.NoError(t, os.MkdirAll(path.Join(tempDir, "sub"), 0o755))
require.NoError(t, os.WriteFile(path.Join(tempDir, "sub", "test2.txt"), []byte("test2"), 0o644))
sb, err := ParseBackend(tempDir, &BackendOptions{})
require.NoError(t, err)
store, err := Create(context.TODO(), sb, true)
require.NoError(t, err)
names := []string{"sub/test2.txt", "test1.txt"}
i := 0
require.NoError(t, store.WalkDir(context.Background(), &storeapi.WalkOption{}, func(path string, size int64) error {
require.Equal(t, names[i], path)
i++
return nil
}))
names = []string{"test1.txt"}
i = 0
require.NoError(t, store.WalkDir(context.Background(), &storeapi.WalkOption{SkipSubDir: true}, func(path string, size int64) error {
require.Equal(t, names[i], path)
i++
return nil
}))
}
func TestLocalURI(t *testing.T) {
ctx := context.Background()
url := "file:///tmp/folder"
sb, err := ParseBackend(url, &BackendOptions{})
require.NoError(t, err)
store, err := Create(ctx, sb, true)
require.NoError(t, err)
obtained := store.URI()
require.Equal(t, url, obtained)
}
func TestLocalFileReadRange(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
sb, err := ParseBackend("file://"+filepath.ToSlash(dir), &BackendOptions{})
require.NoError(t, err)
store, err := Create(ctx, sb, true)
require.NoError(t, err)
name := "test_read_range"
w, err := store.Create(ctx, name, nil)
require.NoError(t, err)
_, err = w.Write(ctx, []byte("0123456789"))
require.NoError(t, err)
require.NoError(t, w.Close(ctx))
checkContent := func(r objectio.Reader, expected string) {
buf := make([]byte, 10)
n, _ := r.Read(buf)
require.Equal(t, expected, string(buf[:n]))
n, err = r.Read(buf)
require.Equal(t, 0, n)
require.ErrorIs(t, err, io.EOF)
}
// [2, 6]
start, end := int64(2), int64(6)
r, err := store.Open(ctx, name, &storeapi.ReaderOption{
StartOffset: &start,
EndOffset: &end,
})
require.NoError(t, err)
checkContent(r, "2345")
// full range
r, err = store.Open(ctx, name, nil)
require.NoError(t, err)
checkContent(r, "0123456789")
// [5, ...)
start = 5
r, err = store.Open(ctx, name, &storeapi.ReaderOption{
StartOffset: &start,
})
require.NoError(t, err)
checkContent(r, "56789")
// [..., 5)
end = 5
r, err = store.Open(ctx, name, &storeapi.ReaderOption{
EndOffset: &end,
})
require.NoError(t, err)
checkContent(r, "01234")
// test read into smaller buffer
smallBuf := make([]byte, 2)
start, end = int64(2), int64(6)
r, err = store.Open(ctx, name, &storeapi.ReaderOption{
StartOffset: &start,
EndOffset: &end,
})
require.NoError(t, err)
n, _ := r.Read(smallBuf)
require.Equal(t, "23", string(smallBuf[:n]))
}
func TestWalkBrokenSymLink(t *testing.T) {
ctx := context.Background()
dir := t.TempDir()
err := os.Symlink(filepath.Join(dir, "non-existing-file"), filepath.Join(dir, "file-that-should-be-ignored"))
require.NoError(t, err)
sb, err := ParseBackend("file://"+filepath.ToSlash(dir), nil)
require.NoError(t, err)
store, err := New(ctx, sb, nil)
require.NoError(t, err)
files := map[string]int64{}
err = store.WalkDir(ctx, nil, func(path string, size int64) error {
files[path] = size
return nil
})
require.NoError(t, err)
require.Equal(t, map[string]int64{"file-that-should-be-ignored": 0}, files)
}