Test: vcs.git.backend tests #9507
Open
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
radoering
requested changes
Jun 23, 2024
tests/vcs/git/test_backend.py
Outdated
Comment on lines
139
to
173
| def test_git_ref_spec_resolve_branch(fetch_pack_result: FetchPackResult) -> None: | ||
| mock_fetch_pack_result = fetch_pack_result | ||
|
|
||
| refspec = GitRefSpec(branch="main") | ||
| refspec.resolve(mock_fetch_pack_result) | ||
|
|
||
| assert refspec.ref == b"refs/heads/main" | ||
| assert refspec.branch == "main" | ||
| assert refspec.revision is None | ||
| assert refspec.tag is None | ||
|
|
||
|
|
||
| def test_git_ref_spec_resolve_tag(fetch_pack_result: FetchPackResult) -> None: | ||
| mock_fetch_pack_result = fetch_pack_result | ||
|
|
||
| refspec = GitRefSpec(revision="v1.0.0") | ||
| refspec.resolve(mock_fetch_pack_result) | ||
|
|
||
| assert refspec.ref == annotated_tag(b"refs/tags/v1.0.0") | ||
| assert refspec.branch is None | ||
| assert refspec.revision is None | ||
| assert refspec.tag == "v1.0.0" | ||
|
|
||
|
|
||
| def test_git_ref_spec_resolve_sha(fetch_pack_result: FetchPackResult) -> None: | ||
| mock_fetch_pack_result = fetch_pack_result | ||
|
|
||
| refspec = GitRefSpec(revision="abc") | ||
|
|
||
| refspec.resolve(mock_fetch_pack_result) | ||
|
|
||
| assert refspec.ref == b"refs/heads/main" | ||
| assert refspec.branch is None | ||
| assert refspec.tag is None | ||
| assert refspec.revision == "abc" |
There was a problem hiding this comment.
Can we merge these three ref_spec_resolve tests into one parameterized test?
There are still some uncovered branches in _normalise, e.g. specifying a branch as revision, which can be covered easily. If we add more test variants, a parameterized tests will make even more sense.
abn
reviewed
Nov 17, 2024
Comment on lines
+157
to
+166
| Parameterized test for GitRefSpec resolve with different parameters. | ||
|
|
||
| Args: | ||
| fetch_pack_result (FetchPackResult): The mocked FetchPackResult object. | ||
| refspec_params (dict): Parameters for creating GitRefSpec. | ||
| expected_ref (bytes): The expected resolved ref. | ||
| expected_branch (str): The expected resolved branch. | ||
| expected_revision (str): The expected resolved revision. | ||
| expected_tag (str): The expected resolved tag. | ||
| """ |
There was a problem hiding this comment.
Suggested change
| Parameterized test for GitRefSpec resolve with different parameters. | |
| Args: | |
| fetch_pack_result (FetchPackResult): The mocked FetchPackResult object. | |
| refspec_params (dict): Parameters for creating GitRefSpec. | |
| expected_ref (bytes): The expected resolved ref. | |
| expected_branch (str): The expected resolved branch. | |
| expected_revision (str): The expected resolved revision. | |
| expected_tag (str): The expected resolved tag. | |
| """ |
Comment on lines
+134
to
+147
| @pytest.mark.parametrize( | ||
| "refspec_params, expected_ref, expected_branch, expected_revision, expected_tag", | ||
| [ | ||
| ({"branch": "main"}, b"refs/heads/main", "main", None, None), | ||
| ( | ||
| {"revision": "v1.0.0"}, | ||
| annotated_tag(b"refs/tags/v1.0.0"), | ||
| None, | ||
| None, | ||
| "v1.0.0", | ||
| ), | ||
| ({"revision": "abc"}, b"refs/heads/main", None, "abc", None), | ||
| ], | ||
| ) |
There was a problem hiding this comment.
Nitpicks, but can you update this to pass in GitRefSpec instances as parameters instead? And make sure we cover, branch, revision, tag, ref parameters.
Additionally, if we can move to using real(ish) short and full shas instead would help with reasoning.
There was a problem hiding this comment.
And resolution should verify that shart shas when it exists in the fetch pack gets resolved to full shas. So, abc must resolve to abc123 from the fixture.
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.
Pull Request Check List
Relates-to: #3155
poetry.vcs.git.backend(increased coverage from 30% to 51%)