Merge pull request #1 from ibm-messaging/local-bindings

Support for local bindings connections

Author: matrober-uk

Gopkg.lock

@@ -27,11 +27,11 @@
 
 [[constraint]]
   name = "github.com/ibm-messaging/mq-golang"
-  version = "3.3.4"
+  version = "4.1.0"
 
 [[constraint]]
   name = "github.com/stretchr/testify"
-  version = "1.3.0"
+  version = "1.4.0"
 
 [prune]
   go-tests = true

Gopkg.toml

@@ -110,7 +110,8 @@ assert.Equal(t, "MQRC_NOT_AUTHORIZED", err.GetReason())
 Other sample code can be found in the testcase files as follows. When writing your own applications you will
 generally replace the various "assert" calls that test the successful execution of the application logic with
 your own error handling or logging.
-* Creating a ConnectionFactory - [connectionfactory_test.go](connectionfactory_test.go)
+* Creating a ConnectionFactory that uses a client connection to a remote queue manager - [connectionfactory_test.go](connectionfactory_test.go)
+* Creating a ConnectionFactory that uses a bindings connection to a local queue manager - [local_bindings_test.go](local_bindings_test.go)
 * Send/receive a text string - [sample_sendreceive_test.go](sample_sendreceive_test.go)
 * Send a message as Persistent or NonPersistent - [deliverymode_test.go](deliverymode_test.go)
 * Get by CorrelationID - [getbycorrelid_test.go](getbycorrelid_test.go)
