Merge pull request #11 from aristanetworks/release-v0.2.0

Release v0.2.0

Author: cheynearista

.travis.yml

@@ -1,10 +1,9 @@
 language: go
 go:
-  - 1.5.1
+  - 1.7.3
 before_install:
   - go get golang.org/x/tools/cmd/cover
   - go get github.com/golang/lint/golint
-  - go get golang.org/x/tools/cmd/vet
 install:
   - go list ./... | grep -v examples | go get
 before_script:

CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
-## 0.1.0 (2015-11-11)
+## v0.1.0 (2015-11-11)
 
 Initial public release
 
 - Add documentation
 - Add unit tests
+
+## v0.2.0 (2016-12-15)
+
+**Implemented enhancements:**
+- Add unix socket support [\#4](https://github.com/aristanetworks/goeapi/issues/4)
+- Add support for Connect Timeout [\#2]( https://github.com/aristanetworks/goeapi/issues/2)
+
+
+**Fixed Bugs:**
+- Bump up travis to go1.7 [\#10](https://github.com/aristanetworks/goeapi/issues/10)
+- Url endpoint shouldn't terminate in '/' [\#8]( https://github.com/aristanetworks/goeapi/issues/8)
+- Fix examples and vet issues [\#6]( https://github.com/aristanetworks/goeapi/issues/6)

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2015, Arista Networks
+Copyright (c) 2015-2016, Arista Networks
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -93,6 +93,7 @@ The following configuration options are available for defining node entries:
 * **transport** - Configures the type of transport connection to use.  The default value is _https_.  Valid values are:
   * http
   * https
+  * socket
 * **port** - Configures the port to use for the eAPI connection. (Currently Not Implemented)
 
 _Note:_ See the EOS User Manual found at arista.com for more details on configuring eAPI values.
@@ -321,15 +322,16 @@ corresponding test cases otherwise the pull request will be rejected.
 
 # License
 
-Copyright (c) 2015, Arista Networks, Inc. All rights reserved.
+Copyright (c) 2015-2016, 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 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.
+* 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.
+* 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.
 

client.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2015, Arista Networks, Inc.
+// Copyright (c) 2015-2016, Arista Networks, Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -44,6 +44,12 @@ import (
 	"github.com/vaughan0/go-ini"
 )
 
+//
+const (
+	RunningConfig = "running-config"
+	StartupConfig = "startup-config"
+)
+
 // A Node represents a single device for sending and receiving eAPI messages
 //
 // Node provides an instance for communicating with Arista EOS
@@ -111,7 +117,7 @@ func (n *Node) RunningConfig() string {
 	if n.runningConfig != "" {
 		return n.runningConfig
 	}
-	n.runningConfig, _ = n.GetConfig("running-config", "all")
+	n.runningConfig, _ = n.GetConfig(RunningConfig, "all")
 	return n.runningConfig
 }
 
@@ -124,7 +130,7 @@ func (n *Node) StartupConfig() string {
 	if n.startupConfig != "" {
 		return n.startupConfig
 	}
-	n.startupConfig, _ = n.GetConfig("startup-config", "")
+	n.startupConfig, _ = n.GetConfig(StartupConfig, "")
 	return n.startupConfig
 }
 
@@ -184,7 +190,7 @@ func (n *Node) GetHandle(encoding string) (*EapiReqHandle, error) {
 // Returns:
 //  Will return a string of the config requested or error if failure
 func (n *Node) GetConfig(config string, params string) (string, error) {
-	if config != "running-config" && config != "startup-config" {
+	if config != RunningConfig && config != StartupConfig {
 		return "", fmt.Errorf("Invalid config type: %s", config)
 	}
 	commands := []string{strings.TrimSpace("show " + config + " " + params)}
@@ -208,11 +214,11 @@ func (n *Node) GetConfig(config string, params string) (string, error) {
 //  Error returned on failure.
 func (n *Node) GetSection(regex string, config string) (string, error) {
 	var params string
-	if config == "" || config == "running-config" {
-		config = "running-config"
+	if config == "" || config == RunningConfig {
+		config = RunningConfig
 		params = "all"
 	}
-	if config != "running-config" && config != "startup-config" {
+	if config != RunningConfig && config != StartupConfig {
 		return "", fmt.Errorf("Invalid config type: %s", config)
 	}
 	sectionRegex, err := regexp.Compile(regex)
@@ -593,8 +599,7 @@ func (e *EapiConfig) AddConnection(name string) ini.Section {
 // This method wil load the connection:localhost profile into the client
 // configuration if it is not already present.
 func (e *EapiConfig) addDefaultConnection() {
-	name := "localhost"
-	conn := e.GetConnection(name)
+	conn := e.GetConnection("localhost")
 	if conn == nil {
 		e.AddConnection("localhost")["transport"] = "socket"
 	}

client_test.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2015, Arista Networks, Inc.
+// Copyright (c) 2015-2016, Arista Networks, Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -459,6 +459,21 @@ func TestClientConnectInvalidTransport_UnitTest(t *testing.T) {
 	}
 }
 
+func TestClientConnectTimeout_UnitTest(t *testing.T) {
+	node := &Node{}
+
+	// 1.1.1.2 is assumed to be an unreachable bogus address
+	conn, err := Connect("http", "1.1.1.2", "admin", "admin", 80)
+	if err != nil {
+		t.Fatal("Error in connect.")
+	}
+	conn.SetTimeout(5)
+	node.SetConnection(conn)
+	if _, err = node.GetConfig("running-config", "all"); err == nil {
+		t.Fatal("Should timeout and return error")
+	}
+}
+
 func TestClientNodeEnablePasswd_UnitTest(t *testing.T) {
 	node := &Node{}
 	node.EnableAuthentication("root")
@@ -545,7 +560,7 @@ func TestClientNodeGetSection_SystemTest(t *testing.T) {
 		if found := re.MatchString(section); !found {
 			t.Fatalf("Failed to obtain section from startup-config")
 		}
-		section, err = dut.GetSection(invalidRegexp, "startup-config")
+		_, err = dut.GetSection(invalidRegexp, "startup-config")
 		if err == nil {
 			t.Fatalf("Invalid regexp didn't fail")
 		}

eapi.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2015, Arista Networks, Inc.
+// Copyright (c) 2015-2016, Arista Networks, Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without

eapi_test.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2015, Arista Networks, Inc.
+// Copyright (c) 2015-2016, Arista Networks, Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without