* More consistently pass --package-db flag to tests

Previously `--package-db` was only passed to test which used the `v2-`
prefix.

Now we pass `--package-db` to things which use the `v2-` prefix, not
things which use the `v1-` prefix and by default assume that unprefixed
commands are v2 commands.

(cherry picked from commit 2b44677c)

# Conflicts:
#	cabal-testsuite/PackageTests/CustomTestCoverage/cabal.out

* fixup! resolve conflicts

---------

Co-authored-by: Matthew Pickering <matthewtpickering@gmail.com>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

(cherry picked from commit 225d2b15)

Co-authored-by: Pierre Le Marre <dev@wismill.eu>

* testsuite: Refactor withShorterPathForNewBuildStore

This makes `withShorterPathForNewBuildStore` fit more nicely into the
rest of the testing infrastructure.

* Move `withShorterPathForNewBuildStore` to `TestM` monad
* Move responsibility for passing `--store-dir` to `cabalGArgs` function
* Move `findDependencyInStore` into `TestM`, and remove requirement to
  pass path to store directory.
* Introduce `testStoreDir` function which returns the store location
  (and honours `withShorterPathForNewBuildStore`)
* Migrate tests which use `withShorterPathForNewBuildStore`.

(cherry picked from commit 2a2d0b30)

# Conflicts:
#	Cabal-tests/Cabal-tests.cabal
#	Cabal-tests/lib/Test/Utils/TempTestDir.hs

* !fixup resolve conflicts

* fixup! always import `(</>)`

---------

Co-authored-by: Matthew Pickering <matthewtpickering@gmail.com>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>
Co-authored-by: brandon s allbery kf8nh <allbery.b@gmail.com>

[3.12] PackageTests/NewUpdate: fix skipping flaky tests

Zoe Zuser authored 10 months ago and Artem Pelenitsyn committed 10 months ago

RejectFutureIndexStates and UpdateIndexState are marked "skip", but it's
under withRemoteRepo, which causes flakiness before skip is called.

* Rename projects to cabal.*.project

- Rename cabal.bootstrap.project
- Rename cabal.meta.project
- Rename cabal.validate-libonly.project
- Rename cabal.validate.project
- Rename cabal.release.project

(cherry picked from commit d8147f62)

# Conflicts:
#	.github/workflows/quick-jobs.yml
#	Makefile
#	cabal.bootstrap.project

* Fix conflict with #9990

---------

Co-authored-by: Phil de Joux <philderbeast@gmail.com>
Co-authored-by: brandon s allbery kf8nh <allbery.b@gmail.com>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

* Fix #9815: switch quick-jobs CI to XDG

Fix #9815:
- Cache `~/.local/state/cabal` instead of `~/.cabal/store`
- `~/.local/bin` is used instead of `~/.cabal/bin` and is already in the PATH
  (verify this by calling `alex` after installing it)

As I am passing by:
- bump cache action to v4
- double-quote `$USER` to keep actionlint happy
- move `if` from shell-level to job-level
- allow newest `alex`

(cherry picked from commit e916cb59)

* CI quick-jobs: use preinstalled GHC and Cabal

(cherry picked from commit c209a827)

* Makefile: remove dead target 'lexer', use '.PHONY' systematically

The `lexer` target was removed in
https://github.com/haskell/cabal/pull/8980



(cherry picked from commit e6000878)

* CI "Meta checks": correct cache key

(cherry picked from commit 56426e4f)

* CI "Meta checks": print Haskell versions

(cherry picked from commit 9a311bd8)

* CI "Doctest Cabal": daily refresh of cache

(cherry picked from commit ba6f6ffc)

* CI "Check Field Syntax Reference": correct cache key

(cherry picked from commit 5949e3fd)

* Update generated Cabal/src/Distribution/Simple/Build/Macros/Z.hs

Not sure why this was not up to date on master and still CI passed.
Maybe the content of this file is dependent on the GHC version we are
using to build the `get-cabal-macros` tool?

(cherry picked from commit 947860a8)

* CI quick-jobs: entirely wipe ghcup directory rights workaround

(cherry picked from commit 5aa8afd4)

* !fixup

---------

Co-authored-by: Andreas Abel <andreas.abel@ifi.lmu.de>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

Co-authored-by: Rodrigo Mesquita <rodrigo.m.mesquita@gmail.com>

* Recommend using latest cabal-install

- Shorten the suggestion to use cabal.release.project
- Move up cabal.release.project for initial build
- Put the --project-file option after as suggested by the command help
- Usage: cabal build [TARGETS] [FLAGS]
- Use the latest markup for note
- $ prefix for command line

