Add SplitLines helper to pkg/strings

We have 2 duplicate implementations of this code.
It's renamed to 'Split' instead of 'Parse' to be more consistent with
other go APIs.

Author: cfergeau

pkg/crc/services/dns/dns_windows.go

@@ -1,9 +1,7 @@
 package dns
 
 import (
-	"bufio"
 	"fmt"
-	"strings"
 	"time"
 
 	"github.com/crc-org/crc/pkg/crc/network"
@@ -41,7 +39,7 @@ func getInterfaceNameserverValues(iface string) []string {
 	getDNSServerCommand := fmt.Sprintf(`(Get-DnsClientServerAddress "%s")[0].ServerAddresses`, iface)
 	stdOut, _, _ := powershell.Execute(getDNSServerCommand)
 
-	return parseLines(stdOut)
+	return crcstrings.SplitLines(stdOut)
 }
 
 func setInterfaceNameserverValue(iface string, address string) {
@@ -51,14 +49,3 @@ func setInterfaceNameserverValue(iface string, address string) {
 	// ignore the error as this is useless (prefer not to use nolint here)
 	_ = win32.ShellExecuteAsAdmin(fmt.Sprintf("add dns server address to interface %s", iface), win32.HwndDesktop, exe, args, "", 0)
 }
-
-func parseLines(input string) []string {
-	output := []string{}
-
-	s := bufio.NewScanner(strings.NewReader(input))
-	for s.Scan() {
-		output = append(output, s.Text())
-	}
-
-	return output
-}

pkg/drivers/hyperv/hyperv_windows.go

@@ -12,6 +12,7 @@ import (
 	log "github.com/crc-org/crc/pkg/crc/logging"
 	crcos "github.com/crc-org/crc/pkg/os"
 	"github.com/crc-org/crc/pkg/os/windows/powershell"
+	crcstrings "github.com/crc-org/crc/pkg/strings"
 	"github.com/crc-org/machine/libmachine/drivers"
 	"github.com/crc-org/machine/libmachine/state"
 )
@@ -93,7 +94,7 @@ func (d *Driver) GetState() (state.State, error) {
 		return state.Error, fmt.Errorf("Failed to find the VM status: %v - %s", err, stderr)
 	}
 
-	resp := parseLines(stdout)
+	resp := crcstrings.SplitLines(stdout)
 	if len(resp) < 1 {
 		return state.Error, fmt.Errorf("unexpected Hyper-V state %s", stdout)
 	}
@@ -256,7 +257,7 @@ func (d *Driver) chooseVirtualSwitch() (string, error) {
 		return "", err
 	}
 
-	switches := parseLines(stdout)
+	switches := crcstrings.SplitLines(stdout)
 
 	found := false
 	for _, name := range switches {
@@ -397,7 +398,7 @@ func (d *Driver) GetIP() (string, error) {
 		return "", err
 	}
 
-	resp := parseLines(stdout)
+	resp := crcstrings.SplitLines(stdout)
 	if len(resp) < 1 {
 		return "", fmt.Errorf("IP not found")
 	}

pkg/drivers/hyperv/powershell_windows.go

@@ -1,13 +1,12 @@
 package hyperv
 
 import (
-	"bufio"
 	"errors"
 	"fmt"
-	"strings"
 
 	log "github.com/crc-org/crc/pkg/crc/logging"
 	"github.com/crc-org/crc/pkg/os/windows/powershell"
+	crcstrings "github.com/crc-org/crc/pkg/strings"
 )
 
 var (
@@ -26,24 +25,13 @@ func cmd(args ...string) error {
 	return err
 }
 
-func parseLines(stdout string) []string {
-	resp := []string{}
-
-	s := bufio.NewScanner(strings.NewReader(stdout))
-	for s.Scan() {
-		resp = append(resp, s.Text())
-	}
-
-	return resp
-}
-
 func hypervAvailable() error {
 	stdout, err := cmdOut("@(Get-Module -ListAvailable hyper-v).Name | Get-Unique")
 	if err != nil {
 		return err
 	}
 
-	resp := parseLines(stdout)
+	resp := crcstrings.SplitLines(stdout)
 	if resp[0] != "Hyper-V" {
 		return ErrNotInstalled
 	}
@@ -74,7 +62,7 @@ func isHypervAdministrator() bool {
 		return false
 	}
 
-	resp := parseLines(stdout)
+	resp := crcstrings.SplitLines(stdout)
 	return resp[0] == "True"
 }
 
@@ -84,7 +72,7 @@ func isWindowsAdministrator() (bool, error) {
 		return false, err
 	}
 
-	resp := parseLines(stdout)
+	resp := crcstrings.SplitLines(stdout)
 	return resp[0] == "True", nil
 }
 

pkg/strings/strings.go

@@ -1,5 +1,10 @@
 package strings
 
+import (
+	"bufio"
+	"strings"
+)
+
 func Contains(input []string, match string) bool {
 	for _, v := range input {
 		if v == match {
@@ -8,3 +13,15 @@ func Contains(input []string, match string) bool {
 	}
 	return false
 }
+
+// Split a multi line string in an array of string, one for each line
+func SplitLines(input string) []string {
+	output := []string{}
+
+	s := bufio.NewScanner(strings.NewReader(input))
+	for s.Scan() {
+		output = append(output, s.Text())
+	}
+
+	return output
+}

pkg/strings/strings_test.go

@@ -50,3 +50,46 @@ func TestContains(t *testing.T) {
 		}
 	})
 }
+
+type splitLinesTest struct {
+	input       string
+	splitOutput []string
+}
+
+var splitLinesTests = map[string]splitLinesTest{
+	"ThreeLines": {
+		input:       "line1\nline2\nline3\n",
+		splitOutput: []string{"line1", "line2", "line3"},
+	},
+	"ThreeLinesNoFinalEOL": {
+		input:       "line1\nline2\nline3",
+		splitOutput: []string{"line1", "line2", "line3"},
+	},
+	"WindowsEOL": {
+		input:       "line1\r\nline2\r\nline3\r\n",
+		splitOutput: []string{"line1", "line2", "line3"},
+	},
+	"EmptyString": {
+		input:       "",
+		splitOutput: []string{},
+	},
+	"EOLOnly": {
+		input:       "\n",
+		splitOutput: []string{""},
+	},
+	"NoEOL": {
+		input:       "line1",
+		splitOutput: []string{"line1"},
+	},
+}
+
+func TestSplitLines(t *testing.T) {
+	t.Run("SplitLines", func(t *testing.T) {
+		for name, test := range splitLinesTests {
+			t.Run(name, func(t *testing.T) {
+				output := SplitLines(test.input)
+				assert.Equal(t, test.splitOutput, output)
+			})
+		}
+	})
+}