text:
package main

import (
	"encoding/gob"
	"io/ioutil"
	"os"
	"path"
	"sync"
	"testing"
	"time"

	"gopkg.in/yaml.v2"

	"github.com/ciao-project/ciao/payloads"
	"github.com/ciao-project/ciao/ssntp"
)

type fakeStatus struct {
	status ssntp.Status
	ready  *payloads.Ready
}

type fakeDeviceInfo struct{}

func (fakeDeviceInfo) GetLoadAvg() int {
	return 1
}

func (fakeDeviceInfo) GetFSInfo(path string) (total, available int) {
	return 100 * 1000, 75 * 1000
}

func (fakeDeviceInfo) GetOnlineCPUs() int {
	return 2
}

func (fakeDeviceInfo) GetMemoryInfo() (total, available int) {
	return 16000, 8000
}

type overseerTestState struct {
	t        *testing.T
	ac       *agentClient
	statusCh chan *fakeStatus
	statsCh  chan *payloads.Stat
}

func (v *overseerTestState) SendError(error ssntp.Error, payload []byte) (int, error) {
	return 0, nil
}

func (v *overseerTestState) SendEvent(event ssntp.Event, payload []byte) (int, error) {
	return 0, nil
}

func (v *overseerTestState) Dial(config *ssntp.Config, ntf ssntp.ClientNotifier) error {
	return nil
}

func (v *overseerTestState) SendStatus(status ssntp.Status, payload []byte) (int, error) {
	if v.statusCh == nil {
		return 0, nil
	}
	switch status {
	case ssntp.READY:
		ready := &payloads.Ready{}
		err := yaml.Unmarshal(payload, ready)
		if err != nil {
			v.t.Errorf("Failed to unmarshall READY status %v", err)
		}
		v.statusCh <- &fakeStatus{status, ready}
	case ssntp.FULL:
		fallthrough
	case ssntp.MAINTENANCE:
		v.statusCh <- &fakeStatus{status, nil}
	}

	return 0, nil
}

func (v *overseerTestState) SendCommand(cmd ssntp.Command, payload []byte) (int, error) {

	switch cmd {
	case ssntp.STATS:
		if v.statsCh == nil {
			return 0, nil
		}
		stats := &payloads.Stat{}
		err := yaml.Unmarshal(payload, stats)
		if err != nil {
			v.t.Errorf("Failed to unmarshall Stats %v", err)
		}
		v.statsCh <- stats
	}

	return 0, nil
}

func (v *overseerTestState) Role() ssntp.Role {
	return ssntp.AGENT | ssntp.NETAGENT
}

func (v *overseerTestState) UUID() string {
	return "test-uuid"
}

func (v *overseerTestState) Close() {

}

func (v *overseerTestState) isConnected() bool {
	return true
}

func (v *overseerTestState) setStatus(status bool) {

}

func (v *overseerTestState) ClusterConfiguration() (payloads.Configure, error) {
	return payloads.Configure{}, nil
}

func shutdownOverseer(ovsCh chan<- interface{}, state *overseerTestState) {
	close(ovsCh)

DONE:
	for {
		select {
		case <-state.statusCh:
		case <-state.statsCh:
		default:
			break DONE
		}
	}
}

func addInstance(t *testing.T, ovsCh chan<- interface{}, state *overseerTestState, needStats bool) *payloads.Stat {
	addCh := make(chan ovsAddResult)

	select {
	case <-state.statusCh:
	case <-state.statsCh:
	case ovsCh <- &ovsAddCmd{
		instance: "test-instance",
		cfg: &vmConfig{
			Cpus:        2,
			Mem:         370,
			Disk:        8000,
			Instance:    "testInstance",
			DockerImage: "testImage",
			Legacy:      true,
			VnicMAC:     "02:00:e6:f5:af:f9",
			VnicIP:      "192.168.8.2",
			ConcIP:      "192.168.42.21",
			SubnetIP:    "192.168.8.0/21",
			TenantUUID:  "67d86208-000-4465-9018-fe14087d415f",
			ConcUUID:    "67d86208-b46c-4465-0000-fe14087d415f",
			VnicUUID:    "67d86208-b46c-0000-9018-fe14087d415f",
		},
		targetCh: addCh,
	}:
	case <-time.After(time.Second):
		t.Fatal("Unable to add instance")
	}

	var stats *payloads.Stat
	var addResult *ovsAddResult
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case <-state.statusCh:
		case stats = <-state.statsCh:
			if addResult != nil {
				break DONE
			}
		case ar := <-addCh:
			if addResult == nil {
				addResult = &ar
			}
			if !needStats || stats != nil {
				break DONE
			}
		case <-timer:
			t.Fatal("Timed out waiting for Stats and AddResult")
			break DONE
		}
	}

	if addResult.errorCode != "" {
		t.Error("Unable to add instance")
	}

	return stats
}

