Made stdio test more reliable by running fake discovery through TCP

Author: cmaglie

client_test.go

@@ -18,7 +18,7 @@
 package discovery
 
 import (
-	"io"
+	"net"
 	"testing"
 	"time"
 
@@ -27,25 +27,31 @@ import (
 )
 
 func TestDiscoveryStdioHandling(t *testing.T) {
-	// Build `cat` helper inside testdata/cat
+	// Build `netcat` helper inside testdata/cat
 	builder, err := paths.NewProcess(nil, "go", "build")
 	require.NoError(t, err)
-	builder.SetDir("testdata/cat")
+	builder.SetDir("testdata/netcat")
 	require.NoError(t, builder.Run())
 
-	// Run cat and test if streaming json works as expected
-	disc := NewClient("test", "testdata/cat/cat") // copy stdin to stdout
+	// Run netcat and test if streaming json works as expected
+	listener, err := net.ListenTCP("tcp", nil)
+	require.NoError(t, err)
 
+	disc := NewClient("test", "testdata/netcat/netcat", listener.Addr().String())
 	err = disc.runProcess()
 	require.NoError(t, err)
 
-	_, err = disc.outgoingCommandsPipe.Write([]byte(`{ "eventType":`)) // send partial JSON
+	listener.SetDeadline(time.Now().Add(time.Second))
+	conn, err := listener.Accept()
+	require.NoError(t, err)
+
+	_, err = conn.Write([]byte(`{ "eventType":`)) // send partial JSON
 	require.NoError(t, err)
 	msg, err := disc.waitMessage(time.Millisecond * 100)
 	require.Error(t, err)
 	require.Nil(t, msg)
 
-	_, err = disc.outgoingCommandsPipe.Write([]byte(`"ev1" }{ `)) // complete previous json and start another one
+	_, err = conn.Write([]byte(`"ev1" }{ `)) // complete previous json and start another one
 	require.NoError(t, err)
 
 	msg, err = disc.waitMessage(time.Millisecond * 100)
@@ -57,7 +63,7 @@ func TestDiscoveryStdioHandling(t *testing.T) {
 	require.Error(t, err)
 	require.Nil(t, msg)
 
-	_, err = disc.outgoingCommandsPipe.Write([]byte(`"eventType":"ev2" }`)) // complete previous json
+	_, err = conn.Write([]byte(`"eventType":"ev2" }`)) // complete previous json
 	require.NoError(t, err)
 
 	msg, err = disc.waitMessage(time.Millisecond * 100)
@@ -67,9 +73,9 @@ func TestDiscoveryStdioHandling(t *testing.T) {
 
 	require.True(t, disc.Alive())
 
-	err = disc.outgoingCommandsPipe.(io.ReadCloser).Close()
+	err = conn.Close()
 	require.NoError(t, err)
-	time.Sleep(time.Millisecond * 100)
+	time.Sleep(time.Millisecond * 500)
 
 	require.False(t, disc.Alive())
 }

testdata/cat/.gitignore

@@ -0,0 +1,2 @@
+netcat
+netcat.exe

testdata/netcat/.gitignore

@@ -1,6 +1,6 @@
-// This file is part of arduino-cli.
+// This file is part of pluggable-discovery-protocol-handler.
 //
-// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
+// Copyright 2024 ARDUINO SA (http://www.arduino.cc/)
 //
 // This software is released under the GNU General Public License version 3,
 // which covers the main part of arduino-cli.
@@ -13,16 +13,34 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-// Echo stdin to stdout.
+// Proxy stdin/stdout through a TCP socket.
 // This program is used for testing purposes, to make it available on all
-// OS a tool equivalent to UNIX "cat".
+// OS a tool equivalent to UNIX "nc".
 package main
 
 import (
 	"io"
+	"net"
 	"os"
 )
 
 func main() {
-	io.Copy(os.Stdout, os.Stdin)
+	tcpAddr, err := net.ResolveTCPAddr("tcp", os.Args[1])
+	if err != nil {
+		println("ResolveTCPAddr failed:", err.Error())
+		os.Exit(1)
+	}
+
+	conn, err := net.DialTCP("tcp", nil, tcpAddr)
+	if err != nil {
+		println("Dial failed:", err.Error())
+		os.Exit(1)
+	}
+
+	go func() {
+		io.Copy(os.Stdout, conn)
+		os.Exit(0)
+	}()
+	io.Copy(conn, os.Stdin)
+	os.Exit(0)
 }