agdcslog: add tests

Author: schzhn

internal/agdcslog/agdcslog_test.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"log/slog"
 	"os"
+	"os/exec"
 	"strconv"
 	"strings"
 	"sync"
@@ -22,22 +23,35 @@ const testTimeout = 1 * time.Second
 
 const testServiceName = "AdGuardDNSClientTest"
 
-func requireIntegration(t *testing.T) {
-	t.Helper()
+// requireIntegration skips the test unless TEST_AGDCSLOG parses to true.
+func requireIntegration(tb testing.TB) {
+	tb.Helper()
 
 	const envName = "TEST_AGDCSLOG"
 
 	val := os.Getenv(envName)
 	if val == "" {
-		t.Skip()
+		tb.Skip("skipping: env is not set")
 	}
 
 	ok, err := strconv.ParseBool(val)
 	if err != nil || !ok {
-		t.Skip()
+		tb.Skip("skipping: unexpected value")
+	}
+}
+
+// requireLogReader skips the test unless there is a system log reader.
+func requireLogReader(tb testing.TB) {
+	tb.Helper()
+
+	_, err := exec.LookPath(cmdLogReader)
+	if err != nil {
+		tb.Skip("skipping: no system log reader")
 	}
 }
 
+// integrationSystemLogger returns a slog.Logger configured for system logging
+// in integration tests.
 func integrationSystemLogger(t *testing.T) (l *slog.Logger) {
 	t.Helper()
 
@@ -54,6 +68,31 @@ func integrationSystemLogger(t *testing.T) (l *slog.Logger) {
 	return slog.New(h)
 }
 
+func TestSystemLogger_integration(t *testing.T) {
+	requireIntegration(t)
+	requireLogReader(t)
+
+	l := integrationSystemLogger(t)
+
+	since := time.Now()
+	sinceStr := since.Format(time.DateTime)
+
+	msg := strconv.FormatInt(since.UnixNano(), 10)
+
+	ctx := testutil.ContextWithTimeout(t, testTimeout)
+	l.DebugContext(ctx, msg)
+
+	require.EventuallyWithT(t, func(ct *assert.CollectT) {
+		findCtx, cancel := context.WithTimeout(ctx, testTimeout)
+		defer cancel()
+
+		ok, err := findInLog(findCtx, sinceStr, msg)
+		require.NoError(ct, err)
+
+		assert.True(ct, ok)
+	}, testTimeout, testTimeout/10)
+}
+
 // testLogger is a mock implementation of [agdcslog.SystemLogger] interface for
 // tests.
 //

internal/agdcslog/syslog_darwin_test.go

@@ -3,14 +3,30 @@
 package agdcslog_test
 
 import (
-	"testing"
+	"bytes"
+	"context"
+	"fmt"
+	"strings"
 
-	"github.com/stretchr/testify/require"
+	"github.com/AdguardTeam/golibs/osutil/executil"
 )
 
-func TestSystemLogger_integration(t *testing.T) {
-	requireIntegration(t)
+// cmdLogReader is the name of the system log reader.
+const cmdLogReader = "log"
 
-	l := integrationSystemLogger(t)
-	require.NotNil(t, l)
+// findInLog searches the macOS unified log for the message.
+func findInLog(ctx context.Context, since, msg string) (ok bool, err error) {
+	var stdOut, stdErr bytes.Buffer
+
+	err = executil.Run(ctx, executil.SystemCommandConstructor{}, &executil.CommandConfig{
+		Path:   cmdLogReader,
+		Args:   []string{"show", "--style", "syslog", "--start", since, "--debug"},
+		Stdout: &stdOut,
+		Stderr: &stdErr,
+	})
+	if err != nil {
+		return false, fmt.Errorf("log search failed: %w; stderr=%q", err, &stdErr)
+	}
+
+	return strings.Contains(stdOut.String(), msg), nil
 }

internal/agdcslog/syslog_linux_test.go

@@ -7,50 +7,25 @@ import (
 	"context"
 	"fmt"
 	"strings"
-	"testing"
-	"time"
 
 	"github.com/AdguardTeam/golibs/osutil/executil"
-	"github.com/AdguardTeam/golibs/testutil"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 )
 
-func TestSystemLogger_integration(t *testing.T) {
-	requireIntegration(t)
+// cmdLogReader is the name of the system log reader.
+const cmdLogReader = "journalctl"
 
-	l := integrationSystemLogger(t)
-
-	since := time.Now()
-	sinceStr := since.Format(time.DateTime)
-
-	msg := fmt.Sprintf("%d", since.UnixNano())
-
-	ctx := testutil.ContextWithTimeout(t, testTimeout)
-	l.DebugContext(ctx, msg)
-
-	require.EventuallyWithT(t, func(ct *assert.CollectT) {
-		findCtx, cancel := context.WithTimeout(ctx, testTimeout)
-		defer cancel()
-
-		ok, err := findInJournald(findCtx, sinceStr, msg)
-		require.NoError(ct, err)
-
-		assert.True(ct, ok)
-	}, testTimeout, testTimeout/10)
-}
-
-func findInJournald(ctx context.Context, since, msg string) (ok bool, err error) {
+// findInLog searches the systemd journal for the message.
+func findInLog(ctx context.Context, since, msg string) (ok bool, err error) {
 	var stdOut, stdErr bytes.Buffer
 
 	err = executil.Run(ctx, executil.SystemCommandConstructor{}, &executil.CommandConfig{
-		Path:   "journalctl",
+		Path:   cmdLogReader,
 		Args:   []string{"-o", "cat", "-t", testServiceName, "--since", since, "--no-pager"},
 		Stdout: &stdOut,
 		Stderr: &stdErr,
 	})
 	if err != nil {
-		return false, fmt.Errorf("journalctl failed: %w; stderr=%q", err, &stdErr)
+		return false, fmt.Errorf("log search failed: %w; stderr=%q", err, &stdErr)
 	}
 
 	return strings.Contains(stdOut.String(), msg), nil

internal/agdcslog/syslog_windows_test.go

@@ -3,14 +3,33 @@
 package agdcslog_test
 
 import (
-	"testing"
+	"bytes"
+	"context"
+	"fmt"
+	"strings"
 
-	"github.com/stretchr/testify/require"
+	"github.com/AdguardTeam/golibs/osutil/executil"
 )
 
-func TestSystemLogger_integration(t *testing.T) {
-	requireIntegration(t)
+// cmdLogReader is the name of the system log reader.
+const cmdLogReader = "wevtutil"
 
-	l := integrationSystemLogger(t)
-	require.NotNil(t, l)
+// findInLog searches the Windows Application event log for the message.
+func findInLog(ctx context.Context, _, msg string) (ok bool, err error) {
+	var stdOut, stdErr bytes.Buffer
+
+	ms := testTimeout.Milliseconds()
+	query := fmt.Sprintf(`*[System[TimeCreated[timediff(@SystemTime) <= %d]]]`, ms)
+
+	err = executil.Run(ctx, executil.SystemCommandConstructor{}, &executil.CommandConfig{
+		Path:   cmdLogReader,
+		Args:   []string{"qe", "Application", "/rd:true", "/f:text", "/q:" + query},
+		Stdout: &stdOut,
+		Stderr: &stdErr,
+	})
+	if err != nil {
+		return false, fmt.Errorf("log search failed: %w; stderr=%q", err, &stdErr)
+	}
+
+	return strings.Contains(stdOut.String(), msg), nil
 }