mirror of
https://github.com/containers/podman.git
synced 2025-08-06 19:44:14 +08:00
408e764b94
When streaming events, prevent returning duplicates after a log rotation by marking a beginning and an end for rotated events. Before starting to stream, get a timestamp while holding the event lock. The timestamp allows for detecting whether a rotation event happened while reading the log file and to skip all events between the begin and end rotation event. In an ideal scenario, we could detect rotated events by enforcing a chronological order when reading and skip those detected to not be more recent than the last read event. However, events are not always _written_ in chronological order. While this can be changed, existing event files could not be read correctly anymore. Fixes: #17665 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
138 lines
3.3 KiB
Go
138 lines
3.3 KiB
Go
package events
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestRotateLog(t *testing.T) {
|
|
tests := []struct {
|
|
// If sizeInitial + sizeContent >= sizeLimit, then rotate
|
|
sizeInitial uint64
|
|
sizeContent uint64
|
|
sizeLimit uint64
|
|
mustRotate bool
|
|
}{
|
|
// No rotation
|
|
{0, 0, 1, false},
|
|
{1, 1, 0, false},
|
|
{10, 10, 30, false},
|
|
{1000, 500, 1600, false},
|
|
// Rotation
|
|
{10, 10, 20, true},
|
|
{30, 0, 29, true},
|
|
{200, 50, 150, true},
|
|
{1000, 600, 1500, true},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
tmp, err := os.CreateTemp("", "log-rotation-")
|
|
require.NoError(t, err)
|
|
defer os.Remove(tmp.Name())
|
|
defer tmp.Close()
|
|
|
|
// Create dummy file and content.
|
|
initialContent := make([]byte, test.sizeInitial)
|
|
logContent := make([]byte, test.sizeContent)
|
|
|
|
// Write content to the file.
|
|
_, err = tmp.Write(initialContent)
|
|
require.NoError(t, err)
|
|
|
|
// Now rotate
|
|
fInfoBeforeRotate, err := tmp.Stat()
|
|
require.NoError(t, err)
|
|
isRotated, err := rotateLog(tmp.Name(), string(logContent), test.sizeLimit)
|
|
require.NoError(t, err)
|
|
|
|
fInfoAfterRotate, err := os.Stat(tmp.Name())
|
|
// Test if rotation was successful
|
|
if test.mustRotate {
|
|
// File has been renamed
|
|
require.True(t, isRotated)
|
|
require.NoError(t, err, "log file has been renamed")
|
|
require.NotEqual(t, fInfoBeforeRotate.Size(), fInfoAfterRotate.Size())
|
|
} else {
|
|
// File has not been renamed
|
|
require.False(t, isRotated)
|
|
require.NoError(t, err, "log file has not been renamed")
|
|
require.Equal(t, fInfoBeforeRotate.Size(), fInfoAfterRotate.Size())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestTruncationOutput(t *testing.T) {
|
|
contentBefore := `0
|
|
1
|
|
2
|
|
3
|
|
4
|
|
5
|
|
6
|
|
7
|
|
8
|
|
9
|
|
10
|
|
`
|
|
// Create dummy file
|
|
tmp, err := os.CreateTemp("", "log-rotation")
|
|
require.NoError(t, err)
|
|
defer os.Remove(tmp.Name())
|
|
defer tmp.Close()
|
|
|
|
// Write content before truncation to dummy file
|
|
_, err = tmp.WriteString(contentBefore)
|
|
require.NoError(t, err)
|
|
|
|
// Truncate the file
|
|
beforeTruncation, err := os.ReadFile(tmp.Name())
|
|
require.NoError(t, err)
|
|
err = truncate(tmp.Name())
|
|
require.NoError(t, err)
|
|
afterTruncation, err := os.ReadFile(tmp.Name())
|
|
require.NoError(t, err)
|
|
// Content has changed
|
|
require.NotEqual(t, beforeTruncation, afterTruncation)
|
|
split := strings.Split(string(afterTruncation), "\n")
|
|
require.Len(t, split, 8) // 2 events + 5 rotated lines + last new line
|
|
require.Contains(t, split[0], "\"Attributes\":{\"io.podman.event.rotate\":\"begin\"}")
|
|
require.Equal(t, split[1:6], []string{"6", "7", "8", "9", "10"})
|
|
require.Contains(t, split[6], "\"Attributes\":{\"io.podman.event.rotate\":\"end\"}")
|
|
require.Contains(t, split[7], "")
|
|
}
|
|
|
|
func TestRenameLog(t *testing.T) {
|
|
fileContent := `0
|
|
1
|
|
2
|
|
3
|
|
4
|
|
5
|
|
`
|
|
// Create two dummy files
|
|
source, err := os.CreateTemp("", "removing")
|
|
require.NoError(t, err)
|
|
target, err := os.CreateTemp("", "renaming")
|
|
require.NoError(t, err)
|
|
|
|
// Write to source dummy file
|
|
_, err = source.WriteString(fileContent)
|
|
require.NoError(t, err)
|
|
|
|
// Rename the files
|
|
beforeRename, err := os.ReadFile(source.Name())
|
|
require.NoError(t, err)
|
|
err = renameLog(source.Name(), target.Name())
|
|
require.NoError(t, err)
|
|
afterRename, err := os.ReadFile(target.Name())
|
|
require.NoError(t, err)
|
|
|
|
// Test if renaming was successful
|
|
require.Error(t, os.Remove(source.Name()))
|
|
require.NoError(t, os.Remove(target.Name()))
|
|
require.Equal(t, beforeRename, afterRename)
|
|
}
|