TrueCloudLab/frostfs-s3-gw
17
3
Fork 20
Code Issues 26 Pull requests 7 Projects Releases 33 Packages 1 Activity Actions

[#596] Use zaptest.Logger
All checks were successful
/ DCO (pull_request) Successful in 35s
Details
/ Vulncheck (pull_request) Successful in 1m9s
Details
/ Builds (pull_request) Successful in 1m32s
Details
/ OCI image (pull_request) Successful in 2m6s
Details
/ Lint (pull_request) Successful in 2m14s
Details
/ Tests (pull_request) Successful in 1m20s
Details

Browse source 
Use zaptest to get logs which get printed only if a test fails
or if you ran go test -v.

Dont use zaptest.Logger for fuzz otherwise ngfuzz/libfuzz crashes

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2025-02-20 17:26:42 +03:00
parent bfec3e0a5e
commit 1d3f484018
6 changed files with 32 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
api/cache/objects_test.go vendored
View file

@ -8,14 +8,14 @@ import (
oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id" oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id"
objecttest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/test" objecttest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/test"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
"go.uber.org/zap" "go.uber.org/zap/zaptest"
) )
func getTestConfig() *Config { func getTestConfig(t *testing.T) *Config {
return &Config{ return &Config{
Size: 10, Size: 10,
Lifetime: 5 * time.Second, Lifetime: 5 * time.Second,
Logger: zap.NewExample(), Logger: zaptest.NewLogger(t),
} }
} }
@ -44,7 +44,7 @@ func TestCache(t *testing.T) {
} }
t.Run("check get", func(t *testing.T) { t.Run("check get", func(t *testing.T) {
cache := New(getTestConfig()) cache := New(getTestConfig(t))
err := cache.PutObject(extObjInfo) err := cache.PutObject(extObjInfo)
require.NoError(t, err) require.NoError(t, err)
@ -53,7 +53,7 @@ func TestCache(t *testing.T) {
}) })
t.Run("check delete", func(t *testing.T) { t.Run("check delete", func(t *testing.T) {
cache := New(getTestConfig()) cache := New(getTestConfig(t))
err := cache.PutObject(extObjInfo) err := cache.PutObject(extObjInfo)
require.NoError(t, err) require.NoError(t, err)

22
api/cache/objectslist_test.go vendored
View file

@ -8,17 +8,17 @@ import (
cidtest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id/test" cidtest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id/test"
oidtest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id/test" oidtest "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id/test"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
"go.uber.org/zap" "go.uber.org/zap/zaptest"
) )
const testingCacheLifetime = 5 * time.Second const testingCacheLifetime = 5 * time.Second
const testingCacheSize = 10 const testingCacheSize = 10
func getTestObjectsListConfig() *Config { func getTestObjectsListConfig(t *testing.T) *Config {
return &Config{ return &Config{
Size: testingCacheSize, Size: testingCacheSize,
Lifetime: testingCacheLifetime, Lifetime: testingCacheLifetime,
Logger: zap.NewExample(), Logger: zaptest.NewLogger(t),
} }
} }
@ -35,7 +35,7 @@ func TestObjectsListCache(t *testing.T) {
t.Run("lifetime", func(t *testing.T) { t.Run("lifetime", func(t *testing.T) {
var ( var (
config = getTestObjectsListConfig() config = getTestObjectsListConfig(t)
cache = NewObjectsListCache(config) cache = NewObjectsListCache(config)
listKey = ObjectsListKey{cid: cidKey} listKey = ObjectsListKey{cid: cidKey}
) )
@ -53,7 +53,7 @@ func TestObjectsListCache(t *testing.T) {
t.Run("get cache with empty prefix", func(t *testing.T) { t.Run("get cache with empty prefix", func(t *testing.T) {
var ( var (
cache = NewObjectsListCache(getTestObjectsListConfig()) cache = NewObjectsListCache(getTestObjectsListConfig(t))
listKey = ObjectsListKey{cid: cidKey} listKey = ObjectsListKey{cid: cidKey}
) )
err := cache.PutVersions(listKey, versions) err := cache.PutVersions(listKey, versions)
@ -73,7 +73,7 @@ func TestObjectsListCache(t *testing.T) {
prefix: "dir", prefix: "dir",
} }
cache := NewObjectsListCache(getTestObjectsListConfig()) cache := NewObjectsListCache(getTestObjectsListConfig(t))
err := cache.PutVersions(listKey, versions) err := cache.PutVersions(listKey, versions)
require.NoError(t, err) require.NoError(t, err)
@ -98,7 +98,7 @@ func TestObjectsListCache(t *testing.T) {
} }
) )
cache := NewObjectsListCache(getTestObjectsListConfig()) cache := NewObjectsListCache(getTestObjectsListConfig(t))
err := cache.PutVersions(listKey, versions) err := cache.PutVersions(listKey, versions)
require.NoError(t, err) require.NoError(t, err)
@ -116,7 +116,7 @@ func TestObjectsListCache(t *testing.T) {
} }
) )
cache := NewObjectsListCache(getTestObjectsListConfig()) cache := NewObjectsListCache(getTestObjectsListConfig(t))
err := cache.PutVersions(listKey, versions) err := cache.PutVersions(listKey, versions)
require.NoError(t, err) require.NoError(t, err)
@ -137,7 +137,7 @@ func TestCleanCacheEntriesChangedWithPutObject(t *testing.T) {
} }
t.Run("put object to the root of the bucket", func(t *testing.T) { t.Run("put object to the root of the bucket", func(t *testing.T) {
config := getTestObjectsListConfig() config := getTestObjectsListConfig(t)
config.Lifetime = time.Minute config.Lifetime = time.Minute
cache := NewObjectsListCache(config) cache := NewObjectsListCache(config)
for _, k := range keys { for _, k := range keys {
@ -156,7 +156,7 @@ func TestCleanCacheEntriesChangedWithPutObject(t *testing.T) {
}) })
t.Run("put object to dir/", func(t *testing.T) { t.Run("put object to dir/", func(t *testing.T) {
config := getTestObjectsListConfig() config := getTestObjectsListConfig(t)
config.Lifetime = time.Minute config.Lifetime = time.Minute
cache := NewObjectsListCache(config) cache := NewObjectsListCache(config)
for _, k := range keys { for _, k := range keys {
@ -175,7 +175,7 @@ func TestCleanCacheEntriesChangedWithPutObject(t *testing.T) {
}) })
t.Run("put object to dir/lol/", func(t *testing.T) { t.Run("put object to dir/lol/", func(t *testing.T) {
config := getTestObjectsListConfig() config := getTestObjectsListConfig(t)
config.Lifetime = time.Minute config.Lifetime = time.Minute
cache := NewObjectsListCache(config) cache := NewObjectsListCache(config)
for _, k := range keys { for _, k := range keys {

10
api/handler/handler_fuzz_test.go
View file

@ -22,7 +22,7 @@ import (
"git.frostfs.info/TrueCloudLab/frostfs-s3-gw/creds/accessbox" "git.frostfs.info/TrueCloudLab/frostfs-s3-gw/creds/accessbox"
engineiam "git.frostfs.info/TrueCloudLab/policy-engine/iam" engineiam "git.frostfs.info/TrueCloudLab/policy-engine/iam"
utils "github.com/trailofbits/go-fuzz-utils" utils "github.com/trailofbits/go-fuzz-utils"
"go.uber.org/zap/zaptest" "go.uber.org/zap"
) )
var ( var (
@ -40,9 +40,9 @@ const (
func createTestBucketAndInitContext() { func createTestBucketAndInitContext() {
fuzzt = new(tt.T) fuzzt = new(tt.T)
log := zaptest.NewLogger(fuzzt) log := zap.NewExample()
var err error var err error
fuzzHc, err = prepareHandlerContextBase(layer.DefaultCachesConfigs(log)) fuzzHc, err = prepareHandlerContextBase(layer.DefaultCachesConfigs(log), log)
if err != nil { if err != nil {
panic(err) panic(err)
} }
@ -171,9 +171,9 @@ func generateHeaders(tp *utils.TypeProvider, r *http.Request, params []string) e
func InitFuzzCreateBucketHandler() { func InitFuzzCreateBucketHandler() {
fuzzt = new(tt.T) fuzzt = new(tt.T)
log := zaptest.NewLogger(fuzzt) log := zap.NewExample()
var err error var err error
fuzzHc, err = prepareHandlerContextBase(layer.DefaultCachesConfigs(log)) fuzzHc, err = prepareHandlerContextBase(layer.DefaultCachesConfigs(log), log)
if err != nil { if err != nil {
panic(err) panic(err)
} }

12
api/handler/handlers_test.go
View file

@ -35,6 +35,7 @@ import (
"github.com/panjf2000/ants/v2" "github.com/panjf2000/ants/v2"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
"go.uber.org/zap" "go.uber.org/zap"
"go.uber.org/zap/zaptest"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@ -158,7 +159,8 @@ func (c *configMock) putLocationConstraint(constraint string) {
} }
func prepareHandlerContext(t *testing.T) *handlerContext { func prepareHandlerContext(t *testing.T) *handlerContext {
hc, err := prepareHandlerContextBase(layer.DefaultCachesConfigs(zap.NewExample())) log := zaptest.NewLogger(t)
hc, err := prepareHandlerContextBase(layer.DefaultCachesConfigs(log), log)
require.NoError(t, err) require.NoError(t, err)
return &handlerContext{ return &handlerContext{
handlerContextBase: hc, handlerContextBase: hc,
@ -167,7 +169,8 @@ func prepareHandlerContext(t *testing.T) *handlerContext {
} }
func prepareHandlerContextWithMinCache(t *testing.T) *handlerContext { func prepareHandlerContextWithMinCache(t *testing.T) *handlerContext {
hc, err := prepareHandlerContextBase(getMinCacheConfig(zap.NewExample())) log := zaptest.NewLogger(t)
hc, err := prepareHandlerContextBase(getMinCacheConfig(log), log)
require.NoError(t, err) require.NoError(t, err)
return &handlerContext{ return &handlerContext{
handlerContextBase: hc, handlerContextBase: hc,
@ -175,13 +178,12 @@ func prepareHandlerContextWithMinCache(t *testing.T) *handlerContext {
} }
} }
func prepareHandlerContextBase(cacheCfg *layer.CachesConfig) (*handlerContextBase, error) { func prepareHandlerContextBase(cacheCfg *layer.CachesConfig, log *zap.Logger) (*handlerContextBase, error) {
key, err := keys.NewPrivateKey() key, err := keys.NewPrivateKey()
if err != nil { if err != nil {
return nil, err return nil, err
} }
log := zap.NewExample()
tp := layer.NewTestFrostFS(key) tp := layer.NewTestFrostFS(key)
testResolver := &resolver.Resolver{Name: "test_resolver"} testResolver := &resolver.Resolver{Name: "test_resolver"}
@ -197,7 +199,7 @@ func prepareHandlerContextBase(cacheCfg *layer.CachesConfig) (*handlerContextBas
return nil, err return nil, err
} }
treeMock := tree.NewTree(memCli, zap.NewExample()) treeMock := tree.NewTree(memCli, log)
features := &layer.FeatureSettingsMock{} features := &layer.FeatureSettingsMock{}

4
api/handler/object_list_test.go
View file

@ -103,7 +103,7 @@ func TestListObjectsVersionsSkipLogTaggingNodesError(t *testing.T) {
loggerCore, observedLog := observer.New(zap.DebugLevel) loggerCore, observedLog := observer.New(zap.DebugLevel)
log := zap.New(loggerCore) log := zap.New(loggerCore)
hcBase, err := prepareHandlerContextBase(layer.DefaultCachesConfigs(log)) hcBase, err := prepareHandlerContextBase(layer.DefaultCachesConfigs(log), log)
require.NoError(t, err) require.NoError(t, err)
hc := &handlerContext{ hc := &handlerContext{
handlerContextBase: hcBase, handlerContextBase: hcBase,
@ -176,7 +176,7 @@ func TestListObjectsContextCanceled(t *testing.T) {
layerCfg.SessionList.Lifetime = time.Hour layerCfg.SessionList.Lifetime = time.Hour
layerCfg.SessionList.Size = 1 layerCfg.SessionList.Size = 1
hcBase, err := prepareHandlerContextBase(layerCfg) hcBase, err := prepareHandlerContextBase(layerCfg, log)
require.NoError(t, err) require.NoError(t, err)
hc := &handlerContext{ hc := &handlerContext{
handlerContextBase: hcBase, handlerContextBase: hcBase,

4
api/layer/versioning_test.go
View file

@ -18,7 +18,7 @@ import (
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/user" "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/user"
"github.com/nspcc-dev/neo-go/pkg/crypto/keys" "github.com/nspcc-dev/neo-go/pkg/crypto/keys"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
"go.uber.org/zap" "go.uber.org/zap/zaptest"
) )
func (tc *testContext) putObject(content []byte) *data.ObjectInfo { func (tc *testContext) putObject(content []byte) *data.ObjectInfo {
@ -139,7 +139,7 @@ type testContext struct {
} }
func prepareContext(t *testing.T, cachesConfig ...*CachesConfig) *testContext { func prepareContext(t *testing.T, cachesConfig ...*CachesConfig) *testContext {
logger := zap.NewExample() logger := zaptest.NewLogger(t)
key, err := keys.NewPrivateKey() key, err := keys.NewPrivateKey()
require.NoError(t, err) require.NoError(t, err)