1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
package fluentd
import (
"context"
"net"
"path/filepath"
"runtime"
"sync"
"testing"
"time"
"github.com/docker/docker/daemon/logger"
"github.com/google/go-cmp/cmp"
"gotest.tools/v3/assert"
)
func TestValidateLogOptReconnectInterval(t *testing.T) {
invalidIntervals := []string{"-1", "1", "-1s", "99ms", "11s"}
for _, v := range invalidIntervals {
t.Run("invalid "+v, func(t *testing.T) {
err := ValidateLogOpt(map[string]string{asyncReconnectIntervalKey: v})
assert.ErrorContains(t, err, "invalid value for fluentd-async-reconnect-interval:")
})
}
validIntervals := []string{"100ms", "10s"}
for _, v := range validIntervals {
t.Run("valid "+v, func(t *testing.T) {
err := ValidateLogOpt(map[string]string{asyncReconnectIntervalKey: v})
assert.NilError(t, err)
})
}
}
func TestValidateLogOptAddress(t *testing.T) {
// ports to try, and their results
validPorts := map[string]int{
"": defaultPort,
":": defaultPort,
":123": 123,
":65535": 65535,
}
// paths to try, which should result in an error
paths := []string{"/", "/some-path"}
tests := []struct {
addr string
ports map[string]int // combinations of addr + port -> expected port
paths []string // paths to append to addr, should be an error for tcp/udp
expected location
expectedErr string
}{
{
addr: "",
expected: location{
protocol: defaultProtocol,
host: defaultHost,
port: defaultPort,
},
},
{
addr: "192.168.1.1",
ports: validPorts,
paths: paths,
expected: location{
protocol: defaultProtocol,
host: "192.168.1.1",
},
},
{
addr: "[::1]",
ports: validPorts,
paths: paths,
expected: location{
protocol: defaultProtocol,
host: "::1",
},
},
{
addr: "example.com",
ports: validPorts,
paths: paths,
expected: location{
protocol: defaultProtocol,
host: "example.com",
},
},
{
addr: "tcp://",
paths: paths,
expected: location{
protocol: "tcp",
host: defaultHost,
port: defaultPort,
},
},
{
addr: "tcp://example.com",
ports: validPorts,
paths: paths,
expected: location{
protocol: "tcp",
host: "example.com",
},
},
{
addr: "tls://",
paths: paths,
expected: location{
protocol: "tls",
host: defaultHost,
port: defaultPort,
},
},
{
addr: "tls://example.com",
ports: validPorts,
paths: paths,
expected: location{
protocol: "tls",
host: "example.com",
},
},
{
addr: "://",
expectedErr: "missing protocol scheme",
},
{
addr: "something://",
expectedErr: "unsupported scheme: 'something'",
},
{
addr: "udp://",
expectedErr: "unsupported scheme: 'udp'",
},
{
addr: "unixgram://",
expectedErr: "unsupported scheme: 'unixgram'",
},
{
addr: "tcp+tls://",
expectedErr: "unsupported scheme: 'tcp+tls'",
},
{
addr: "corrupted:c",
expectedErr: "invalid port",
},
{
addr: "tcp://example.com:port",
expectedErr: "invalid port",
},
{
addr: "tcp://example.com:-1",
expectedErr: "invalid port",
},
{
addr: "tcp://example.com:65536",
expectedErr: "invalid port",
},
{
addr: "unix://",
expectedErr: "path is empty",
},
{
addr: "unix:///some/socket.sock",
expected: location{
protocol: "unix",
path: "/some/socket.sock",
},
},
{
addr: "unix:///some/socket.sock:80", // unusual, but technically valid
expected: location{
protocol: "unix",
path: "/some/socket.sock:80",
},
},
}
for _, tc := range tests {
if len(tc.ports) == 0 {
tc.ports = map[string]int{"": tc.expected.port}
}
// always try empty paths; add paths to try if the test specifies it
tc.paths = append([]string{""}, tc.paths...)
for port, expectedPort := range tc.ports {
for _, path := range tc.paths {
address := tc.addr + port + path
expected := tc.expected
expected.port = expectedPort
t.Run(address, func(t *testing.T) {
err := ValidateLogOpt(map[string]string{addressKey: address})
if path != "" {
assert.ErrorContains(t, err, "should not contain a path element")
return
}
if tc.expectedErr != "" {
assert.ErrorContains(t, err, tc.expectedErr)
return
}
assert.NilError(t, err)
addr, _ := parseAddress(address)
assert.DeepEqual(t, expected, *addr, cmp.AllowUnexported(location{}))
})
}
}
}
}
func TestValidateWriteTimeoutDuration(t *testing.T) {
invalidDurations := []string{"-1", "1", "-1s"}
for _, d := range invalidDurations {
t.Run("invalid "+d, func(t *testing.T) {
err := ValidateLogOpt(map[string]string{writeTimeoutKey: d})
assert.ErrorContains(t, err, "invalid value for fluentd-write-timeout:")
})
}
validDurations := map[string]time.Duration{
"100ms": 100 * time.Millisecond,
"10s": 10 * time.Second,
"": 0,
}
for k, v := range validDurations {
t.Run("valid "+k, func(t *testing.T) {
err := ValidateLogOpt(map[string]string{writeTimeoutKey: k})
assert.NilError(t, err)
cfg, err := parseConfig(map[string]string{writeTimeoutKey: k})
// This check is mostly redundant since it's checked in ValidateLogOpt as well.
// This is here to guard against potential regressions in the future.
assert.NilError(t, err)
assert.Equal(t, cfg.WriteTimeout, v)
})
}
}
// TestWriteTimeoutIsEffective tests that writes timeout when the server is unresponsive.
// The test ensures that instead of hanging forever, the fluentd write operation returns
// an error when writes cannot be completed within the specified duration.
func TestWriteTimeoutIsEffective(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("windows not supported")
}
// Create a temporary directory for the socket file
tmpDir := t.TempDir()
socketFile := filepath.Join(tmpDir, "fluent-logger-golang.sock")
l, err := net.Listen("unix", socketFile)
assert.NilError(t, err, "unable to create listener for socket %s", socketFile)
defer l.Close()
// This is to guard against potential run-away test scenario so that a future change
// doesn't cause the tests suite to timeout. It "fluentd-write-timeout" is not set, this
// test will be blocked on the socket write operation. The timeout guards against that.
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
var connectedWG sync.WaitGroup
connectedWG.Add(1)
// Start accepting connections.
go func(ctx context.Context, wg *sync.WaitGroup) {
wg.Done()
for {
conn, err := l.Accept()
if err != nil {
// Unable to process the connection. This can happen if the connection is closed.
select {
case <-ctx.Done():
// If the context is canceled, there's nothing for us to do here.
return
default:
t.Logf("Unable to accept connection: %v", err)
continue
}
}
// Handle an incoming connection. We're essentially blackholing this by not reading from
// or writing to the connection.
go func(ctx context.Context, conn net.Conn) {
// Simulate unresponsive server: do nothing with the connection
<-ctx.Done()
_ = conn.Close()
}(ctx, conn)
}
}(ctx, &connectedWG)
f, err := New(logger.Info{
ContainerName: "/test-container",
ContainerID: "container-abcdefghijklmnopqrstuvwxyz01234567890",
Config: map[string]string{
"fluentd-address": "unix://" + socketFile,
"tag": "{{.Name}}/{{.FullID}}",
// Disabling async behavior with limited retries and buffer size lets
// us test this in a more preditable manner for failures. Otherwise,
// write errors could be silently consumed. The "fluentd-write-timeout"
// flag should be equally effective regardless of async being enabled/disabled.
"fluentd-async": "false",
"fluentd-max-retries": "1",
"fluentd-retry-wait": "10ms",
"fluentd-buffer-limit": "1",
"fluentd-write-timeout": "1ms",
},
})
assert.NilError(t, err)
defer f.Close()
// Ensure that the server is ready to accept connections since we have disabled async mode
// in fluentd options.
connectedWG.Wait()
// Attempt writing 1MiB worth of log data (all 0's) repeatedly. We should see a failure
// after the 1st or the 2nd attempt depending on when the connection's write buffer gets
// filled up.
// If we don't set a write timeout on the connection, this will hang forever. But, because
// we have a write timeout, we expect the `Log` method to return an error.
data := make([]byte, 1024*1024)
for range 10 {
err = f.Log(&logger.Message{
Line: data,
Timestamp: time.Now(),
})
if err != nil {
break
}
}
// Checks if the error contains the expected message. The full message is of the format:
// "fluent#write: failed to write after %d attempts".
assert.ErrorContains(t, err, "fluent#write: failed to write after")
}
|