first commit

pkg/mqini/dspmqinf1.txt

@@ -0,0 +1,5 @@
+QueueManager:
+   Name=foo
+   Directory=foo
+   Prefix=/var/mqm
+   InstallationName=Installation1

pkg/mqini/dspmqinf2.txt

@@ -0,0 +1,5 @@
+QueueManager:
+   Name=a/b
+   Directory=a&b
+   Prefix=/var/mqm
+   InstallationName=Installation1

pkg/mqini/dspmqinf3.txt

@@ -0,0 +1,5 @@
+QueueManager:
+   Name=..
+   Directory=!!
+   Prefix=/var/mqm
+   InstallationName=Installation1

pkg/mqini/mqini.go

@@ -0,0 +1,92 @@
+/*
+© Copyright IBM Corporation 2018, 2023
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package mqini provides information about queue managers
+package mqini
+
+import (
+	"bufio"
+	"errors"
+	"os"
+	"strings"
+
+	"github.com/ibm-messaging/mq-container/internal/command"
+	"github.com/ibm-messaging/mq-container/internal/pathutils"
+)
+
+// QueueManager describe high-level configuration information for a queue manager
+type QueueManager struct {
+	Name             string
+	Prefix           string
+	Directory        string
+	DataPath         string
+	InstallationName string
+}
+
+// getQueueManagerFromStanza parses a queue manager stanza
+func getQueueManagerFromStanza(stanza string) (*QueueManager, error) {
+	scanner := bufio.NewScanner(strings.NewReader(stanza))
+	qm := QueueManager{}
+	for scanner.Scan() {
+		l := scanner.Text()
+		l = strings.TrimSpace(l)
+		t := strings.Split(l, "=")
+		switch t[0] {
+		case "Name":
+			qm.Name = t[1]
+		case "Prefix":
+			qm.Prefix = t[1]
+		case "Directory":
+			qm.Directory = t[1]
+		case "DataPath":
+			qm.DataPath = t[1]
+		case "InstallationName":
+			qm.InstallationName = t[1]
+		}
+	}
+	return &qm, scanner.Err()
+}
+
+// GetQueueManager returns queue manager configuration information
+func GetQueueManager(name string) (*QueueManager, error) {
+	_, err := os.Stat("/var/mqm/mqs.ini")
+	if err != nil {
+		// Don't run dspmqinf, which will generate an FDC if mqs.ini isn't there yet
+		return nil, errors.New("dspmqinf should not be run before crtmqdir")
+	}
+	// dspmqinf essentially returns a subset of mqs.ini, but it's simpler to parse
+	out, _, err := command.Run("dspmqinf", "-o", "stanza", name)
+	if err != nil {
+		return nil, err
+	}
+	return getQueueManagerFromStanza(out)
+}
+
+// GetErrorLogDirectory returns the directory holding the error logs for the
+// specified queue manager
+func GetErrorLogDirectory(qm *QueueManager) string {
+	return pathutils.CleanPath(GetDataDirectory(qm), "errors")
+}
+
+// GetDataDirectory returns the data directory for the specified queue manager
+func GetDataDirectory(qm *QueueManager) string {
+	if qm.DataPath != "" {
+		// Data path has been set explicitly (e.g. for multi-instance queue manager)
+		return qm.DataPath
+	} else {
+		return pathutils.CleanPath(qm.Prefix, "qmgrs", qm.Directory)
+	}
+}

pkg/mqini/mqini_test.go

@@ -0,0 +1,64 @@
+/*
+© Copyright IBM Corporation 2018, 2023
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package mqini
+
+import (
+	"os"
+	"testing"
+)
+
+var getQueueManagerTests = []struct {
+	file        string
+	name        string
+	prefix      string
+	directory   string
+	errorLogDir string
+}{
+	{"dspmqinf1.txt", "foo", "/var/mqm", "foo", "/var/mqm/qmgrs/foo/errors"},
+	{"dspmqinf2.txt", "a/b", "/var/mqm", "a&b", "/var/mqm/qmgrs/a&b/errors"},
+	{"dspmqinf3.txt", "..", "/var/mqm", "!!", "/var/mqm/qmgrs/!!/errors"},
+}
+
+func TestGetQueueManager(t *testing.T) {
+	for _, table := range getQueueManagerTests {
+		t.Run(table.file, func(t *testing.T) {
+			b, err := os.ReadFile(table.file)
+			if err != nil {
+				t.Fatal(err)
+			}
+			qm, err := getQueueManagerFromStanza(string(b))
+			if err != nil {
+				t.Fatal(err)
+			}
+			t.Logf("%#v", qm)
+			if qm.Name != table.name {
+				t.Errorf("Expected name=%v; got %v", table.name, qm.Name)
+			}
+			if qm.Prefix != table.prefix {
+				t.Errorf("Expected prefix=%v; got %v", table.prefix, qm.Prefix)
+			}
+			if qm.Directory != table.directory {
+				t.Errorf("Expected directory=%v; got %v", table.directory, qm.Directory)
+			}
+
+			// Test
+			d := GetErrorLogDirectory(qm)
+			if d != table.errorLogDir {
+				t.Errorf("Expected error log directory=%v; got %v", table.errorLogDir, d)
+			}
+		})
+	}
+}