Cabal Init Omnibus #7344

emilypi · 2021-03-30T00:30:01Z

Please include the following checklist in your PR:

Patches conform to the coding conventions.
Any changes that could be relevant to users have been recorded in the changelog.
The documentation has been updated, if necessary.

New additions

This PR does the following:

Completely rewrites the cabal init command to have a saner structure that can be tested easily.
Optimizing for individual component target generation allows us to golden test individual stanzas under various scenarios instead of just whole cabal files
Coverage reports may now be generated for every component of the command. Coverage works for the whole project now, full stop.
Control flow for interactive vs. non-interactive vs. simple target generation is completely decoupled.
Cleans up the file creation spaghetti, and prunes unused or redundant behavior wherever it arises.
Rewrites the prompt code to be less unnecessarily typed (strings are fine!)

This comes with bugfixes:

Cabal/src/Distribution/Fields/Pretty.hs

phadej · 2021-03-30T10:24:02Z

Why bundle coverage changes and cabal init changes? Are they related? I don't see how.

cabal-install/cabal-install.cabal

phadej · 2021-03-30T10:32:51Z

I don't like how this contains at least three separate changes in one PR. I hope this is just a draft.

emilypi · 2021-03-30T14:20:35Z

@phadej it's clearly marked a draft. I'll split it out into several PRs if that makes you less uneasy.

Why bundle coverage changes and cabal init changes? Are they related? I don't see how.

Because i can't test the init script reasonably well if i can't generate coverage. It turns out that in order to make any effective change towards fixing things for cabal init, I needed to test it. And then I found out that testing is woefully underserved due to the way the project was structured. Then one thing led to another, and this is the minimal changeset needed to get things working properly so that i can generate coverage for the unit tests we're writing and actually fix cabal init problems with any level of certainty.

emilypi · 2021-04-14T15:56:26Z

@fgaz just so @ptkato and I can parallelize a bit, how do you want to split this PR up into reviewable chunks?

fgaz · 2021-04-14T16:56:41Z

At the commit level, ideally the smallest chunks that make sense (and build) on their own. At the pr level, strongly related changes can be on the same pr. Or not. So something like this, following OP:

PR: infrastructure stuff (should probably be a single pr since most of the stuff depends on the previous)
- commit: Expose modules as part of a cabal-install library
- commit: Gets rid of the dogfooding framework...
- commit: generate coverage reports
- commit: Move cabal-install-solver out to its own directory.
- commit: Move all long-running tests to their own test target
PR: fix for HPC generation (or was this the pr that just got merged?)
PR: init stuff
- no idea if this can be split. probably not?

emilypi · 2021-04-14T18:38:54Z

