Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better diagnostic error message when encountering a git-lfs placeholder file #17407

Closed
permcody opened this issue Mar 22, 2021 · 2 comments
Closed
Labels
C: Framework Good first issue P: normal A defect affecting operation with a low possibility of significantly affects. T: task An enhancement to the software.

Comments

@permcody
Copy link
Member

Reason

If you checkout a repository on a system that doesn't have git-lfs installed or enabled. You will get placeholder files for any files that are stored in git-lfs data stores. Those files contain plain ASCII text like this:

version https://git-lfs.github.com/spec/v1
oid sha256:3b7a78871b902e28e46756241a510dcb72de8f3eb2dd3d5bc31342085f1976ed
size 145124

The problem is that this confuses some of the readers in MOOSE. In particular we sometimes store large mesh files like this in which case the user will get a message like this:

*** ERROR ***
Error opening ExodusII mesh file: /Users/johndoe/projects/foo/problems/big_mesh.e

This occurs even if the file is there.

Design

We already have utility routines that check for file readability or writeability before trying to interpret data. We are fairly consistent with calling these. I would propose that we add another utility routine that specifically checks for git-lfs placeholder files that we can call from the readability routine. We could then issue a much more useful error and potentially helpful diagnostic message that could help a user recover without seeking assistance from the developer community.

Impact

None, moderate annoyance.

@permcody permcody added C: Framework T: task An enhancement to the software. P: normal A defect affecting operation with a low possibility of significantly affects. labels Mar 22, 2021
@WilkAndy
Copy link
Contributor

Yep, this stumped me a while ago. Not a big deal, but confusing.

permcody added a commit to permcody/moose that referenced this issue Apr 2, 2021
permcody added a commit to permcody/moose that referenced this issue Apr 2, 2021
permcody added a commit to permcody/moose that referenced this issue Apr 8, 2021
aeslaughter pushed a commit to aeslaughter/moose that referenced this issue Jun 2, 2021
aeslaughter pushed a commit to aeslaughter/moose that referenced this issue Jun 2, 2021
aeslaughter pushed a commit to aeslaughter/moose that referenced this issue Jun 2, 2021
@permcody
Copy link
Member Author

Closed by #17489

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Framework Good first issue P: normal A defect affecting operation with a low possibility of significantly affects. T: task An enhancement to the software.
Projects
None yet
Development

No branches or pull requests

2 participants