Skip to content
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

Add test-wrapper option to wrap test execution #5995

Merged
merged 12 commits into from
Apr 30, 2019
Merged

Add test-wrapper option to wrap test execution #5995

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bb48e46
Add test-wrapper option to wrap test execution
angerman Apr 10, 2019
5fc435c
Update Setup.hs
angerman Apr 10, 2019
166c294
Update ProjectPlanning.hs
angerman Apr 10, 2019
07ff963
More testWrapper.
angerman Apr 10, 2019
633bf42
Fix compilation error for cabal-install package
JoshMeredith Apr 23, 2019
db8745c
Expose test-wrapper option through the cabal-install package client
JoshMeredith Apr 24, 2019
3273cd6
Fix test suite compile errors
JoshMeredith Apr 26, 2019
3cacbe7
Add filterTestFlags
JoshMeredith Apr 26, 2019
ce1b49e
Documentation and changelog
JoshMeredith Apr 26, 2019
58ce473
Fix unnecessary export/dodgy import
JoshMeredith Apr 29, 2019
7322ecc
Clarify documentation
JoshMeredith Apr 29, 2019
a9471cd
Fix round trip print/parse tests
JoshMeredith Apr 29, 2019
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
7 changes: 7 additions & 0 deletions Cabal/Distribution/Simple/Setup.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1864,6 +1864,7 @@ data TestFlags = TestFlags {
testMachineLog :: Flag PathTemplate,
testShowDetails :: Flag TestShowDetails,
testKeepTix :: Flag Bool,
testWrapper :: Flag FilePath,
testFailWhenNoTestSuites :: Flag Bool,
-- TODO: think about if/how options are passed to test exes
testOptions :: [PathTemplate]
Expand All @@ -1877,6 +1878,7 @@ defaultTestFlags = TestFlags {
testMachineLog = toFlag $ toPathTemplate $ "$pkgid.log",
testShowDetails = toFlag Failures,
testKeepTix = toFlag False,
testWrapper = NoFlag,
testFailWhenNoTestSuites = toFlag False,
testOptions = []
}
Expand Down Expand Up @@ -1942,6 +1944,11 @@ testOptions' showOrParseArgs =
"keep .tix files for HPC between test runs"
testKeepTix (\v flags -> flags { testKeepTix = v})
trueArg
, option [] ["test-wrapper"]
"Run test through a wrapper."
testWrapper (\v flags -> flags { testWrapper = v })
(reqArg' "FILE" (toFlag :: FilePath -> Flag FilePath)
(flagToList :: Flag FilePath -> [FilePath]))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add this to at least Distribution.Cabal.Setup.testOptions if you want it to actually make it through to a user-facing option.

, option [] ["fail-when-no-test-suites"]
("Exit with failure when no test suites are found.")
testFailWhenNoTestSuites (\v flags -> flags { testFailWhenNoTestSuites = v})
Expand Down
7 changes: 6 additions & 1 deletion Cabal/Distribution/Simple/Test/ExeV10.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,12 @@ runTest pkg_descr lbi clbi flags suite = do
return (addLibraryPath os paths shellEnv)
else return shellEnv

exit <- rawSystemIOWithEnv verbosity cmd opts Nothing (Just shellEnv')
exit <- case testWrapper flags of
Flag path -> rawSystemIOWithEnv verbosity path (cmd:opts) Nothing (Just shellEnv')
-- these handles are automatically closed
Nothing (Just wOut) (Just wErr)

NoFlag -> rawSystemIOWithEnv verbosity cmd opts Nothing (Just shellEnv')
-- these handles are automatically closed
Nothing (Just wOut) (Just wErr)

Expand Down
11 changes: 8 additions & 3 deletions Cabal/Distribution/Simple/Test/LibV09.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,14 @@ runTest pkg_descr lbi clbi flags suite = do
cpath <- canonicalizePath $ LBI.componentBuildDir lbi clbi
return (addLibraryPath os (cpath : paths) shellEnv)
else return shellEnv
createProcessWithEnv verbosity cmd opts Nothing (Just shellEnv')
-- these handles are closed automatically
CreatePipe (UseHandle wOut) (UseHandle wOut)
case testWrapper flags of
Flag path -> createProcessWithEnv verbosity path (cmd:opts) Nothing (Just shellEnv')
-- these handles are closed automatically
CreatePipe (UseHandle wOut) (UseHandle wOut)

NoFlag -> createProcessWithEnv verbosity cmd opts Nothing (Just shellEnv')
-- these handles are closed automatically
CreatePipe (UseHandle wOut) (UseHandle wOut)

hPutStr wIn $ show (tempLog, PD.testName suite)
hClose wIn
Expand Down
1 change: 1 addition & 0 deletions cabal-install/Distribution/Client/Config.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,7 @@ instance Semigroup SavedConfig where
testMachineLog = combine testMachineLog,
testShowDetails = combine testShowDetails,
testKeepTix = combine testKeepTix,
testWrapper = combine testWrapper,
testFailWhenNoTestSuites = combine testFailWhenNoTestSuites,
testOptions = lastNonEmpty testOptions
}
Expand Down
2 changes: 2 additions & 0 deletions cabal-install/Distribution/Client/ProjectConfig/Legacy.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,7 @@ convertLegacyPerPackageFlags configFlags installFlags haddockFlags testFlags =
testMachineLog = packageConfigTestMachineLog,
testShowDetails = packageConfigTestShowDetails,
testKeepTix = packageConfigTestKeepTix,
testWrapper = packageConfigTestWrapper,
testFailWhenNoTestSuites = packageConfigTestFailWhenNoTestSuites,
testOptions = packageConfigTestTestOptions
} = testFlags
Expand Down Expand Up @@ -795,6 +796,7 @@ convertToLegacyPerPackageConfig PackageConfig {..} =
testMachineLog = packageConfigTestMachineLog,
testShowDetails = packageConfigTestShowDetails,
testKeepTix = packageConfigTestKeepTix,
testWrapper = packageConfigTestWrapper,
testFailWhenNoTestSuites = packageConfigTestFailWhenNoTestSuites,
testOptions = packageConfigTestTestOptions
}
Expand Down
1 change: 1 addition & 0 deletions cabal-install/Distribution/Client/ProjectConfig/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ data PackageConfig
packageConfigTestMachineLog :: Flag PathTemplate,
packageConfigTestShowDetails :: Flag TestShowDetails,
packageConfigTestKeepTix :: Flag Bool,
packageConfigTestWrapper :: Flag FilePath,
packageConfigTestFailWhenNoTestSuites :: Flag Bool,
packageConfigTestTestOptions :: [PathTemplate]
}
Expand Down
2 changes: 2 additions & 0 deletions cabal-install/Distribution/Client/ProjectPlanning.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1884,6 +1884,7 @@ elaborateInstallPlan verbosity platform compiler compilerprogdb pkgConfigDB
elabTestHumanLog = perPkgOptionMaybe pkgid packageConfigTestHumanLog
elabTestShowDetails = perPkgOptionMaybe pkgid packageConfigTestShowDetails
elabTestKeepTix = perPkgOptionFlag pkgid False packageConfigTestKeepTix
elabTestWrapper = perPkgOptionFlag pkgid False packageConfigTestWrapper
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean perPkgOptionMaybe pkgid packageConfigTestWrapper?

elabTestFailWhenNoTestSuites = perPkgOptionFlag pkgid False packageConfigTestFailWhenNoTestSuites
elabTestTestOptions = perPkgOptionList pkgid packageConfigTestTestOptions

Expand Down Expand Up @@ -3440,6 +3441,7 @@ setupHsTestFlags (ElaboratedConfiguredPackage{..}) _ verbosity builddir = Cabal.
, testHumanLog = maybe mempty toFlag elabTestHumanLog
, testShowDetails = maybe (Flag Cabal.Always) toFlag elabTestShowDetails
, testKeepTix = toFlag elabTestKeepTix
, testWrapper = mempty
, testFailWhenNoTestSuites = toFlag elabTestFailWhenNoTestSuites
, testOptions = elabTestTestOptions
}
Expand Down
1 change: 1 addition & 0 deletions cabal-install/Distribution/Client/ProjectPlanning/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ data ElaboratedConfiguredPackage
elabTestHumanLog :: Maybe PathTemplate,
elabTestShowDetails :: Maybe TestShowDetails,
elabTestKeepTix :: Bool,
elabTestWrapper :: Maybe FilePath
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing trailing comma means this doesn't compile.

elabTestFailWhenNoTestSuites :: Bool,
elabTestTestOptions :: [PathTemplate],

Expand Down
14 changes: 8 additions & 6 deletions cabal-install/tests/UnitTests/Distribution/Client/ProjectConfig.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,8 +656,9 @@ instance Arbitrary PackageConfig where
, packageConfigTestMachineLog = x45
, packageConfigTestShowDetails = x46
, packageConfigTestKeepTix = x47
, packageConfigTestFailWhenNoTestSuites = x48
, packageConfigTestTestOptions = x49 } =
, packageConfigTestWrapper = x48
, packageConfigTestFailWhenNoTestSuites = x49
, packageConfigTestTestOptions = x50 } =
[ PackageConfig { packageConfigProgramPaths = postShrink_Paths x00'
, packageConfigProgramArgs = postShrink_Args x01'
, packageConfigProgramPathExtra = x02'
Expand Down Expand Up @@ -709,8 +710,9 @@ instance Arbitrary PackageConfig where
, packageConfigTestMachineLog = x45'
, packageConfigTestShowDetails = x46'
, packageConfigTestKeepTix = x47'
, packageConfigTestFailWhenNoTestSuites = x48'
, packageConfigTestTestOptions = x49' }
, packageConfigTestWrapper = x48'
, packageConfigTestFailWhenNoTestSuites = x49'
, packageConfigTestTestOptions = x50' }
| (((x00', x01', x02', x03', x04'),
(x05', x42', x06', x50', x07', x08', x09'),
(x10', x11', x12', x13', x14'),
Expand All @@ -720,7 +722,7 @@ instance Arbitrary PackageConfig where
(x30', x31', x32', (x33', x33_1'), x34'),
(x35', x36', x37', x38', x43', x39'),
(x40', x41'),
(x44', x45', x46', x47', x48', x49')))
(x44', x45', x46', x47', x48', x49', x50')))
<- shrink
(((preShrink_Paths x00, preShrink_Args x01, x02, x03, x04),
(x05, x42, x06, x50, x07, x08, x09),
Expand All @@ -734,7 +736,7 @@ instance Arbitrary PackageConfig where
(x30, x31, x32, (x33, x33_1), x34),
(x35, x36, fmap NonEmpty x37, x38, x43, fmap NonEmpty x39),
(x40, x41),
(x44, x45, x46, x47, x48, x49)))
(x44, x45, x46, x47, x48, x49, x50)))
]
where
preShrink_Paths = Map.map NonEmpty
Expand Down