Improve assertion messages in IntegrationTests2 testConfigOptionComments
#10314
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before, failing asserts in this test would look like this:
```
Writing default configuration to
/Users/wiggles/cabal/cabal-install/tests/IntegrationTests2/config/cabal-config/config
Downloading the latest package list from hackage.haskell.org
Package list of hackage.haskell.org has been updated.
The index-state is set to 2024-09-04T15:12:07Z.
Integration tests (internal)
Flag tests
Test Config options for commented options: FAIL
tests/IntegrationTests2.hs:2015:
expected: " urll"
but got: " url"
```
The output includes a message that a configuration file has been
written, but that's not the configuration file under test! The actual
configuration file being tested is
`cabal-install/tests/IntegrationTests2/config/default-config`, which
shows up nowhere in the output.
Now, the messages include the setting name being searched for and the
path of the relevant configuration file:
```
Downloading the latest package list from hackage.haskell.org
Package list of hackage.haskell.org has been updated.
The index-state is set to 2024-09-04T22:53:05Z.
Integration tests (internal)
Flag tests
Test Config options for commented options: FAIL
tests/IntegrationTests2.hs:2015:
Did not find expected line for setting "url" in configuration file /Users/wiggles/cabal/cabal-install/tests/IntegrationTests2/config/default-config
expected: " urll"
but got: " url"
```
The `Writing default configuration to...` message with the misleading
path has also been silenced.
geekosaur
approved these changes
Sep 5, 2024
| callProcess "cabal" ["user-config", "init", "-f"] | ||
| -- NOTE: This is running the `cabal` from the user environment, which is | ||
| -- generally not the `cabal` being tested! | ||
| callProcess "cabal" ["-v0", "user-config", "init", "-f"] |
There was a problem hiding this comment.
That one was my fault; I'd intended to silence it after verifying it, but forgot. (See #10205.)
The choice to use the environment cabal was deliberate, as I wanted a reliable pristine configuration for the tests and it seemed to me that using the cabal under test was incorrect, especially since that is only tested much later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before, failing asserts in this test would look like this:
The output includes a message that a configuration file has been written, but that's not the configuration file under test! The actual configuration file being tested is
cabal-install/tests/IntegrationTests2/config/default-config, which shows up nowhere in the output.Now, the messages include the setting name being searched for and the path of the relevant configuration file:
The
Writing default configuration to...message with the misleading path has also been silenced.