haskell-cabal-sandboxing

.travis.yml

@@ -1,5 +1,12 @@
 language: cpp
 
+cache:
+  directories:
+    $HOME/.m2
+    $HOME/.cabal
+    $HOME/Library/Haskell
+    $TRAVIS_BUILD_DIR/../build/.cabal-sandbox
+
 #
 # Define the build matrix
 #
@@ -30,20 +37,20 @@ matrix:
       compiler: gcc
       env: [ FULL=ON ]
 
-    # HASKELL: Only build Haskell binding and plugin
-
     - os: osx
       osx_image: xcode9.1
-      compiler: clang
-      env: [ HASKELL=ON ]
+      compiler: gcc
 
     - os: osx
       osx_image: xcode9.1
-      compiler: gcc
+      compiler: clang
+
+    # HASKELL: Only build Haskell binding and plugin
 
     - os: osx
       osx_image: xcode9.1
       compiler: clang
+      env: [ HASKELL=ON ]
 
     - os: linux
       compiler: gcc
@@ -96,9 +103,12 @@ before_install:
     if [[ "$TRAVIS_OS_NAME" == "osx" && "$HASKELL" == "ON" ]] ; then
       brew install cabal-install
       cabal update
-      cabal install happy alex
+      # avoid reinstalls if we already have them cached
+      # disable everything that slows down compilation times of the dependencies to have reasonable travis build times
       PATH=$PATH:"$HOME/.cabal/bin"
-      cabal install QuickCheck hspec c2hs
+      which happy || cabal install happy
+      which alex || cabal install alex
+      which c2hs || cabal install c2hs
     fi
   - |
     if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
@@ -119,15 +129,19 @@ before_script:
   - >
     [[ "$TRAVIS_OS_NAME" == "linux" ]] && INSTALL_DIR="$PWD/install" || INSTALL_DIR="/usr/local"
   - SYSTEM_DIR="$PWD/kdbsystem"
-  - mkdir build && cd build
+  # gets created due to sandbox caching automatically
+  - cd build
   - >
     [[ $ASAN == ON ]] && CMAKE_OPT=(-DENABLE_ASAN=ON) || CMAKE_OPT=()
   - if [[ $FULL == ON ]]; then CMAKE_OPT+=(-DBUILD_FULL=ON); fi
   - |
     if [[ "$TRAVIS_OS_NAME" == "linux" && "$CC" == "clang" || "$TRAVIS_OS_NAME" == "osx" && "${CC:0:3}" == "gcc" ]]; then
       CMAKE_OPT+=("-DCOMMON_FLAGS=-Werror")
     fi
+  # use a minimal configuration for the haskell bindings to give it enough time to compile dependencies
   - if [[ $HASKELL == ON ]]; then bindings="haskell"; fi
+  - if [[ $HASKELL == ON ]]; then plugins="resolver_fm_hpu_b;dump;ini;dini;sync;error;hosts;list;glob;profile;spec;network;tracer;timeofday;base64;haskell"; fi  
+  - if [[ $HASKELL == ON ]]; then tools="kdb"; fi  
   - |
     if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
       python2_ver=$(python2 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))') &&                  \
@@ -145,7 +159,7 @@ before_script:
     -DPLUGINS="${plugins:-ALL;-jni}"
     -DBINDINGS="${bindings}"
     -DENABLE_DEBUG=ON
-    -DTOOLS=ALL
+    -DTOOLS="${tools:-ALL;}"
     -DINSTALL_SYSTEM_FILES=OFF
     -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
     -DCMAKE_INSTALL_PREFIX="$INSTALL_DIR"
@@ -162,9 +176,5 @@ script:
       ninja run_all
     else
       ninja install
-      # Unfortunately the Haskell tests do not work currently:
-      # https://github.com/ElektraInitiative/libelektra/issues/1631
-      if [[ "$HASKELL" != "ON" ]]; then
-        ninja run_all && kdb run_all
-      fi
+      ninja run_all && kdb run_all
     fi

cmake/Modules/FindHaskell.cmake

@@ -8,6 +8,9 @@
 #  GHC-PKG_EXECUTABLE    - Path to the ghc-pkg executable
 #  GHC_HSPEC_FOUND       - True if the hspec library is available
 #  GHC_QUICKCHECK_FOUND  - True if the QuickCheck library is available
+#  GHC_VERSION			 - The numeric version of the ghc executable
+#  CABAL_DYNLIB_PATH     - The default path where cabal installs dynamic libraries
+#  CABAL_CUSTOM_TARGET   - The default dependencies of the custom Setup.hs for plugins
 #  HASKELL_FOUND         - True if the whole required haskell environment exists
 #    This variable is set to true if CABAL_EXECUTABLE, C2HS_EXECUTABLE, GHC_EXECUTABLE
 #    and GHC-PKG_EXECUTABLE are all available. If BUILD_TESTING is enabled, it also
@@ -25,7 +28,7 @@ if (CABAL_EXECUTABLE)
 if (C2HS_EXECUTABLE)
 if (GHC_EXECUTABLE)
 if (GHC-PKG_EXECUTABLE)
-	
+
 	# check for hspec and QuickCheck
 	# ghc-pkg return code is 0 on success, 1 otherwise
 	execute_process (
@@ -53,17 +56,43 @@ if (GHC-PKG_EXECUTABLE)
 		set (GHC_QUICKCHECK_FOUND 0)
 	endif (GHC_QUICKCHECK_FOUND EQUAL 0)
 
-	if (GHC_HSPEC_FOUND OR NOT BUILD_TESTING)
-	if (GHC_QUICKCHECK_FOUND OR NOT BUILD_TESTING)
-		# all set, have fun with haskell!
-		set (HASKELL_FOUND 1)
-	else (GHC_QUICKCHECK_FOUND OR NOT BUILD_TESTING)
-		set (HASKELL_NOTFOUND_INFO "QuickCheck library not found")
-	endif (GHC_QUICKCHECK_FOUND OR NOT BUILD_TESTING)
-	else (GHC_HSPEC_FOUND OR NOT BUILD_TESTING)
-		set (HASKELL_NOTFOUND_INFO "hspec library not found")
-	endif (GHC_HSPEC_FOUND OR NOT BUILD_TESTING)
+	execute_process (
+		COMMAND ${GHC_EXECUTABLE} --numeric-version
+		OUTPUT_VARIABLE GHC_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE
+	)
+
+	# find the default cabal installation path
+	# sort of hacky but i haven't found a uniform way of doing this
+	# first find the global cabal directory
+	execute_process (
+		COMMAND ${CABAL_EXECUTABLE} --ignore-sandbox help
+		COMMAND tail -n1
+		COMMAND xargs dirname
+		OUTPUT_VARIABLE CABAL_LOCATION OUTPUT_STRIP_TRAILING_WHITESPACE
+	)
+	# filter the library path matching our ghc version, ignoring architectures for now
+	execute_process (
+		COMMAND ls -F "${CABAL_LOCATION}/lib"
+		COMMAND grep ghc-${GHC_VERSION}
+		OUTPUT_VARIABLE GHC_DYNAMIC_LIBRARY_DIR OUTPUT_STRIP_TRAILING_WHITESPACE
+	)
+	set (CABAL_DYNLIB_PATH "${CABAL_LOCATION}/lib/${GHC_DYNAMIC_LIBRARY_DIR}")
+
+	# dependencies for the default cmake Setup.hs
+	set (CABAL_CUSTOM_SETUP
+"custom-setup
+  setup-depends:
+    Cabal      >= 1.24 && < 2.1,
+    containers >= 0.4  && < 0.6,
+    base       >= 4.7  && < 5  ,
+    directory  >= 1.1  && < 1.4,
+    process    >= 1.2  && < 1.7,
+    filepath   >= 1.3  && < 1.5")
 
+	# By using cabal sandboxes we can install hspec and QuickCheck to the sandbox without
+	# any concerns as they are independent from the global environment. So they are not required.
+	# All set, have fun with haskell!
+	set (HASKELL_FOUND 1)
 else (GHC-PKG_EXECUTABLE)
 	set (HASKELL_NOTFOUND_INFO "ghc-pkg not found")
 endif (GHC-PKG_EXECUTABLE)
@@ -84,6 +113,9 @@ mark_as_advanced (
 	GHC-PKG_EXECUTABLE
 	C2HS_EXECUTABLE
 	CABAL_EXECUTABLE
+	CABAL_DYNLIB_PATH
+	CABAL_CUSTOM_TARGET
+	GHC_VERSION
 	GHC_HSPEC_FOUND
 	GHC_QUICKCHECK_FOUND
 )