cabal-install integration-tests replacement omnibus patch #4124

ezyang · 2016-11-20T22:25:54Z

UPDATE. This branch has been commandeered into a bigger integration-tests replacement patch

These flags allow users to configure the location of
cabal.project and dist-newstyle, respectively. Primary
motivation is for the test suite, to allow non-clobbering
inplace testing.

Bikeshed points:

GlobalFlags or InstallFlags? I picked GlobalFlags as it
seemed more appropriate from a semantic perspective, but
the downside is that you must now specify the flag
before new-build, i.e., cabal --dist-dir=... new-build.
However, if we ever support a Nix-style command that
doesn't take the full complement of InstallFlags, GlobalFlags
is the only place it could go.
Flag names? I think --project-file is good but perhaps
someone has a better idea for --dist-dir.
Is this in duplication with globalConfigFile? I have
no idea what that parameter does, so I don't think so.

It's not too easy to make the value of 'dist-dir' saveable
to the cabal.project file, as we'd prefer to load directly
from the cache if cabal.project is not updated.

CC @hvr

mention-bot · 2016-11-20T22:25:56Z

@ezyang, thanks for your PR! By analyzing the history of the files in this pull request, we identified @dcoutts, @23Skidoo and @brendanhay to be potential reviewers.

hvr · 2016-11-20T22:36:51Z

As pointed out on IRC, there's already an option in cabal install named

    --builddir=DIR                   The directory where Cabal puts generated
                                     build files (default dist)

ezyang · 2016-11-21T02:14:23Z

It's not entirely clear to me that reusing --builddir here is the right thing to do, since --builddir needs to have different, distinct values for every subcall to Cabal. Could be error-prone.

23Skidoo · 2016-11-21T04:35:17Z

From the user's point of view, what would be the diffrerence between --dist-dir and --builddir? We must explain it well to our users if we are going to have both.

ezyang · 2016-11-21T04:39:50Z

I'm OK with these not being user facing.

A --builddir has a specific layout: you can find the executable named foo at $builddir/build/foo/foo. A --dist-dir guarantees a JSON plan file at $distdir/cache/plan.json but otherwise the format is unspecified.

hvr · 2016-11-21T08:02:07Z

Otoh, weren't we going to rename the default dist-newstyle to dist anyway? And what about the state when new-build is becoming the default and the "old-build" is getting removed?

23Skidoo · 2016-11-23T11:27:45Z

I'm OK with these not being user facing.

Then I guess we should hide them in --help output?

ezyang · 2016-11-25T04:15:06Z

Based on #4127, I've been convinced that we should use --builddir to control the location of dist-newstyle. Note that --builddir is a flag that is separately represented in every flags data structure (e.g., ConfigFlags, InstallFlags, CopyFlags; see ****DistPref) so some care must be taken. We cannot convert it into a global flag as that will break backwards compatibility with scripts that expect to be able pass --builddir after the subcommand (global flags must be specified before the subcommand.) Possibly for consistencies sake this means that --project-file should move out to (though I'm not sure to where.) I do not know if we can refactor dist-pref so that it doesn't show up in every flag settings individually.

hvr · 2016-11-25T12:56:56Z

@ezyang is there any chance to enhance the option parser to have it accept (some or all) global flags even after the subcommand? Then we could also make verbosity a global flag... (unless there's a reason not to)

ezyang · 2016-11-25T15:55:21Z

We'd have to make more breaking API changes in this case, as GlobalFlags is not passed into many of the subcommand functions (e.g., configure only takes ConfigFlags.

ezyang · 2016-11-27T04:02:49Z

Retiring this PR for now.

Signed-off-by: Edward Z. Yang <[email protected]>

Previously, these flags had no affect on new-build. Now, they let you specify where the dist-newstyle directory should go. Note that if a relative path is provided, it is resolved relative to the *project root*. If this is undesirable, pass an absolute path instead. Fixes haskell#4127. Signed-off-by: Edward Z. Yang <[email protected]>

This is a global flag, so it can only be specified prior to the subcommand. It controls the name of the cabal.project file which new-build and related commands looks for. Signed-off-by: Edward Z. Yang <[email protected]>

Signed-off-by: Edward Z. Yang <[email protected]>

This information is useful for determining where the build products are placed, so we can, e.g., run the built executables. Signed-off-by: Edward Z. Yang <[email protected]>

Signed-off-by: Edward Z. Yang <[email protected]>

TODO: This hacks HOME so that it works in CI which doesn't have old-time available in system GHC, remove that hack eventually. Signed-off-by: Edward Z. Yang <[email protected]>

…t up) Signed-off-by: Edward Z. Yang <[email protected]>

Signed-off-by: Edward Z. Yang <[email protected]>

