Warn on all tools when shadowed

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Revision history for ghcup
 
+## 0.1.17.10 -- 2022-05-12
+
+* windows hotfix (hackage-only release)
+
+## 0.1.17.9 -- 2022-05-12
+
+* broken sdist (hackage-only release)
+
 ## 0.1.17.8 -- 2022-05-11
 
 * Fix a serious (but hard to trigger) bug when combining `--isolate <DIR>` with `--force`, please make sure to upgrade or avoid `--force`

app/ghcup/BrickMain.hs

@@ -437,7 +437,7 @@ install' _ (_, ListResult {..}) = do
               , TarDirDoesNotExist
               , FileAlreadyExistsError
               , ProcessError
-              , GHCupShadowed
+              , ToolShadowed
               , UninstallFailed
               , MergeFileTreeError
               ]

app/ghcup/GHCup/OptParse/Upgrade.hs

@@ -94,7 +94,7 @@ type UpgradeEffects = '[ DigestError
                        , FileDoesNotExistError
                        , CopyError
                        , DownloadFailed
-                       , GHCupShadowed
+                       , ToolShadowed
                        ]
 
 

docs/guide.md

@@ -287,10 +287,11 @@ GHCup itself is also pre-installed on all platforms, but may use non-standard in
 GHCup supports verifying the GPG signature of the metadata file. The metadata file then contains SHA256 hashes of all downloads, so
 this is cryptographically secure.
 
-First, obtain the gpg key:
+First, obtain the gpg keys:
 
 ```sh
-gpg --batch --keyserver keys.openpgp.org --recv-keys 7784930957807690A66EBDBE3786C5262ECB4A3F
+gpg --batch --keyserver keys.openpgp.org     --recv-keys 7784930957807690A66EBDBE3786C5262ECB4A3F
+gpg --batch --keyserver keyserver.ubuntu.com --recv-keys FE5AB6C91FEA597C3B31180B73EDE9E8CFBAEF01
 ```
 
 Then verify the gpg key in one of these ways:

docs/install.md

