feat: replace errors with custom errors

d-strobel · Nov 14, 2023 · 076099c · 076099c
1 parent f4935f3
commit 076099c
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 20 deletions.
diff --git a/connection/connection.go b/connection/connection.go
@@ -30,10 +30,10 @@ func New(conf *Config) (*Connection, error) {
 
 	// Assert WinRM and SSH configuration
 	if conf.WinRM == nil && conf.SSH == nil {
-		return nil, winerror.Errorf(winerror.ConfigError, "Connection: object 'WinRMConfig' or 'SSHConfig' must be set")
+		return nil, winerror.Errorf(winerror.ConfigError, "connection client: Connection object 'WinRMConfig' or 'SSHConfig' must be set")
 	}
 	if conf.WinRM != nil && conf.SSH != nil {
-		return nil, winerror.Errorf(winerror.ConfigError, "Connection: object must only contain 'WinRMConfig' or 'SSHConfig'")
+		return nil, winerror.Errorf(winerror.ConfigError, "connection client: Connection object must only contain 'WinRMConfig' or 'SSHConfig'")
 	}
 
 	// Allocate a new Connection
@@ -43,7 +43,7 @@ func New(conf *Config) (*Connection, error) {
 	if conf.WinRM != nil {
 		winRMClient, err := newWinRMClient(conf.WinRM)
 		if err != nil {
-			return nil, winerror.Errorf(winerror.ConnectionError, "WinRM: %s", err)
+			return nil, err
 		}
 
 		c = &Connection{
@@ -55,7 +55,7 @@ func New(conf *Config) (*Connection, error) {
 	if conf.SSH != nil {
 		sshClient, err := newSSHClient(conf.SSH)
 		if err != nil {
-			return nil, winerror.Errorf(winerror.ConnectionError, "SSH: %s", err)
+			return nil, err
 		}
 
 		c = &Connection{
@@ -71,7 +71,7 @@ func (c *Connection) Close() error {
 	if c.SSH != nil {
 		err := c.SSH.Close()
 		if err != nil {
-			return winerror.Errorf(winerror.ConnectionError, "Connection: %s", err)
+			return winerror.Errorf(winerror.ConnectionError, "connection client: %s", err)
 		}
 	}
 

diff --git a/connection/connection_test.go b/connection/connection_test.go
@@ -13,7 +13,7 @@ func TestNewConnectionErrorMessages(t *testing.T) {
 		_, err := New(conf)
 
 		assert.Error(t, err)
-		assert.Contains(t, err.Error(), "Connection: object 'WinRMConfig' or 'SSHConfig' must be set")
+		assert.Contains(t, err.Error(), "connection client: Connection object 'WinRMConfig' or 'SSHConfig' must be set")
 	})
 
 	t.Run("Error - Both WinRM and SSH", func(t *testing.T) {
@@ -37,6 +37,6 @@ func TestNewConnectionErrorMessages(t *testing.T) {
 		_, err := New(conf)
 
 		assert.Error(t, err)
-		assert.Contains(t, err.Error(), "Connection: object must only contain 'WinRMConfig' or 'SSHConfig'")
+		assert.Contains(t, err.Error(), "connection client: Connection object must only contain 'WinRMConfig' or 'SSHConfig'")
 	})
 }
diff --git a/connection/ssh.go b/connection/ssh.go
@@ -2,10 +2,10 @@ package connection
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"io"
 
+	"github.com/d-strobel/gowindows/winerror"
 	"golang.org/x/crypto/ssh"
 )
 
@@ -25,7 +25,7 @@ func newSSHClient(config *SSHConfig) (*ssh.Client, error) {
 
 	// Assert
 	if config.SSHHost == "" || config.SSHUsername == "" || config.SSHPassword == "" {
-		return nil, errors.New("SSHHost, SSHUsername, and SSHPassword must be set")
+		return nil, winerror.Errorf(winerror.ConfigError, "ssh client: SSHConfig parameter 'SSHHost', 'SSHUsername' and 'SSHPassword' must be set")
 	}
 
 	// Parse ssh host string
@@ -44,7 +44,7 @@ func newSSHClient(config *SSHConfig) (*ssh.Client, error) {
 	// Connect to the remote server and perform the SSH handshake.
 	client, err := ssh.Dial("tcp", sshHost, sshConfig)
 	if err != nil {
-		return nil, err
+		return nil, winerror.Errorf(winerror.ConnectionError, "ssh client: %s", err)
 	}
 
 	return client, nil

diff --git a/connection/ssh_test.go b/connection/ssh_test.go
@@ -2,6 +2,8 @@ package connection
 
 import (
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestNewSSHClient(t *testing.T) {
@@ -17,9 +19,6 @@ func TestNewSSHClient(t *testing.T) {
 			t.Error("Expected a nil SSH client, but got non-nil")
 		}
 
-		expectedErrorMsg := "SSHHost, SSHUsername, and SSHPassword must be set"
-		if err.Error() != expectedErrorMsg {
-			t.Errorf("Expected error message '%s', but got '%s'", expectedErrorMsg, err.Error())
-		}
+		assert.Contains(t, err.Error(), "ssh client: SSHConfig parameter 'SSHHost', 'SSHUsername' and 'SSHPassword' must be set")
 	})
 }
diff --git a/connection/winrm.go b/connection/winrm.go
@@ -1,9 +1,9 @@
 package connection
 
 import (
-	"errors"
 	"time"
 
+	"github.com/d-strobel/gowindows/winerror"
 	"github.com/masterzen/winrm"
 )
 
@@ -31,7 +31,7 @@ func newWinRMClient(config *WinRMConfig) (*winrm.Client, error) {
 
 	// Assert
 	if config.WinRMHost == "" || config.WinRMUsername == "" || config.WinRMPassword == "" {
-		return nil, errors.New("WinRMHost, WinRMUsername, and WinRMPassword must be set")
+		return nil, winerror.Errorf(winerror.ConfigError, "winrm client: WinRMConfig parameter 'WinRMHost', 'WinRMUsername', and 'WinRMPassword' must be set")
 	}
 
 	// Set default values

diff --git a/connection/winrm_test.go b/connection/winrm_test.go
@@ -2,6 +2,8 @@ package connection
 
 import (
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestNewWinRMClient(t *testing.T) {
@@ -41,10 +43,7 @@ func TestNewWinRMClient(t *testing.T) {
 			t.Error("Expected a nil client, but got non-nil")
 		}
 
-		expectedErrorMsg := "WinRMHost, WinRMUsername, and WinRMPassword must be set"
-		if err.Error() != expectedErrorMsg {
-			t.Errorf("Expected error message '%s', but got '%s'", expectedErrorMsg, err.Error())
-		}
+		assert.Contains(t, err.Error(), "winrm client: WinRMConfig parameter 'WinRMHost', 'WinRMUsername', and 'WinRMPassword' must be set")
 	})
 }