daemon_concurrency_test.go

// This file is part of arduino-cli.
//
// Copyright 2022 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.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

package daemon_test

import (
	"context"
	"errors"
	"fmt"
	"io"
	"sync"
	"testing"
	"time"

	"github.com/arduino/arduino-cli/internal/integrationtest"
	"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
	"github.com/arduino/go-paths-helper"
	"github.com/stretchr/testify/require"
)

func TestArduinoCliDaemonCompileWithLotOfOutput(t *testing.T) {
	// See: https://github.com/arduino/arduino-cli/issues/2169

	env, cli := integrationtest.CreateEnvForDaemon(t)
	defer env.CleanUp()

	_, _, err := cli.Run("core", "install", "arduino:avr")
	require.NoError(t, err)

	grpcInst := cli.Create()
	require.NoError(t, grpcInst.Init("", "", func(ir *commands.InitResponse) {
		fmt.Printf("INIT> %v\n", ir.GetMessage())
	}))

	sketchPath, err := paths.New("..", "testdata", "ManyWarningsSketch").Abs()
	require.NoError(t, err)

	testCompile := func() {
		ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
		defer cancel()
		compile, err := grpcInst.Compile(ctx, "arduino:avr:uno", sketchPath.String(), "all")
		require.NoError(t, err)
		msgCount := 0
		for {
			_, err := compile.Recv()
			if errors.Is(err, io.EOF) {
				break
			}
			msgCount++
			require.NoError(t, err)
		}
		fmt.Println("Received", msgCount, "messages.")
	}

	// The synchronization bug doesn't always happens, try 10 times to
	// increase the chance to trigger it.
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
	testCompile()
}

func TestInitAndMonitorConcurrency(t *testing.T) {
	// See: https://github.com/arduino/arduino-cli/issues/2719

	env, cli := integrationtest.CreateEnvForDaemon(t)
	defer env.CleanUp()

	_, _, err := cli.Run("core", "install", "arduino:avr")
	require.NoError(t, err)

	grpcInst := cli.Create()
	require.NoError(t, grpcInst.Init("", "", func(ir *commands.InitResponse) {
		fmt.Printf("INIT> %v\n", ir.GetMessage())
	}))

	cli.InstallMockedSerialMonitor(t)

	// Open the serial monitor for 5 seconds
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()
	mon, err := grpcInst.Monitor(ctx, &commands.Port{
		Address:  "/dev/test",
		Protocol: "serial",
	})
	require.NoError(t, err)
	var monitorCompleted sync.WaitGroup
	monitorCompleted.Add(1)
	go func() {
		for {
			msg, err := mon.Recv()
			if err != nil {
				break
			}
			fmt.Println("MON> ", msg)
		}
		fmt.Println("MON CLOSED")
		monitorCompleted.Done()
	}()

	// Check that Init completes without blocking when the monitor is open
	start := time.Now()
	require.NoError(t, grpcInst.Init("", "", func(ir *commands.InitResponse) {
		fmt.Printf("INIT> %v\n", ir.GetMessage())
	}))
	require.LessOrEqual(t, time.Since(start), 4*time.Second)
	cancel()
	monitorCompleted.Wait()

	// Allow some time for the mocked-monitor process to terminate (otherwise the
	// test will fail on Windows when the cleanup function tries to remove the
	// executable).
	time.Sleep(2 * time.Second)
}