func removeInstance(t *testing.T, ovsCh chan<- interface{}, state *overseerTestState, needStats bool) *payloads.Stat {
	removeCh := make(chan error)

	select {
	case ovsCh <- &ovsRemoveCmd{
		instance: "test-instance",
		errCh:    removeCh,
	}:
	case <-state.statusCh:
	case <-state.statsCh:
	case <-time.After(time.Second):
		t.Fatal("Unable to remove instance")
	}

	var stats *payloads.Stat
	var err error
	gotErr := false
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case <-state.statusCh:
		case stats = <-state.statsCh:
			if gotErr {
				break DONE
			}
		case err = <-removeCh:
			gotErr = true
			if !needStats || stats != nil {
				break DONE
			}
		case <-timer:
			t.Fatal("Timed out waiting for Stats and RemoveResult")
			break DONE
		}
	}

	if err != nil {
		t.Errorf("Unable to delete instance: %v", err)
	}

	return stats
}

func getStatusStats(t *testing.T, ovsCh chan<- interface{},
	state *overseerTestState) (*fakeStatus, *payloads.Stat) {
	select {
	case ovsCh <- &ovsStatsStatusCmd{}:
	case <-time.After(time.Second):
		t.Fatal("Unable to send ovsStatsStatusCmd")
	}

	var status *fakeStatus
	var stats *payloads.Stat
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case status = <-state.statusCh:
			if state.statsCh == nil || stats != nil {
				break DONE
			}
		case stats = <-state.statsCh:
			if state.statusCh == nil || status != nil {
				break DONE
			}
		case <-timer:
			t.Fatal("Timed out waiting for Status or Stats")
			break DONE
		}
	}

	return status, stats
}

func createTestInstance(t *testing.T, instancesDir string) {

	cfg := &vmConfig{
		Cpus:        2,
		Mem:         370,
		Disk:        8000,
		Instance:    "testInstance",
		DockerImage: "testImage",
		Legacy:      true,
		VnicMAC:     "02:00:e6:f5:af:f9",
		VnicIP:      "192.168.8.2",
		ConcIP:      "192.168.42.21",
		SubnetIP:    "192.168.8.0/21",
		TenantUUID:  "67d86208-000-4465-9018-fe14087d415f",
		ConcUUID:    "67d86208-b46c-4465-0000-fe14087d415f",
		VnicUUID:    "67d86208-b46c-0000-9018-fe14087d415f",
	}
	instanceDir := path.Join(instancesDir, "test-instance")
	err := os.Mkdir(instanceDir, 0755)
	if err != nil {
		t.Fatalf("Unable to create instance directory")
	}

	cfgFilePath := path.Join(instanceDir, instanceState)
	cfgFile, err := os.OpenFile(cfgFilePath, os.O_CREATE|os.O_RDWR, 0600)
	if err != nil {
		t.Fatalf("Unable to create state file %v", err)
	}
	defer func() { _ = cfgFile.Close() }()

	enc := gob.NewEncoder(cfgFile)
	err = enc.Encode(cfg)
	if err != nil {
		t.Fatalf("Failed to store state information %v", err)
	}
}

// Checks that the overseer go routine can be started and stopped.
//
// We start the overseer and then close the overseer channel to
// shut it down.
//
// Overseer should start and stop cleanly
func TestStartStopOverseer(t *testing.T) {
	diskLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{t: t}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*900,
		fakeDeviceInfo{})
	close(ovsCh)
	wg.Wait()
}

