create_test.go

package device

import (
	"testing"

	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
)

// Test variables
var (
	portsNoBoards = []*rpc.DetectedPort{
		{
			Address: "ACM0",
			Boards:  []*rpc.BoardListItem{},
		},
		{
			Address: "ACM1",
			Boards:  []*rpc.BoardListItem{},
		},
	}

	portsTwoBoards = []*rpc.DetectedPort{
		{
			Address: "ACM0",
			Boards: []*rpc.BoardListItem{
				{Fqbn: "arduino:samd:nano_33_iot"},
			},
		},
		{
			Address: "ACM1",
			Boards: []*rpc.BoardListItem{
				{Fqbn: "arduino:avr:uno"},
			},
		},
	}
)

func TestDeviceFromPorts(t *testing.T) {
	tests := []struct {
		name   string
		filter *CreateParams
		ports  []*rpc.DetectedPort
		want   *device
	}{

		{
			name:   "port-filter",
			filter: &CreateParams{Fqbn: "", Port: "ACM1"},
			ports:  portsTwoBoards,
			want:   &device{fqbn: "arduino:avr:uno", port: "ACM1"},
		},

		{
			name:   "fqbn-filter",
			filter: &CreateParams{Fqbn: "arduino:avr:uno", Port: ""},
			ports:  portsTwoBoards,
			want:   &device{fqbn: "arduino:avr:uno", port: "ACM1"},
		},

		{
			name:   "no-filter-noboards",
			filter: &CreateParams{Fqbn: "", Port: ""},
			ports:  portsNoBoards,
			want:   nil,
		},

		{
			name:   "no-filter",
			filter: &CreateParams{Fqbn: "", Port: ""},
			ports:  portsTwoBoards,
			// first device found is selected
			want: &device{fqbn: "arduino:samd:nano_33_iot", port: "ACM0"},
		},

		{
			name:   "both-filter-noboards",
			filter: &CreateParams{Fqbn: "arduino:avr:uno", Port: "ACM1"},
			ports:  portsNoBoards,
			want:   nil,
		},

		{
			name:   "both-filter-found",
			filter: &CreateParams{Fqbn: "arduino:avr:uno", Port: "ACM1"},
			ports:  portsTwoBoards,
			want:   &device{fqbn: "arduino:avr:uno", port: "ACM1"},
		},

		{
			name:   "both-filter-notfound",
			filter: &CreateParams{Fqbn: "arduino:avr:uno", Port: "ACM0"},
			ports:  portsTwoBoards,
			want:   nil,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got := deviceFromPorts(tt.ports, tt.filter)

			if got == nil && tt.want == nil {
				return

			} else if got != nil && tt.want == nil {
				t.Errorf("Expected nil device, received not nil device with port %s and fqbn %s", got.port, got.fqbn)

			} else if got == nil && tt.want != nil {
				t.Errorf("Expected not nil device with port %s and fqbn %s, received a nil device", tt.want.port, tt.want.fqbn)

			} else if got.port != tt.want.port || got.fqbn != tt.want.fqbn {
				t.Errorf("Expected device with port %s and fqbn %s, received device with port %s and fqbn %s",
					tt.want.port, tt.want.fqbn, got.port, got.fqbn)
			}
		})
	}
}