feat(plc4go): add option WithTraceTransportInstance to limit tracing …

…of test.TransportInstance

.github/workflows/go-platform.yml

@@ -64,6 +64,10 @@ on:
         description: "sets tracing for executor workers"
         required: false
         default: 'false'
+      traceTestTransportInstance:
+        description: "sets tracing for test transport instance"
+        required: false
+        default: 'false'
 
 env:
   PLC4X_TEST_HIGH_TEST_LOG_PRECISION: ${{ github.event.inputs.highLogPrecision }}
@@ -73,6 +77,7 @@ env:
   PLC4X_TEST_TRACE_TRANSACTION_MANAGER_TRANSACTIONS: ${{ github.event.inputs.traceTransactionManagerTransactions }}
   PLC4X_TEST_TRACE_DEFAULT_MESSAGE_CODEC_WORKER: ${{ github.event.inputs.traceDefaultMessageCodecWorker }}
   PLC4X_TEST_TRACE_EXECUTOR_WORKERS: ${{ github.event.inputs.traceExecutorWorkers }}
+  PLC4X_TEST_TEST_TRANSPORT_INSTANCE: ${{ github.event.inputs.traceTestTransportInstance }}
 
 jobs:
   test:

plc4go/spi/testutils/TestUtils.go

@@ -34,6 +34,7 @@ import (
 	"github.com/apache/plc4x/plc4go/spi/options"
 	"github.com/apache/plc4x/plc4go/spi/pool"
 	"github.com/apache/plc4x/plc4go/spi/transactions"
+	"github.com/apache/plc4x/plc4go/spi/transports/test"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 
 	"github.com/ajankovic/xdiff"
@@ -129,6 +130,7 @@ var (
 	traceTransactionManagerTransactions bool
 	traceDefaultMessageCodecWorker      bool
 	traceExecutorWorkers                bool
+	traceTestTransportInstance          bool
 )
 
 func init() {
@@ -143,6 +145,7 @@ func init() {
 	getOrLeaveBool("PLC4X_TEST_TRACE_TRANSACTION_MANAGER_TRANSACTIONS", &traceTransactionManagerTransactions)
 	getOrLeaveBool("PLC4X_TEST_TRACE_DEFAULT_MESSAGE_CODEC_WORKER", &traceDefaultMessageCodecWorker)
 	getOrLeaveBool("PLC4X_TEST_TRACE_EXECUTOR_WORKERS", &traceExecutorWorkers)
+	getOrLeaveBool("PLC4X_TEST_TEST_TRANSPORT_INSTANCE", &traceTestTransportInstance)
 }
 
 func getOrLeaveBool(key string, setting *bool) {
@@ -237,6 +240,7 @@ func EnrichOptionsWithOptionsForTesting(t *testing.T, _options ...options.WithOp
 		options.WithTraceTransactionManagerTransactions(traceTransactionManagerTransactions),
 		options.WithTraceDefaultMessageCodecWorker(traceDefaultMessageCodecWorker),
 		options.WithExecutorOptionTracerWorkers(traceExecutorWorkers),
+		test.WithTraceTransportInstance(traceTestTransportInstance),
 	)
 	// We always create a custom executor to ensure shared executor for transaction manager is not used for tests
 	testSharedExecutorInstance := pool.NewFixedSizeExecutor(

plc4go/spi/transports/test/TransportInstance.go

@@ -50,6 +50,12 @@ type TransportInstance struct {
 
 func NewTransportInstance(transport *Transport, _options ...options.WithOption) *TransportInstance {
 	customLogger := options.ExtractCustomLoggerOrDefaultToGlobal(_options...)
+	shouldTrace, found := ExtractTraceTransportInstance(_options...)
+	if found && !shouldTrace {
+		if customLogger.GetLevel() < zerolog.InfoLevel {
+			customLogger = customLogger.Level(zerolog.InfoLevel)
+		}
+	}
 	return &TransportInstance{
 		readBuffer:  []byte{},
 		writeBuffer: []byte{},
@@ -59,6 +65,27 @@ func NewTransportInstance(transport *Transport, _options ...options.WithOption)
 	}
 }
 
+// WithTraceTransportInstance enables tracing of the test transport instance
+func WithTraceTransportInstance(trace bool) options.WithOption {
+	return withTraceTransportInstance{trace: trace}
+}
+
+// ExtractTraceTransportInstance to extract the flag indicating that transport instance should be traced
+func ExtractTraceTransportInstance(options ...options.WithOption) (trace bool, found bool) {
+	for _, option := range options {
+		switch option := option.(type) {
+		case withTraceTransportInstance:
+			trace, found = option.trace, true
+		}
+	}
+	return
+}
+
+type withTraceTransportInstance struct {
+	options.Option
+	trace bool
+}
+
 func (m *TransportInstance) Connect() error {
 	m.stateChangeMutex.Lock()
 	defer m.stateChangeMutex.Unlock()