Pull request 85: AGDNS-3219-agdcslog-integration-tests

Merge in GO/adguarddnsclient from AGDNS-3219-agdcslog-integration-tests to master

Squashed commit of the following:

commit 5c8b471
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Oct 6 17:25:49 2025 +0300

    all: fix typo

commit 588ef72
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Oct 6 17:24:47 2025 +0300

    agdcslog: imp naming

commit edfb0c6
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Oct 6 15:27:38 2025 +0300

    agdcslog: add test

commit fdca529
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed Oct 1 19:04:11 2025 +0300

    all: ci set env

commit b66055e
Merge: 27b59b1 826395c
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed Oct 1 18:57:07 2025 +0300

    Merge branch 'master' into AGDNS-3219-agdcslog-integration-tests

commit 27b59b1
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue Sep 30 23:10:22 2025 +0300

    agdcslog: imp tests

commit ca1d219
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Sep 29 22:53:16 2025 +0300

    agdcslog: add tests

commit 2febb2a
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Mon Sep 29 13:54:46 2025 +0300

    agdcslog: integration tests

Author: schzhn

.github/workflows/build.yml

@@ -16,6 +16,7 @@
     'runs-on': '${{ matrix.os }}'
     'env':
       'GO111MODULE': 'on'
+      'TEST_AGDCSLOG': '1'
     'strategy':
       'fail-fast': false
       'matrix':

bamboo-specs/bamboo.yaml

@@ -9,6 +9,7 @@
     'key': 'DNSCLIENT'
     'name': 'AdGuardDNSClient'
 'variables':
+    # NOTE:  The Test stage depends on BusyBox syslogd on Alpine.
     'dockerGo': 'adguard/go-builder:1.25.1--1'
     'maintainer': 'Adguard Go Team'
     'name': 'AdGuardDNSClient'
@@ -118,6 +119,16 @@
 
               set -e -f -u -x
 
+              export TEST_AGDCSLOG=1
+
+              # Run syslogd in the foreground (-n) so its PID can be captured,
+              # and enable the in-memory ring buffer (-C) so that logread can
+              # read messages during integration tests.
+              syslogd -n -C &
+
+              syslogd_pid="$!"
+              readonly syslogd_pid
+
               make \
                   TEST_REPORTS_DIR="./test-reports/" \
                   VERBOSE=1 \
@@ -129,6 +140,8 @@
               exit_code="$(cat ./test-reports/test-exit-code.txt)"
               readonly exit_code
 
+              kill "$syslogd_pid"
+
               exit "$exit_code"
 
 'Artifact':

internal/agdcslog/agdcslog_test.go

