Update to travis build and change to directory structure (KxSystems#9)

Author: cmccarthy1

.travis.yml

@@ -1,47 +1,98 @@
-os: linux
+matrix:
+  include:
+  - dist: xenial
+    os: linux
+  - dist: trusty 
+    os: linux
+  - dist: bionic
+    os: linux
+  - os: osx
+  - os: windows
 language: c
 compiler: gcc
 
-stage:
-  - build Release
+before_install:
+  - export FILE_ROOT="prometheus-exporter"
+  - export TESTS="False"
+  - export BUILD="False"
 
-jobs:
-  include:
-    # LINUX BUILD
-    - stage: build Release
-      os: linux
-      script:
-        tar -zcvf prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.tgz LICENSE README.md *.q example/
-      deploy:
-        provider: releases
-        api_key: "$GITHUB_APIKEY"
-        file: prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.tgz
-        on:
-          tags: true
-        skip_cleanup: 'true'
-
-    # OSX BUILD
-    - stage: build Release
-      os: osx
-      script:
-        tar -zcvf prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.tgz LICENSE README.md *.q example/
-      deploy:
-        provider: releases
-        api_key: "$GITHUB_APIKEY"
-        file: prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.tgz
-        on:
-          tags: true
-        skip_cleanup: 'true'
-
-    # WINDOWS BUILD
-    - stage: build Release
-      os: windows
-      script:
-        7z a -tzip prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.zip LICENSE README.md *.q example
-      deploy:
-        provider: releases
-        api_key: "$GITHUB_APIKEY"
-        file: prom-exporter-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.zip
-        on:
-          tags: true
-        skip_cleanup: 'true'
+  # Run instructions to install the C/C++ requirements (BUILD_HOME) set in place of PAHO_HOME/HDF5_HOME etc.
+  # Files in this case are unzipped into cbuild within travis_setup.sh
+  - if [[ $BUILD == "True" ]]; then
+      chmod +x travis_setup.sh; 
+      ./travis_setup.sh;
+      export BUILD_HOME=$TRAVIS_BUILD_DIR/cbuild
+      export LIB="cmake/$FILE_ROOT/lib";
+      mkdir cmake;
+    else
+      export LIB="";
+    fi
+
+  - if [[ $TRAVIS_OS_NAME == "linux" ]]; then
+      QLIBDIR=l64; OD=$L64;
+    elif [[ $TRAVIS_OS_NAME == "osx" ]]; then
+      QLIBDIR=m64; OD=$M64;
+    elif [[ $TRAVIS_OS_NAME == "windows" ]]; then
+      QLIBDIR=w64; OD=$W64;
+    else
+      echo "unknown OS ('$TRAVIS_OS_NAME')" >&2; exit 1;
+    fi
+
+  - export QLIBDIR
+  - mkdir qhome;
+  - export QHOME=$(pwd)/qhome;
+  - export PATH=$QHOME/$QLIBDIR:$PATH;
+  
+  # Set up q for testing and execute tests on multiple 
+  - if [[ $TESTS == "True" && "x$OD" != "x" && "x$QLIC_KC" != "x" ]]; then
+      export LD_LIBRARY_PATH=$BUILD_HOME/lib:$LD_LIBRARY_PATH;
+      export DYLD_LIBRARY_PATH=$BUILD_HOME/lib:$LD_LIBRARY_PATH;
+      export PATH=$BUILD_HOME/lib:$PATH;
+      curl -o qhome/q.zip -L $OD;
+      unzip -d qhome qhome/q.zip;
+      rm qhome/q.zip;
+      echo -n $QLIC_KC |base64 --decode > qhome/kc.lic;
+    else
+      echo No kdb+, no tests;
+    fi
+
+  - if [[ $TRAVIS_OS_NAME == "windows" ]]; then
+      export FILE_TAIL="zip";
+    else
+      export FILE_TAIL="tgz";
+    fi
+  - export FILE_NAME=$FILE_ROOT-$TRAVIS_OS_NAME-$TRAVIS_BRANCH.$FILE_TAIL
+
+  # Make binaries for the library as appropriate
+  - if [[ $BUILD == "True" && $TRAVIS_OS_NAME == "windows" ]]; then
+      cd cmake && cmake -G "Visual Studio 15 2017 Win64" .. ;
+      export MSBUILD_PATH="/c/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/MSBuild/15.0/Bin/";
+      export PATH=$MSBUILD_PATH:$PATH;
+      MSBuild.exe INSTALL.vcxproj //m //nologo //verbosity:normal //p:Configuration=Release //p:Platform=x64;
+      cd ..;
+    elif [[ $BUILD == "True" && ( $TRAVIS_OS_NAME == "linux" || $TRAVIS_OS_NAME == "osx" ) ]]; then
+      cd cmake && cmake .. -DCMAKE_BUILD_TYPE=Release && make install && cd .. ;
+    fi
+
+script:
+  - if [[ $TESTS == "True" && "x$OD" != "x" && "x$QLIC_KC" != "x" ]]; then
+      q test.q tests/ -q;
+    fi
+  - if [[ $TRAVIS_OS_NAME == "windows" && $BUILD == "True" ]]; then
+      7z a -tzip -r $FILE_NAME ./cmake/$FILE_ROOT/*;
+    elif [[ $BUILD == "True" && ( $TRAVIS_OS_NAME == "linux" || $TRAVIS_OS_NAME == "osx" ) ]]; then  
+      tar  -zcvf $FILE_NAME -C cmake/$FILE_ROOT .;
+    elif [[ $TRAVIS_OS_NAME == "windows" ]]; then
+      7z a -tzip $FILE_NAME README.md install.bat LICENSE q examples;
+    elif [[ $TRAVIS_OS_NAME == "linux" || $TRAVIS_OS_NAME == "osx" ]]; then
+      tar  -zcvf $FILE_NAME README.md install.sh LICENSE q examples;
+    fi
+
+deploy:
+  provider: releases
+  api_key: "$GITHUB_APIKEY"
+  file: "$FILE_NAME"
+  on:
+    tags: true
+    condition: $TRAVIS_OS_NAME = windows || $TRAVIS_OS_NAME = osx || ($TRAVIS_DIST = trusty && $TRAVIS_OS_NAME = linux) 
+  skip_cleanup: 'true'

README.md

@@ -4,7 +4,7 @@
 
 ## Introduction
 
-This interface provides a method by which to expose metrics from a kdb+ process or multiple processes to Prometheus for monitoring. This is done via the script `exporter.q` which exposes kdb+ process metrics which can be consumed by Prometheus.
+This interface provides a method by which to expose metrics from a kdb+ process or multiple processes to Prometheus for monitoring. This is done via the script `q/exporter.q` which exposes kdb+ process metrics which can be consumed by Prometheus.
 
 This interface is part of the [_Fusion for kdb+_](https://code.kx.com/v2/interfaces/fusion/) project.
 
@@ -23,7 +23,7 @@ Visualization and querying can be done through the Prometheus built in expressio
 Run kdb+ with the supplied q script. This script will expose metrics on port 8080 which can be monitored by Prometheus
 
 ```
-q exporter.q -p 8080
+q q/exporter.q -p 8080
 ```
 
 Once running, you can use your web browser to view the currently exposed statistics on the metrics URL e.g. http://localhost:8080/metrics. The metrics exposed will be the metric values at the time at which the URL is requested.

example/DockerCompose/docker-compose-linux.yml examples/DockerCompose/docker-compose-linux.yml

@@ -10,7 +10,7 @@ This demonstration requires a Docker instance capable of running a Unix based co
 Start a q session locally on port 8080, running `exporter.q` from this folder via the command
 
 ```bash
-q ../exporter.q -p 8080
+q ../q/exporter.q -p 8080
 ```
 
 This will expose the metrics associated with this process on port 8080 for consumption by Prometheus.

example/DockerCompose/docker-compose.yml examples/DockerCompose/docker-compose.yml

@@ -0,0 +1,32 @@
+@echo off
+
+IF "%QHOME%"=="" (
+    ECHO ERROR: Enviroment variable QHOME is NOT defined 
+    EXIT /B
+)
+
+IF NOT EXIST %QHOME%\w64 (
+    ECHO ERROR: Installation destination %QHOME%\w64 does not exist
+    EXIT /B
+)
+
+
+IF EXIST q (
+    ECHO Copying q script to %QHOME%
+    COPY q\* %QHOME%
+    IF %ERRORLEVEL% NEQ 0 (
+        ECHO ERROR: Copy failed
+        EXIT /B %ERRORLEVEL%
+    )
+)
+
+IF EXIST lib (
+    ECHO Copying DLL to %QHOME%\w64
+    COPY lib\* %QHOME%\w64\
+    IF %ERRORLEVEL% NEQ 0 (
+        ECHO ERROR: Copy failed
+        EXIT /B %ERRORLEVEL%
+    )
+)
+
+ECHO Installation complete

example/DockerCompose/grafana-config/dashboards/dashboard.yml examples/DockerCompose/grafana-config/dashboards/dashboard.yml

@@ -0,0 +1,81 @@
+#!/bin/bash
+
+if [ -z "$QHOME" ]
+then
+    echo "ERROR: QHOME environment not set. Installation failed."
+    exit 1
+fi
+
+echo "Detected System"
+echo "* OS: $OSTYPE"
+echo "* TYPE: $HOSTTYPE"
+echo "* MACHINE TYPE: $MACHTYPE"
+
+# DETECT OS TYPE BEING USED
+Q_PATH_SEP="/"
+Q_HOST_TYPE=""
+if [[ "$OSTYPE" == "linux-gnu" ]]; then
+        Q_HOST_TYPE="l"
+elif [[ "$OSTYPE" == "darwin"* ]]; then
+        # Mac OSX
+        Q_HOST_TYPE="m"
+elif [[ "$OSTYPE" == "cygwin" ]]; then
+        # POSIX compatibility layer and Linux environment emulation for Windows
+        Q_HOST_TYPE="w"
+        Q_PATH_SEP="\\"
+elif [[ "$OSTYPE" == "msys" ]]; then
+        # Lightweight shell and GNU utilities compiled for Windows (part of MinGW)
+        Q_HOST_TYPE="w"
+        Q_PATH_SEP="\\"
+elif [[ "$OSTYPE" == "win32" ]]; then
+        Q_HOST_TYPE="w"
+        Q_PATH_SEP="\\"
+elif [[ "$OSTYPE" == "freebsd"* ]]; then
+        Q_HOST_TYPE="l"
+else
+        echo "ERROR: OSTYPE $OSTYPE not currently supported by this script"
+        echo "Please view README.md for installation instructions"
+        exit 1
+fi
+
+# DETECT WHETHER 32 OR 64 BIT
+Q_MACH_TYPE=""
+if [[ "$HOSTTYPE" == "x86_64" ]]; then
+    Q_MACH_TYPE="64"
+else
+    Q_MACH_TYPE="32"
+fi
+
+Q_SCRIPT_DIR=${QHOME}${Q_PATH_SEP}
+Q_SHARED_LIB_DIR="${QHOME}${Q_PATH_SEP}${Q_HOST_TYPE}${Q_SHARED_LIB_DIR}${Q_MACH_TYPE}${Q_PATH_SEP}"
+
+# check destination directory exists
+if [ ! -w "$Q_SCRIPT_DIR" ]; then
+    echo "ERROR: Directory '$Q_SCRIPT_DIR' does not exist"
+    exit 1
+fi
+if [ ! -w "$Q_SHARED_LIB_DIR" ]; then
+    echo "ERROR: Directory '$Q_SHARED_LIB_DIR' does not exist"
+    exit 1
+fi
+
+if [ -d q ]; then
+  echo "Copying q script to $Q_SCRIPT_DIR ..."
+  cp q/* $Q_SCRIPT_DIR
+  if [ $? -ne 0 ]; then
+    echo "ERROR: copy failed"
+    exit 1
+  fi
+fi
+
+if [ -d lib ]; then
+  echo "Copying shared lib to $Q_SHARED_LIB_DIR ..."
+  cp lib/* $Q_SHARED_LIB_DIR
+  if [ $? -ne 0 ]; then
+    echo "ERROR: copy failed"
+    exit 1
+  fi
+fi
+
+echo "Install complete"
+exit 0