Update broken OmegaConfigLoader test #3696
Merged
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
Close #3287. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
AhdraMeraliQB
requested review from
yetudada,
astrojuanlu and
merelcht
as code owners
astrojuanlu
reviewed
Mar 12, 2024
Signed-off-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com>
noklam
reviewed
Mar 12, 2024
Comment on lines
442
to
445
| # Assert any specific config file was only loaded once | ||
| expected_path = (tmp_path / "dev" / "user1" / "catalog2.yml").resolve() | ||
| load_spy.assert_called_once_with(expected_path) | ||
|
|
merelcht
approved these changes
Mar 12, 2024
7 tasks
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
noklam
reviewed
Mar 14, 2024
Comment on lines
440
to
470
| def test_overlapping_patterns_in_same_env(self, tmp_path, mocker): | ||
| """Check that configuration files that match several patterns are only loaded once in each env.""" | ||
| _write_yaml( | ||
| tmp_path / _BASE_ENV / "catalog0.yml", | ||
| {"env": "base", "common": "common"}, | ||
| ) | ||
| _write_yaml(tmp_path / _BASE_ENV / "user1" / "catalog2.yml", {"user1_c2": True}) | ||
|
|
||
| catalog_patterns = { | ||
| "catalog": [ | ||
| "catalog*", | ||
| "user1/catalog*", | ||
| "*/catalog2*", | ||
| ] | ||
| } | ||
|
|
||
| load_spy = mocker.spy(OmegaConf, "load") | ||
| catalog = OmegaConfigLoader( | ||
| conf_source=str(tmp_path), | ||
| base_env=_BASE_ENV, | ||
| config_patterns=catalog_patterns, | ||
| )["catalog"] | ||
| expected_catalog = { | ||
| "env": "base", | ||
| "common": "common", | ||
| "user1_c2": True, | ||
| } | ||
| assert catalog == expected_catalog | ||
|
|
||
| # Assert load is only called once for each file | ||
| assert load_spy.call_count == 2 |
There was a problem hiding this comment.
I tested it and it works fine. I think one improvement we can make is simply remove anything about catalog0.yml, since the test is focusing on the deduplication, only catalog 2 is being scan twice but read once. It also make the test simpler.
noklam
approved these changes
Mar 15, 2024
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.
Description
In #3587 it was pointed out that the test
test_overlapping_patternscontained an assert statement that was passing trivially. Correcting this assert showed that the logic being tested was redundant, a remnant from the previous ConfigLoader setup that was not carried over to the OmegaConfigLoader. As a result, this assert statement has been removed.Development notes
The test coverage is unaffected by this removal.
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-byline in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.mdfile