@@ -4,6 +4,9 @@ import (
 	"bytes"
 	"context"
 	"log/slog"
+	"os"
+	"os/exec"
+	"strconv"
 	"strings"
 	"sync"
 	"testing"
@@ -15,6 +18,88 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// testTimeout is the common timeout for tests.
+const testTimeout = 1 * time.Second
+
+// testServiceName is the service name for integration tests.
+const testServiceName = "AdGuardDNSClientTest"
+
+// requireIntegration skips the test unless TEST_AGDCSLOG is set to "1".
+func requireIntegration(tb testing.TB) {
+	tb.Helper()
+
+	const envName = "TEST_AGDCSLOG"
+
+	switch v := os.Getenv(envName); v {
+	case "":
+		tb.Skipf("skipping: %s is not set", envName)
+	case "0":
+		tb.Skip("skipping: integration tests are disabled")
+	case "1":
+		// Go on.
+	default:
+		tb.Skipf(`skipping: %s must be "1" or "0", got %q`, envName, v)
+	}
+}
+
+// requireExec skips the test if the executable is not in the PATH environment
+// variable or the provided path does not exist.
+func requireExec(tb testing.TB, name string) {
+	tb.Helper()
+
+	_, err := exec.LookPath(name)
+	if err != nil {
+		tb.Skipf("skipping: executable %q not found on PATH", name)
+	}
+}
+
+// integrationSystemLogger returns a slog.Logger configured for system logging
+// in integration tests.
+func integrationSystemLogger(tb testing.TB) (l *slog.Logger) {
+	tb.Helper()
+
+	ctx := testutil.ContextWithTimeout(tb, testTimeout)
+	sl, err := agdcslog.NewSystemLogger(ctx, testServiceName)
+	require.NoError(tb, err)
+
+	testutil.CleanupAndRequireSuccess(tb, sl.Close)
+
+	h := agdcslog.NewSyslogHandler(sl, &slog.HandlerOptions{
+		Level: slog.LevelDebug,
+	})
+
+	return slog.New(h)
+}
+
+// requireEventuallyFound writes a message to the system log and observes it
+// using the provided finder function.
+func requireEventuallyFound(
+	tb testing.TB,
+	cmdLogReader string,
+	find func(ctx context.Context, msg string) (ok bool, err error),
+) {
+	tb.Helper()
+
+	requireIntegration(tb)
+	requireExec(tb, cmdLogReader)
+
+	l := integrationSystemLogger(tb)
+	msg := strconv.FormatInt(time.Now().UnixNano(), 10)
+
+	ctx := testutil.ContextWithTimeout(tb, testTimeout)
+	l.InfoContext(ctx, msg)
+
+	require.EventuallyWithT(tb, func(ct *assert.CollectT) {
+		findCtx, cancel := context.WithTimeout(ctx, testTimeout)
+		defer cancel()
+
+		ok, err := find(findCtx, 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

@@ -0,0 +1,37 @@
+//go:build darwin
+
+package agdcslog_test
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/AdguardTeam/golibs/osutil/executil"
+)
+
+// cmdLogReader is the name of the system log reader.
+const cmdLogReader = "log"
+
+// findInLog searches the macOS unified log for the message.
+func findInLog(ctx context.Context, 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", "--last", testTimeout.String(), "--info"},
+		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
+}
+
+func TestSystemLogger_integration(t *testing.T) {
+	requireEventuallyFound(t, cmdLogReader, findInLog)
+}

internal/agdcslog/syslog_linux_test.go

@@ -0,0 +1,65 @@
+//go:build linux
+
+package agdcslog_test
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/AdguardTeam/golibs/osutil/executil"
+)
+
+const (
+	// systemdLogReader is the systemd log reader.
+	systemdLogReader = "journalctl"
+
+	// syslogLogReader is the BusyBox syslog log reader.
+	syslogLogReader = "logread"
+)
+
+// findWithJournalctl searches the systemd journal for the message.
+func findWithJournalctl(ctx context.Context, msg string) (ok bool, err error) {
+	var stdOut, stdErr bytes.Buffer
+
+	since := "-" + testTimeout.String()
+
+	err = executil.Run(ctx, executil.SystemCommandConstructor{}, &executil.CommandConfig{
+		Path:   systemdLogReader,
+		Args:   []string{"-o", "cat", "-t", testServiceName, "--since", since, "--no-pager"},
+		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
+}
+
+// findWithLogread searches the syslog ring buffer for the message.
+func findWithLogread(ctx context.Context, msg string) (ok bool, err error) {
+	var stdOut, stdErr bytes.Buffer
+
+	err = executil.Run(ctx, executil.SystemCommandConstructor{}, &executil.CommandConfig{
+		Path:   syslogLogReader,
+		Args:   nil,
+		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
+}
+
+func TestSystemLogger_integration_systemd(t *testing.T) {
+	requireEventuallyFound(t, systemdLogReader, findWithJournalctl)
+}
+
+func TestSystemLogger_integration_syslogd(t *testing.T) {
+	requireEventuallyFound(t, syslogLogReader, findWithLogread)
+}

internal/agdcslog/syslog_windows_test.go

@@ -0,0 +1,43 @@
+//go:build windows
+
+package agdcslog_test
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/AdguardTeam/golibs/osutil/executil"
+)
+
+// cmdLogReader is the name of the system log reader.
+const cmdLogReader = "wevtutil"
+
+// 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", "/uni", "/q:" + query},
+		Stdout: &stdOut,
+		Stderr: &stdErr,
+	})
+	if err != nil {
+		return false, fmt.Errorf("log search failed: %w; stderr=%q", err, &stdErr)
+	}
+
+	// Strip NUL bytes from UTF-16LE output.
+	out := stdOut.Bytes()
+	out = bytes.ReplaceAll(out, []byte{0x00}, nil)
+
+	return bytes.Contains(out, []byte(msg)), nil
+}
+
+func TestSystemLogger_integration(t *testing.T) {
+	requireEventuallyFound(t, cmdLogReader, findInLog)
+}