Automate checking against MQ 9.1, and fix #1

Author: ibmmqmet

code/ibmmq/ibmmqc.c

@@ -235,7 +235,16 @@ static PyObject * ibmmqc_MQCONNX(PyObject *self, PyObject *args) {
   PMQCD mqcd = NULL;
   PMQSCO sco = NULL;
   PMQCSP csp = NULL;
+
+  /* The MQBNO structure was introduced after the oldest version of MQ (9.1) stated as
+   * supported by this package. So we have to use ifdefs to not refer to it if
+   * that's where we are building.
+   */
+#if defined MQBNO_CURRENT_VERSION
   PMQBNO bno = NULL;
+#else
+  void *bno = NULL;
+#endif
 
   Py_ssize_t mqcd_len = 0;
   Py_ssize_t sco_len = 0;
@@ -270,7 +279,7 @@ static PyObject * ibmmqc_MQCONNX(PyObject *self, PyObject *args) {
 
     // SPLProtection is the only MQCD field more recent than the baseline 9.1
     // ... and it's only really valid for qmgr channels so should never be set by
-    // client applications! But it's convenient for testing VERSION policies here.
+    // client applications. But it's convenient for testing VERSION policies here.
 #if defined(MQCD_VERSION_12)
     if (mqcd->SPLProtection != 0) {
       if (mqcd->Version < MQCD_VERSION_12) {
@@ -290,10 +299,11 @@ static PyObject * ibmmqc_MQCONNX(PyObject *self, PyObject *args) {
     if (cno->Version < MQCNO_VERSION_7) {
       cno->Version = MQCNO_VERSION_7;
     }
-#endif
   }
+#endif
 
   if (sco != NULL) {
+
 #if defined(MQSCO_VERSION_6)
     if (sco->KeyRepoPasswordPtr) {
       if (sco->Version < MQSCO_VERSION_6) {
@@ -314,6 +324,10 @@ static PyObject * ibmmqc_MQCONNX(PyObject *self, PyObject *args) {
 #endif
   }
 
+
+  /* The bno variable is always available even for older levels of MQ. But it is not USABLE without the
+   * MQBNO structure and the CNO versions being suitable.
+   */
   if (bno != NULL) {
 #if defined(MQCNO_VERSION_8)
     if (cno->Version < MQCNO_VERSION_8) {
@@ -1341,7 +1355,7 @@ static PyObject* ibmmqc_MQSETMP(PyObject *self, PyObject *args) {
     /* String value */
     case MQTYPE_STRING:
       v = PyUnicode_AsEncodedString(property_value_object,"utf-8","ignore");
-      value = PyBytes_AsString(v); 
+      value = PyBytes_AsString(v);
       break;
 
     /* 32-bit floating-point number value */

setup.py

@@ -16,12 +16,10 @@
 # This is the only place where package version number is set!
 # The version should correspond to PEP440 and gets normalised if
 # not in the right format. VRM can be followed with a|b|rc with a further numeric
-# to indicate alpha/beta/release candidate versions.
+# to indicate alpha/beta/release-candidate versions.
 VERSION = '2.0.0b2'
 
 # If the MQ SDK is in a non-default location, set MQ_FILE_PATH environment variable.
-# If that env var is not set, then use a default root of the current directory (which
-# might not be necessary, but shouldn't do any harm.
 custom_path = os.environ.get('MQ_FILE_PATH', None)
 
 # Always build in 64-bit mode. And use libmqm regardless of whether the package
@@ -31,15 +29,20 @@
     # Seems the closest exception (now an alias of EnvironmentError)
     raise OSError("Cannot build in 32-bit mode. Only 64-bit systems supported.")
 
+# The include_dirs and library_dirs used to be lists that always included the default
+# directories. But if you've gone to the trouble of setting a non-default
+# custom_path, then we should only use that. Otherwise the compile might get confused and use
+# the "wrong" version of the files.
+
 def get_windows_settings():
     """ Windows settings.
     """
 
-    library_dirs = [r'c:\Program Files\IBM\MQ\tools\Lib64']
     include_dirs = [r'c:\Program Files\IBM\MQ\tools\c\include']
+    library_dirs = [r'c:\Program Files\IBM\MQ\tools\Lib64']
     if custom_path:
-        library_dirs.append(r'{}\tools\Lib64'.format(custom_path))
-        include_dirs.append(r'{}\tools\c\include'.format(custom_path))
+        library_dirs = [r'{}\tools\Lib64'.format(custom_path)]
+        include_dirs = [r'{}\tools\c\include'.format(custom_path)]
 
     libraries = ['mqm']
 
@@ -53,8 +56,8 @@ def get_aix_settings():
     include_dirs = ['/usr/mqm/inc']
 
     if custom_path:
-        library_dirs.append('{}/lib64'.format(custom_path))
-        include_dirs.append('{}/inc'.format(custom_path))
+        library_dirs = ['{}/lib64'.format(custom_path)]
+        include_dirs = ['{}/inc'.format(custom_path)]
 
     libraries = ['mqm_r']
 
@@ -68,8 +71,8 @@ def get_generic_unix_settings():
     include_dirs = ['/opt/mqm/inc']
 
     if custom_path:
-        library_dirs.append('{}/lib64'.format(custom_path))
-        include_dirs.append('{}/inc'.format(custom_path))
+        library_dirs = ['{}/lib64'.format(custom_path)]
+        include_dirs = ['{}/inc'.format(custom_path)]
 
     # Get an embedded rpath into the library which can reduce need for LD_LIBRARY_PATH
     for d in library_dirs:
@@ -141,7 +144,10 @@ def get_locations_by_command_path(command_path):
     if os.path.isfile(p):
         found_headers = True
 if not found_headers:
-    raise FileNotFoundError("Cannot find MQ C header files. Ensure you have already installed the MQ Client and SDK")
+    msg = "Cannot find MQ C header files.\n"
+    msg += "Ensure you have already installed the MQ Client and SDK.\n"
+    msg += "Use the MQ_FILE_PATH environment variable to identify a non-default location."
+    raise FileNotFoundError(msg)
 
 LONG_DESCRIPTION = """
 Python library for IBM MQ
@@ -179,7 +185,7 @@ def get_locations_by_command_path(command_path):
     print('Here is the message:', msg)
 """
 
-# Define how the C module gets built. Set flags to try to build using the Python 3.9
+# Define how the C module gets built. Set flags to build using the Python 3.9
 # Limited API which should make the binary extension forwards compatible.
 mqi_extension = Extension('ibmmq.ibmmqc', c_source,
                           define_macros=[('PYVERSION', '"' + VERSION + '"'),

tools/check

@@ -223,6 +223,23 @@ else
   #fi
 fi
 
+# Try building against an old level of MQ
+if [ -x $curdir/checkOld ]
+then
+  echo
+  continueYN "Build against an old level of MQ"
+  if [ $? -eq 0 ]
+  then
+    cd $curdir
+    checkOld
+    if [ $? -ne 0 ]
+    then
+      echo " ERROR : Problem running old level build"
+      exit 1
+    fi
+  fi
+fi
+
 # Give a chance to quit now, before spending a lot of time on tests
 if [ -x $curdir/checkRemote ]
 then

tools/checkOld

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Make sure we can compile against the oldest "supported" level of MQ (9.1)
+# Assumes the MQ installation is under /opt/mqm.91
+
+curdir=`pwd`
+
+# Location of old header files
+export MQ_FILE_PATH=/opt/mqm.91
+
+venv=../../venv
+. $venv/bin/activate
+pip uninstall -y ibmmq
+cd ..
+
+# Do an install of the local tree to check it builds
+pip install --verbose -e .
+pip list 2>&1| grep -q ibmmq
+if [ $? -ne 0 ]
+then
+  echo "ERROR: Could not install ibmmq"
+  exit 1
+fi
+
+# MQ 9.1.5 Redist Client package does not have setmqenv, so
+# we fake it and export the symbols that might be relevant
+$MQ_FILE_PATH/bin/crtmqenv -k -s > /tmp/crtmqenv
+. /tmp/crtmqenv
+export LD_LIBRARY_PATH
+export PATH
+export MQ_INSTALLATION_NAME
+export MQ_INSTALLATION_PATH
+
+# Now try to connect as a client to the qmgr. Since my machine
+# is using the redist client package, it can't rely on version-switching
+# to use local bindings.
+python $curdir/../code/examples/connect_client.py
+exit $?
+