// Check the overseer sends stats when there are no instances.
//
// Start the overseer with a stats interval of 300ms.  Wait
// for a stats command.
//
// A stats command should be received.  Its instance array should
// be empty
func TestEmptyStats(t *testing.T) {
	diskLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:       t,
		statsCh: make(chan *payloads.Stat),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Millisecond*300,
		fakeDeviceInfo{})

	var stats *payloads.Stat
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case stats = <-state.statsCh:
			break DONE
		case <-timer:
			t.Fatal("Timed out waiting for Status or Stats")
			break DONE
		}
	}

	if len(stats.Instances) != 0 {
		t.Errorf("Zero instances expected.  Found %d", len(stats.Instances))
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Check the overseer sends a status command
//
// Start the overseer with a high stats interval and send an ovsStatusCmd.
// Shutdown the overseer.
//
// A status command should be received.  The overseer should shut down cleanly.
func TestEmptyStatus(t *testing.T) {
	diskLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:        t,
		statusCh: make(chan *fakeStatus),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})
	select {
	case ovsCh <- &ovsStatusCmd{}:
	case <-time.After(time.Second):
		t.Fatal("Unable to send ovsStatusCmd")
	}

	var status *fakeStatus
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case status = <-state.statusCh:
			break DONE
		case <-timer:
			t.Fatal("Timed out waiting for Status or Stats")
			break DONE
		}
	}

	if status.ready.NodeUUID != state.UUID() {
		t.Errorf("Unexpected UUID received for READY event, expected %s got %s",
			state.UUID(), status.ready.NodeUUID)
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Check the overseer sends a FULL status command when no instances are
// available
//
// Start the overseer with a high stats interval and maxInstances set to zero
// and send an ovsStatusCmd.  Shutdown the overseer.
//
// A ssntp.FULL status command should be received.  The overseer should shut
// down cleanly.
func TestFullStatus(t *testing.T) {
	defer func(instances int) { maxInstances = instances }(maxInstances)
	maxInstances = 0

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:        t,
		statusCh: make(chan *fakeStatus),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})
	select {
	case ovsCh <- &ovsStatusCmd{}:
	case <-time.After(time.Second):
		t.Fatal("Unable to send ovsStatusCmd")
	}

	var status *fakeStatus
	timer := time.After(time.Second)
DONE:
	for {
		select {
		case status = <-state.statusCh:
			break DONE
		case <-timer:
			t.Fatal("Timed out waiting for Status or Stats")
			break DONE
		}
	}

	if status.status != ssntp.FULL {
		t.Errorf("Expected a FULL status message")
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Check the overseer sends a MAINTENANCE status command when in maintenance
// mode.
//
// Start the overseer, send an ovsMaintenanceCmd command, followed by an
// ovsStatusCmd followed by ovsRestoreCommand followed by another ovsStatusCmd
// command.  Then shutdown the overseer.
//
// A ssntp.MAINTENANCE status command should be received for the first status
// command and a ssntp.READY command should be received for the second.  The
// overseer should shut down cleanly.
func TestMaintenanceStatus(t *testing.T) {
	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:        t,
		statusCh: make(chan *fakeStatus),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})

	mCh := make(chan struct{})
	rCh := make(chan struct{})

	for _, s := range []struct {
		doneCh chan struct{}
		status ssntp.Status
		cmd    interface{}
	}{
		{mCh, ssntp.MAINTENANCE, &ovsMaintenanceCmd{mCh}},
		{rCh, ssntp.READY, &ovsRestoreCmd{rCh}},
	} {
		select {
		case ovsCh <- s.cmd:
		case <-time.After(time.Second):
			t.Fatal("Unable to send ovsMaintenanceCmd")
		}

		select {
		case <-s.doneCh:
		case <-time.After(time.Second):
			t.Fatal("Timed out waiting for ovsMaintenanceCmd to complete")
		}

		select {
		case ovsCh <- &ovsStatusCmd{}:
		case <-time.After(time.Second):
			t.Fatal("Unable to send ovsStatusCmd")
		}

		var status *fakeStatus
		timer := time.After(time.Second)
		select {
		case status = <-state.statusCh:
		case <-timer:
			t.Fatal("Timed out waiting for status update from overseer")
		}

		if status.status != s.status {
			t.Errorf("Expected a %s status message", status.status)
		}
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Check we can add and delete an instance
//
// Start the overseer, send and ovsAddCmd, check the instance is reflected
// in the next stats command.  Send an ovsDeleteCmd, check the instance is
// no longer present in the next stats command.  Shutdown overseer.
//
// It should be possible to add and delete an instance and statistics sent
// by the overseer should be updated accordingly.
func TestAddDelete(t *testing.T) {
	diskLimit = false
	memLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:       t,
		statsCh: make(chan *payloads.Stat),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})

	_ = addInstance(t, ovsCh, state, false)
	_, stats := getStatusStats(t, ovsCh, state)
	if len(stats.Instances) != 1 {
		t.Errorf("1 instance expected.  Found: %d", len(stats.Instances))
	}

	_ = removeInstance(t, ovsCh, state, false)
	_, stats = getStatusStats(t, ovsCh, state)
	if len(stats.Instances) != 0 {
		t.Errorf("0 instances expected.  Found: %d", len(stats.Instances))
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Checks overseer detects initial instances
//
// Prepopulate the temporary instance directory with an instance and
// start the overseer.  Then wait for a stats command and shut down
// overseer.
//
// The overseer should start correctly and the stats command should
// indicate that there is one instance pending.  The overseer should
// shutdown correctly.
func TestInitialInstance(t *testing.T) {
	diskLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	createTestInstance(t, instancesDir)

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:       t,
		statsCh: make(chan *payloads.Stat),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Millisecond*300,
		fakeDeviceInfo{})

	timer := time.After(time.Second)
	var stats *payloads.Stat
DONE:
	for {
		select {
		case stats = <-state.statsCh:
			break DONE
		case <-timer:
			t.Fatal("Timed out waiting for Stats")
			break DONE
		}
	}

	if len(stats.Instances) != 1 && stats.Instances[0].InstanceUUID != "test-instance" {
		t.Error("Expected one running instance called test-instance")
	}

	close(ovsCh)
	wg.Wait()
}

