replace special characters in qm name (#524)

Author: ShashikanthRaoT

cmd/runmqserver/qmgr.go

@@ -61,7 +61,7 @@ func createQueueManager(name string, devMode bool) (bool, error) {
 		return false, err
 	}
 
-	dataDir := getQueueManagerDataDir(mounts, name)
+	dataDir := getQueueManagerDataDir(mounts, replaceCharsInQMName(name))
 
 	// Run 'dspmqinf' to check if 'mqs.ini' configuration file exists
 	// If command succeeds, the queue manager (or standby queue manager) has already been created
@@ -316,7 +316,7 @@ func updateQMini(qmname string) error {
 		log.Printf("Error getting mounts for queue manager")
 		return err
 	}
-	dataDir := getQueueManagerDataDir(mounts, qmname)
+	dataDir := getQueueManagerDataDir(mounts, replaceCharsInQMName(qmname))
 	qmgrDir := filepath.Join(dataDir, "qm.ini")
 	//read the initial version.
 	// #nosec G304 - qmgrDir filepath is derived from dspmqinf
@@ -337,3 +337,17 @@ func updateQMini(qmname string) error {
 	}
 	return nil
 }
+
+// If queue manager name contains a '.', then the '.' will be replaced with '!'
+// in the name of the data directory created by the queue manager. Similarly
+// '/' will be replaced with '&'.
+func replaceCharsInQMName(qmname string) string {
+	replacedName := qmname
+	if strings.Contains(replacedName, ".") {
+		replacedName = strings.ReplaceAll(replacedName, ".", "!")
+	}
+	if strings.Contains(replacedName, "/") {
+		replacedName = strings.ReplaceAll(replacedName, "/", "&")
+	}
+	return replacedName
+}

cmd/runmqserver/qmgr_test.go

@@ -17,6 +17,7 @@ package main
 
 import (
 	"io/ioutil"
+	"strings"
 	"testing"
 )
 
@@ -84,3 +85,38 @@ func Test_validateLogFilePageSetting(t *testing.T) {
 		})
 	}
 }
+
+// Unit test for special character in queue manager names
+func Test_SpecialCharInQMNameReplacements(t *testing.T) {
+	type qmNames struct {
+		qmName         string
+		replacedQMName string
+	}
+
+	tests := []qmNames{
+		{
+			qmName:         "QM.",
+			replacedQMName: "QM!",
+		}, {
+			qmName:         "QM/",
+			replacedQMName: "QM&",
+		},
+		{
+			qmName:         "QM.GR.NAME",
+			replacedQMName: "QM!GR!NAME",
+		}, {
+			qmName:         "QM/GR/NAME",
+			replacedQMName: "QM&GR&NAME",
+		}, {
+			qmName:         "QMGRNAME",
+			replacedQMName: "QMGRNAME",
+		},
+	}
+
+	for _, test := range tests {
+		replacedQMName := replaceCharsInQMName(test.qmName)
+		if !strings.EqualFold(replacedQMName, test.replacedQMName) {
+			t.Fatalf("QMName replacement failed. Expected %s but got %s\n", test.replacedQMName, replacedQMName)
+		}
+	}
+}