@fgaz i agree with that timeline. The HPC + coverage stuff is covered by Ocharles' PR that just went in, and the init stuff can't be split (or at least, shouldn't)

* Restructures the `cabal init` command to fix historical issues. All flags are preserved. * Codebases for interactive and non-interactive flags are disentangled. * Data structures now exploit relevant stanza structure and formatters only care about stanza data * Heuristics and prompts have a pure and impure implementation. * Sets default behavior to be `--interactive` as opposed to `--non-interactive`. * Rewrites tests to achieve 98% coverage * Golden files now test every stanza individually * Every flag is covered by a unit test * Interactive, simple, and non-interactive workflows are covered.

cabal-install/tests/fixtures/init/golden/cabal/cabal-lib-and-exe-with-comments.golden

emilypi · 2021-05-05T12:05:49Z

cabal-install/src/Distribution/Client/Init/Interactive/Command.hs

    -> InstalledPackageIndex
    -> SourcePackageDb
    -> InitFlags
    -> m ProjectSettings
-createProject v pkgIx srcDb initFlags = do
+createProject v _comp pkgIx srcDb initFlags = do


@ptkato This is unused in a bunch of cases (interactive + simple, including thier tests). I'd just configure NonInteractive.createProject to take the compiler arg first and then return NonInteractive.createProject comp as the function returned in the where clause. Otherwise it just introduces cruft into more places than we want.

tests/fixtures/init/golden/pkg-desc/pkg-with-comments.golden

Mikolaj

Awesome mega-PR. I can't do it justice, not taking part in the epic struggle from the beginning, but I'm duly impressed by its breadth and the law and order it imposes. I would feel uncomfortable with such a large PR, but I understand it provides an excellent test coverage for what it changes. Great job.

cabal-install/tests/fixtures/init/golden/cabal/cabal-lib-and-exe-with-comments.golden

emilypi · 2021-05-26T18:33:11Z

🎉

emilypi changed the title ~~Cabal Init Rewrite~~ Cabal Init Omnibus Mar 30, 2021

phadej reviewed Mar 30, 2021

View reviewed changes

Cabal/src/Distribution/Fields/Pretty.hs Show resolved Hide resolved

phadej reviewed Mar 30, 2021

View reviewed changes

cabal-install/cabal-install.cabal Outdated Show resolved Hide resolved

emilypi mentioned this pull request Apr 3, 2021

Allow bytestring-0.11 + tree-diff-0.2 #7346

Merged

emilypi mentioned this pull request Apr 14, 2021

Expose cabal-install lib, remove dogfooding, expose cabal-install-solver as own lib, enable HPC coverage reporting. #7358

Merged

3 tasks

ptkato force-pushed the cabal-init-rewrite branch from 6c217c7 to f6b4f65 Compare May 3, 2021 21:49

emilypi force-pushed the cabal-init-rewrite branch from 17e31e9 to 1068755 Compare May 4, 2021 18:09

emilypi added a commit to ptkato/cabal that referenced this pull request May 4, 2021

Add changelog.d entry for haskell#7344

972ceb3

emilypi marked this pull request as ready for review May 4, 2021 18:14

emilypi requested review from Mikolaj and fgaz May 4, 2021 18:14

emilypi added cabal-install: cmd/init cabal-install: tests/unit-tests type: enhancement labels May 4, 2021

emilypi commented May 4, 2021

View reviewed changes

cabal-install/tests/fixtures/init/golden/cabal/cabal-lib-and-exe-with-comments.golden Show resolved Hide resolved

Add changelog.d entry for haskell#7344

5892f42

emilypi force-pushed the cabal-init-rewrite branch from 972ceb3 to 5892f42 Compare May 4, 2021 18:41

ptkato added 4 commits May 4, 2021 19:01

Changing to canonicalizePathNoThrow to prevent exceptions

186d448

Preppending the package dir to the app dir

6a7621c

Using the compiler version from Distribution.Simple.Compiler

7c82d28

Adding tests for base version bounds

299db9a

emilypi commented May 5, 2021

View reviewed changes

Mikolaj reviewed May 5, 2021

View reviewed changes

tests/fixtures/init/golden/pkg-desc/pkg-with-comments.golden Outdated Show resolved Hide resolved

ptkato and others added 5 commits May 11, 2021 18:44

Adding more checks for the existence of paths

fcce141

Adjusting tests for the remaining checks

a63fe9b

Pinpointing in which modules the packages couldn't be found

836d6b6

remove golden file cruft

7d91d3c

Parametrizing verbosity for dependencies function

0d20866

ptkato force-pushed the cabal-init-rewrite branch from 582d4c3 to 0d20866 Compare May 14, 2021 04:32

emilypi added 7 commits May 14, 2021 00:41

undo reversion

a0f1ef2

respect minimal flag

5995ada

regen golden tests with better names

03dbdd7

fix warnings

509a2dd

fix some prompt bugs, last minute file creation bugs

9118940

fix some prompt bugs, last minute file creation bugs

6ffee75

Remove redundant imports

0e20b01

emilypi requested a review from Mikolaj May 16, 2021 20:46

emilypi added 3 commits May 17, 2021 10:25

improve filecreation consistency and safety checks

f2c8bb7

remove tem dir

76468fb

remove stale test directory

1ae7433

Mikolaj approved these changes May 18, 2021

View reviewed changes

cabal-install/tests/fixtures/init/golden/cabal/cabal-lib-and-exe-with-comments.golden Show resolved Hide resolved

fgaz mentioned this pull request May 18, 2021

[ fix #7251 ] sort and nub module list inferred by cabal init --lib #7253

Closed

5 tasks

emilypi merged commit a39d590 into haskell:master May 26, 2021

emilypi deleted the cabal-init-rewrite branch May 26, 2021 18:40

fgaz mentioned this pull request May 27, 2021

cabal init fails if folder name exists on hackage #6236

Closed

emilypi mentioned this pull request May 27, 2021

cabal init --tests does not create any tests if not using --lib{andexe} #7410

Closed

Mikolaj mentioned this pull request May 28, 2021

cabal init -i Cabal version does not list 3.0 #6239

Closed

ptkato pushed a commit to ptkato/cabal that referenced this pull request May 31, 2021

Add changelog.d entry for haskell#7344

3575a4e

ptkato mentioned this pull request Jun 5, 2021

Proposal for Init #7265

Closed

jneira mentioned this pull request Jul 17, 2021

cabal init incorrectly writes non-ASCII file names in library:exposed-modules #6507

Open

ffaf1 mentioned this pull request Feb 15, 2023

Return empty default when git fails #8755

Merged

andreasabel mentioned this pull request Feb 21, 2023

cabal init will relocate and rename project structure #8787

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cabal Init Omnibus #7344

Cabal Init Omnibus #7344

emilypi commented Mar 30, 2021 •

edited

Loading

phadej commented Mar 30, 2021

phadej commented Mar 30, 2021

emilypi commented Mar 30, 2021 •

edited

Loading

emilypi commented Apr 14, 2021

fgaz commented Apr 14, 2021

emilypi commented Apr 14, 2021 •

edited

Loading

emilypi May 5, 2021 •

edited

Loading

Mikolaj left a comment

emilypi commented May 26, 2021

Cabal Init Omnibus #7344

Cabal Init Omnibus #7344

Conversation

emilypi commented Mar 30, 2021 • edited Loading

New additions

phadej commented Mar 30, 2021

phadej commented Mar 30, 2021

emilypi commented Mar 30, 2021 • edited Loading

emilypi commented Apr 14, 2021

fgaz commented Apr 14, 2021

emilypi commented Apr 14, 2021 • edited Loading

emilypi May 5, 2021 • edited Loading

Choose a reason for hiding this comment

Mikolaj left a comment

Choose a reason for hiding this comment

emilypi commented May 26, 2021

emilypi commented Mar 30, 2021 •

edited

Loading

emilypi commented Mar 30, 2021 •

edited

Loading

emilypi commented Apr 14, 2021 •

edited

Loading

emilypi May 5, 2021 •

edited

Loading