agdcslog: imp docs

Author: schzhn

internal/agdcslog/agdcslog_internal_test.go

@@ -0,0 +1,6 @@
+package agdcslog
+
+import "time"
+
+// testTimeout is the common timeout for tests.
+const testTimeout = 1 * time.Second

internal/agdcslog/syslog_darwin.go

@@ -62,6 +62,8 @@ func newSystemLogger(ctx context.Context, tag string) (l SystemLogger, err error
 
 // newSystemLoggerWithCommandConstructor returns a macOS-specific system logger
 // using the provided command constructor.
+//
+// TODO(s.chzhen):  Use this as the actual constructor.
 func newSystemLoggerWithCommandConstructor(
 	ctx context.Context,
 	cmdCons executil.CommandConstructor,
@@ -77,22 +79,22 @@ func newSystemLoggerWithCommandConstructor(
 	// first argument and an error as the second.
 	const msgFmt = "creating %s logger process: %w"
 
-	sysl.debug, err = newProcess(ctx, cmdCons, sevDebug)
+	sysl.debug, err = newOSProcess(ctx, cmdCons, sevDebug)
 	if err != nil {
 		errs = append(errs, fmt.Errorf(msgFmt, sevDebug, err))
 	}
 
-	sysl.info, err = newProcess(ctx, cmdCons, sevInfo)
+	sysl.info, err = newOSProcess(ctx, cmdCons, sevInfo)
 	if err != nil {
 		errs = append(errs, fmt.Errorf(msgFmt, sevInfo, err))
 	}
 
-	sysl.warning, err = newProcess(ctx, cmdCons, sevWarning)
+	sysl.warning, err = newOSProcess(ctx, cmdCons, sevWarning)
 	if err != nil {
 		errs = append(errs, fmt.Errorf(msgFmt, sevWarning, err))
 	}
 
-	sysl.error, err = newProcess(ctx, cmdCons, sevError)
+	sysl.error, err = newOSProcess(ctx, cmdCons, sevError)
 	if err != nil {
 		errs = append(errs, fmt.Errorf(msgFmt, sevError, err))
 	}
@@ -181,8 +183,8 @@ type osProcess struct {
 	severity severity
 }
 
-// newProcess creates a new process with a particular severity.
-func newProcess(
+// newOSProcess creates a new process with a particular severity.
+func newOSProcess(
 	ctx context.Context,
 	cmdCons executil.CommandConstructor,
 	sev severity,

internal/agdcslog/syslog_darwin_internal_test.go

@@ -8,7 +8,6 @@ import (
 	"io"
 	"sync"
 	"testing"
-	"time"
 
 	"github.com/AdguardTeam/golibs/osutil/executil"
 	"github.com/AdguardTeam/golibs/testutil"
@@ -17,9 +16,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// testTimeout is the common timeout for tests.
-const testTimeout = 1 * time.Second
-
 // lockedWriter protects concurrent writes to an underlying writer.
 type lockedWriter struct {
 	mu *sync.Mutex
@@ -38,6 +34,8 @@ func (lw *lockedWriter) Write(b []byte) (n int, err error) {
 }
 
 func TestSystemLogger(t *testing.T) {
+	t.Parallel()
+
 	const (
 		testTag = "tag"
 

internal/agdcslog/syslog_linux_internal_test.go

@@ -3,7 +3,6 @@
 package agdcslog
 
 import (
-	"bytes"
 	"io"
 	"log/syslog"
 	"net"
@@ -17,11 +16,12 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// testTimeout is the common timeout for tests.
-const testTimeout = 1 * time.Second
-
 func TestSystemLogger(t *testing.T) {
+	t.Parallel()
+
 	const (
+		network = "tcp"
+
 		testTag = "tag"
 
 		debugMsg = "debug_msg"
@@ -32,43 +32,33 @@ func TestSystemLogger(t *testing.T) {
 
 	localhostAnyPort := netip.AddrPortFrom(netutil.IPv4Localhost(), 0)
 	addr := net.TCPAddrFromAddrPort(localhostAnyPort)
-	ln, err := net.ListenTCP("tcp", addr)
+	ln, err := net.ListenTCP(network, addr)
 	require.NoError(t, err)
 	testutil.CleanupAndRequireSuccess(t, ln.Close)
 
-	w, err := syslog.Dial("tcp", ln.Addr().String(), syslog.LOG_LOCAL0, testTag)
+	w, err := syslog.Dial(network, ln.Addr().String(), syslog.LOG_LOCAL0, testTag)
 	require.NoError(t, err)
 
 	l := &systemLogger{writer: w}
 	require.NoError(t, l.Debug(debugMsg))
 	require.NoError(t, l.Info(infoMsg))
 	require.NoError(t, l.Warning(warnMsg))
 	require.NoError(t, l.Error(errMsg))
+
+	// Close the syslog writer to signal EOF to the reader.
 	require.NoError(t, l.Close())
 
 	conn, err := ln.Accept()
 	require.NoError(t, err)
 	testutil.CleanupAndRequireSuccess(t, conn.Close)
 
-	stdoutBuf := bytes.Buffer{}
-	data := make([]byte, 4096)
-	for {
-		err = conn.SetReadDeadline(time.Now().Add(testTimeout))
-		require.NoError(t, err)
-
-		var n int
-		n, err = conn.Read(data)
-		if err == io.EOF {
-			break
-		}
-
-		require.NoError(t, err)
+	err = conn.SetReadDeadline(time.Now().Add(testTimeout))
+	require.NoError(t, err)
 
-		_, err = stdoutBuf.Write(data[:n])
-		require.NoError(t, err)
-	}
+	data, err := io.ReadAll(conn)
+	require.NoError(t, err)
 
-	out := stdoutBuf.String()
+	out := string(data)
 	assert.Contains(t, out, debugMsg)
 	assert.Contains(t, out, infoMsg)
 	assert.Contains(t, out, warnMsg)

internal/agdcslog/syslog_windows_internal_test.go

@@ -20,6 +20,7 @@ type fakeEventlogWriter struct {
 	infoID   uint32
 	warnID   uint32
 	errID    uint32
+	closed   bool
 }
 
 // type check
@@ -51,9 +52,15 @@ func (f *fakeEventlogWriter) Error(id uint32, msg string) (err error) {
 }
 
 // Close implements the [eventlogWriter] interface for *fakeEventlogWriter.
-func (f *fakeEventlogWriter) Close() error { return nil }
+func (f *fakeEventlogWriter) Close() error {
+	f.closed = true
+
+	return nil
+}
+
+func TestSystemLogger(t *testing.T) {
+	t.Parallel()
 
-func TestSystemLogger_Windows_DelegatesAndEventIDs(t *testing.T) {
 	const (
 		debugMsg = "debug_msg"
 		infoMsg  = "info_msg"
@@ -79,4 +86,6 @@ func TestSystemLogger_Windows_DelegatesAndEventIDs(t *testing.T) {
 	assert.Equal(t, uint32(infoEventID), f.infoID)
 	assert.Equal(t, uint32(warningEventID), f.warnID)
 	assert.Equal(t, uint32(errorEventID), f.errID)
+
+	assert.True(t, f.closed)
 }