This is a pretty important new feature in the test suite, which is to construct a remote repository on the fly as part of the test suite. The general principle is that you create a directory full of folders for all of the packages you want available in the repo, and then the 'withRepo' function will initialize this into a secure repo you can do tests with. Fixes haskell#4016. Signed-off-by: Edward Z. Yang <[email protected]>

Note: hackage-repo-tool doesn't build with Windows, so that support is commented out. Signed-off-by: Edward Z. Yang <[email protected]>

Signed-off-by: Edward Z. Yang <[email protected]>

Previously, in some cases we would carry around an explicit FilePath for an executable that we wanted to invoke subsequently. In this new scheme, any executable we want to execute gets registered to the ProgramDb we are carrying around. Now we can uniformly use runProgramM in all cases. Great! Signed-off-by: Edward Z. Yang <[email protected]>

Previously, clients of runM had to explicitly record and check the exit code of a run subcommand. This has now been folded into runM, so this is done always (which is what you wanted anyway.) Signed-off-by: Edward Z. Yang <[email protected]>

TODO: This seems to cause Windows failure Signed-off-by: Edward Z. Yang <[email protected]>

ezyang · 2016-11-27T22:49:31Z

GREEEEEEEEEEEEEEN.

Otherwise, ghc-pkg will complain that it's reinitializing the package database. Possibly there is some refactor to make withPackageDb more robust if it is called multiple times. Signed-off-by: Edward Z. Yang <[email protected]>

This fixes some "permission denied" failures on Windows, but it would be a lot better to fix properly. See the comment in Test.Cabal.Monad for more details. Signed-off-by: Edward Z. Yang <[email protected]>

Signed-off-by: Edward Z. Yang <[email protected]>

ezyang mentioned this pull request Nov 22, 2016

new-build ignores --builddir option #4127

Closed

ezyang force-pushed the cabal-shake branch from f8f166a to 4a31bae Compare November 26, 2016 06:43

ezyang changed the title ~~Support for --project-file and --dist-dir flags.~~ cabal-install integration-tests replacement omnibus patch Nov 26, 2016

ezyang mentioned this pull request Nov 27, 2016

Story for new-build tests into the global store #4016

Closed

ezyang closed this Nov 27, 2016

ezyang reopened this Nov 27, 2016

ezyang added 13 commits November 27, 2016 10:58

Remove redundant import.

3b8589f

Signed-off-by: Edward Z. Yang <[email protected]>

Documentation for --builddir and --project-file flags.

847d3f5

Signed-off-by: Edward Z. Yang <[email protected]>

Use --project-file and --builddir in cabal new-build tests.

fa3746a

Signed-off-by: Edward Z. Yang <[email protected]>

Add default-language pragmas to cabal-testsuite.cabal

ef432a4

Signed-off-by: Edward Z. Yang <[email protected]>

Switch cabal-tests to executable so it is always configured.

7e7b4e9

Signed-off-by: Edward Z. Yang <[email protected]>

Add support for reading plan.json from new-build in test suite.

65f8eec

This information is useful for determining where the build products are placed, so we can, e.g., run the built executables. Signed-off-by: Edward Z. Yang <[email protected]>

Enable cabal-install tests with cabal-testsuite in CI.

dd7fa17

Signed-off-by: Edward Z. Yang <[email protected]>

Port backpack/includes2 to new test suite.

e309598

Signed-off-by: Edward Z. Yang <[email protected]>

Port backpack/includes3 to new test suite.

7b90a21

Signed-off-by: Edward Z. Yang <[email protected]>

Add accidentally dropped ConfigureComponent/SubLib test

c20c114

Signed-off-by: Edward Z. Yang <[email protected]>

Ignore Setup executables.

20c0c2d

Signed-off-by: Edward Z. Yang <[email protected]>

ezyang added 20 commits November 27, 2016 11:15

Port exec/auto_configures_on_exec to new test suite

c2008fd

Signed-off-by: Edward Z. Yang <[email protected]>

Tweaks for when to pass --builddir to cabal executable.

2ae93d3

Signed-off-by: Edward Z. Yang <[email protected]>

Teach cabal exec the --builddir option.

322214c

Signed-off-by: Edward Z. Yang <[email protected]>

Port exec/can_run_executables_installed_in_sandbox to new test suite

6d3a00a

Signed-off-by: Edward Z. Yang <[email protected]>

Port exec/configures_cabal_to_use_sandbox to use new test suite

158cc06

Signed-off-by: Edward Z. Yang <[email protected]>

Port exec/configures_ghc_to_use_sandbox to new test suite.

e8ce472

Signed-off-by: Edward Z. Yang <[email protected]>

Port exec/exit_with_failure_without_args to new test suite.

ea0c388

Signed-off-by: Edward Z. Yang <[email protected]>

Port exec/runs_given_command to new test suite.

768da11

Signed-off-by: Edward Z. Yang <[email protected]>

Add new-build variant of CustomDep test.