@@ -187,7 +187,7 @@ Lower availability of bindists. Stack and HLS binaries are experimental.
 Download the binary for your platform at [https://downloads.haskell.org/~ghcup/](https://downloads.haskell.org/~ghcup/)
 and place it into your `PATH` anywhere.
 
-If you want to GPG verify the binaries, import the following key first: `7784930957807690A66EBDBE3786C5262ECB4A3F`.
+If you want to GPG verify the binaries, import the following keys first: `7784930957807690A66EBDBE3786C5262ECB4A3F` and `FE5AB6C91FEA597C3B31180B73EDE9E8CFBAEF01`.
 
 Then adjust your `PATH` in `~/.bashrc` (or similar, depending on your shell) like so:
 

lib/GHCup.hs

@@ -77,6 +77,7 @@ import           Text.Regex.Posix
 
 import qualified Data.Text                     as T
 import qualified Streamly.Prelude              as S
+import Text.PrettyPrint.HughesPJClass (prettyShow)
 
 
 
@@ -291,7 +292,7 @@ upgradeGHCup :: ( MonadMask m
                    , DownloadFailed
                    , NoDownload
                    , NoUpdate
-                   , GHCupShadowed
+                   , ToolShadowed
                    ]
                   m
                   Version
@@ -322,17 +323,9 @@ upgradeGHCup mtarget force' fatal = do
   liftIO (isShadowed destFile) >>= \case
     Nothing -> pure ()
     Just pa
-      | fatal -> throwE (GHCupShadowed pa destFile latestVer)
+      | fatal -> throwE (ToolShadowed GHCup pa destFile latestVer)
       | otherwise ->
-        lift $ logWarn $ "ghcup is shadowed by "
+        lift $ logWarn $ T.pack $ prettyShow (ToolShadowed GHCup pa destFile latestVer)
-          <> T.pack pa
-          <> ". The upgrade will not be in effect, unless you remove "
-          <> T.pack pa
-          <> " or make sure "
-          <> T.pack destDir
-          <> " comes before "
-          <> T.pack (takeDirectory pa)
-          <> " in PATH."
 
   pure latestVer
 

lib/GHCup/Cabal.hs

@@ -50,6 +50,7 @@ import           System.FilePath
 import           System.IO.Error
 
 import qualified Data.Text                     as T
+import Text.PrettyPrint.HughesPJClass (prettyShow)
 
 
 
@@ -230,6 +231,10 @@ setCabal ver = do
   let destL = targetFile
   lift $ createLink destL cabalbin
 
+  liftIO (isShadowed cabalbin) >>= \case
+    Nothing -> pure ()
+    Just pa -> lift $ logWarn $ T.pack $ prettyShow (ToolShadowed Cabal pa cabalbin ver)
+
   pure ()
 
 unsetCabal :: ( MonadMask m

lib/GHCup/Errors.hs

@@ -308,19 +308,21 @@ instance Pretty HadrianNotFound where
   pPrint HadrianNotFound =
     text "Could not find Hadrian build files. Does this GHC version support Hadrian builds?"
 
-data GHCupShadowed = GHCupShadowed
+data ToolShadowed = ToolShadowed
+                       Tool
                        FilePath  -- shadow binary
                        FilePath  -- upgraded binary
                        Version   -- upgraded version
   deriving Show
 
-instance Pretty GHCupShadowed where
+instance Pretty ToolShadowed where
-  pPrint (GHCupShadowed sh up _) =
+  pPrint (ToolShadowed tool sh up _) =
-    text ("ghcup is shadowed by "
+    text (prettyShow tool
+         <> " is shadowed by "
          <> sh
-         <> ". The upgrade will not be in effect, unless you remove "
+         <> ".\nThe upgrade will not be in effect, unless you remove "
          <> sh
-         <> " or make sure "
+         <> "\nor make sure "
          <> takeDirectory up
          <> " comes before "
          <> takeDirectory sh

lib/GHCup/GHC.hs

@@ -442,6 +442,11 @@ setGHC ver sghc mBinDir = do
       destL <- binarySymLinkDestination binDir fileWithExt
       lift $ createLink destL fullF
 
+      when (targetFile == "ghc") $
+        liftIO (isShadowed fullF) >>= \case
+          Nothing -> pure ()
+          Just pa -> lift $ logWarn $ T.pack $ prettyShow (ToolShadowed GHC pa fullF (_tvVersion ver))
+
   when (isNothing mBinDir) $ do
     -- create symlink for share dir
     when (isNothing . _tvTarget $ ver) $ lift $ symlinkShareDir (fromGHCupPath ghcdir) verS

lib/GHCup/HLS.hs

@@ -68,6 +68,7 @@ import qualified Data.List.NonEmpty            as NE
 import qualified Data.ByteString               as B
 import qualified Data.Text                     as T
 import qualified Text.Megaparsec               as MP
+import Text.PrettyPrint.HughesPJClass (prettyShow)
 
 
 
@@ -549,6 +550,10 @@ setHLS ver shls mBinDir = do
       when (isNothing mBinDir) $
         lift warnAboutHlsCompatibility
 
+      liftIO (isShadowed wrapper) >>= \case
+        Nothing -> pure ()
+        Just pa -> lift $ logWarn $ T.pack $ prettyShow (ToolShadowed HLS pa wrapper ver)
+
 
 unsetHLS :: ( MonadMask m
             , MonadReader env m

lib/GHCup/Stack.hs

@@ -50,6 +50,7 @@ import           System.FilePath
 import           System.IO.Error
 
 import qualified Data.Text                     as T
+import Text.PrettyPrint.HughesPJClass (prettyShow)
 
 
 
@@ -229,6 +230,10 @@ setStack ver = do
 
   lift $ createLink targetFile stackbin
 
+  liftIO (isShadowed stackbin) >>= \case
+    Nothing -> pure ()
+    Just pa -> lift $ logWarn $ T.pack $ prettyShow (ToolShadowed Cabal pa stackbin ver)
+
   pure ()
 
 

scripts/bootstrap/bootstrap-haskell

@@ -763,7 +763,7 @@ if [ -z "${BOOTSTRAP_HASKELL_MINIMAL}" ] ; then
 
 	do_cabal_config_init $ask_cabal_config_init_answer
 
-	edo cabal new-update --ignore-project
+	edo cabal update --ignore-project
 else # don't install ghc and cabal
 	case "${plat}" in
 			MSYS*|MINGW*)