Reset

config/endpoint/ssh/ssh.go

@@ -0,0 +1,33 @@
+package ssh
+
+import (
+	"errors"
+)
+
+var (
+	// ErrEndpointWithoutSSHUsername is the error with which Gatus will panic if an endpoint with SSH monitoring is configured without a user.
+	ErrEndpointWithoutSSHUsername = errors.New("you must specify a username for each SSH endpoint")
+
+	// ErrEndpointWithoutSSHPassword is the error with which Gatus will panic if an endpoint with SSH monitoring is configured without a password.
+	ErrEndpointWithoutSSHPassword = errors.New("you must specify a password for each SSH endpoint")
+)
+
+type Config struct {
+	Username string `yaml:"username,omitempty"`
+	Password string `yaml:"password,omitempty"`
+}
+
+// Validate the SSH configuration
+func (cfg *Config) Validate() error {
+	// If there's no username and password, this endpoint can still check the SSH banner, so the endpoint is still valid
+	if len(cfg.Username) == 0 && len(cfg.Password) == 0 {
+		return nil
+	}
+	if len(cfg.Username) == 0 {
+		return ErrEndpointWithoutSSHUsername
+	}
+	if len(cfg.Password) == 0 {
+		return ErrEndpointWithoutSSHPassword
+	}
+	return nil
+}

config/endpoint/ssh/ssh_test.go

@@ -0,0 +1,23 @@
+package ssh
+
+import (
+	"errors"
+	"testing"
+)
+
+func TestSSH_validate(t *testing.T) {
+	cfg := &Config{}
+	if err := cfg.Validate(); err != nil {
+		t.Error("didn't expect an error")
+	}
+	cfg.Username = "username"
+	if err := cfg.Validate(); err == nil {
+		t.Error("expected an error")
+	} else if !errors.Is(err, ErrEndpointWithoutSSHPassword) {
+		t.Errorf("expected error to be '%v', got '%v'", ErrEndpointWithoutSSHPassword, err)
+	}
+	cfg.Password = "password"
+	if err := cfg.Validate(); err != nil {
+		t.Errorf("expected no error, got '%v'", err)
+	}
+}