(cherry picked from commit de89ffe7)

# Conflicts:
#	CONTRIBUTING.md

* !fixup resolve conflict

---------

Co-authored-by: Phil de Joux <philderbeast@gmail.com>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

generate doc/requirements.txt (backport #10031)

* generate doc/requirements.txt

As suggested in https://github.com/haskell/cabal/pull/10030#pullrequestreview-2064505535

* generate doc/requirements.txt

As suggested in https://github.com/haskell/cabal/pull/10030#pullrequestreview-2064505535

(cherry picked from commit 2658ac6c)

Improve bad cabal-version error message (backport #9754)

See: #4899

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit b48a6206)

Show abbreviated mixed versions with suffix (backport #9824)

- Use independent package name in doctest
- Add changelog entry
- Still use showOption when linked
- Typo, package is cabal-install-solver
- Rename showIsOrVs to showOptions
- Add linked doctests for showOptions

(cherry picked from commit 4a1f73c1)

update jinja2 per CVE-2024-34064 (backport #10030)

(cherry picked from commit b61946f0)

Only use -Werror in validate (backport #9867)

Reverts a change that made `-Werror` be applied when building in tree Cabal, even when just developing.
Puts `-Werror` back in the `cabal.project.validate` validation project.

Fixes #9866

(cherry picked from commit 355b48c3)

offline flag disables `source-repository-package` sync (backport #9771)

https://github.com/haskell/cabal/issues/9641

warning when offline mode skips `source-repository-package`s
i.e.
```
Warning: --offline was specified, skipping sync of repositories:
Warning: https://github.com/haskell/text.git
```

(cherry picked from commit df8f0c58)

* testsuite: Add tests for #9467 (base shim, setup qualifier interaction)

This adds two tests for issue #9467

(cherry picked from commit 3851043a)

* testsuite: Add two tests for independent goals (#9466)

These tests check how constraints interact with the --independent-goals
flag.

(cherry picked from commit b169cd4a)

* testsuite: Add some tests for setup component scope interacts with stanza flags

These tests check how the setup qualified scope interacts with the
stanza flags (specified on the top-level and with the any qualifier)

(cherry picked from commit 573c15d2)

---------

Co-authored-by: Matthew Pickering <matthewtpickering@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Add “Add default-language” suggestion (backport #9766)

As a warning (“Hackage would reject this package”), to prepare users
to GHC language editions.

(cherry picked from commit f9d2af42)

Bump index-state in the release project file

* changelog-d moved to codeberg

(cherry picked from commit 067967e2)

* Add required-fields to changelog.d config

(cherry picked from commit 5168b01c)

# Conflicts:
#	changelog.d/issue-8680
#	changelog.d/issue-9098-lexbraces
#	changelog.d/issue-9678
#	changelog.d/issue-9736
#	changelog.d/pkgconfig-once

---------

Co-authored-by: Francesco Gazzetta <fgaz@fgaz.me>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Ignore testdb/intree generated files (backport #9847)

(cherry picked from commit 57b961ca)

Remove skipIfGhcVersion "== 9.6.3" (backport #9749)

Phil de Joux authored 1 year ago and Artem Pelenitsyn committed 10 months ago

Not able to reproduce the problem this avoids. Tested with;

- --with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.6.3/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal
--with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.8.1/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal

(cherry picked from commit 3e8d2d21)

CI changelogs: switch to XDG, fix cache key (backport #9849)

This is the same as #9845 but for the changelogs.yml workflow.

`changelog-d` currently has restrictive bound `base < 4.19` which we
need to ignore if we want to build on the latest GHC as shipped by the
GHA runner.

(cherry picked from commit af5d6061)

Cf. https://github.com/haskell/cabal/pull/9818#issuecomment-2109132238

Add a --dry-run build check of cabal.project.release (backport #9610)

(cherry picked from commit d6e067e8)

The release project disables tests and benchmarks.

(cherry picked from commit 135611e4)

- Cache of ~/.cabal/store not needed for --dry-run
- Remove workaround for the new job only

(cherry picked from commit cdc8bdef)

Testsuite: pass -i argument to runghc invocations (backport #9518)

This commit modifies the generation of runghc commands to pass an
additional -i argument to account for the change in working directory.

This ensures that, in the testsuite, runghc is able to see other modules.
For example, an invocation of runghc to run a Custom Setup script will
now properly see the modules imported, e.g. if one has a directory
structure like

  test.cabal
  Setup.hs
  SetupDep.hs

and Setup.hs imports SetupDep.hs.

(cherry picked from commit b2b9c2f6)