Allow to set ghcup msys2 environment #992

hasufell · 2024-01-29T06:42:17Z

Fixes #982

runeksvendsen · 2024-01-31T08:47:42Z

@hasufell how could we go about testing this? Are all those environments supposed to Just Work for any msys installation (excluding e.g. arm64 on x86, of course)?

hasufell · 2024-01-31T08:51:40Z

I don't think I'm gonna test functionality on any env but the default one.

Testing whether setting the env works correctly will mostly amount to using something like ghcup run -m -- echo '$PATH'

runeksvendsen

I don't think I'm gonna test functionality on any env but the default one.

I really dislike testing in production. If we merge this change, how will we know it's actually working without some kind of test?

For example, it looks like you've forgotten to append /bin to the paths returned by ghcupMsys2BinDirs'. I would like to have a test that catches this.

hasufell · 2024-02-01T09:47:09Z

I really dislike testing in production.

As described in #982 all the different environments can have different issues when compiling and linking against C libraries. I don't think I have the bandwidth to setup proper tests for each of them. And I'm happy to mark using any env other than MINGW64 as experimental.

If we merge this change, how will we know it's actually working without some kind of test?

We have no tests for linking C libraries at the moment. It is too fragile, because it depends on the state of the msys2 repositories, which are rolling-release.

For example, it looks like you've forgotten to append /bin to the paths returned by ghcupMsys2BinDirs'. I would like to have a test that catches this.

Yes, I know. I'm testing this manually in a VM.

We can add the checks I described above to the test suite, e.g.:

run ghcup run -m -- echo '$PATH' and inspect the output
run ghcup run -m -- pacman --version

runeksvendsen

A few initial questions. Will test in a VM as the next step, and leave another review based on that.

runeksvendsen · 2024-02-02T10:46:38Z

.github/workflows/bootstrap.yaml

          $curDir = Get-Location
          Write-Host "Current Working Directory: $curDir"
-          ./scripts/bootstrap/bootstrap-haskell.ps1 -InstallDir ${GITHUB_WORKSPACE} -BootstrapUrl ("{0}/scripts/bootstrap/bootstrap-haskell" -f $curDir) -InBash
+          ./scripts/bootstrap/bootstrap-haskell.ps1 -InstallDir ${GITHUB_WORKSPACE} -BootstrapUrl ("{0}/scripts/bootstrap/bootstrap-haskell" -f $curDir) -InBash -Msys2Env "MINGW64"


Should the Windows/PowerShell installation command listed here (after clicking "Show all platforms") be changed if we default to passing -Msys2Env "MINGW64" here?

Perhaps it would make sense to also test the default in CI?

Should the Windows/PowerShell installation command listed here (after clicking "Show all platforms") be changed if we default to passing -Msys2Env "MINGW64" here?

No, not necessary.

@hasufell I think the Windows/PowerShell installation command listed on https://www.haskell.org/ghcup should be tested in CI.

It is:

ghcup-hs/.github/workflows/bootstrap.yaml

Line 57 in 2a79c66

./scripts/bootstrap/bootstrap-haskell.ps1 -InstallDir ${GITHUB_WORKSPACE} -BootstrapUrl ("{0}/scripts/bootstrap/bootstrap-haskell" -f $curDir) -InBash

Well... this PR proposes to change that line.

Furthermore, why pass that argument when it's the default anyway?

I'm not sure what you are proposing. Do you want to test all combinations of flags and their effects? That's not in scope for this PR and probably considerable work, given that it's just plain powershell.

@hasufell I'm proposing we test the command listed on https://www.haskell.org/ghcup, ie. not passing -Msys2Env

scripts/bootstrap/bootstrap-haskell.ps1

.github/scripts/test.sh

scripts/bootstrap/bootstrap-haskell.ps1

hasufell · 2024-02-09T16:16:08Z

    Exec "$Bash" '-lc' 'pacman --noconfirm -S --needed curl autoconf mingw-w64-x86_64-pkgconf'

This probably needs to depend on the environment as well, specifically mingw-w64-x86_64-pkgconf.

runeksvendsen

I'm unable to assess whether this works as intended since it's unclear to me exactly what the indented usage is of the new options and environment variables. #992 contains a lot of back-and-forth conversation, but I'm missing a more concise spec of what, exactly, this PR is implementing.

