manager_test.go

package gobot

import (
	"errors"
	"fmt"
	"log"
	"os"
	"testing"
	"time"

	multierror "github.com/hashicorp/go-multierror"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func initTestManager() *Manager {
	log.SetOutput(&NullReadWriteCloser{})
	g := NewManager()
	g.trap = func(c chan os.Signal) {
		c <- os.Interrupt
	}
	g.AddRobot(newTestRobot("Robot1"))
	g.AddRobot(newTestRobot("Robot2"))
	g.AddRobot(newTestRobot(""))
	return g
}

func initTestManager1Robot() *Manager {
	log.SetOutput(&NullReadWriteCloser{})
	g := NewManager()
	g.trap = func(c chan os.Signal) {
		c <- os.Interrupt
	}
	g.AddRobot(newTestRobot("Robot99"))

	return g
}

func TestNullReadWriteCloser(t *testing.T) {
	n := &NullReadWriteCloser{}
	i, _ := n.Write([]byte{1, 2, 3})
	assert.Equal(t, 3, i)
	i, _ = n.Read(make([]byte, 10))
	assert.Equal(t, 10, i)
	require.NoError(t, n.Close())
}

func TestManagerRobot(t *testing.T) {
	g := initTestManager()
	assert.Equal(t, "Robot1", g.Robot("Robot1").Name)
	assert.Equal(t, (*Robot)(nil), g.Robot("Robot4"))
	assert.Equal(t, (Device)(nil), g.Robot("Robot4").Device("Device1"))
	assert.Equal(t, (Connection)(nil), g.Robot("Robot4").Connection("Connection1"))
	assert.Equal(t, (Device)(nil), g.Robot("Robot1").Device("Device4"))
	assert.Equal(t, "Device1", g.Robot("Robot1").Device("Device1").Name())
	assert.Equal(t, 3, g.Robot("Robot1").Devices().Len())
	assert.Equal(t, (Connection)(nil), g.Robot("Robot1").Connection("Connection4"))
	assert.Equal(t, 3, g.Robot("Robot1").Connections().Len())
}

func TestManagerToJSON(t *testing.T) {
	g := initTestManager()
	g.AddCommand("test_function", func(params map[string]interface{}) interface{} {
		return nil
	})
	json := NewJSONManager(g)
	assert.Len(t, json.Robots, g.Robots().Len())
	assert.Len(t, json.Commands, len(g.Commands()))
}

func TestManagerStart(t *testing.T) {
	g := initTestManager()
	require.NoError(t, g.Start())
	require.NoError(t, g.Stop())
	assert.False(t, g.Running())
}

func TestManagerStartAutoRun(t *testing.T) {
	g := NewManager()
	g.AddRobot(newTestRobot("Robot99"))
	go func() { _ = g.Start() }()
	time.Sleep(10 * time.Millisecond)
	assert.True(t, g.Running())

	// stop it
	require.NoError(t, g.Stop())
	assert.False(t, g.Running())
}

func TestManagerStartDriverErrors(t *testing.T) {
	// arrange
	g := initTestManager1Robot()
	var ec int
	es := [4]error{
		nil,
		errors.New("driver start error 1"),
		errors.New("driver start error 2"),
		errors.New("driver start error 3"),
	}
	testDriverStart = func() error {
		ec++
		return es[ec]
	}
	defer func() { testDriverStart = func() error { return nil } }()

	var want error
	want = multierror.Append(want, fmt.Errorf("'Device1' start error: %w", es[1]))
	want = multierror.Append(want, fmt.Errorf("'Device2' start error: %w", es[2]))
	want = multierror.Append(want, fmt.Errorf("'' start error: %w", es[3]))

	// act & assert
	assert.Equal(t, want, g.Start())
	require.NoError(t, g.Stop())
}

func TestManagerHaltFromRobotDriverErrors(t *testing.T) {
	// arrange
	g := initTestManager1Robot()
	es := [4]error{
		nil,
		errors.New("driver halt error 1"),
		errors.New("driver halt error 2"),
		errors.New("driver halt error 3"),
	}
	var ec int
	testDriverHalt = func() error {
		ec++
		return es[ec]
	}
	defer func() { testDriverHalt = func() error { return nil } }()

	var want error
	want = multierror.Append(want, fmt.Errorf("'Device1' halt error: %w", es[1]))
	want = multierror.Append(want, fmt.Errorf("'Device2' halt error: %w", es[2]))
	want = multierror.Append(want, fmt.Errorf("'' halt error: %w", es[3]))

	// act & assert
	assert.Equal(t, want, g.Start())
}

func TestManagerStartRobotAdaptorErrors(t *testing.T) {
	// arrange
	g := initTestManager1Robot()
	es := [4]error{
		nil,
		errors.New("adaptor start error 1"),
		errors.New("adaptor start error 2"),
		errors.New("adaptor start error 3"),
	}
	var ec int
	testAdaptorConnect = func() error {
		ec++
		return es[ec]
	}
	defer func() { testAdaptorConnect = func() error { return nil } }()

	var want error
	want = multierror.Append(want, fmt.Errorf("'Connection1' connect error: %w", es[1]))
	want = multierror.Append(want, fmt.Errorf("'Connection2' connect error: %w", es[2]))
	want = multierror.Append(want, fmt.Errorf("'' connect error: %w", es[3]))

	// act & assert
	assert.Equal(t, want, g.Start())
	require.NoError(t, g.Stop())
}

func TestManagerFinalizeErrors(t *testing.T) {
	// arrange
	g := initTestManager1Robot()
	es := [4]error{
		nil,
		errors.New("adaptor finalize error 1"),
		errors.New("adaptor finalize error 2"),
		errors.New("adaptor finalize error 3"),
	}
	var ec int
	testAdaptorFinalize = func() error {
		ec++
		return fmt.Errorf("adaptor finalize error %d", ec)
	}
	defer func() { testAdaptorFinalize = func() error { return nil } }()

	var want error
	want = multierror.Append(want, fmt.Errorf("'Connection1' finalize error: %w", es[1]))
	want = multierror.Append(want, fmt.Errorf("'Connection2' finalize error: %w", es[2]))
	want = multierror.Append(want, fmt.Errorf("'' finalize error: %w", es[3]))

	// act & assert
	assert.Equal(t, want, g.Start())
}