export_test.go

//
// Copyright (c) 2015, Arista Networks, Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//   * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
//   * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
//   * Neither the name of Arista Networks nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ARISTA NETWORKS
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
// BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
// IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
package goeapi

import (
	"encoding/json"
	"fmt"
	"io"
	"io/ioutil"
	"math/rand"
	"os"
	"path"
	"runtime"
	"testing"
	"time"
)

const checkMark = "\u2713"
const xMark = "\u2717"

var fixturesPath = ""

func init() {
	_, filename, _, _ := runtime.Caller(1)
	fixturesPath = path.Join(path.Dir(filename), "./testdata/fixtures")

	rand.Seed(time.Now().UTC().UnixNano())
}

/*
 ****************************************************************************
 *
 * DummyEapiConnection is a Dummy connection object that adheres to the
 * EapiConnection Inteface. The Execute() method below (currently) returns
 * a non-error with allocated JSONRPCResponse so the upper layer API can
 * be tested. Commands received by this DummyConnection are cached and retreived
 * to compare to what would be sent.
 *
 * Note:
 *		Execute() clears the the previous cached list of commands and replaces
 *		with current command list.
 *
 ****************************************************************************
 */
type DummyEapiConnection struct {
	EapiConnection
	Commands []interface{}
	retError bool
}

func NewDummyEapiConnection(transport string, host string, username string,
	password string, port int) *DummyEapiConnection {
	conn := EapiConnection{}
	return &DummyEapiConnection{EapiConnection: conn, retError: false}
}

func (conn *DummyEapiConnection) Execute(commands []interface{},
	encoding string) (*JSONRPCResponse, error) {
	if conn.retError {
		conn.retError = false
		err := fmt.Errorf("Mock Error")
		conn.SetError(err)
		return &JSONRPCResponse{}, err
	}
	conn.ClearError()
	conn.Commands = nil
	conn.Commands = append(conn.Commands, commands...)
	resp := &JSONRPCResponse{
		Result: make([]map[string]interface{}, len(commands)),
	}

	if encoding == "json" {
		return resp, nil
	}

	for idx := range resp.Result {
		resp.Result[idx] = make(map[string]interface{})
		resp.Result[idx]["output"] = ""
	}

	if encoding == "text" && len(commands) >= 2 &&
		(commands[1] == "show running-config all" ||
			commands[1] == "show startup-config") {
		resp.Result[1]["output"] = LoadFixtureFile("running_config.text")
	}

	return resp, nil
}

func (conn *DummyEapiConnection) setReturnError(enable bool) {
	conn.retError = enable
}

func (conn *DummyEapiConnection) decodeJSONFile(r io.Reader) *JSONRPCResponse {
	dec := json.NewDecoder(r)
	var v JSONRPCResponse
	if err := dec.Decode(&v); err != nil {
		panic(err)
	}
	return &v
}

// Retreive the cached list of commands from the connection.
func (conn *DummyEapiConnection) GetCommands() []interface{} {
	return conn.Commands
}

var runConf string
var dummyNode *Node
var dummyConnection *DummyEapiConnection
var duts []*Node

// Setup/Teardown
func TestMain(m *testing.M) {
	runConf = GetFixture("running_config.text")
	LoadConfig(GetFixture("dut.conf"))
	conns := Connections()
	fmt.Println("Connections: ", conns)
	for _, name := range conns {
		if name != "localhost" {
			node, _ := ConnectTo(name)
			duts = append(duts, node)
		}
	}
	// Create a Node with a DummyConnection to be used in
	// UnitTests.
	dummyConnection = NewDummyEapiConnection("", "", "", "", 0)
	dummyNode = &Node{}
	dummyNode.SetAutoRefresh(false)
	dummyNode.SetConnection(dummyConnection)

	os.Exit(m.Run())
}

// GetFixturesPath aquires the global fixtures path
func GetFixturesPath() string {
	return fixturesPath
}

// GetFixture returns the full path to filenmae within
// fixtures
func GetFixture(filename string) string {
	return path.Join(fixturesPath, filename)
}

// LoadFixtureFile reads the fixtures file into a string.
func LoadFixtureFile(file string) string {
	if data, err := ioutil.ReadFile(GetFixture(file)); err == nil {
		return string(data)
	}
	return ""
}

// RandomInt randomly creates a int between
// min and max
func RandomInt(min int, max int) int {
	return min + rand.Intn(max-min)
}

const charBytes = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

// RandomString randomly creates a string within the
// range of minchar to maxchar
func RandomString(minchar int, maxchar int) string {
	size := RandomInt(minchar, maxchar)
	bytes := make([]byte, size)
	for i := 0; i < size; i++ {
		bytes[i] = charBytes[rand.Intn(len(charBytes)-1)]
	}
	return string(bytes)
}