Add a unit test for component status reporting

Author: faec

exporter/elasticsearchexporter/esclient.go

@@ -81,7 +81,7 @@ func (cl *clientLogger) LogRoundTrip(requ *http.Request, resp *http.Response, cl
 			zap.NamedError("reason", clientErr),
 		)
 		zl.Debug("Request failed.", fields...)
-		err := fmt.Errorf("Elasticsearch request failed: %v", clientErr.Error())
+		err := fmt.Errorf("Elasticsearch request failed: %w", clientErr)
 		componentstatus.ReportStatus(
 			cl.componentHost, componentstatus.NewRecoverableErrorEvent(err))
 

exporter/elasticsearchexporter/esclient_test.go

@@ -0,0 +1,74 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package elasticsearchexporter
+
+import (
+	"errors"
+	"io"
+	"net/http"
+	"net/url"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/component/componentstatus"
+	"go.uber.org/zap"
+)
+
+func TestComponentStatus(t *testing.T) {
+	statusChan := make(chan *componentstatus.Event, 1)
+	reporter := &testStatusReporter{statusChan}
+	esLogger := clientLogger{
+		Logger:          zap.New(nil),
+		logRequestBody:  false,
+		logResponseBody: false,
+		componentHost:   reporter,
+	}
+
+	// Pass in an error and make sure it's sent to the component status reporter
+	esLogger.LogRoundTrip(nil, nil, io.EOF, time.Now(), 0)
+	select {
+	case event := <-statusChan:
+		assert.True(t, errors.Is(event.Err(), io.EOF), "LogRoundTrip should report a component status error wrapping its error parameter")
+		assert.Equal(t, componentstatus.StatusRecoverableError, event.Status(), "LogRoundTrip on an error parameter should report a recoverable error")
+	default:
+		require.Fail(t, "LogRoundTrip with an error should report a recoverable error status")
+	}
+
+	// Pass in an http error status and make sure it's sent to the component status reporter
+	esLogger.LogRoundTrip(&http.Request{URL: &url.URL{}}, &http.Response{StatusCode: 401, Status: "401 Unauthorized"}, nil, time.Now(), 0)
+	select {
+	case event := <-statusChan:
+		err := event.Err()
+		require.NotNil(t, err, "LogRoundTrip with an http error status should report a component status error")
+		assert.Contains(t, err.Error(), "401 Unauthorized", "LogRoundTrip with an http error status should include the status in its error state")
+		assert.Equal(t, componentstatus.StatusRecoverableError, event.Status(), "LogRoundTrip with an http error status should report a recoverable error")
+	default:
+		require.Fail(t, "LogRoundTrip with an http error code should report a recoverable error status")
+	}
+
+	// Pass in an http success status and make sure the component status returns to OK
+	esLogger.LogRoundTrip(&http.Request{URL: &url.URL{}}, &http.Response{StatusCode: 200}, nil, time.Now(), 0)
+	select {
+	case event := <-statusChan:
+		assert.Nil(t, event.Err(), "LogRoundTrip with a success status shouldn't report a component status error")
+		assert.Equal(t, componentstatus.StatusOK, event.Status(), "LogRoundTrip with a success status should report component status OK")
+	default:
+		require.Fail(t, "LogRoundTrip with an http success should report component status OK")
+	}
+}
+
+type testStatusReporter struct {
+	statusChan chan *componentstatus.Event
+}
+
+func (tsr *testStatusReporter) Report(event *componentstatus.Event) {
+	tsr.statusChan <- event
+}
+
+func (tsr *testStatusReporter) GetExtensions() map[component.ID]component.Component {
+	return make(map[component.ID]component.Component)
+}