Merge pull request #7575 from runeksvendsen/ghcjs-build-runner

Restore GHCJS "-build-runner" option

Cabal/src/Distribution/Simple/GHCJS.hs

@@ -1093,11 +1093,22 @@ gbuild verbosity numJobs pkg_descr lbi bm clbi = do
       needProfiling       = withProfExe lbi
 
   -- build executables
+      buildRunner = case clbi of
+                      LibComponentLocalBuildInfo   {} -> False
+                      FLibComponentLocalBuildInfo  {} -> False
+                      ExeComponentLocalBuildInfo   {} -> True
+                      TestComponentLocalBuildInfo  {} -> True
+                      BenchComponentLocalBuildInfo {} -> True
       baseOpts   = (componentGhcOptions verbosity lbi bnfo clbi tmpDir)
                     `mappend` mempty {
                       ghcOptMode         = toFlag GhcModeMake,
                       ghcOptInputFiles   = toNubListR inputFiles,
-                      ghcOptInputModules = toNubListR inputModules
+                      ghcOptInputModules = toNubListR inputModules,
+                      -- for all executable components (exe/test/bench),
+                      -- GHCJS must be passed the "-build-runner" option
+                      ghcOptExtra =
+                        if buildRunner then ["-build-runner"]
+                                       else mempty
                     }
       staticOpts = baseOpts `mappend` mempty {
                       ghcOptDynLinkMode    = toFlag GhcStaticOnly,

cabal-testsuite/PackageTests/GHCJS/BuildRunner/BuildRunner.cabal

+name: BuildRunner
+version: 1.0
+build-type: Simple
+cabal-version: >= 1.10
+
+test-suite ghcjs-test
+    type: exitcode-stdio-1.0
+    main-is: BuildRunner.hs
+    build-depends: base
+    default-language: Haskell2010
+
+executable ghcjs-exe
+    main-is: BuildRunner.hs
+    build-depends: base
+    default-language: Haskell2010
+
+benchmark ghcjs-bench
+    type: exitcode-stdio-1.0
+    main-is: BuildRunner.hs
+    build-depends: base
+    default-language: Haskell2010

cabal-testsuite/PackageTests/GHCJS/BuildRunner/BuildRunner.hs

+module Main where
+
+import System.Exit (exitSuccess)
+
+main :: IO ()
+main = do
+  exitSuccess

cabal-testsuite/PackageTests/GHCJS/BuildRunner/README.md

+This test verifies that the `-build-runner` option is passed to GHCJS when the cabal commands `test`/`run`/`bench` are run with the `--ghcjs` option.
+
+This test was created in order to avoid regressions in running GHCJS executables, e.g.:
+
+* https://github.com/haskell/cabal/issues/6175
+* https://github.com/haskell/cabal/issues/6361

cabal-testsuite/PackageTests/GHCJS/BuildRunner/cabal.project

+packages: .

cabal-testsuite/PackageTests/GHCJS/BuildRunner/cabal.test.hs

+import Test.Cabal.Prelude
+
+main = cabalTest . recordMode DoNotRecord $ do
+    skipIfWindows -- disabled because (I presume) Windows doesn't have BASH
+    cwd <- fmap testCurrentDir getTestEnv
+    testInvokedWithBuildRunner cwd "test" []
+    testInvokedWithBuildRunner cwd "run" ["ghcjs-exe"]
+    testInvokedWithBuildRunner cwd "bench" []
+
+magicString = "SUCCESS! GHCJS was invoked with '-build-runner' option"
+
+testInvokedWithBuildRunner cwd cabalCmd extraArgs = do
+    output <- fails $ cabal' cabalCmd $ extraArgs ++
+        [ "--ghcjs"
+        , "--with-compiler", cwd </> fakeGhcjsPath
+        ]
+    assertOutputContains magicString output
+  where
+    fakeGhcjsPath = "scripts/fake-ghcjs.sh"

cabal-testsuite/PackageTests/GHCJS/BuildRunner/scripts/fake-ghcjs.sh

+#!/usr/bin/env bash
+
+# A script that will print out $MAGIC_STRING when invoked with the
+# '-build-runner' option.
+#
+# When cabal is invoked with the '--ghcjs' option and the '--with-compiler'
+# option set to the path of this script, cabal will successfully get to the linking
+# stage (where it *should* call this script with the '-build-runner' option).
+
+MAGIC_STRING="SUCCESS! GHCJS was invoked with '-build-runner' option"
+
+if [ "$1" == "--numeric-ghcjs-version" ]; then
+   ghc --numeric-version
+elif [ "$1" == "--numeric-ghc-version" ]; then
+   ghc --numeric-version
+elif [[ "$*" == *-build-runner* ]]; then
+   echo "$MAGIC_STRING"
+else
+   ghc "$@"
+fi

cabal-testsuite/PackageTests/GHCJS/BuildRunner/scripts/ghcjs-pkg

+#!/usr/bin/env bash
+
+if [ "$1" == "--numeric-ghcjs-version" ]; then
+   ghc --numeric-version
+elif [ "$1" == "--numeric-ghc-version" ]; then
+   ghc --numeric-version
+else
+   ghc-pkg "$@"
+fi

changelog.d/pr-7575

+synopsis: Fix running GHCJS executables
+packages: cabal-install
+prs: #7575
+issues: #6175 #6361