@@ -130,7 +131,7 @@ go test -run TestSampleSendReceiveWithErrorHandling
 The IBM MQ client on which this library depends is supported on Linux and Windows, and is [now available for development use on MacOS](https://developer.ibm.com/messaging/2019/02/05/ibm-mq-macos-toolkit-for-developers/)).
 
 1. Install Golang
-    - This library has been validated with Golang v1.11.4. If you don't have Golang installed on your system you can [download it here](https://golang.org/doc/install) for MacOS, Linux or Windows
+    - This library has been validated with Golang v1.11.4 and v1.12.9. If you don't have Golang installed on your system you can [download it here](https://golang.org/doc/install) for MacOS, Linux or Windows
 2. Install 'dep' to manage the dependent packages
     - See [Installation instructions](https://github.com/golang/dep#installation) for details
 3. Install the MQ Client library
@@ -193,9 +194,9 @@ The test cases use the `CreateConnectionFactoryFromDefaultJSONFiles` method to o
 - `connection_info.json` contains information like the hostname/port/channel
   - If you are using the MQ on Cloud service you can download a pre-populated file directly from the queue manager details page as [described here](https://cloud.ibm.com/docs/services/mqcloud/mqoc_jms_tls.html#connection_info-json)
   - Otherwise you can insert details of your own queue manager into [this sample file](./config-samples/connection_info.json) and copy it to your `/Downloads` directory
-- `apiKey.json` contains the Application username and password that will be used to connect to your queue manager
+- `applicationApiKey.json` contains the Application username and password that will be used to connect to your queue manager
   - If you are using the MQ on Cloud service you can download a pre-populated file directly from the Application Permissions tab in the service console as [described here](https://cloud.ibm.com/docs/services/mqcloud/mqoc_jms_tls.html#apikey-json)
-  - Otherwise you can insert details of your own queue manager into [this sample file](./config-samples/apiKey.json) and copy it to your `/Downloads` directory
+  - Otherwise you can insert details of your own queue manager into [this sample file](./config-samples/applicationApiKey.json) and copy it to your `/Downloads` directory
 
 Once you have added the details of your queue manager and user credentials into the two JSON files and placed them in your `/Downloads` directory you are ready to run the test, which is done in the same way as any other Go tests.
 

README.md

@@ -30,6 +30,8 @@ func TestLoadCFFromJSON(t *testing.T) {
 		log.Fatal(err)
 	}
 
+	assert.Equal(t, mqjms.TransportType_CLIENT, cf.TransportType)
+
 	// Creates a connection to the queue manager, using defer to close it automatically
 	// at the end of the function (if it was created successfully)
 	context, errCtx := cf.CreateContext()

config-samples/apiKey.json renamed to config-samples/applicationApiKey.json

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) IBM Corporation 2019
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package main
+
+import (
+	"fmt"
+	"github.com/ibm-messaging/mq-golang-jms20/mqjms"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+)
+
+/*
+ * Test the use of a local bindings connection to the queue manager, as
+ * opposed to a remote client connection.
+ *
+ * Assumes a locally running queue manager called QM1, with a defined local
+ * queue called LOCAL.QUEUE
+ */
+func TestLocalBindingsConnect(t *testing.T) {
+
+	// Checking the presence of the mqs.ini file is a reasonably reliable way of
+	// identifying if there is a local queue manager installation, so that we
+	// can skip this test if necessary.
+	if _, err := os.Stat("/var/mqm/mqs.ini"); os.IsNotExist(err) {
+		fmt.Println("Skipping local bindings test as there is no local queue manager installation.")
+		return
+	}
+
+	// Create a connection factory that indicates we should use local bindings.
+	// Note that it includes none of the normal parameters like hostname, port etc.
+	cf := mqjms.ConnectionFactoryImpl{
+		QMName:        "QM1",
+		TransportType: mqjms.TransportType_BINDINGS,
+	}
+
+	// Creates a connection to the queue manager, using defer to close it automatically
+	// at the end of the function (if it was created successfully)
+	context, ctxErr := cf.CreateContext()
+	assert.Nil(t, ctxErr)
+	if context != nil {
+		defer context.Close()
+	}
+	assert.NotNil(t, context)
+
+	// Equivalent to a JNDI lookup or other declarative definition
+	queue := context.CreateQueue("LOCAL.QUEUE")
+
+	// Set up the consumer ready to receive messages.
+	consumer, conErr := context.CreateConsumer(queue)
+	assert.Nil(t, conErr)
+	if consumer != nil {
+		defer consumer.Close()
+	}
+
+	// Check no message on the queue to start with
+	testMsg, err1 := consumer.ReceiveNoWait()
+	assert.Nil(t, err1)
+	assert.Nil(t, testMsg)
+
+	// Check the getter/setter behaviour on a producer.
+	tmpProducer := context.CreateProducer()
+	tmpProducer.SetTimeToLive(2000)
+
+	// Send a message that will expire after 1 second, then immediately receive it (will not have expired)
+	msgBody := "Local message."
+	context.CreateProducer().SendString(queue, msgBody)
+	rcvBody, rcvErr := consumer.ReceiveStringBodyNoWait()
+	assert.Nil(t, rcvErr)
+	assert.NotNil(t, rcvBody)
+	assert.Equal(t, msgBody, *rcvBody)
+
+}

connectionfactory_test.go

@@ -10,8 +10,8 @@
 package mqjms
 
 import (
-	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"github.com/ibm-messaging/mq-golang-jms20/jms20subset"
+	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"strconv"
 )
 
@@ -28,6 +28,8 @@ type ConnectionFactoryImpl struct {
 	ChannelName string
 	UserName    string
 	Password    string
+
+	TransportType int // Default to TransportType_CLIENT (0)
 }
 
 // CreateContext implements the JMS method to create a connection to an IBM MQ
@@ -36,26 +38,36 @@ func (cf ConnectionFactoryImpl) CreateContext() (jms20subset.JMSContext, jms20su
 
 	// Allocate the internal structures required to create an connection to IBM MQ.
 	cno := ibmmq.NewMQCNO()
-	cd := ibmmq.NewMQCD()
-
-	// Fill in the required fields in the channel definition structure
-	cd.ChannelName = cf.ChannelName
-	cd.ConnectionName = cf.Hostname + "(" + strconv.Itoa(cf.PortNumber) + ")"
-
-	// Store the user credentials in an MQCSP, which ensures that long passwords
-	// can be used.
-	csp := ibmmq.NewMQCSP()
-	csp.AuthenticationType = ibmmq.MQCSP_AUTH_USER_ID_AND_PWD
-	csp.UserId = cf.UserName
-	csp.Password = cf.Password
-
-	// Join the objects together as necessary so that they can be provided as
-	// part of the connect call.
-	cno.ClientConn = cd
-	cno.SecurityParms = csp
-
-	// Indicate that we want to use a client (TCP) connection.
-	cno.Options = ibmmq.MQCNO_CLIENT_BINDING
+
+	if cf.TransportType == TransportType_CLIENT {
+
+		// Indicate that we want to use a client (TCP) connection.
+		cno.Options = ibmmq.MQCNO_CLIENT_BINDING
+
+		// Fill in the required fields in the channel definition structure
+		cd := ibmmq.NewMQCD()
+		cd.ChannelName = cf.ChannelName
+		cd.ConnectionName = cf.Hostname + "(" + strconv.Itoa(cf.PortNumber) + ")"
+		cno.ClientConn = cd
+
+	} else if cf.TransportType == TransportType_BINDINGS {
+
+		// Indicate to use Bindings connections.
+		cno.Options = ibmmq.MQCNO_LOCAL_BINDING
+
+	}
+
+	if cf.UserName != "" {
+
+		// Store the user credentials in an MQCSP, which ensures that long passwords
+		// can be used.
+		csp := ibmmq.NewMQCSP()
+		csp.AuthenticationType = ibmmq.MQCSP_AUTH_USER_ID_AND_PWD
+		csp.UserId = cf.UserName
+		csp.Password = cf.Password
+		cno.SecurityParms = csp
+
+	}
 
 	var ctx jms20subset.JMSContext
 	var retErr jms20subset.JMSException

local_bindings_test.go

@@ -0,0 +1,18 @@
+// Copyright (c) IBM Corporation 2019.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License 2.0, which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0
+
+// Implementation of the JMS style Golang interfaces to communicate with IBM MQ.
+package mqjms
+
+// Used to configure the TransportType property of the ConnectionFactory,
+// to use a TCP client connection to the queue manager. This is the default.
+const TransportType_CLIENT int = 0
+
+// Used to configure the TransportType property of the ConnectionFactory,
+// to use a local bindings connection to the queue manager
+const TransportType_BINDINGS int = 1

mqjms/ConnectionFactoryImpl.go

@@ -11,8 +11,8 @@ package mqjms
 
 import (
 	"errors"
-	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"github.com/ibm-messaging/mq-golang-jms20/jms20subset"
+	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"strconv"
 	"strings"
 )

mqjms/Constants.go

@@ -10,8 +10,8 @@
 package mqjms
 
 import (
-	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"github.com/ibm-messaging/mq-golang-jms20/jms20subset"
+	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"strconv"
 )
 

mqjms/ConsumerImpl.go

@@ -58,7 +58,7 @@ func CreateConnectionFactoryFromJSON(connectionInfoLocn string, apiKeyLocn strin
 	}
 
 	if apiKeyLocn == "" {
-		apiKeyLocn = os.Getenv("HOME") + "/Downloads/apiKey.json"
+		apiKeyLocn = os.Getenv("HOME") + "/Downloads/applicationApiKey.json"
 	}
 
 	// Attempt to read the connection info file at the specified location.

mqjms/ContextImpl.go

@@ -11,8 +11,8 @@ package mqjms
 
 import (
 	"fmt"
-	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"github.com/ibm-messaging/mq-golang-jms20/jms20subset"
+	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"log"
 	"strconv"
 )

mqjms/FactoryFactory.go

@@ -12,8 +12,8 @@ package mqjms
 import (
 	"encoding/hex"
 	"fmt"
-	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"github.com/ibm-messaging/mq-golang-jms20/jms20subset"
+	"github.com/ibm-messaging/mq-golang/ibmmq"
 	"log"
 	"strconv"
 	"strings"
@@ -99,7 +99,7 @@ func (msg *TextMessageImpl) SetJMSReplyTo(dest jms20subset.Destination) jms20sub
 		log.Fatal(jms20subset.CreateJMSException("UnexpectedDestinationType", "UnexpectedDestinationType", nil))
 	}
 
-  // The option to return an error is not currently used.
+	// The option to return an error is not currently used.
 	return nil
 }
 

mqjms/ProducerImpl.go

@@ -14,7 +14,6 @@ Not currently implemented:
 - Topics (pub/sub)
 - Message Properties etc
 - Temporary destinations
-- Local bindings connections
 - Priority