etcd/tests/framework/testutils/log_observer.go
Wei Fu 50aa00b203 tests: make log monitor as common helper
It's followup of #15667.

This patch is to use zaptest/observer as base to provide a similar
function to pkg/expect.Expect.

The test env

```bash
11th Gen Intel(R) Core(TM) i5-1135G7 @ 2.40GHz
mkdir /sys/fs/cgroup/etcd-followup-15667
echo 0-2 | tee /sys/fs/cgroup/etcd-followup-15667/cpuset.cpus # three cores
```

Before change:

* memory.peak: ~ 681 MiB
* Elapsed (wall clock) time (h:mm:ss or m:ss): 6:14.04

After change:

* memory.peak: ~ 671 MiB
* Elapsed (wall clock) time (h:mm:ss or m:ss): 6:13.07

Based on the test result, I think it's safe to be enabled by default.

Signed-off-by: Wei Fu <fuweid89@gmail.com>
2023-04-18 09:00:24 +08:00

102 lines
2.6 KiB
Go

// Copyright 2023 The etcd Authors
//
// 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 testutils
import (
"context"
"fmt"
"strings"
"sync"
"time"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
zapobserver "go.uber.org/zap/zaptest/observer"
)
type LogObserver struct {
ob *zapobserver.ObservedLogs
enc zapcore.Encoder
mu sync.Mutex
// entries stores all the logged entries after syncLogs.
entries []zapobserver.LoggedEntry
}
func NewLogObserver(level zapcore.LevelEnabler) (zapcore.Core, *LogObserver) {
// align with zaptest
enc := zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig())
co, ob := zapobserver.New(level)
return co, &LogObserver{
ob: ob,
enc: enc,
}
}
// Expect returns the first N lines containing the given string.
func (logOb *LogObserver) Expect(ctx context.Context, s string, count int) ([]string, error) {
return logOb.ExpectFunc(ctx, func(log string) bool { return strings.Contains(log, s) }, count)
}
// ExpectFunc returns the first N line satisfying the function f.
func (logOb *LogObserver) ExpectFunc(ctx context.Context, filter func(string) bool, count int) ([]string, error) {
i := 0
res := make([]string, 0, count)
for {
select {
case <-ctx.Done():
return nil, ctx.Err()
default:
}
entries := logOb.syncLogs()
// The order of entries won't be changed because of append-only.
// It's safe to skip scanned entries by reusing `i`.
for ; i < len(entries); i++ {
buf, err := logOb.enc.EncodeEntry(entries[i].Entry, entries[i].Context)
if err != nil {
return nil, fmt.Errorf("failed to encode entry: %w", err)
}
logInStr := buf.String()
if filter(logInStr) {
res = append(res, logInStr)
}
if len(res) >= count {
break
}
}
if len(res) >= count {
return res, nil
}
time.Sleep(10 * time.Millisecond)
}
}
// syncLogs is to take all the existing logged entries from zapobserver and
// truncate zapobserver's entries slice.
func (logOb *LogObserver) syncLogs() []zapobserver.LoggedEntry {
logOb.mu.Lock()
defer logOb.mu.Unlock()
logOb.entries = append(logOb.entries, logOb.ob.TakeAll()...)
return logOb.entries
}