Skip to content

acquisition/journalctl: test cleanup #4182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmetc merged 1 commit into from
Jan 8, 2026
Merged

acquisition/journalctl: test cleanup #4182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 65 additions & 68 deletions pkg/acquisition/modules/journalctl/journalctl_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ import (
"time"

"github.com/sirupsen/logrus"
logtest "github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
logtest "github.com/sirupsen/logrus/hooks/test"

"github.com/crowdsecurity/go-cs-lib/cstest"

Expand All @@ -27,26 +27,25 @@ func TestBadConfiguration(t *testing.T) {
ctx := t.Context()

tests := []struct {
config string
expectedErr string
config string
wantErr string
}{
{
config: `foobar: asd.log`,
expectedErr: `cannot parse: [1:1] unknown field "foobar"`,
config: `foobar: asd.log`,
wantErr: `cannot parse: [1:1] unknown field "foobar"`,
},
{
config: `
mode: tail
source: journalctl`,
expectedErr: "journalctl_filter is required",
wantErr: "journalctl_filter is required",
},
{
config: `
mode: cat
source: journalctl
journalctl_filter:
- _UID=42`,
expectedErr: "",
},
}

Expand All @@ -55,7 +54,7 @@ journalctl_filter:
f := Source{}
logger, _ := logtest.NewNullLogger()
err := f.Configure(ctx, []byte(tc.config), logrus.NewEntry(logger), metrics.AcquisitionMetricsLevelNone)
cstest.RequireErrorContains(t, err, tc.expectedErr)
cstest.RequireErrorContains(t, err, tc.wantErr)
})
}
}
Expand All @@ -66,44 +65,44 @@ func TestConfigureDSN(t *testing.T) {
ctx := t.Context()

tests := []struct {
dsn string
expectedErr string
dsn string
wantErr string
}{
{
dsn: "asd://",
expectedErr: "invalid DSN asd:// for journalctl source, must start with journalctl://",
dsn: "asd://",
wantErr: "invalid DSN asd:// for journalctl source, must start with journalctl://",
},
{
dsn: "journalctl://",
expectedErr: "empty journalctl:// DSN",
dsn: "journalctl://",
wantErr: "empty journalctl:// DSN",
},
{
dsn: "journalctl://foobar=42",
expectedErr: "unsupported key foobar in journalctl DSN",
dsn: "journalctl://foobar=42",
wantErr: "unsupported key foobar in journalctl DSN",
},
{
dsn: "journalctl://filters=%ZZ",
expectedErr: "could not parse journalctl DSN: invalid URL escape \"%ZZ\"",
dsn: "journalctl://filters=%ZZ",
wantErr: "could not parse journalctl DSN: invalid URL escape \"%ZZ\"",
},
{
dsn: "journalctl://filters=_UID=42?log_level=warn",
expectedErr: "",
dsn: "journalctl://filters=_UID=42?log_level=warn",
},
{
dsn: "journalctl://filters=_UID=1000&log_level=foobar",
expectedErr: `not a valid logrus Level: "foobar"`,
dsn: "journalctl://filters=_UID=1000&log_level=foobar",
wantErr: `not a valid logrus Level: "foobar"`,
},
{
dsn: "journalctl://filters=_UID=1000&log_level=warn&since=yesterday",
expectedErr: "",
dsn: "journalctl://filters=_UID=1000&log_level=warn&since=yesterday",
},
}

for _, test := range tests {
f := Source{}
logger, _ := logtest.NewNullLogger()
err := f.ConfigureByDSN(ctx, test.dsn, map[string]string{"type": "testtype"}, logrus.NewEntry(logger), "")
cstest.RequireErrorContains(t, err, test.expectedErr)
for _, tc := range tests {
t.Run(tc.dsn, func(t *testing.T) {
f := Source{}
logger, _ := logtest.NewNullLogger()
err := f.ConfigureByDSN(ctx, tc.dsn, map[string]string{"type": "testtype"}, logrus.NewEntry(logger), "")
cstest.RequireErrorContains(t, err, tc.wantErr)
})
}
}

Expand All @@ -113,55 +112,55 @@ func TestOneShot(t *testing.T) {
ctx := t.Context()

tests := []struct {
config string
expectedErr string
expectedLines int
expectedLog []string
config string
wantErr string
wantLines int
wantLog []string
}{
{
config: `
source: journalctl
mode: cat
journalctl_filter:
- "-_UID=42"`,
expectedErr: "exit status 1",
expectedLog: []string{
wantErr: "exit status 1",
wantLog: []string{
"Got stderr: journalctl: invalid option -- '_'",
},
expectedLines: 0,
wantLines: 0,
},
{
config: `
source: journalctl
mode: cat
journalctl_filter:
- _SYSTEMD_UNIT=ssh.service`,
expectedLines: 14,
wantLines: 14,
},
}
for _, ts := range tests {
out := make(chan pipeline.Event, 100)
j := Source{}
t.Run(ts.config, func(t *testing.T) {
out := make(chan pipeline.Event, 100)
j := Source{}

logger, hook := logtest.NewNullLogger()
logger, hook := logtest.NewNullLogger()

err := j.Configure(ctx, []byte(ts.config), logrus.NewEntry(logger), metrics.AcquisitionMetricsLevelNone)
require.NoError(t, err)
err := j.Configure(ctx, []byte(ts.config), logrus.NewEntry(logger), metrics.AcquisitionMetricsLevelNone)
require.NoError(t, err)

err = j.OneShot(ctx, out)
cstest.RequireErrorContains(t, err, ts.expectedErr)
err = j.OneShot(ctx, out)
cstest.RequireErrorContains(t, err, ts.wantErr)

for _, expectedMessage := range ts.expectedLog {
cstest.RequireLogContains(t, hook, expectedMessage)
}
for _, wantMessage := range ts.wantLog {
cstest.RequireLogContains(t, hook, wantMessage)
}

if ts.expectedErr != "" {
continue
}
if ts.wantErr != "" {
return
}

if ts.expectedLines != 0 {
assert.Len(t, out, ts.expectedLines)
}
assert.Len(t, out, ts.wantLines)
})
}
}

Expand All @@ -171,17 +170,17 @@ func TestStreaming(t *testing.T) {
ctx := t.Context()

tests := []struct {
config string
expectedErr string
expectedLines int
config string
wantErr string
wantLines int
}{
{
config: `
source: journalctl
mode: cat
journalctl_filter:
- _SYSTEMD_UNIT=ssh.service`,
expectedLines: 14,
wantLines: 14,
},
}
for idx, ts := range tests {
Expand All @@ -195,36 +194,34 @@ journalctl_filter:
err := j.Configure(ctx, []byte(ts.config), logrus.NewEntry(logger), metrics.AcquisitionMetricsLevelNone)
require.NoError(t, err)

actualLines := 0
gotLines := 0
var wg sync.WaitGroup

if ts.expectedLines != 0 {
wg.Add(1)
go func() {
defer wg.Done()
if ts.wantLines != 0 {
wg.Go(func() {
for {
select {
case <-out:
actualLines++
gotLines++
case <-time.After(1 * time.Second):
cancel()
return
}
}
}()
})
}

err = j.Stream(ctx, out)
cstest.RequireErrorContains(t, err, ts.expectedErr)
cstest.RequireErrorContains(t, err, ts.wantErr)

if ts.expectedErr != "" {
if ts.wantErr != "" {
cancel()
return
}

if ts.expectedLines != 0 {
if ts.wantLines != 0 {
wg.Wait()
assert.Equal(t, ts.expectedLines, actualLines)
assert.Equal(t, ts.wantLines, gotLines)
}

cancel()
Expand Down