Skipped test in test_coding_standards #2278
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
greglucas
approved these changes
Nov 11, 2023
| REPO_DIR = subprocess.Popen(['git', 'rev-parse', '--show-toplevel'], | ||
| stdout=subprocess.PIPE | ||
| ).communicate()[0].rstrip().decode('utf-8') | ||
| REPO_DIR = Path(REPO_DIR) |
There was a problem hiding this comment.
Do we need to keep supporting CARTOPY_GIT_DIR?
Suggested change
| REPO_DIR = Path(REPO_DIR) | |
| REPO_DIR = Path(os.getenv("CARTOPY_GIT_DIR", REPO_DIR)) |
|
This might be problematic for downstream packagers if they put their stuff in git and Cartopy is unpacked in that directory. But downstream packagers probably don't want to check stylistic things like this, so tests like this should probably get a pytest marker so they can be skipped. |
lgolston
force-pushed
the
skipped-license-test
branch
from
c921c41
to
b932312
Compare
|
Over at SciTools/cf-units#364 (comment), @pelson suggested these checks would be better via pre-commit hooks. I found this insert-license is a supported hook. Edit: I opened SciTools/.github#22 to see if Iris wants to do something like that. If they do, we could just follow. |
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.
Rationale
The CI server gives a message like: "SKIPPED [1] ../../../../../opt/hostedtoolcache/Python/3.12.0/x64/lib/python3.12/site-packages/cartopy/tests/test_coding_standards.py:78: cartopy installation did not look like a git repo: /opt/hostedtoolcache/Python/3.12.0/x64/lib/python3.12 is not a git repository." suggesting it cannot find the root directory (locally seems to work fine).
Implications
This PR tries a different approach to finding the git repository location so the test [which checks the license headers] will not be skipped.