Mercurial > hg
view hgext/lfs/wrapper.py @ 39772:ae531f5e583c
testing: add interface unit tests for file storage
Our strategy for supporting alternate storage backends is to define
interfaces for everything then "code to the interface."
We already have interfaces for various primitives, including file
and manifest storage.
What we don't have is generic unit tests for those interfaces. Up
to this point we've been relying on high-level integration tests
(mainly in the form of existing .t tests) to test alternate storage
backends. And my experience with developing the "simple store" test
extension is that such testing is very tedious: it takes several
minutes to run all tests and when you find a failure, it is often
non-trivial to debug.
This commit starts to change that.
This commit introduces the mercurial.testing.storage module. It
contains testing code for storage. Currently, it defines some
unittest.TestCase classes for testing the file storage interfaces.
It also defines some factory functions that allow a caller to easily
spawn a custom TestCase "bound" to a specific file storage backend
implementation.
A new .py test has been added. It simply defines a callable to produce
filelog and transaction instances on demand and then "registers" the
various test classes so the filelog class can be tested with the
storage interface unit tests.
As part of writing the tests, I identified a couple of apparent
bugs in revlog.py and filelog.py! These are tracked with inline
TODO comments.
Writing the tests makes it more obvious where the storage interface
is lacking. For example, we raise either IndexError or
error.LookupError for missing revisions depending on whether we
use an integer revision or a node. Also, we raise error.RevlogError
in various places when we should be raising a storage-agnostic
error type.
The storage interfaces are currently far from perfect and there is much
work to be done to improve them. But at least with this commit we
finally have the start of unit tests that can be used to "qualify"
the behavior of a storage backend. And when implementing and debugging
new storage backends, we now have an obvious place to define new
tests and have obvious places to insert breakpoints to facilitate
debugging. This should be invaluable when implementing new storage
backends.
I added the mercurial.testing package because these interface
conformance tests are generic and need to be usable by all storage
backends. Having the code live in tests/ would make it difficult for
storage backends implemented in extensions to test their interface
conformance. First, it would require obtaining a copy of Mercurial's
storage test code in order to test. Second, it would make testing
against multiple Mercurial versions difficult, as you would need to
import N copies of the storage testing code in order to achieve test
coverage. By making the test code part of the Mercurial distribution
itself, extensions can `import mercurial.testing.*` to access and run
the test code. The test will run against whatever Mercurial version
is active.
FWIW I've always wanted to move parts of run-tests.py into the
mercurial.* package to make the testing story simpler (e.g. imagine an
`hg debugruntests` command that could invoke the test harness). While I
have no plans to do that in the near future, establishing the
mercurial.testing package does provide a natural home for that code
should someone do this in the future.
Differential Revision: https://phab.mercurial-scm.org/D4650
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 18 Sep 2018 16:52:11 -0700 |
parents | b26350d9d7b5 |
children | d3d4b4b5f725 |
line wrap: on
line source
# wrapper.py - methods wrapping core mercurial logic # # Copyright 2017 Facebook, Inc. # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. from __future__ import absolute_import import hashlib from mercurial.i18n import _ from mercurial.node import bin, hex, nullid, short from mercurial import ( error, revlog, util, ) from mercurial.utils import ( stringutil, ) from ..largefiles import lfutil from . import ( blobstore, pointer, ) def allsupportedversions(orig, ui): versions = orig(ui) versions.add('03') return versions def _capabilities(orig, repo, proto): '''Wrap server command to announce lfs server capability''' caps = orig(repo, proto) if util.safehasattr(repo.svfs, 'lfslocalblobstore'): # XXX: change to 'lfs=serve' when separate git server isn't required? caps.append('lfs') return caps def bypasscheckhash(self, text): return False def readfromstore(self, text): """Read filelog content from local blobstore transform for flagprocessor. Default tranform for flagprocessor, returning contents from blobstore. Returns a 2-typle (text, validatehash) where validatehash is True as the contents of the blobstore should be checked using checkhash. """ p = pointer.deserialize(text) oid = p.oid() store = self.opener.lfslocalblobstore if not store.has(oid): p.filename = self.filename self.opener.lfsremoteblobstore.readbatch([p], store) # The caller will validate the content text = store.read(oid, verify=False) # pack hg filelog metadata hgmeta = {} for k in p.keys(): if k.startswith('x-hg-'): name = k[len('x-hg-'):] hgmeta[name] = p[k] if hgmeta or text.startswith('\1\n'): text = revlog.packmeta(hgmeta, text) return (text, True) def writetostore(self, text): # hg filelog metadata (includes rename, etc) hgmeta, offset = revlog.parsemeta(text) if offset and offset > 0: # lfs blob does not contain hg filelog metadata text = text[offset:] # git-lfs only supports sha256 oid = hex(hashlib.sha256(text).digest()) self.opener.lfslocalblobstore.write(oid, text) # replace contents with metadata longoid = 'sha256:%s' % oid metadata = pointer.gitlfspointer(oid=longoid, size='%d' % len(text)) # by default, we expect the content to be binary. however, LFS could also # be used for non-binary content. add a special entry for non-binary data. # this will be used by filectx.isbinary(). if not stringutil.binary(text): # not hg filelog metadata (affecting commit hash), no "x-hg-" prefix metadata['x-is-binary'] = '0' # translate hg filelog metadata to lfs metadata with "x-hg-" prefix if hgmeta is not None: for k, v in hgmeta.iteritems(): metadata['x-hg-%s' % k] = v rawtext = metadata.serialize() return (rawtext, False) def _islfs(rlog, node=None, rev=None): if rev is None: if node is None: # both None - likely working copy content where node is not ready return False rev = rlog.rev(node) else: node = rlog.node(rev) if node == nullid: return False flags = rlog.flags(rev) return bool(flags & revlog.REVIDX_EXTSTORED) def filelogaddrevision(orig, self, text, transaction, link, p1, p2, cachedelta=None, node=None, flags=revlog.REVIDX_DEFAULT_FLAGS, **kwds): # The matcher isn't available if reposetup() wasn't called. lfstrack = self.opener.options.get('lfstrack') if lfstrack: textlen = len(text) # exclude hg rename meta from file size meta, offset = revlog.parsemeta(text) if offset: textlen -= offset if lfstrack(self.filename, textlen): flags |= revlog.REVIDX_EXTSTORED return orig(self, text, transaction, link, p1, p2, cachedelta=cachedelta, node=node, flags=flags, **kwds) def filelogrenamed(orig, self, node): if _islfs(self, node): rawtext = self.revision(node, raw=True) if not rawtext: return False metadata = pointer.deserialize(rawtext) if 'x-hg-copy' in metadata and 'x-hg-copyrev' in metadata: return metadata['x-hg-copy'], bin(metadata['x-hg-copyrev']) else: return False return orig(self, node) def filelogsize(orig, self, rev): if _islfs(self, rev=rev): # fast path: use lfs metadata to answer size rawtext = self.revision(rev, raw=True) metadata = pointer.deserialize(rawtext) return int(metadata['size']) return orig(self, rev) def filectxcmp(orig, self, fctx): """returns True if text is different than fctx""" # some fctx (ex. hg-git) is not based on basefilectx and do not have islfs if self.islfs() and getattr(fctx, 'islfs', lambda: False)(): # fast path: check LFS oid p1 = pointer.deserialize(self.rawdata()) p2 = pointer.deserialize(fctx.rawdata()) return p1.oid() != p2.oid() return orig(self, fctx) def filectxisbinary(orig, self): if self.islfs(): # fast path: use lfs metadata to answer isbinary metadata = pointer.deserialize(self.rawdata()) # if lfs metadata says nothing, assume it's binary by default return bool(int(metadata.get('x-is-binary', 1))) return orig(self) def filectxislfs(self): return _islfs(self.filelog(), self.filenode()) def _updatecatformatter(orig, fm, ctx, matcher, path, decode): orig(fm, ctx, matcher, path, decode) fm.data(rawdata=ctx[path].rawdata()) def convertsink(orig, sink): sink = orig(sink) if sink.repotype == 'hg': class lfssink(sink.__class__): def putcommit(self, files, copies, parents, commit, source, revmap, full, cleanp2): pc = super(lfssink, self).putcommit node = pc(files, copies, parents, commit, source, revmap, full, cleanp2) if 'lfs' not in self.repo.requirements: ctx = self.repo[node] # The file list may contain removed files, so check for # membership before assuming it is in the context. if any(f in ctx and ctx[f].islfs() for f, n in files): self.repo.requirements.add('lfs') self.repo._writerequirements() # Permanently enable lfs locally self.repo.vfs.append( 'hgrc', util.tonativeeol('\n[extensions]\nlfs=\n')) return node sink.__class__ = lfssink return sink def vfsinit(orig, self, othervfs): orig(self, othervfs) # copy lfs related options for k, v in othervfs.options.items(): if k.startswith('lfs'): self.options[k] = v # also copy lfs blobstores. note: this can run before reposetup, so lfs # blobstore attributes are not always ready at this time. for name in ['lfslocalblobstore', 'lfsremoteblobstore']: if util.safehasattr(othervfs, name): setattr(self, name, getattr(othervfs, name)) def hgclone(orig, ui, opts, *args, **kwargs): result = orig(ui, opts, *args, **kwargs) if result is not None: sourcerepo, destrepo = result repo = destrepo.local() # When cloning to a remote repo (like through SSH), no repo is available # from the peer. Therefore the hgrc can't be updated. if not repo: return result # If lfs is required for this repo, permanently enable it locally if 'lfs' in repo.requirements: repo.vfs.append('hgrc', util.tonativeeol('\n[extensions]\nlfs=\n')) return result def hgpostshare(orig, sourcerepo, destrepo, bookmarks=True, defaultpath=None): orig(sourcerepo, destrepo, bookmarks, defaultpath) # If lfs is required for this repo, permanently enable it locally if 'lfs' in destrepo.requirements: destrepo.vfs.append('hgrc', util.tonativeeol('\n[extensions]\nlfs=\n')) def _prefetchfiles(repo, revs, match): """Ensure that required LFS blobs are present, fetching them as a group if needed.""" if not util.safehasattr(repo.svfs, 'lfslocalblobstore'): return pointers = [] oids = set() localstore = repo.svfs.lfslocalblobstore for rev in revs: ctx = repo[rev] for f in ctx.walk(match): p = pointerfromctx(ctx, f) if p and p.oid() not in oids and not localstore.has(p.oid()): p.filename = f pointers.append(p) oids.add(p.oid()) if pointers: # Recalculating the repo store here allows 'paths.default' that is set # on the repo by a clone command to be used for the update. blobstore.remote(repo).readbatch(pointers, localstore) def _canskipupload(repo): # Skip if this hasn't been passed to reposetup() if not util.safehasattr(repo.svfs, 'lfsremoteblobstore'): return True # if remotestore is a null store, upload is a no-op and can be skipped return isinstance(repo.svfs.lfsremoteblobstore, blobstore._nullremote) def candownload(repo): # Skip if this hasn't been passed to reposetup() if not util.safehasattr(repo.svfs, 'lfsremoteblobstore'): return False # if remotestore is a null store, downloads will lead to nothing return not isinstance(repo.svfs.lfsremoteblobstore, blobstore._nullremote) def uploadblobsfromrevs(repo, revs): '''upload lfs blobs introduced by revs Note: also used by other extensions e. g. infinitepush. avoid renaming. ''' if _canskipupload(repo): return pointers = extractpointers(repo, revs) uploadblobs(repo, pointers) def prepush(pushop): """Prepush hook. Read through the revisions to push, looking for filelog entries that can be deserialized into metadata so that we can block the push on their upload to the remote blobstore. """ return uploadblobsfromrevs(pushop.repo, pushop.outgoing.missing) def push(orig, repo, remote, *args, **kwargs): """bail on push if the extension isn't enabled on remote when needed, and update the remote store based on the destination path.""" if 'lfs' in repo.requirements: # If the remote peer is for a local repo, the requirement tests in the # base class method enforce lfs support. Otherwise, some revisions in # this repo use lfs, and the remote repo needs the extension loaded. if not remote.local() and not remote.capable('lfs'): # This is a copy of the message in exchange.push() when requirements # are missing between local repos. m = _("required features are not supported in the destination: %s") raise error.Abort(m % 'lfs', hint=_('enable the lfs extension on the server')) # Repositories where this extension is disabled won't have the field. # But if there's a requirement, then the extension must be loaded AND # there may be blobs to push. remotestore = repo.svfs.lfsremoteblobstore try: repo.svfs.lfsremoteblobstore = blobstore.remote(repo, remote.url()) return orig(repo, remote, *args, **kwargs) finally: repo.svfs.lfsremoteblobstore = remotestore else: return orig(repo, remote, *args, **kwargs) def writenewbundle(orig, ui, repo, source, filename, bundletype, outgoing, *args, **kwargs): """upload LFS blobs added by outgoing revisions on 'hg bundle'""" uploadblobsfromrevs(repo, outgoing.missing) return orig(ui, repo, source, filename, bundletype, outgoing, *args, **kwargs) def extractpointers(repo, revs): """return a list of lfs pointers added by given revs""" repo.ui.debug('lfs: computing set of blobs to upload\n') pointers = {} makeprogress = repo.ui.makeprogress with makeprogress(_('lfs search'), _('changesets'), len(revs)) as progress: for r in revs: ctx = repo[r] for p in pointersfromctx(ctx).values(): pointers[p.oid()] = p progress.increment() return sorted(pointers.values()) def pointerfromctx(ctx, f, removed=False): """return a pointer for the named file from the given changectx, or None if the file isn't LFS. Optionally, the pointer for a file deleted from the context can be returned. Since no such pointer is actually stored, and to distinguish from a non LFS file, this pointer is represented by an empty dict. """ _ctx = ctx if f not in ctx: if not removed: return None if f in ctx.p1(): _ctx = ctx.p1() elif f in ctx.p2(): _ctx = ctx.p2() else: return None fctx = _ctx[f] if not _islfs(fctx.filelog(), fctx.filenode()): return None try: p = pointer.deserialize(fctx.rawdata()) if ctx == _ctx: return p return {} except pointer.InvalidPointer as ex: raise error.Abort(_('lfs: corrupted pointer (%s@%s): %s\n') % (f, short(_ctx.node()), ex)) def pointersfromctx(ctx, removed=False): """return a dict {path: pointer} for given single changectx. If ``removed`` == True and the LFS file was removed from ``ctx``, the value stored for the path is an empty dict. """ result = {} for f in ctx.files(): p = pointerfromctx(ctx, f, removed=removed) if p is not None: result[f] = p return result def uploadblobs(repo, pointers): """upload given pointers from local blobstore""" if not pointers: return remoteblob = repo.svfs.lfsremoteblobstore remoteblob.writebatch(pointers, repo.svfs.lfslocalblobstore) def upgradefinishdatamigration(orig, ui, srcrepo, dstrepo, requirements): orig(ui, srcrepo, dstrepo, requirements) # Skip if this hasn't been passed to reposetup() if (util.safehasattr(srcrepo.svfs, 'lfslocalblobstore') and util.safehasattr(dstrepo.svfs, 'lfslocalblobstore')): srclfsvfs = srcrepo.svfs.lfslocalblobstore.vfs dstlfsvfs = dstrepo.svfs.lfslocalblobstore.vfs for dirpath, dirs, files in srclfsvfs.walk(): for oid in files: ui.write(_('copying lfs blob %s\n') % oid) lfutil.link(srclfsvfs.join(oid), dstlfsvfs.join(oid)) def upgraderequirements(orig, repo): reqs = orig(repo) if 'lfs' in repo.requirements: reqs.add('lfs') return reqs