// Check that the ovsGetCmd works correctly.
//
// Start the overseer and add an instance.  Then try to get the
// newly added instance.  Shut down the overseer.
//
// The newly added instance should be retrieved correctly.  It's state
// should be set to pending.
func TestGet(t *testing.T) {
	diskLimit = false
	memLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t: t,
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})

	_ = addInstance(t, ovsCh, state, false)

	getCh := make(chan ovsGetResult)
	select {
	case ovsCh <- &ovsGetCmd{
		instance: "test-instance",
		targetCh: getCh,
	}:
	case <-time.After(time.Second):
		t.Fatal("Unable to send ovsGetCmd")
	}

	timer := time.After(time.Second)

DONE:
	for {
		select {
		case getRes := <-getCh:
			if getRes.running != ovsPending {
				t.Error("Expected pending running state")
			}
			break DONE
		case <-timer:
			t.Fatal("Timed out waiting for get result")
			break DONE
		}
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Checks the ovsStatsStatus command works
//
// Start up the overseer, send an an ovsStatsStatusCmd and then wait for the
// events from the overseer.  Close down the overseer.
//
// A stats command and a status event should be received.  The overseer should
// shut down correctly.
func TestStatsStatus(t *testing.T) {
	diskLimit = false
	memLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:        t,
		statusCh: make(chan *fakeStatus),
		statsCh:  make(chan *payloads.Stat),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})

	status, stats := getStatusStats(t, ovsCh, state)
	if status.ready.NodeUUID != state.UUID() {
		t.Errorf("Unexpected UUID received for READY event, expected %s got %s",
			state.UUID(), status.ready.NodeUUID)
	}

	if len(stats.Instances) != 0 {
		t.Errorf("Zero instances expected.  Found %d", len(stats.Instances))
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}

// Check that the ovsStateChange command works correctly.
//
// Start the overseer, add an instance, set the instances state to
// running and then issue a statsStatusCommand.
//
// A stats command should be received for the instance and the state
// should be running.
func TestStateChange(t *testing.T) {
	diskLimit = false
	memLimit = false

	instancesDir, err := ioutil.TempDir("", "overseer-tests")
	if err != nil {
		t.Fatalf("Unable to create temporary directory")
	}
	defer func() { _ = os.RemoveAll(instancesDir) }()

	var wg sync.WaitGroup
	state := &overseerTestState{
		t:       t,
		statsCh: make(chan *payloads.Stat),
	}
	state.ac = &agentClient{conn: state, cmdCh: make(chan *cmdWrapper)}

	ovsCh := startOverseerFull(instancesDir, &wg, state.ac, time.Second*1000,
		fakeDeviceInfo{})

	_ = addInstance(t, ovsCh, state, false)

	select {
	case ovsCh <- &ovsStateChange{
		instance: "test-instance",
		state:    ovsRunning,
	}:
	case <-time.After(time.Second):
		t.Fatal("Unable to send ovsGetCmd")
	}

	_, stats := getStatusStats(t, ovsCh, state)
	if len(stats.Instances) != 1 && stats.Instances[0].State != payloads.Running {
		t.Error("Expected one running instance")
	}

	shutdownOverseer(ovsCh, state)
	wg.Wait()
}