[UNW-177] CLI should create SSH config if it does not exist (#9)

caldempsey · web-flow · commit 7ecea6526cab · 2023-05-22T16:23:24.000+01:00
diff --git a/ssh/config.go b/ssh/config.go
@@ -16,6 +16,17 @@ func getUnweaveSSHConfigPath() string {
 	return filepath.Join(config.GetGlobalConfigPath(), "ssh_config")
 }
 
+var sshDirPath = func() string {
+	homeDir, err := os.UserHomeDir()
+	if err != nil {
+		ui.Errorf("Failed to get user home directory: %v", err)
+		os.Exit(1)
+	}
+	return filepath.Join(homeDir, ".ssh")
+}()
+
+var sshConfigPath = filepath.Join(sshDirPath, "config")
+
 func AddHost(alias, host, user string, port int, identityFile string) error {
 	configEntry := fmt.Sprintf(`Host %s
     HostName %s
@@ -43,13 +54,16 @@ func AddHost(alias, host, user string, port int, identityFile string) error {
 		return err
 	}
 
-	home, err := os.UserHomeDir()
+	// Add an Include directive to the user's ssh config to unweave_global SSH configs - used for vscode-remote:
+	err = os.MkdirAll(sshDirPath, 0700)
 	if err != nil {
-		ui.Errorf("Failed to get user home directory: %v", err)
-		os.Exit(1)
+		fmt.Println("Failed to create .ssh folder:", err)
+	}
+	if _, err := os.Stat(sshConfigPath); os.IsNotExist(err) {
+		if _, err = os.Create(sshConfigPath); err != nil {
+			return err
+		}
 	}
-	sshConfigPath := filepath.Join(home, ".ssh", "config")
-
 	lines, err := readLines(sshConfigPath)
 	if err != nil {
 		return err
diff --git a/ssh/config_test.go b/ssh/config_test.go
@@ -0,0 +1,53 @@
+package ssh
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	. "github.com/franela/goblin"
+)
+
+func TestConfig(t *testing.T) {
+	g := Goblin(t)
+
+	g.Describe("AddHost", func() {
+		testCfgPath := filepath.Join(sshDirPath, "test_config")
+		unweaveConfigPath := getUnweaveSSHConfigPath()
+
+		g.BeforeEach(func() {
+			if _, err := os.Stat(testCfgPath); os.IsNotExist(err) {
+				initialConfig := "# Test SSH Config\n"
+				err = ioutil.WriteFile(testCfgPath, []byte(initialConfig), 0600)
+				g.Assert(err).Equal(nil)
+			}
+
+			sshConfigPath = testCfgPath
+		})
+
+		g.AfterEach(func() {
+			// Only perform create and destroy operations on the test config file
+			if testCfgPath != sshConfigPath {
+				return
+			}
+
+			err := os.Remove(testCfgPath)
+			g.Assert(err).Equal(nil)
+		})
+
+		g.It("should add the Include directive to the .ssh/config file", func() {
+			err := AddHost("example", "example.com", "user", 22, "")
+			g.Assert(err).Equal(nil)
+
+			configData, err := ioutil.ReadFile(sshConfigPath)
+			g.Assert(err).Equal(nil)
+
+			configContent := string(configData)
+			expectedInclude := "Include " + unweaveConfigPath
+
+			g.Assert(strings.Contains(configContent, expectedInclude)).Equal(true)
+		})
+	})
+}
