This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8145

lfutil: provide a hint if the largefiles/lfs cache path cannot be determined
ClosedPublic

Authored by mharbison72 on Feb 24 2020, 5:47 PM.

Details

Reviewers
marmoute
pulkit
Group Reviewers
hg-reviewers
Commits
rHGca82929e433d: lfutil: provide a hint if the largefiles/lfs cache path cannot be determined
Summary

A coworker hit this error using an LFS repo in a stripped down environment, and
didn't know how to resolve it.

The final conditional is a bit fast and loose, but there is currently no 'posix'
test in hghave, and it doesn't seem like it's worth adding for this since I
think Windows is the only non-POSIX platform we run tests on.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mharbison72 created this revision.Feb 24 2020, 5:47 PM
marmoute added a subscriber: marmoute.Feb 24 2020, 6:37 PM

Could we get a test for this? To make sure the hint looks fine and that the error code does not crash ?

mharbison72 added a comment.Feb 24 2020, 6:52 PM
In D8145#121269, @marmoute wrote:

Could we get a test for this? To make sure the hint looks fine and that the error code does not crash ?

The reason I didn't add a test (or see any changes to existing ones) is because the config property is baked into the config file generated by run-tests.py, so it never hits this path. But I did test by hand on Windows.

marmoute added a comment.Feb 24 2020, 7:07 PM
In D8145#121270, @mharbison72 wrote:
In D8145#121269, @marmoute wrote:

Could we get a test for this? To make sure the hint looks fine and that the error code does not crash ?

The reason I didn't add a test (or see any changes to existing ones) is because the config property is baked into the config file generated by run-tests.py, so it never hits this path. But I did test by hand on Windows.

Could we alter that config in test file to trigger the error in there ?

mharbison72 edited the summary of this revision. (Show Details)Feb 24 2020, 8:20 PM
mharbison72 updated this revision to Diff 20293.
marmoute accepted this revision.Feb 25 2020, 3:46 AM

Thanks for adding the test.

pulkit accepted this revision.Feb 25 2020, 7:19 AM
This revision is now accepted and ready to land.Feb 25 2020, 7:19 AM
pulkit added a comment.Feb 25 2020, 7:49 AM

test-check-code.t says hi:

--- /home/foobar/repo/pushaccess/tests/test-check-code.t
+++ /home/foobar/repo/pushaccess/tests/test-check-code.t.err
@@ -32,6 +32,16 @@
   Skipping i18n/polib.py it has no-che?k-code (glob)
   Skipping mercurial/statprof.py it has no-che?k-code (glob)
   Skipping tests/badserverext.py it has no-che?k-code (glob)
+  tests/test-lfs-bundle.t:102:
+   >   $ env -u HOME -u LOCALAPPDATA -u APPDATA HGRCPATH= hg config lfs --debug
+   don't use 'env -u VAR', use 'unset VAR'
+  tests/test-lfs-bundle.t:109:
+   >   $ env -u HOME HGRCPATH= hg config lfs --debug
+   don't use 'env -u VAR', use 'unset VAR'
+  tests/test-lfs-bundle.t:116:
+   >   $ env -u XDG_CACHE_HOME -u HOME HGRCPATH= hg config lfs --debug
+   don't use 'env -u VAR', use 'unset VAR'
+  [1]
 
 @commands in debugcommands.py should be in alphabetical order.
 

ERROR: test-check-code.t output changed
pulkit accepted this revision.Feb 26 2020, 4:38 AM

Revision Contents
Changeset List

PathPackages
Mhgext/largefiles/lfutil.py (23 lines)
Mtests/test-lfs-bundle.t (29 lines)

Diff 20304

hgext/largefiles/lfutil.py

return os.path.join(_usercachedir(ui), hash) return os.path.join(_usercachedir(ui), hash)
def _usercachedir(ui, name=longname): def _usercachedir(ui, name=longname):
'''Return the location of the "global" largefiles cache.''' '''Return the location of the "global" largefiles cache.'''
path = ui.configpath(name, b'usercache') path = ui.configpath(name, b'usercache')
if path: if path:
return path return path
hint = None
if pycompat.iswindows: if pycompat.iswindows:
appdata = encoding.environ.get( appdata = encoding.environ.get(
b'LOCALAPPDATA', encoding.environ.get(b'APPDATA') b'LOCALAPPDATA', encoding.environ.get(b'APPDATA')
) )
if appdata: if appdata:
return os.path.join(appdata, name) return os.path.join(appdata, name)
hint = _(b"define %s or %s in the environment, or set %s.usercache") % (
b"LOCALAPPDATA",
b"APPDATA",
name,
)
elif pycompat.isdarwin: elif pycompat.isdarwin:
home = encoding.environ.get(b'HOME') home = encoding.environ.get(b'HOME')
if home: if home:
return os.path.join(home, b'Library', b'Caches', name) return os.path.join(home, b'Library', b'Caches', name)
hint = _(b"define %s in the environment, or set %s.usercache") % (
b"HOME",
name,
)
elif pycompat.isposix: elif pycompat.isposix:
path = encoding.environ.get(b'XDG_CACHE_HOME') path = encoding.environ.get(b'XDG_CACHE_HOME')
if path: if path:
return os.path.join(path, name) return os.path.join(path, name)
home = encoding.environ.get(b'HOME') home = encoding.environ.get(b'HOME')
if home: if home:
return os.path.join(home, b'.cache', name) return os.path.join(home, b'.cache', name)
hint = _(b"define %s or %s in the environment, or set %s.usercache") % (
b"XDG_CACHE_HOME",
b"HOME",
name,
)
else: else:
raise error.Abort( raise error.Abort(
_(b'unknown operating system: %s\n') % pycompat.osname _(b'unknown operating system: %s\n') % pycompat.osname
) )
raise error.Abort(_(b'unknown %s usercache location') % name)
raise error.Abort(_(b'unknown %s usercache location') % name, hint=hint)
def inusercache(ui, hash): def inusercache(ui, hash):
path = usercachepath(ui, hash) path = usercachepath(ui, hash)
return os.path.exists(path) return os.path.exists(path)
def findfile(repo, hash): def findfile(repo, hash):

tests/test-lfs-bundle.t

---- Applying src-normal.bundle to dst-normal ---- ---- Applying src-normal.bundle to dst-normal ----
OK OK
---- Applying src-normal.bundle to dst-lfs ---- ---- Applying src-normal.bundle to dst-lfs ----
OK OK
---- Applying src-lfs.bundle to dst-normal ---- ---- Applying src-lfs.bundle to dst-normal ----
OK OK
---- Applying src-lfs.bundle to dst-lfs ---- ---- Applying src-lfs.bundle to dst-lfs ----
OK OK
Hint if the cache location cannot be inferred from the environment
#if windows
$ unset LOCALAPPDATA
$ unset APPDATA
$ HGRCPATH= hg config lfs --debug
abort: unknown lfs usercache location
(define LOCALAPPDATA or APPDATA in the environment, or set lfs.usercache)
[255]
#endif
#if osx
$ unset HOME
$ HGRCPATH= hg config lfs --debug
abort: unknown lfs usercache location
(define HOME in the environment, or set lfs.usercache)
[255]
#endif
#if no-windows no-osx
$ unset XDG_CACHE_HOME
$ unset HOME
$ HGRCPATH= hg config lfs --debug
abort: unknown lfs usercache location
(define XDG_CACHE_HOME or HOME in the environment, or set lfs.usercache)
[255]
#endif