Skip to content

Commit

Permalink
vfs/errorfs: add facilities for error injection in datadriven tests
Browse files Browse the repository at this point in the history 
We frequently use the errorfs package to inject errors into filesystem
operations to test error code paths. This commit builds off this package to
support encoding error injection conditions within datadriven tests through
parsing a small DSL. Future work will build off this to test handling of I/O
errors during iteration.

Informs cockroachdb#1115.
Informs cockroachdb#2994.
  • Loading branch information
@jbowens
jbowens committed Oct 13, 2023
1 parent 36b3f57 commit 0d02bb7
Show file tree
Hide file tree
Showing 15 changed files with 593 additions and 132 deletions.
24 changes: 17 additions & 7 deletions compaction_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2898,7 +2898,7 @@ func TestCompactionErrorCleanup(t *testing.T) {
)

mem := vfs.NewMem()
ii := errorfs.OnIndex(math.MaxInt32) // start disabled
ii := errorfs.OnIndex(math.MaxInt32, errorfs.ErrInjected) // start disabled
opts := (&Options{
FS: errorfs.Wrap(mem, ii),
Levels: make([]LevelOptions, numLevels),
Expand Down Expand Up @@ -3286,8 +3286,8 @@ func TestFlushError(t *testing.T) {
// Error the first five times we try to write a sstable.
var errorOps atomic.Int32
errorOps.Store(3)
fs := errorfs.Wrap(vfs.NewMem(), errorfs.InjectorFunc(func(op errorfs.Op, path string) error {
if op == errorfs.OpCreate && filepath.Ext(path) == ".sst" && errorOps.Add(-1) >= 0 {
fs := errorfs.Wrap(vfs.NewMem(), errorfs.InjectorFunc(func(op errorfs.Op) error {
if op.Kind == errorfs.OpCreate && filepath.Ext(op.Path) == ".sst" && errorOps.Add(-1) >= 0 {
return errorfs.ErrInjected
}
return nil
Expand Down Expand Up @@ -3704,19 +3704,24 @@ type createManifestErrorInjector struct {
enabled atomic.Bool
}

// TODO(jackson): Replace the createManifestErrorInjector with the composition
// of primitives defined in errorfs. This may require additional primitives.

func (i *createManifestErrorInjector) String() string { return "MANIFEST-Creates" }

// enable enables error injection for the vfs.FS.
func (i *createManifestErrorInjector) enable() {
i.enabled.Store(true)
}

// MaybeError implements errorfs.Injector.
func (i *createManifestErrorInjector) MaybeError(op errorfs.Op, path string) error {
func (i *createManifestErrorInjector) MaybeError(op errorfs.Op) error {
if !i.enabled.Load() {
return nil
}
// This necessitates having a MaxManifestSize of 1, to reliably induce
// logAndApply errors.
if strings.Contains(path, "MANIFEST") && op == errorfs.OpCreate {
if strings.Contains(op.Path, "MANIFEST") && op.Kind == errorfs.OpCreate {
return errorfs.ErrInjected
}
return nil
Expand Down Expand Up @@ -3884,6 +3889,11 @@ type WriteErrorInjector struct {
enabled atomic.Bool
}

// TODO(jackson): Replace WriteErrorInjector with use of primitives in errorfs,
// adding new primitives as necessary.

func (i *WriteErrorInjector) String() string { return "FileWrites(ErrInjected)" }

// enable enables error injection for the vfs.FS.
func (i *WriteErrorInjector) enable() {
i.enabled.Store(true)
Expand All @@ -3895,12 +3905,12 @@ func (i *WriteErrorInjector) disable() {
}

// MaybeError implements errorfs.Injector.
func (i *WriteErrorInjector) MaybeError(op errorfs.Op, path string) error {
func (i *WriteErrorInjector) MaybeError(op errorfs.Op) error {
if !i.enabled.Load() {
return nil
}
// Fail any future write.
if op == errorfs.OpFileWrite {
if op.Kind == errorfs.OpFileWrite {
return errorfs.ErrInjected
}
return nil
Expand Down
74 changes: 74 additions & 0 deletions data_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (

"github.com/cockroachdb/datadriven"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/pebble/bloom"
"github.com/cockroachdb/pebble/internal/base"
"github.com/cockroachdb/pebble/internal/humanize"
"github.com/cockroachdb/pebble/internal/keyspan"
Expand All @@ -29,6 +30,7 @@ import (
"github.com/cockroachdb/pebble/objstorage/remote"
"github.com/cockroachdb/pebble/sstable"
"github.com/cockroachdb/pebble/vfs"
"github.com/cockroachdb/pebble/vfs/errorfs"
"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -1447,3 +1449,75 @@ func runLSMCmd(td *datadriven.TestData, d *DB) string {
}
return d.mu.versions.currentVersion().String()
}

func parseDBOptionsArgs(opts *Options, args []datadriven.CmdArg) error {
for _, cmdArg := range args {
switch cmdArg.Key {
case "inject-errors":
injs := make([]errorfs.Injector, len(cmdArg.Vals))
for i := 0; i < len(cmdArg.Vals); i++ {
inj, err := errorfs.ParseInjectorFromDSL(cmdArg.Vals[i])
if err != nil {
return err
}
injs[i] = inj
}
opts.FS = errorfs.Wrap(opts.FS, errorfs.Any(injs...))
case "enable-table-stats":
enable, err := strconv.ParseBool(cmdArg.Vals[0])
if err != nil {
return errors.Errorf("%s: could not parse %q as bool: %s", cmdArg.Key, cmdArg.Vals[0], err)
}
opts.private.disableTableStats = !enable
case "format-major-version":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return err
}
// Override the DB version.
opts.FormatMajorVersion = FormatMajorVersion(v)
case "block-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return err
}
for i := range opts.Levels {
opts.Levels[i].BlockSize = v
}
case "index-block-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return err
}
for i := range opts.Levels {
opts.Levels[i].IndexBlockSize = v
}
case "target-file-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return err
}
for i := range opts.Levels {
opts.Levels[i].TargetFileSize = int64(v)
}
case "bloom-bits-per-key":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return err
}
fp := bloom.FilterPolicy(v)
opts.Filters = map[string]FilterPolicy{fp.Name(): fp}
for i := range opts.Levels {
opts.Levels[i].FilterPolicy = fp
}
case "merger":
switch cmdArg.Vals[0] {
case "appender":
opts.Merger = base.DefaultMerger
default:
return errors.Newf("unrecognized Merger %q\n", cmdArg.Vals[0])
}
}
}
return nil
}
8 changes: 4 additions & 4 deletions error_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ func TestErrors(t *testing.T) {

errorCounts := make(map[string]int)
for i := int32(0); ; i++ {
fs := errorfs.Wrap(vfs.NewMem(), errorfs.OnIndex(i))
fs := errorfs.Wrap(vfs.NewMem(), errorfs.OnIndex(i, errorfs.ErrInjected))
err := run(fs)
if err == nil {
t.Logf("success %d\n", i)
Expand Down Expand Up @@ -166,7 +166,7 @@ func TestErrors(t *testing.T) {
func TestRequireReadError(t *testing.T) {
run := func(formatVersion FormatMajorVersion, index int32) (err error) {
// Perform setup with error injection disabled as it involves writes/background ops.
inj := errorfs.OnIndex(-1)
inj := errorfs.OnIndex(-1, errorfs.ErrInjected)
fs := errorfs.Wrap(vfs.NewMem(), inj)
opts := &Options{
FS: fs,
Expand Down Expand Up @@ -367,8 +367,8 @@ func TestDBWALRotationCrash(t *testing.T) {
memfs := vfs.NewStrictMem()

var index atomic.Int32
inj := errorfs.InjectorFunc(func(op errorfs.Op, _ string) error {
if op.OpKind() == errorfs.OpKindWrite && index.Add(-1) == -1 {
inj := errorfs.InjectorFunc(func(op errorfs.Op) error {
if op.Kind.ReadOrWrite() == errorfs.OpIsWrite && index.Add(-1) == -1 {
memfs.SetIgnoreSyncs(true)
}
return nil
Expand Down
8 changes: 4 additions & 4 deletions ingest_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ func TestIngestLinkFallback(t *testing.T) {
src, err := mem.Create("source")
require.NoError(t, err)

opts := &Options{FS: errorfs.Wrap(mem, errorfs.OnIndex(1))}
opts := &Options{FS: errorfs.Wrap(mem, errorfs.OnIndex(1, errorfs.ErrInjected))}
opts.EnsureDefaults().WithFSDefaults()
objSettings := objstorageprovider.DefaultSettings(opts.FS, "")
// Prevent the provider from listing the dir (where we may get an injected error).
Expand Down Expand Up @@ -2182,7 +2182,7 @@ func TestIngestError(t *testing.T) {
require.NoError(t, w.Set([]byte("d"), nil))
require.NoError(t, w.Close())

inj := errorfs.OnIndex(-1)
inj := errorfs.OnIndex(-1, errorfs.ErrInjected)
d, err := Open("", &Options{
FS: errorfs.Wrap(mem, inj),
Logger: panicLogger{},
Expand Down Expand Up @@ -3225,11 +3225,11 @@ func TestIngestValidation(t *testing.T) {
cLoc: corruptionLocationNone,
wantErr: errorfs.ErrInjected,
wantErrType: errReportLocationBackgroundError,
errorfsInjector: errorfs.InjectorFunc(func(op errorfs.Op, path string) error {
errorfsInjector: errorfs.InjectorFunc(func(op errorfs.Op) error {
// Inject an error on the first read-at operation on an sstable
// (excluding the read on the sstable before ingestion has
// linked it in).
if path != "ext" && op != errorfs.OpFileReadAt || filepath.Ext(path) != ".sst" {
if op.Path != "ext" && op.Kind != errorfs.OpFileReadAt || filepath.Ext(op.Path) != ".sst" {
return nil
}
if errfsCounter.Add(1) == 1 {
Expand Down
78 changes: 20 additions & 58 deletions iterator_histories_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ import (

"github.com/cockroachdb/datadriven"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/pebble/bloom"
"github.com/cockroachdb/pebble/internal/base"
"github.com/cockroachdb/pebble/internal/invariants"
"github.com/cockroachdb/pebble/internal/testkeys"
"github.com/cockroachdb/pebble/sstable"
Expand All @@ -41,70 +39,22 @@ func TestIterHistories(t *testing.T) {
iters[name] = it
return it
}
var opts *Options
parseOpts := func(td *datadriven.TestData) (*Options, error) {
opts := &Options{
opts = &Options{
FS: vfs.NewMem(),
Comparer: testkeys.Comparer,
FormatMajorVersion: FormatRangeKeys,
BlockPropertyCollectors: []func() BlockPropertyCollector{
sstable.NewTestKeysBlockPropertyCollector,
},
}

opts.DisableAutomaticCompactions = true
opts.EnsureDefaults()
opts.WithFSDefaults()

for _, cmdArg := range td.CmdArgs {
switch cmdArg.Key {
case "format-major-version":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return nil, err
}
// Override the DB version.
opts.FormatMajorVersion = FormatMajorVersion(v)
case "block-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return nil, err
}
for i := range opts.Levels {
opts.Levels[i].BlockSize = v
}
case "index-block-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return nil, err
}
for i := range opts.Levels {
opts.Levels[i].IndexBlockSize = v
}
case "target-file-size":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return nil, err
}
for i := range opts.Levels {
opts.Levels[i].TargetFileSize = int64(v)
}
case "bloom-bits-per-key":
v, err := strconv.Atoi(cmdArg.Vals[0])
if err != nil {
return nil, err
}
fp := bloom.FilterPolicy(v)
opts.Filters = map[string]FilterPolicy{fp.Name(): fp}
for i := range opts.Levels {
opts.Levels[i].FilterPolicy = fp
}
case "merger":
switch cmdArg.Vals[0] {
case "appender":
opts.Merger = base.DefaultMerger
default:
return nil, errors.Newf("unrecognized Merger %q\n", cmdArg.Vals[0])
}
}
if err := parseDBOptionsArgs(opts, td.CmdArgs); err != nil {
return nil, err
}
return opts, nil
}
Expand All @@ -128,10 +78,11 @@ func TestIterHistories(t *testing.T) {
datadriven.RunTest(t, path, func(t *testing.T, td *datadriven.TestData) string {
switch td.Cmd {
case "define":
var err error
if err := cleanup(); err != nil {
return err.Error()
}
opts, err := parseOpts(td)
opts, err = parseOpts(td)
if err != nil {
return err.Error()
}
Expand All @@ -140,12 +91,23 @@ func TestIterHistories(t *testing.T) {
return err.Error()
}
return runLSMCmd(td, d)

case "reopen":
var err error
if err := cleanup(); err != nil {
return err.Error()
}
if err := parseDBOptionsArgs(opts, td.CmdArgs); err != nil {
return err.Error()
}
d, err = Open("", opts)
require.NoError(t, err)
return ""
case "reset":
var err error
if err := cleanup(); err != nil {
return err.Error()
}
opts, err := parseOpts(td)
opts, err = parseOpts(td)
if err != nil {
return err.Error()
}
Expand Down
2 changes: 1 addition & 1 deletion metamorphic/meta.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ func RunOnce(t TestingT, runDir string, seed uint64, historyPath string, rOpts .

// Wrap the filesystem with one that will inject errors into read
// operations with *errorRate probability.
opts.FS = errorfs.Wrap(opts.FS, errorfs.WithProbability(errorfs.OpKindRead, runOpts.errorRate))
opts.FS = errorfs.Wrap(opts.FS, errorfs.WithProbability(errorfs.OpIsRead, runOpts.errorRate))

if opts.WALDir != "" {
opts.WALDir = opts.FS.PathJoin(runDir, opts.WALDir)
Expand Down
6 changes: 3 additions & 3 deletions open_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -927,17 +927,17 @@ func TestCrashOpenCrashAfterWALCreation(t *testing.T) {
{
var walCreated, dirSynced atomic.Bool
d, err := Open("", &Options{
FS: errorfs.Wrap(fs, errorfs.InjectorFunc(func(op errorfs.Op, path string) error {
FS: errorfs.Wrap(fs, errorfs.InjectorFunc(func(op errorfs.Op) error {
if dirSynced.Load() {
fs.SetIgnoreSyncs(true)
}
if op == errorfs.OpCreate && filepath.Ext(path) == ".log" {
if op.Kind == errorfs.OpCreate && filepath.Ext(op.Path) == ".log" {
walCreated.Store(true)
}
// Record when there's a sync of the data directory after the
// WAL was created. The data directory will have an empty
// path because that's what we passed into Open.
if op == errorfs.OpFileSync && path == "" && walCreated.Load() {
if op.Kind == errorfs.OpFileSync && op.Path == "" && walCreated.Load() {
dirSynced.Store(true)
}
return nil
Expand Down
Loading

0 comments on commit 0d02bb7

Please sign in to comment.