Add git info test #85
Open
Conversation
This file contains hidden or 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
As per issue neuroinformatics-unit#8, the git-related code is not being tested. This commit can be a starting point for git-related tests. It exposes the repo object, which in turn can be used for various assertions. Completed during UCL ARC's Winter Open-Source Good First Issue Hackathon. Co-authored-by: Matthew Scroggs <[email protected]>
adamltyson
requested changes
Dec 4, 2025
Member
adamltyson
left a comment
adamltyson
left a comment
There was a problem hiding this comment.
Hi @wael-mahlous, thanks for this, much appreciated!
Looks good, I've just left a few small comments.
| "tox", | ||
| "pre-commit", | ||
| "setuptools_scm", | ||
| ] |
Member
There was a problem hiding this comment.
This is needed to ensure that git is installed when setting up a development environment.
Suggested change
| "fancylog[git]" | |
| ] |
| from rich.logging import RichHandler | ||
|
|
||
| import fancylog | ||
| import fancylog.tools.git |
Member
There was a problem hiding this comment.
This isn't really needed as fancylog is imported above.
Suggested change
| import fancylog.tools.git |
| A gitpython repo object. | ||
| """ | ||
| self.repo = repo | ||
| self.head = GitHead(repo.head.commit) |
Member
There was a problem hiding this comment.
Just to use this variable consistently
Suggested change
| self.head = GitHead(repo.head.commit) | |
| self.head = GitHead(self.repo.head.commit) |
| assert f"{'pytest':20} {'1.1.1'}" | ||
|
|
||
|
|
||
| def test_git_info(): |
Member
There was a problem hiding this comment.
Could you add a short description to explain what this text is doing?
Author
|
@adamltyson thanks a lot for your comments and apologies for the late response (due to conflicting priorities). Will address all of these by end of the week! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
What is this PR
Why is this PR needed?
tools/git.py is not currently covered by tests.
What does this PR do?
It exposes the repo object (https://gitpython.readthedocs.io/en/stable/reference.html#git.repo.base.Repo), which in turn can be used for various assertions, as demonstrated by the new test, or perhaps even for logging. Previously, only the head was exposed (https://gitpython.readthedocs.io/en/stable/reference.html#git.repo.base.Repo.head).
References
Issue #8
How has this PR been tested?
The tests were run locally. Coverage was also run locally and increased as a result of the new test.
Is this a breaking change?
No
Does this PR require an update to the documentation?
No
Checklist: