Add passthru.run with wine support (#301)

This can be used to run tests, executables or benchmarks.
Instead of building drv build drv.run and the result should be the output of stdout.

Author: hamishmack

builder/comp-builder.nix

@@ -1,4 +1,4 @@
-{ stdenv, buildPackages, ghc, lib, pkgconfig, gobject-introspection ? null, haskellLib, makeConfigFiles, ghcForComponent, hsPkgs }:
+{ stdenv, buildPackages, ghc, lib, pkgconfig, gobject-introspection ? null, haskellLib, makeConfigFiles, ghcForComponent, hsPkgs, runCommand, libffi, gmp }:
 
 { componentId
 , component
@@ -117,6 +117,13 @@ let
 
   exeExt = lib.optionalString stdenv.hostPlatform.isWindows ".exe";
   testExecutable = "dist/build/${componentId.cname}/${componentId.cname}${exeExt}";
+  # exe components are in /bin, but test and benchmarks are not.  Perhaps to avoid
+  # them being from being added to the PATH when the all component added to an env.
+  # TODO revist this to find out why and document or maybe change this.
+  installedExeDir = if haskellLib.isTest componentId || haskellLib.isBenchmark componentId
+    then name
+    else "bin";
+  installedExe = "${installedExeDir}/${componentId.cname}${exeExt}";
 
 in stdenv.lib.fix (drv:
 
@@ -136,6 +143,9 @@ stdenv.mkDerivation ({
     # The directory containing the haddock documentation.
     # `null' if no haddock documentation was built.
     haddockDir = if doHaddock' then "${docdir drv.doc}/html" else null;
+    run = runCommand (fullName + "-run") {} ''
+      ${toString component.testWrapper} ${drv}/${installedExe} | tee $out
+    '';
   };
 
   meta = {
@@ -177,7 +187,7 @@ stdenv.mkDerivation ({
   prePatch = if (cabalFile != null)
      then ''cat ${cabalFile} > ${package.identifier.name}.cabal''
      else lib.optionalString (cabal-generator == "hpack") ''
-       ${hsPkgs.hpack.components.exes.hpack}/bin/hpack
+       ${buildPackages.haskell-nix.haskellPackages.hpack.components.exes.hpack}/bin/hpack
      '';
 
   configurePhase = ''
@@ -267,6 +277,21 @@ stdenv.mkDerivation ({
     '')
     # In case `setup copy` did not creat this
     + (lib.optionalString enableSeparateDataOutput "mkdir -p $data")
+    + (lib.optionalString (stdenv.hostPlatform.isWindows && (haskellLib.mayHaveExecutable componentId)) ''
+      echo "Copying libffi and gmp .dlls ..."
+      for p in ${lib.concatStringsSep " " [ libffi gmp ]}; do
+        find "$p" -iname '*.dll' -exec cp {} $out/${installedExeDir} \;
+      done
+      # copy all .dlls into the local directory.
+      # we ask ghc-pkg for *all* dynamic-library-dirs and then iterate over the unique set
+      # to copy over dlls as needed.
+      echo "Copying library dependencies..."
+      for libdir in $(x86_64-pc-mingw32-ghc-pkg --package-db=$packageConfDir field "*" dynamic-library-dirs --simple-output|xargs|sed 's/ /\n/g'|sort -u); do
+        if [ -d "$libdir" ]; then
+          find "$libdir" -iname '*.dll' -exec cp {} $out/${installedExeDir} \;
+        fi
+      done
+    '')
     }
     runHook postInstall
   '';

lib/default.nix

@@ -58,8 +58,16 @@ with haskellLib;
 
   isLibrary = componentId: componentId.ctype == "lib";
   isAll = componentId: componentId.ctype == "all";
+  isExe = componentId: componentId.ctype == "exe";
   isTest = componentId: componentId.ctype == "test";
   isBenchmark = componentId: componentId.ctype == "bench";
+  isExecutableType = componentId:
+       isExe componentId
+    || isTest componentId
+    || isBenchmark componentId;
+  mayHaveExecutable = componentId:
+       isExecutableType componentId
+    || isAll componentId;
 
   # Was there a reference to the package source in the `cabal.project` or `stack.yaml` file.
   # This is used to make the default `packages` list for `shellFor`.

test/cabal-22/default.nix

@@ -20,8 +20,8 @@ in
       printf "size of executable $exe is $size. \n" >& 2
 
       # fixme: run on target platform when cross-compiled
-      printf "checking whether executable runs... " >& 2
-      "$exe"
+      printf "checking whether executable rans... " >& 2
+      cat ${packages.project.components.exes.project.run}
 
       printf "checking that executable is dynamically linked to system libraries... " >& 2
     '' + optionalString stdenv.isLinux ''
@@ -46,11 +46,11 @@ in
     '') + ''
       touch $out
 
-      printf "checking whether benchmark runs... " >& 2
-      ${packages.project.components.benchmarks.project-bench}/*/project-bench
+      printf "checking whether benchmark ran... " >& 2
+      cat ${packages.project.components.benchmarks.project-bench.run}
 
-      printf "checking whether tests run... " >& 2
-      ${packages.project.components.tests.unit}/*/unit
+      printf "checking whether tests ran... " >& 2
+      cat ${packages.project.components.tests.unit.run}
     '';
 
     meta.platforms = platforms.all;

test/exe-only/default.nix

@@ -16,14 +16,14 @@ in
     name = "exe-only-test";
 
     buildCommand = ''
-      exe="${packages.exe-only.components.exes.exe-only}/bin/exe-only"
+      exe="${packages.exe-only.components.exes.exe-only}/bin/exe-only${stdenv.hostPlatform.extensions.executable}"
 
       size=$(command stat --format '%s' "$exe")
       printf "size of executable $exe is $size. \n" >& 2
 
       # fixme: run on target platform when cross-compiled
-      printf "checking whether executable runs... " >& 2
-      $exe
+      printf "checking whether executable ran... " >& 2
+      cat ${packages.exe-only.components.exes.exe-only.run}
     '' + (if stdenv.hostPlatform.isMusl then ''
         printf "checking that executable is statically linked... " >& 2
         (ldd $exe 2>&1 || true) | grep -i "not a"
@@ -36,7 +36,7 @@ in
     '') + ''
 
       printf "Checking that \"all\" component has the programs... " >& 2
-      all_exe="${packages.exe-only.components.all}/bin/exe-only"
+      all_exe="${packages.exe-only.components.all}/bin/exe-only${stdenv.hostPlatform.extensions.executable}"
       test -f "$all_exe"
       echo "$all_exe" >& 2
 

test/stack-simple/default.nix

@@ -1,4 +1,4 @@
-{ stdenv, mkStackPkgSet }:
+{ stdenv, pkgs, mkStackPkgSet }:
 
 with stdenv.lib;
 
@@ -13,23 +13,10 @@ let
 
   packages = pkgSet.config.hsPkgs;
 
-in
-  stdenv.mkDerivation {
-    name = "stack-simple-test";
-
-    buildCommand = ''
-      exe="${packages.stack-simple.components.exes.stack-simple-exe}/bin/stack-simple-exe"
-
-      printf "checking whether executable runs... " >& 2
-      $exe
-
-      touch $out
-    '';
-
-    meta.platforms = platforms.all;
-
-    passthru = {
+in pkgs.recurseIntoAttrs {
+  stack-simple-exe = packages.stack-simple.components.exes.stack-simple-exe.run // {
       # Attributes used for debugging with nix repl
       inherit pkgSet packages;
-    };
-  }
+  };
+  stack-simple-test = packages.stack-simple.components.tests.stack-simple-test.run;
+}