mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-09-06 16:45:55 +00:00
cecaf99ee4
The testhook/ package provides an easy way to set up multiple hooks to run before/after tests are run. The audit hooks track open and closes of storage backends, files, indexes, and holders, for example. A tempdir wrapper creates temporary directories which are automatically cleaned up when the test ends. Any kind of resource creation that should be closed at test conclusion can be tracked. We will complain at the end of the TestMain if resources are leaking. Leaks under go1.13: We use a wrapper function which is a no-op for go 1.13, but actually calls testing.TB.Cleanup in go1.14, so we can still build with 1.13 even though tests will leak files all over the place there. Because of this, don't run the testhook tests when using 1.13, as they'll always fail. - the test/pilosa.go http client now times out after 10 seconds to help diagnose hung server situations. - Makefile targets added to get better progress reports.
107 lines
3.1 KiB
Go
107 lines
3.1 KiB
Go
// Copyright 2020 Pilosa Corp.
|
|
//
|
|
// 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 pilosa_test
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"reflect"
|
|
|
|
"github.com/pilosa/pilosa/v2"
|
|
"github.com/pilosa/pilosa/v2/testhook"
|
|
)
|
|
|
|
// AuditLeaksOn is a global switch to turn on resource
|
|
// leak checking at the end of a test run.
|
|
var AuditLeaksOn = true
|
|
|
|
// for tests, we use a single shared auditor used by all of the holders.
|
|
var globalTestAuditor = testhook.NewVerifyCloseAuditor(testHooks)
|
|
|
|
// These audit hooks are desireable during testing, but not in
|
|
// production.
|
|
type auditorIndexHooks struct{}
|
|
type auditorFieldHooks struct{}
|
|
type auditorHolderHooks struct{}
|
|
|
|
// static type checking
|
|
var _ testhook.RegistryHookLive = &auditorIndexHooks{}
|
|
var _ testhook.RegistryHookLive = &auditorFieldHooks{}
|
|
var _ testhook.RegistryHookPostDestroy = &auditorHolderHooks{}
|
|
var _ testhook.RegistryHookLive = &auditorHolderHooks{}
|
|
|
|
var testHooks = map[reflect.Type]testhook.RegistryHook{
|
|
reflect.TypeOf((*pilosa.Index)(nil)): &auditorIndexHooks{},
|
|
reflect.TypeOf((*pilosa.Field)(nil)): &auditorFieldHooks{},
|
|
reflect.TypeOf((*pilosa.Holder)(nil)): &auditorHolderHooks{},
|
|
}
|
|
|
|
func init() {
|
|
if !AuditLeaksOn {
|
|
return
|
|
}
|
|
for k, v := range pilosa.GetInternalTestHooks() {
|
|
testHooks[k] = v
|
|
}
|
|
testhook.RegisterPreTestHook(func() error {
|
|
pilosa.NewAuditor = NewTestAuditor
|
|
return nil
|
|
})
|
|
testhook.RegisterPostTestHook(func() error {
|
|
err, errs := globalTestAuditor.FinalCheck()
|
|
if err != nil {
|
|
for i, e := range errs {
|
|
fmt.Fprintf(os.Stderr, "[%d]: %v\n", i, e)
|
|
}
|
|
}
|
|
return err
|
|
})
|
|
}
|
|
|
|
func NewTestAuditor() testhook.Auditor {
|
|
return globalTestAuditor
|
|
}
|
|
|
|
func (*auditorIndexHooks) Live(o interface{}, entry *testhook.RegistryEntry) error {
|
|
if entry != nil && entry.OpenCount != 0 {
|
|
return fmt.Errorf("index %s still open", o.(*pilosa.Index).Name())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (*auditorFieldHooks) Live(o interface{}, entry *testhook.RegistryEntry) error {
|
|
if entry != nil && entry.OpenCount != 0 {
|
|
return fmt.Errorf("field %s still open", o.(*pilosa.Field).Name())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (*auditorHolderHooks) WasDestroyed(o interface{}, kv testhook.KV, ent *testhook.RegistryEntry, err error) error {
|
|
path := o.(*pilosa.Holder).Path
|
|
if path == "" {
|
|
fmt.Fprintf(os.Stderr, "OOPS: trying to destroy a holder with no path! created: %s\n",
|
|
ent.Stack)
|
|
} else {
|
|
os.RemoveAll(o.(*pilosa.Holder).Path)
|
|
}
|
|
return err
|
|
}
|
|
|
|
func (*auditorHolderHooks) Live(o interface{}, entry *testhook.RegistryEntry) error {
|
|
if entry != nil && entry.OpenCount != 0 {
|
|
return fmt.Errorf("holder %s still open", o.(*pilosa.Holder).Path)
|
|
}
|
|
return nil
|
|
}
|