Skip to content
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.

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

Cherry-pick #20112 to 7.9: [libbeat] Fix write error in ensureWriter.Write #20145

Merged
merged 1 commit into from
Jul 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion libbeat/statestore/backend/memlog/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func (e *ensureWriter) Write(p []byte) (int, error) {
for len(p) > 0 {
n, err := e.w.Write(p)
N, p = N+n, p[n:]
if isRetryErr(err) {
if err != nil && !isRetryErr(err) {
return N, err
}
}
Expand Down
81 changes: 81 additions & 0 deletions libbeat/statestore/backend/memlog/util_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

package memlog

import (
"syscall"
"testing"
)

// A mock Writer implementation that always returns a configurable
// error on the first write call, to test error handling in ensureWriter.
type mockErrorWriter struct {
errorType error
reportedError bool
}

func (mew *mockErrorWriter) Write(data []byte) (n int, err error) {
if !mew.reportedError {
mew.reportedError = true
return 0, mew.errorType
}
return len(data), nil
}

func TestEnsureWriter_RetriableError(t *testing.T) {
// EAGAIN is retriable, ensureWriter.Write should succeed.
errorWriter := &mockErrorWriter{errorType: syscall.EAGAIN}
bytes := []byte{1, 2, 3}
writer := &ensureWriter{errorWriter}
written, err := writer.Write(bytes)
if err != nil {
t.Fatalf("ensureWriter shouldn't propagate retriable errors")
}
if written != len(bytes) {
t.Fatalf("Expected %d bytes written, got %d", len(bytes), written)
}
}

func TestEnsureWriter_NonRetriableError(t *testing.T) {
// EINVAL is not retriable, ensureWriter.Write should return an error.
errorWriter := &mockErrorWriter{errorType: syscall.EINVAL}
bytes := []byte{1, 2, 3}
writer := &ensureWriter{errorWriter}
written, err := writer.Write(bytes)
if err != syscall.EINVAL {
t.Fatalf("ensureWriter should propagate nonretriable errors")
}
if written != 0 {
t.Fatalf("Expected 0 bytes written, got %d", written)
}
}

func TestEnsureWriter_NoError(t *testing.T) {
// This tests the case where the underlying writer returns with no error,
// but without writing the full buffer.
var bytes []byte = []byte{1, 2, 3}
errorWriter := &mockErrorWriter{errorType: nil}
writer := &ensureWriter{errorWriter}
written, err := writer.Write(bytes)
if err != nil {
t.Fatalf("ensureWriter should only error if the underlying writer does")
}
if written != len(bytes) {
t.Fatalf("Expected %d bytes written, got %d", len(bytes), written)
}
}