af26fb6

TODO: This hacks HOME so that it works in CI which doesn't have old-time available in system GHC, remove that hack eventually. Signed-off-by: Edward Z. Yang <[email protected]>

Remove unneeded files from extra-source-files (TODO: break this commi…

749fd0c

…t up) Signed-off-by: Edward Z. Yang <[email protected]>

Add support for known broken tests.

9c41ff0

Signed-off-by: Edward Z. Yang <[email protected]>

Add expectBrokenIf and expectBrokenUnless variants.

b5ee225

Signed-off-by: Edward Z. Yang <[email protected]>

Prefix testDistDir with work to disambiguate.

42e9018

Signed-off-by: Edward Z. Yang <[email protected]>

Swap from testWorkDir to testDistDir for cabal builddir.

59f7943

Signed-off-by: Edward Z. Yang <[email protected]>

Enable hackage-repo-tool in CI

ae03fd0

Note: hackage-repo-tool doesn't build with Windows, so that support is commented out. Signed-off-by: Edward Z. Yang <[email protected]>

Port custom-setup/new_build_requires_Cabal_1_20 to new test suite.

c1caede

Signed-off-by: Edward Z. Yang <[email protected]>

Centralize use of record/require.

326da71

Previously, clients of runM had to explicitly record and check the exit code of a run subcommand. This has now been folded into runM, so this is done always (which is what you wanted anyway.) Signed-off-by: Edward Z. Yang <[email protected]>

Cleanup between setup and cabal tests

9a3cd91

TODO: This seems to cause Windows failure Signed-off-by: Edward Z. Yang <[email protected]>

ezyang force-pushed the cabal-shake branch from 4173e68 to fae73ba Compare November 27, 2016 19:34

ezyang mentioned this pull request Nov 27, 2016

ghc-options applies to all dependencies, not just local packages #3883

Closed

ezyang added 4 commits November 27, 2016 14:50

Try harder not to runTestM twice when it can be avoided.

b431765

This fixes some "permission denied" failures on Windows, but it would be a lot better to fix properly. See the comment in Test.Cabal.Monad for more details. Signed-off-by: Edward Z. Yang <[email protected]>

Split up OS X tests to get them under the time.

ca6f056

Signed-off-by: Edward Z. Yang <[email protected]>

8.0.1 builds are bumping limit, so move TEST_OTHER_VERSIONS to 7.4.2

b1a5ae8

Signed-off-by: Edward Z. Yang <[email protected]>

ezyang force-pushed the cabal-shake branch from 7887f08 to b1a5ae8 Compare November 27, 2016 23:00

ezyang merged commit e7acd71 into haskell:master Nov 28, 2016

ulysses4ever mentioned this pull request Jul 18, 2022

Entry builddir: <dir> silently ignored from cabal.project #7941

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

cabal-install integration-tests replacement omnibus patch #4124

cabal-install integration-tests replacement omnibus patch #4124

Uh oh!

ezyang commented Nov 20, 2016 •

edited

Loading

Uh oh!

mention-bot commented Nov 20, 2016

Uh oh!

hvr commented Nov 20, 2016

Uh oh!

ezyang commented Nov 21, 2016

Uh oh!

23Skidoo commented Nov 21, 2016 •

edited

Loading

Uh oh!

ezyang commented Nov 21, 2016

Uh oh!

hvr commented Nov 21, 2016 •

edited

Loading

Uh oh!

23Skidoo commented Nov 23, 2016

Uh oh!

ezyang commented Nov 25, 2016

Uh oh!

hvr commented Nov 25, 2016 •

edited

Loading

Uh oh!

ezyang commented Nov 25, 2016

Uh oh!

ezyang commented Nov 27, 2016

Uh oh!

ezyang commented Nov 27, 2016

Uh oh!

Uh oh!

cabal-install integration-tests replacement omnibus patch #4124

cabal-install integration-tests replacement omnibus patch #4124

Uh oh!

Conversation

ezyang commented Nov 20, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mention-bot commented Nov 20, 2016

Uh oh!

hvr commented Nov 20, 2016

Uh oh!

ezyang commented Nov 21, 2016

Uh oh!

23Skidoo commented Nov 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ezyang commented Nov 21, 2016

Uh oh!

hvr commented Nov 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

23Skidoo commented Nov 23, 2016

Uh oh!

ezyang commented Nov 25, 2016

Uh oh!

hvr commented Nov 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ezyang commented Nov 25, 2016

Uh oh!

ezyang commented Nov 27, 2016

Uh oh!

ezyang commented Nov 27, 2016

Uh oh!

Uh oh!

ezyang commented Nov 20, 2016 •

edited

Loading

23Skidoo commented Nov 21, 2016 •

edited

Loading

hvr commented Nov 21, 2016 •

edited

Loading

hvr commented Nov 25, 2016 •

edited

Loading