For example, what happens if I set GHCUP_MSYS2_ENV to e.g. "CLANG64" when running GHCup but it was installed using scripts/bootstrap/bootstrap-haskell.ps1 without setting Msys2Env? Also, see review comments with questions.

runeksvendsen · 2024-02-10T10:41:34Z

.github/workflows/bootstrap.yaml

          $curDir = Get-Location
          Write-Host "Current Working Directory: $curDir"
-          ./scripts/bootstrap/bootstrap-haskell.ps1 -InstallDir ${GITHUB_WORKSPACE} -BootstrapUrl ("{0}/scripts/bootstrap/bootstrap-haskell" -f $curDir) -InBash
+          ./scripts/bootstrap/bootstrap-haskell.ps1 -InstallDir ${GITHUB_WORKSPACE} -BootstrapUrl ("{0}/scripts/bootstrap/bootstrap-haskell" -f $curDir) -InBash -Msys2Env "MINGW64"


Well... this PR proposes to change that line.

Furthermore, why pass that argument when it's the default anyway?

scripts/bootstrap/bootstrap-haskell.ps1

runeksvendsen · 2024-02-11T16:21:30Z

scripts/bootstrap/bootstrap-haskell.ps1

+  $Msys2EnvExport = ('export GHCUP_MSYS2_ENV={0} ;' -f $Msys2Env)
+  $null = [Environment]::SetEnvironmentVariable("GHCUP_MSYS2_ENV", $Msys2Env, [System.EnvironmentVariableTarget]::User)
+}
+
 if ((Get-Process -ID $PID).ProcessName.StartsWith("bootstrap-haskell") -Or $InBash) {


I'm confused here as well about why this is done. Please add a code comment to clarify why this is needed.

@hasufell here I was talking specifically about the line starting with

if ((Get-Process -ID $PID).ProcessName.StartsWith("bootstrap-haskell") -Or $InBash) {

and below. Why is this done?

hasufell · 2024-02-12T07:34:55Z

#992 contains a lot of back-and-forth conversation, but I'm missing a more concise spec of what, exactly, this PR is implementing.

I don't really understand what you're requesting. This PR implements support for MSYS2 environments as specified here: https://www.msys2.org/docs/environments/

Based on the environment picked by the user, we:

adjust GHCup's internal behavior so that ghcup run --mingw-path behaves correctly wrt which bin directories are prepended to PATH, see:
- https://github.com/haskell/ghcup-hs/pull/992/files#diff-575c3bedf04426890b33a9e9bb086334ed41f43cbf8d9d15094178dee5cf2a58R344-R383
- https://github.com/haskell/ghcup-hs/pull/992/files#diff-6768d483b9175924542244f8048bc072f540c8f68ea6247b38807e41fdf380aaR267-R268
adjust cabal.config so that extra-include-dirs, extra-lib-dirs and extra-prog-path correspond to the picked environment, see
- https://github.com/haskell/ghcup-hs/pull/992/files#diff-76e4f986d0451c0214f8c4620fc65c5aa79b53fb073549d6b0b5d264b4ab965cR630
adjust boostrap-haskell.ps1 so that it creates the correct shortcuts and installs the correct packages based on the environment

runeksvendsen · 2024-02-15T09:55:02Z

For example, what happens if I set GHCUP_MSYS2_ENV to e.g. "CLANG64" when running GHCup but it was installed using scripts/bootstrap/bootstrap-haskell.ps1 without setting Msys2Env?

@hasufell I'm missing an answer to this question.

EDIT: Ie. does the range of supported values for GHCUP_MSYS2_ENV depend on the Msys2Env argument passed to the Windows install script (scripts/bootstrap/bootstrap-haskell.ps1)? I assume so, because when I install GHCup on Windows I see nothing inside the folder $msys2Dir/clang64/bin.

hasufell · 2024-02-15T11:34:48Z

For example, what happens if I set GHCUP_MSYS2_ENV to e.g. "CLANG64" when running GHCup but it was installed using scripts/bootstrap/bootstrap-haskell.ps1 without setting Msys2Env?

Two things happen:

your cabal.config (extra-include-dirs, extra-lib-dirs and extra-prog-path) is "outdated" and doesn't match what ghcup run -m will use for PATH
the deskop shortcuts will still point to the MINGW64 env and there won't be any clang64 package pre-installed in msys2

The documentation of GHCUP_MSYS2_ENV is rather clear that this is just about ghcup run -m behavior: https://github.com/haskell/ghcup-hs/pull/992/files#diff-07fdd026b11c494c3b62c97f764f6939803c453389ebefd6b05e6f187d44859aR108

This is an advanced feature that will not be exposed to end-users through a question during bootstrap. I expect users to understand the implications. The rest could/should be done at cabal documentation (@Kleidukos).

Kleidukos · 2024-02-15T11:37:47Z

More than happy to continue the conversation on the cabal ticket tracker. :)

runeksvendsen

I just installed GHCup in a Windows VM using this PR's version of scripts/bootstrap/bootstrap-haskell.ps1 and it seems setting GHCUP_MSYS2_ENV has no effect. C:\ghcup\msys64\mingw64\bin is added to the PATH regardless, and setting GHCUP_MSYS2_ENV to an invalid value doesn't throw an error:

rune@RUNESVENDSEFBC3 MINGW64 ~
$ ghcup debug-info
[ Info  ] verifying digest of: gs.exe
Debug Info
==========
GHCup base dir: C:\ghcup
GHCup bin dir: C:\ghcup\bin
GHCup GHC directory: C:\ghcup\ghc
GHCup cache directory: C:\ghcup\cache
Architecture: x86_64
Platform: Windows
Version: 0.1.20.0

rune@RUNESVENDSEFBC3 MINGW64 ~
$ echo $GHCUP_MSYS2_ENV
CLANG64

rune@RUNESVENDSEFBC3 MINGW64 ~
$ ghcup run -m -- echo $PATH
[ Warn  ] New ghc version available. If you want to install this latest version, run 'ghcup install ghc 9.8.1'
[ Info  ] verifying digest of: gs.exe
C:\Users\rune\.cabal\bin;C:\ghcup\bin;C:\ghcup\msys64\mingw64\bin;C:\ghcup\msys64\usr\local\bin;C:\ghcup\msys64\usr\bin;C:\ghcup\msys64\usr\bin;C:\Windows\System32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\ghcup\msys64\usr\bin\site_perl;C:\ghcup\msys64\usr\bin\vendor_perl;C:\ghcup\msys64\usr\bin\core_perl

rune@RUNESVENDSEFBC3 MINGW64 ~
$ export GHCUP_MSYS2_ENV=blah

rune@RUNESVENDSEFBC3 MINGW64 ~
$ echo $GHCUP_MSYS2_ENV
blah

rune@RUNESVENDSEFBC3 MINGW64 ~
$ ghcup run -m -- echo $PATH
[ Warn  ] New ghc version available. If you want to install this latest version, run 'ghcup install ghc 9.8.1'
[ Info  ] verifying digest of: gs.exe
C:\Users\rune\.cabal\bin;C:\ghcup\bin;C:\ghcup\msys64\mingw64\bin;C:\ghcup\msys64\usr\local\bin;C:\ghcup\msys64\usr\bin;C:\ghcup\msys64\usr\bin;C:\Windows\System32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\ghcup\msys64\usr\bin\site_perl;C:\ghcup\msys64\usr\bin\vendor_perl;C:\ghcup\msys64\usr\bin\core_perl

Also, a few more questions.

scripts/bootstrap/bootstrap-haskell.ps1

runeksvendsen · 2024-02-17T13:58:23Z

scripts/bootstrap/bootstrap-haskell.ps1

 if ((Get-Process -ID $PID).ProcessName.StartsWith("bootstrap-haskell") -Or $InBash) {
-  Exec "$Bash" '-lc' ('{4} {6} {7} {8} {9} {10} {12} [ -n ''{1}'' ] && export GHCUP_MSYS2=$(cygpath -m ''{1}'') ; [ -n ''{2}'' ] && export GHCUP_INSTALL_BASE_PREFIX=$(cygpath -m ''{2}/'') ; export PATH=$(cygpath -u ''{3}/bin''):$PATH ; export CABAL_DIR=''{5}'' ; [[ ''{0}'' = https* ]]  && {11} {0} | bash || cat $(cygpath -m ''{0}'') | bash' -f $BootstrapUrl, $MsysDir, $GhcupBasePrefix, $GhcupDir, $SilentExport, $CabalDirFull, $StackInstallExport, $HLSInstallExport, $AdjustCabalConfigExport, $MinimalExport, $BootstrapDownloader, $DownloadScript, $AdjustBashRcExport)
+  Exec "$Bash" '-lc' ('{4} {6} {7} {8} {9} {10} {12} {13} [ -n ''{1}'' ] && export GHCUP_MSYS2=$(cygpath -m ''{1}'') ; [ -n ''{2}'' ] && export GHCUP_INSTALL_BASE_PREFIX=$(cygpath -m ''{2}/'') ; export PATH=$(cygpath -u ''{3}/bin''):$PATH ; export CABAL_DIR=''{5}'' ; [[ ''{0}'' = https* ]]  && {11} {0} | bash || cat $(cygpath -m ''{0}'') | bash' -f $BootstrapUrl, $MsysDir, $GhcupBasePrefix, $GhcupDir, $SilentExport, $CabalDirFull, $StackInstallExport, $HLSInstallExport, $AdjustCabalConfigExport, $MinimalExport, $BootstrapDownloader, $DownloadScript, $AdjustBashRcExport, $Msys2EnvExport)


What does this line do?

It runs the bootstrap haskell shellscript.

runeksvendsen · 2024-02-17T13:58:29Z

scripts/bootstrap/bootstrap-haskell.ps1

 } else {
-  Exec "$Msys2Shell" '-mingw64' '-mintty'  '-shell' 'bash' '-c' ('{4} {6} {7} {8} {9} {10} {12} [ -n ''{1}'' ] && export GHCUP_MSYS2=$(cygpath -m ''{1}'') ; [ -n ''{2}'' ] && export GHCUP_INSTALL_BASE_PREFIX=$(cygpath -m ''{2}/'') ; export PATH=$(cygpath -u ''{3}/bin''):$PATH ; export CABAL_DIR=''{5}'' ; trap ''echo Press any key to exit && read -n 1 && exit'' 2 ; [[ ''{0}'' = https* ]]  && {11} {0} | bash || cat $(cygpath -m ''{0}'') | bash ; echo ''Press any key to exit'' && read -n 1' -f $BootstrapUrl, $MsysDir, $GhcupBasePrefix, $GhcupDir, $SilentExport, $CabalDirFull, $StackInstallExport, $HLSInstallExport, $AdjustCabalConfigExport, $MinimalExport, $BootstrapDownloader, $DownloadScript, $AdjustBashRcExport)
+  Exec "$Msys2Shell" $ShellType '-mintty'  '-shell' 'bash' '-c' ('{4} {6} {7} {8} {9} {10} {12} {13} [ -n ''{1}'' ] && export GHCUP_MSYS2=$(cygpath -m ''{1}'') ; [ -n ''{2}'' ] && export GHCUP_INSTALL_BASE_PREFIX=$(cygpath -m ''{2}/'') ; export PATH=$(cygpath -u ''{3}/bin''):$PATH ; export CABAL_DIR=''{5}'' ; trap ''echo Press any key to exit && read -n 1 && exit'' 2 ; [[ ''{0}'' = https* ]]  && {11} {0} | bash || cat $(cygpath -m ''{0}'') | bash ; echo ''Press any key to exit'' && read -n 1' -f $BootstrapUrl, $MsysDir, $GhcupBasePrefix, $GhcupDir, $SilentExport, $CabalDirFull, $StackInstallExport, $HLSInstallExport, $AdjustCabalConfigExport, $MinimalExport, $BootstrapDownloader, $DownloadScript, $AdjustBashRcExport, $Msys2EnvExport)


What does this line do?

It also runs the bootstrap haskell shellscript.

hasufell · 2024-02-17T15:46:27Z

ghcup run -m -- echo $PATH

This does not work. As the integration test suite shows: https://github.com/haskell/ghcup-hs/pull/992/files#diff-d2a2c2295ab9310565a95908a3da85cfac1fa1bc63dff49f34f6c049d099f71eR45

You have to do ghcup run -m -- sh -c 'echo $PATH'. Otherwise it will just print whatever is in the parent shell.

Fixes #982

hasufell force-pushed the issue-982 branch 2 times, most recently from 6ec43f0 to f682dbb Compare January 29, 2024 06:51

runeksvendsen requested changes Feb 1, 2024

View reviewed changes

hasufell force-pushed the issue-982 branch 3 times, most recently from ad86f76 to 0930c78 Compare February 1, 2024 16:17

hasufell requested a review from runeksvendsen February 1, 2024 17:18

hasufell added this to the 0.1.22.0 milestone Feb 2, 2024

hasufell force-pushed the issue-982 branch from 84b24f8 to cb95f23 Compare February 2, 2024 08:21

runeksvendsen reviewed Feb 2, 2024

View reviewed changes

hasufell marked this pull request as draft February 2, 2024 11:17

hasufell force-pushed the issue-982 branch from cb95f23 to 23f919f Compare February 9, 2024 14:52

hasufell marked this pull request as ready for review February 9, 2024 14:56

hasufell requested a review from runeksvendsen February 9, 2024 14:56

runeksvendsen reviewed Feb 11, 2024

View reviewed changes

hasufell force-pushed the issue-982 branch from 23f919f to 46b2e59 Compare February 12, 2024 10:31

hasufell mentioned this pull request Feb 15, 2024

[Windows] Document use and integration of MSYS2 haskell/cabal#9713

Closed

runeksvendsen reviewed Feb 17, 2024

View reviewed changes

hasufell force-pushed the issue-982 branch 2 times, most recently from c6d6939 to a8f257d Compare February 17, 2024 16:21

hasufell requested a review from runeksvendsen February 17, 2024 16:22

hasufell force-pushed the issue-982 branch 2 times, most recently from 049a111 to 096ca54 Compare February 18, 2024 08:07

Allow to set ghcup msys2 environment

96f7aa5

Fixes #982

hasufell force-pushed the issue-982 branch from 096ca54 to 96f7aa5 Compare February 18, 2024 08:22

hasufell merged commit 4831798 into master Feb 21, 2024
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to set ghcup msys2 environment #992

Allow to set ghcup msys2 environment #992

hasufell commented Jan 29, 2024

runeksvendsen commented Jan 31, 2024

hasufell commented Jan 31, 2024

runeksvendsen left a comment

hasufell commented Feb 1, 2024

runeksvendsen left a comment

runeksvendsen Feb 2, 2024

hasufell Feb 2, 2024

runeksvendsen Feb 3, 2024

hasufell Feb 3, 2024

runeksvendsen Feb 10, 2024

hasufell Feb 12, 2024

runeksvendsen Feb 15, 2024 •

edited

Loading

hasufell commented Feb 9, 2024

runeksvendsen left a comment

runeksvendsen Feb 10, 2024

runeksvendsen Feb 11, 2024

runeksvendsen Feb 15, 2024

hasufell commented Feb 12, 2024

runeksvendsen commented Feb 15, 2024 •

edited

Loading

hasufell commented Feb 15, 2024

Kleidukos commented Feb 15, 2024

runeksvendsen left a comment •

edited

Loading

runeksvendsen Feb 17, 2024

hasufell Feb 17, 2024

runeksvendsen Feb 17, 2024

hasufell Feb 17, 2024 •

edited

Loading

hasufell commented Feb 17, 2024 •

edited

Loading

Allow to set ghcup msys2 environment #992

Allow to set ghcup msys2 environment #992

Conversation

hasufell commented Jan 29, 2024

runeksvendsen commented Jan 31, 2024

hasufell commented Jan 31, 2024

runeksvendsen left a comment

Choose a reason for hiding this comment

hasufell commented Feb 1, 2024

runeksvendsen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

runeksvendsen Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

hasufell commented Feb 9, 2024

runeksvendsen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasufell commented Feb 12, 2024

runeksvendsen commented Feb 15, 2024 • edited Loading

hasufell commented Feb 15, 2024

Kleidukos commented Feb 15, 2024

runeksvendsen left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasufell Feb 17, 2024 • edited Loading

Choose a reason for hiding this comment

hasufell commented Feb 17, 2024 • edited Loading

runeksvendsen Feb 15, 2024 •

edited

Loading

runeksvendsen commented Feb 15, 2024 •

edited

Loading

runeksvendsen left a comment •

edited

Loading

hasufell Feb 17, 2024 •

edited

Loading

hasufell commented Feb 17, 2024 •

edited

Loading