Skip to content

merge queue: checking master (bc15653) and #12073 together #12088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mergify wants to merge 2 commits into from
+48 −5
Closed

merge queue: checking master (bc15653) and #12073 together #12088

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0170f8
Add a section for assertions and note marked output
philderbeast Jul 1, 2026
96620e6
Merge of #12073
mergify[bot] Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 48 additions & 5 deletions cabal-testsuite/src/Test/Cabal/Prelude.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,45 @@
{-# LANGUAGE NondecreasingIndentation #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ViewPatterns #-}
{-# OPTIONS_GHC -Wno-duplicate-exports #-}
{-# OPTIONS_GHC -Wno-redundant-constraints #-}

-- | Generally useful definitions that we expect most test scripts
-- to use.
module Test.Cabal.Prelude
( module Test.Cabal.Prelude
( -- * Assertions

-- ** Assert Marked Output
-- $marked-output
assertOutputContains
, assertOutputDoesNotContain
, assertOutputMatches
, assertOutputDoesNotMatch
, assertOn

-- ** Assert File
, assertFileDoesContain
, assertFileDoesNotContain
, assertFindInFile
, assertAnyFileContains
, assertNoFileContains

-- ** Assert Glob
, assertGlobMatches
, assertGlobDoesNotMatch
, assertGlobMatchesTestDir
, assertGlobDoesNotMatchTestDir

-- ** Other Assertions
, assertBool
, assertEqual
, assertExitCode
, assertFailure
, assertNotEqual
, assertRegex

-- * Re-exports
, module Test.Cabal.Prelude
, module Test.Cabal.Monad
, module Test.Cabal.NeedleHaystack
, module Test.Cabal.Run
Expand Down Expand Up @@ -36,9 +69,6 @@ import Distribution.Simple.Configure
import Distribution.Simple.PackageDescription (readGenericPackageDescription)
import Distribution.Simple.Program
import Distribution.Simple.Utils
( tryFindPackageDesc
, withFileContents
)
import Distribution.System (Arch (JavaScript), OS (Linux, OSX, Windows), buildArch, buildOS)
import Distribution.Types.LocalBuildInfo
import Distribution.Utils.Path
Expand Down Expand Up @@ -67,7 +97,7 @@ import qualified Data.ByteString.Base16 as Base16
import qualified Data.ByteString.Char8 as C
import qualified Data.ByteString.Lazy as BSL
import qualified Data.Char as Char
import Data.List (isInfixOf, isPrefixOf, stripPrefix)
import Data.List (isPrefixOf, stripPrefix)
import Data.Maybe (fromMaybe, isJust, mapMaybe)
import Network.Wait (waitTcpVerbose)
import System.Directory
Expand All @@ -85,6 +115,19 @@ import System.Process
import System.Posix.Resource
#endif

-- $marked-output
-- When asserting on the output of a command we only have access to the marked
-- output. That is the output between these markers:
--
-- @
-- -----BEGIN CABAL OUTPUT-----
-- -----END CABAL OUTPUT-----
-- @
--
-- This is the output from 'notice' and `warn` messages. It does not include the
-- output from `debug` or `info` messages. This is mostly because the output
-- from `debug` and `info` messages is not expected to be deterministic.

------------------------------------------------------------------------

-- * Utilities
Expand Down
Loading