Add scripts to compile samples in Docker

Author: ibmmqmet

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 Newest updates are at the top of this file.
 
-## March 26 2019
+## April 1 2019
+* Added scripts to compile samples inside a container
+
+## March 26 2019 - v4.0.2
 * BREAKING API: Add hConn to callback function
 * Callbacks not setting hConn correctly (#93)
 

Dockerfile

@@ -0,0 +1,72 @@
+# © Copyright IBM Corporation 2019
+#
+# 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.
+
+ARG BASE_IMAGE=ubuntu:18.10
+FROM $BASE_IMAGE
+
+ARG GOPATH_ARG="/go"
+
+ENV GOVERSION=1.10 \
+    GOPATH=$GOPATH_ARG \
+    ORG="github.com/ibm-messaging" \
+    REPO="mq-golang"
+
+# Location of the downloadable MQ client package \
+ENV RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist" \
+    RDTAR="IBM-MQC-Redist-LinuxX64.tar.gz" \
+    VRMF=9.1.2.0
+
+# Install the Go compiler and Git
+RUN export DEBIAN_FRONTEND=noninteractive \
+  && bash -c 'source /etc/os-release; \
+     echo "deb http://archive.ubuntu.com/ubuntu/ ${UBUNTU_CODENAME} main restricted" > /etc/apt/sources.list; \
+     echo "deb http://archive.ubuntu.com/ubuntu/ ${UBUNTU_CODENAME}-updates main restricted" >> /etc/apt/sources.list; \
+     echo "deb http://archive.ubuntu.com/ubuntu/ ${UBUNTU_CODENAME}-backports main restricted universe" >> /etc/apt/sources.list; \
+     echo "deb http://archive.ubuntu.com/ubuntu/ ${UBUNTU_CODENAME} universe" >> /etc/apt/sources.list; \
+     echo "deb http://archive.ubuntu.com/ubuntu/ ${UBUNTU_CODENAME}-updates universe" >> /etc/apt/sources.list;' \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends \
+    golang-${GOVERSION} \
+    git \
+    ca-certificates \
+    curl \
+    tar \
+    bash \
+    go-dep \
+    build-essential \
+  && rm -rf /var/lib/apt/lists/*
+
+# Create location for the git clone and MQ installation
+RUN mkdir -p $GOPATH/src $GOPATH/bin $GOPATH/pkg \
+  && chmod -R 777 $GOPATH \
+  && mkdir -p $GOPATH/src/$ORG \
+  && mkdir -p /opt/mqm \
+  && chmod a+rx /opt/mqm
+
+# Install the MQ client from the Redistributable package. This also contains the
+# header files we need to compile against.
+RUN cd /opt/mqm \
+ && curl -LO "$RDURL/$VRMF-$RDTAR" \
+ && tar -zxf ./*.tar.gz \
+ && rm -f ./*.tar.gz
+
+# Insert the script that will do the build
+COPY buildInDocker.sh $GOPATH
+RUN chmod 777 $GOPATH/buildInDocker.sh
+
+# Copy the rest of the source tree from this directory into the container
+COPY . $GOPATH/src/$ORG/$REPO
+
+# Set the entrypoint to the script that will do the compilation
+ENTRYPOINT $GOPATH/buildInDocker.sh

Dockerfile-build-packages

@@ -9,7 +9,8 @@ some monitoring packages. These have now been moved to a
 new [GitHub repository called mq-metric-samples](https://github.com/ibm-messaging/mq-metric-samples).
 
 A minimum level of MQ V8 is required to build these packages. However, note that
-the monitoring data published by the queue manager is not available before MQ V9.
+the monitoring data published by the queue manager and exploited in the mqmetric package
+is not available before MQ V9.
 
 ## Health Warning
 
@@ -77,10 +78,10 @@ export CGO_LDFLAGS_ALLOW="-Wl,-rpath.*"
 ### Windows
 
 * Install the Go runtime and compiler. On Windows, the common directory is `c:\Go`
-* Ensure you have a gcc-based compiler, for example from the Cygwin distribution. 
-I recommend you use the mingw variation, to ensure compiled code can be used on systems without Cygwin installed. 
+* Ensure you have a gcc-based compiler, for example from the Cygwin distribution.
+I recommend you use the mingw variation, to ensure compiled code can be used on systems without Cygwin installed.
 The default `gcc` compiler from Cygwin does not work because it tries to build a
-Cygwin-enabled executable but the MQ libraries do not work in that model; 
+Cygwin-enabled executable but the MQ libraries do not work in that model;
 the `mingw` versions build Windows-native programs.
 * Create a working directory. For example, `mkdir c:\Gowork`
 * Set environment variables. Based on the previous lines,
@@ -105,7 +106,7 @@ set CC=x86_64-w64-mingw32-gcc.exe
 * If you have not installed MQ libraries into the default location, then set environment variables
 for the C compiler to recognise those directories. You may get messages from the compiler
 saying that the default MQ directories cannot be found, but those warnings can be ignored.
-The exact values for these environment variables will vary by platform, but follow the 
+The exact values for these environment variables will vary by platform, but follow the
 corresponding CFLAGS/LDFLAGS values in `mqi.go`
 
 For example,
@@ -133,6 +134,9 @@ For example,
 At this point, you should have a compiled copy of the program in `$GOPATH/bin`. See the
 `samples` directory for more sample programs.
 
+The `buildSamples.sh` script in this directory can also be used to create a container which will
+compile the samples and copy them to a local directory.
+
 ## Limitations
 
 All regular MQI verbs are now available through the `ibmmq` package.

Dockerfile-build-samples

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# © Copyright IBM Corporation 2019
+#
+# 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.
+
+# Script to build the Go libraries and sample programs from within a Docker container
+# This script is INSIDE the container and used as the entrypoint.
+
+export PATH="${PATH}:/usr/lib/go-${GOVERSION}/bin:/go/bin"
+export CGO_CFLAGS="-I/opt/mqm/inc/"
+export CGO_LDFLAGS_ALLOW="-Wl,-rpath.*"
+
+# Build the libraries so they can be used by other programs
+cd $GOPATH/src
+
+for pkg in $ORG/$REPO/ibmmq $ORG/$REPO/mqmetric
+do
+  lib=`basename $pkg`
+  echo "Building $lib"
+  go install  $pkg
+done
+
+# And do the sample program builds into the bin directory
+cd $GOPATH
+srcdir=src/$ORG/$REPO/samples
+
+for samp in $srcdir/*.go
+do
+  exe=`basename $samp .go`
+  echo "Building $exe"
+  go build -o bin/$exe $samp
+done

README.md

@@ -0,0 +1,52 @@
+# © Copyright IBM Corporation 2019
+#
+# 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.
+
+# This simple script builds a Docker container whose purpose is simply
+# to compile the libraries and sample programs, and then to copy those
+# outputs to a local temporary directory.
+# In order to run the sample programs you will still need a copy of
+# the MQ runtime libraries in the environment.
+
+GOPATH="/go"
+
+TAG="mq-golang-samples-gobuild"
+# Assume repo tags have been created in a sensible order
+VER=`git tag -l | sort | tail -1 | sed "s/^v//g"`
+if [ -z "$VER" ]
+then
+  VER="latest"
+fi
+echo "Building container $TAG:$VER"
+
+# Build a container that has all the pieces needed to compile the Go programs for MQ
+docker build --build-arg GOPATH_ARG=$GOPATH -t $TAG:$VER .
+rc=$?
+
+if [ $rc -eq 0 ]
+then
+  # Run the image to do the compilation and extract the files
+  # from it into local directories mounted into the container.
+  OUTBINDIR=$HOME/tmp/mq-golang-samples/bin
+  OUTPKGDIR=$HOME/tmp/mq-golang-samples/pkg
+  rm -rf $OUTBINDIR $OUTPKGDIR >/dev/null 2>&1
+  mkdir -p $OUTBINDIR $OUTPKGDIR
+
+  # Mount an output directory
+  # Delete the container once it's done its job
+  docker run --rm \
+          -v $OUTBINDIR:$GOPATH/bin:z \
+          -v $OUTPKGDIR:$GOPATH/pkg:z \
+          $TAG:$VER
+  echo "Compiled samples should now be in $OUTBINDIR"
+fi

buildInDocker.sh

@@ -8,6 +8,9 @@ which configuration values can be changed.
 Make sure you first read the README in the root of this repository to set up an environment
 where Go programs can be compiled, and how the packages refer to the MQ interfaces.
 
+The `buildSamples.sh` script in the root directory can be used to create a container to
+compile the samples and copy them to a local directory.
+
 ## Default values
 Where needed for the sample programs: