Move server config string parsing to config package

Config string parsing functions moved to config package and made public
to be importable by other services (e.g., gin-doi) which may require
using client functions and configurations.  These will eventually be
moved to libgin.

Author: achilleas-k

ginclient/config/config.go

@@ -5,8 +5,11 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strconv"
+	"strings"
 
 	"github.com/G-Node/gin-cli/ginclient/log"
+	"github.com/G-Node/gin-cli/gincmd/ginerrors"
 	"github.com/fatih/color"
 	"github.com/shibukawa/configdir"
 	"github.com/spf13/viper"
@@ -249,6 +252,54 @@ func Path(create bool) (string, error) {
 
 // Util functions //
 
+// ParseWebString takes a string which contains all information about a
+// server's web configuration (e.g., https://gin.g-node.org:443) and returns a
+// WebCfg struct.
+func ParseWebString(webstring string) (WebCfg, error) {
+	var webconf WebCfg
+	errmsg := fmt.Sprintf("invalid web configuration line %s", webstring)
+	split := strings.SplitN(webstring, "://", 2)
+	if len(split) != 2 {
+		return webconf, fmt.Errorf("%s: %s", errmsg, ginerrors.MissingURLScheme)
+	}
+	webconf.Protocol = split[0]
+
+	split = strings.SplitN(split[1], ":", 2)
+	if len(split) != 2 {
+		return webconf, fmt.Errorf(errmsg)
+	}
+	port, err := strconv.ParseUint(split[1], 10, 16)
+	if err != nil {
+		return webconf, fmt.Errorf("%s: %s", errmsg, ginerrors.BadPort)
+	}
+	webconf.Host, webconf.Port = split[0], uint16(port)
+	return webconf, nil
+}
+
+// ParseGitString takes a string which contains all information about a
+// server's git configuration (e.g., [email protected]:22) and returns a
+// GitCfg struct.
+func ParseGitString(gitstring string) (GitCfg, error) {
+	var gitconf GitCfg
+	errmsg := fmt.Sprintf("invalid git configuration line %s", gitstring)
+	split := strings.SplitN(gitstring, "@", 2)
+	if len(split) != 2 {
+		return gitconf, fmt.Errorf("%s: %s", errmsg, ginerrors.MissingGitUser)
+	}
+	gitconf.User = split[0]
+
+	split = strings.SplitN(split[1], ":", 2)
+	if len(split) != 2 {
+		return gitconf, fmt.Errorf(errmsg)
+	}
+	port, err := strconv.ParseUint(split[1], 10, 16)
+	if err != nil {
+		return gitconf, fmt.Errorf("%s: %s", errmsg, ginerrors.BadPort)
+	}
+	gitconf.Host, gitconf.Port = split[0], uint16(port)
+	return gitconf, nil
+}
+
 // pathExists returns true if the path exists
 func pathExists(path string) bool {
 	if _, err := os.Stat(path); os.IsNotExist(err) {

gincmd/addservercmd.go

@@ -2,7 +2,6 @@ package gincmd
 
 import (
 	"fmt"
-	"strconv"
 	"strings"
 
 	"github.com/G-Node/gin-cli/ginclient/config"
@@ -40,46 +39,6 @@ func promptForGit() (gitconf config.GitCfg) {
 	return
 }
 
-func parseWebstring(webstring string) (webconf config.WebCfg) {
-	errmsg := fmt.Sprintf("invalid web configuration line %s", webstring)
-	split := strings.SplitN(webstring, "://", 2)
-	if len(split) != 2 {
-		Die(errmsg)
-	}
-	webconf.Protocol = split[0]
-
-	split = strings.SplitN(split[1], ":", 2)
-	if len(split) != 2 {
-		Die(errmsg)
-	}
-	port, err := strconv.ParseUint(split[1], 10, 16)
-	if err != nil {
-		Die(fmt.Sprintf("%s: %s", errmsg, ginerrors.BadPort))
-	}
-	webconf.Host, webconf.Port = split[0], uint16(port)
-	return
-}
-
-func parseGitstring(gitstring string) (gitconf config.GitCfg) {
-	errmsg := fmt.Sprintf("invalid git configuration line %s", gitstring)
-	split := strings.SplitN(gitstring, "@", 2)
-	if len(split) != 2 {
-		Die(errmsg)
-	}
-	gitconf.User = split[0]
-
-	split = strings.SplitN(split[1], ":", 2)
-	if len(split) != 2 {
-		Die(errmsg)
-	}
-	port, err := strconv.ParseUint(split[1], 10, 16)
-	if err != nil {
-		Die(fmt.Sprintf("%s: %s", errmsg, ginerrors.BadPort))
-	}
-	gitconf.Host, gitconf.Port = split[0], uint16(port)
-	return
-}
-
 func addHostKey(gitconf *config.GitCfg) {
 	hostkeystr, fingerprint, err := git.GetHostKey(*gitconf)
 	CheckError(err)
@@ -115,22 +74,25 @@ func addServer(cmd *cobra.Command, args []string) {
 
 	serverConf := config.ServerCfg{}
 
+	var err error
 	if webstring == "" {
 		serverConf.Web = promptForWeb()
 	} else {
-		serverConf.Web = parseWebstring(webstring)
+		serverConf.Web, err = config.ParseWebString(webstring)
+		CheckError(err)
 	}
 
 	if gitstring == "" {
 		serverConf.Git = promptForGit()
 	} else {
-		serverConf.Git = parseGitstring(gitstring)
+		serverConf.Git, err = config.ParseGitString(gitstring)
+		CheckError(err)
 	}
 
 	addHostKey(&serverConf.Git)
 
 	// Save to config
-	err := config.AddServerConf(alias, serverConf)
+	err = config.AddServerConf(alias, serverConf)
 	if err != nil {
 		Die("failed to update configuration file")
 	}

gincmd/ginerrors/errors.go

@@ -9,4 +9,10 @@ const (
 
 	// BadPort is returned when a port number is outside the valid range (1..65535)
 	BadPort = "port must be between 0 and 65535 (inclusive)"
+
+	// MissingURLScheme is returned when a string is assumed to be a URL but does not contain a scheme (missing ://)
+	MissingURLScheme = "could not determine protocol scheme (no ://)"
+
+	// MissingGitUser is returned when a string is assumed to be a git configuration but does not contain a user (missing @)
+	MissingGitUser = "could not determine git username (no @)"
 )