External commands: Add tests for #9402 #9403 #9404

This adds 4 tests which test the new external commands feature:

* ExternalCommand - Tests the expected usage of external command invoked
  via cabal-install
* ExternalCommandSetup - Tests that the ./Setup interface does not
  support external commands (#9403)
* ExternalCommandEnv - Tests that environment variables are set and
  preserved appropiately  (#9402)
* ExternalCommandHelp - Test that `cabal help <cmd>` is interpreted appropiately (#9404)

cabal-testsuite/PackageTests/ExternalCommand/cabal.out

@@ -0,0 +1,8 @@
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - setup-test-0.1.0.0 (exe:cabal-aaaa) (first run)
+Configuring executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Preprocessing executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Building executable 'cabal-aaaa' for setup-test-0.1.0.0...

cabal-testsuite/PackageTests/ExternalCommand/cabal.project

@@ -0,0 +1 @@
+packages: setup-test/

cabal-testsuite/PackageTests/ExternalCommand/cabal.test.hs

@@ -0,0 +1,37 @@
+import Test.Cabal.Prelude
+import qualified System.Process as Process
+import Control.Concurrent (threadDelay)
+import System.Directory (removeFile)
+import Control.Exception (catch, throwIO)
+import System.IO.Error (isDoesNotExistError)
+import qualified Data.Time.Clock as Time
+import qualified Data.Time.Format as Time
+import Data.Maybe
+import System.Environment
+
+main = do
+  cabalTest $ do
+    res <- cabalWithStdin "v2-build" ["all"] ""
+    exe_path <- withPlan $ planExePath "setup-test" "cabal-aaaa"
+    env <- getTestEnv
+    path <- liftIO $ getEnv "PATH"
+    let newpath = takeDirectory exe_path ++ ":" ++ path
+    let new_env = (("PATH", Just newpath) : (testEnvironment env))
+    withEnv new_env $ do
+      res <- cabal_raw_action ["aaaa"] (\h -> () <$ Process.waitForProcess h)
+      assertOutputContains "aaaa" res
+
+
+cabal_raw_action :: [String] -> (Process.ProcessHandle -> IO ()) -> TestM Result
+cabal_raw_action args action = do
+    configured_prog <- requireProgramM cabalProgram
+    env <- getTestEnv
+    r <- liftIO $ runAction (testVerbosity env)
+                 (Just (testCurrentDir env))
+                 (testEnvironment env)
+                 (programPath configured_prog)
+                 args
+                 Nothing
+                 action
+    recordLog r
+    requireSuccess r

cabal-testsuite/PackageTests/ExternalCommand/setup-test/AAAA.hs

@@ -0,0 +1,4 @@
+module Main where
+
+main = do
+  putStrLn "aaaa"

cabal-testsuite/PackageTests/ExternalCommand/setup-test/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for setup-test
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

cabal-testsuite/PackageTests/ExternalCommand/setup-test/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2023, Matthew Pickering
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Matthew Pickering nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cabal-testsuite/PackageTests/ExternalCommand/setup-test/setup-test.cabal

@@ -0,0 +1,25 @@
+cabal-version:      3.0
+name:               setup-test
+version:            0.1.0.0
+-- synopsis:
+-- description:
+license:            BSD-3-Clause
+license-file:       LICENSE
+author:             Matthew Pickering
+maintainer:         matthewtpickering@gmail.com
+-- copyright:
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+-- extra-source-files:
+
+common warnings
+    ghc-options: -Wall
+
+executable cabal-aaaa
+    import:           warnings
+    main-is: AAAA.hs
+    -- other-modules:
+    -- other-extensions:
+    build-depends:    base ^>=4.18.0.0
+    hs-source-dirs:   .
+    default-language: Haskell2010

cabal-testsuite/PackageTests/ExternalCommandEnv/cabal.out

@@ -0,0 +1,8 @@
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - setup-test-0.1.0.0 (exe:cabal-aaaa) (first run)
+Configuring executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Preprocessing executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Building executable 'cabal-aaaa' for setup-test-0.1.0.0...

cabal-testsuite/PackageTests/ExternalCommandEnv/cabal.project

@@ -0,0 +1 @@
+packages: setup-test/

cabal-testsuite/PackageTests/ExternalCommandEnv/cabal.test.hs

@@ -0,0 +1,39 @@
+import Test.Cabal.Prelude
+import qualified System.Process as Process
+import Control.Concurrent (threadDelay)
+import System.Directory (removeFile)
+import Control.Exception (catch, throwIO)
+import System.IO.Error (isDoesNotExistError)
+import qualified Data.Time.Clock as Time
+import qualified Data.Time.Format as Time
+import Data.Maybe
+import System.Environment
+
+main = do
+  cabalTest $ expectBroken 9402 $ do
+    res <- cabalWithStdin "v2-build" ["all"] ""
+    exe_path <- withPlan $ planExePath "setup-test" "cabal-aaaa"
+    env <- getTestEnv
+    path <- liftIO $ getEnv "PATH"
+    let newpath = takeDirectory exe_path ++ ":" ++ path
+    let new_env = (("OTHER_VAR", Just "is set") : ("PATH", Just newpath) : (testEnvironment env))
+
+    withEnv new_env $ do
+      res <- cabal_raw_action ["aaaa"] (\h -> () <$ Process.waitForProcess h)
+      assertOutputContains "cabal-install" res
+      assertOutputContains "is set" res
+
+
+cabal_raw_action :: [String] -> (Process.ProcessHandle -> IO ()) -> TestM Result
+cabal_raw_action args action = do
+    configured_prog <- requireProgramM cabalProgram
+    env <- getTestEnv
+    r <- liftIO $ runAction (testVerbosity env)
+                 (Just (testCurrentDir env))
+                 (testEnvironment env)
+                 (programPath configured_prog)
+                 args
+                 Nothing
+                 action
+    recordLog r
+    requireSuccess r

cabal-testsuite/PackageTests/ExternalCommandEnv/setup-test/AAAA.hs

@@ -0,0 +1,11 @@
+module Main where
+
+import System.Environment
+import System.Process
+
+main = do
+  cabal_proc <- getEnv "CABAL"
+  other_var <- getEnv "OTHER_VAR"
+  putStrLn ("OTHER_VAR is set to: " ++ other_var)
+  callProcess cabal_proc ["--version"]
+

cabal-testsuite/PackageTests/ExternalCommandEnv/setup-test/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for setup-test
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

cabal-testsuite/PackageTests/ExternalCommandEnv/setup-test/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2023, Matthew Pickering
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Matthew Pickering nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cabal-testsuite/PackageTests/ExternalCommandEnv/setup-test/setup-test.cabal

@@ -0,0 +1,25 @@
+cabal-version:      3.0
+name:               setup-test
+version:            0.1.0.0
+-- synopsis:
+-- description:
+license:            BSD-3-Clause
+license-file:       LICENSE
+author:             Matthew Pickering
+maintainer:         matthewtpickering@gmail.com
+-- copyright:
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+-- extra-source-files:
+
+common warnings
+    ghc-options: -Wall
+
+executable cabal-aaaa
+    import:           warnings
+    main-is: AAAA.hs
+    -- other-modules:
+    -- other-extensions:
+    build-depends:    base ^>=4.18.0.0, process
+    hs-source-dirs:   .
+    default-language: Haskell2010

cabal-testsuite/PackageTests/ExternalCommandHelp/cabal.out

@@ -0,0 +1,12 @@
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - setup-test-0.1.0.0 (exe:cabal-aaaa) (first run)
+ - setup-test-0.1.0.0 (exe:setup) (first run)
+Configuring executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Preprocessing executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Building executable 'cabal-aaaa' for setup-test-0.1.0.0...
+Configuring executable 'setup' for setup-test-0.1.0.0...
+Preprocessing executable 'setup' for setup-test-0.1.0.0...
+Building executable 'setup' for setup-test-0.1.0.0...

cabal-testsuite/PackageTests/ExternalCommandHelp/cabal.project

@@ -0,0 +1 @@
+packages: setup-test/

cabal-testsuite/PackageTests/ExternalCommandHelp/cabal.test.hs

@@ -0,0 +1,37 @@
+import Test.Cabal.Prelude
+import qualified System.Process as Process
+import Control.Concurrent (threadDelay)
+import System.Directory (removeFile)
+import Control.Exception (catch, throwIO)
+import System.IO.Error (isDoesNotExistError)
+import qualified Data.Time.Clock as Time
+import qualified Data.Time.Format as Time
+import Data.Maybe
+import System.Environment
+
+main = do
+  cabalTest $ expectBroken 9404 $ do
+    res <- cabalWithStdin "v2-build" ["all"] ""
+    exe_path <- withPlan $ planExePath "setup-test" "cabal-aaaa"
+    env <- getTestEnv
+    path <- liftIO $ getEnv "PATH"
+    let newpath = takeDirectory exe_path ++ ":" ++ path
+    let new_env = (("PATH", Just newpath) : (testEnvironment env))
+    withEnv new_env $ do
+      res <- cabal_raw_action ["help", "aaaa"] (\h -> () <$ Process.waitForProcess h)
+      assertOutputContains "I am helping with the aaaa command" res
+
+
+cabal_raw_action :: [String] -> (Process.ProcessHandle -> IO ()) -> TestM Result
+cabal_raw_action args action = do
+    configured_prog <- requireProgramM cabalProgram
+    env <- getTestEnv
+    r <- liftIO $ runAction (testVerbosity env)
+                 (Just (testCurrentDir env))
+                 (testEnvironment env)
+                 (programPath configured_prog)
+                 args
+                 Nothing
+                 action
+    recordLog r
+    requireSuccess r

cabal-testsuite/PackageTests/ExternalCommandHelp/setup-test/AAAA.hs

@@ -0,0 +1,9 @@
+module Main where
+
+import System.Environment
+
+main = do
+  args <- getArgs
+  case args of
+    ["--help"] -> putStrLn "I am helping with the aaaa command"
+    _ -> putStrLn "aaaa"

cabal-testsuite/PackageTests/ExternalCommandHelp/setup-test/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for setup-test
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

cabal-testsuite/PackageTests/ExternalCommandHelp/setup-test/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2023, Matthew Pickering
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Matthew Pickering nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cabal-testsuite/PackageTests/ExternalCommandHelp/setup-test/setup-test.cabal

@@ -0,0 +1,25 @@
+cabal-version:      3.0
+name:               setup-test
+version:            0.1.0.0
+-- synopsis:
+-- description:
+license:            BSD-3-Clause
+license-file:       LICENSE
+author:             Matthew Pickering
+maintainer:         matthewtpickering@gmail.com
+-- copyright:
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+-- extra-source-files:
+
+common warnings
+    ghc-options: -Wall
+
+executable cabal-aaaa
+    import:           warnings
+    main-is: AAAA.hs
+    -- other-modules:
+    -- other-extensions:
+    build-depends:    base ^>=4.18.0.0
+    hs-source-dirs:   .
+    default-language: Haskell2010

cabal-testsuite/PackageTests/ExternalCommandSetup/aaaa/Main.hs

@@ -0,0 +1,3 @@
+module Main where
+
+main = putStrLn "aaaa"

cabal-testsuite/PackageTests/ExternalCommandSetup/aaaa/aaaa.cabal

@@ -0,0 +1,22 @@
+cabal-version:      3.0
+name:               aaaa
+version:            0.1.0.0
+license:            BSD-3-Clause
+license-file:       LICENSE
+author:             Matthew Pickering
+maintainer:         matthewtpickering@gmail.com
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+-- extra-source-files:
+
+common warnings
+    ghc-options: -Wall
+
+executable cabal-aaaa
+    import:           warnings
+    main-is:          Main.hs
+    -- other-modules:
+    -- other-extensions:
+    build-depends:    base ^>=4.18.0.0
+    hs-source-dirs:   .
+    default-language: Haskell2010