Mercurial > hg
view tests/hypothesishelpers.py @ 27372:a79cba6cb206
help: add documentation for changegroup formats
There is no formal location for spec-like technical/internal docs. The
repository makes sense as such a location because spec-like
documentation should be reviewed (ruling out a wiki). mpm has also
stated that he would like this documentation to be part of the
built-in help system. So, we establish an "internals" sub-directory
to hold this class of documentation.
The format of changegroups does not appear to be documented anywhere,
even in source code. It therefore seemed like an appropriate first thing
to document.
This patch adds low-level documentation of versions 1 and 2 of the
changegroup foromat. It currently only describes the raw data format.
There is probably room to write higher-level documentation on strategies
for producing and consuming the data. We'll leave that for another day.
The added file is not yet accessible via `hg help` nor via hgweb.
Support for this will follow in subsequent patches.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Sun, 25 Oct 2015 00:19:45 +0100 |
parents | 0f76c64f5cc3 |
children | 84513a4fcc3a |
line wrap: on
line source
# Helper module to use the Hypothesis tool in tests # # Copyright 2015 David R. MacIver # # For details see http://hypothesis.readthedocs.org import os import sys import traceback from hypothesis.settings import set_hypothesis_home_dir import hypothesis.strategies as st from hypothesis import given, Settings # hypothesis store data regarding generate example and code set_hypothesis_home_dir(os.path.join( os.getenv('TESTTMP'), ".hypothesis" )) def check(*args, **kwargs): """decorator to make a function a hypothesis test Decorated function are run immediately (to be used doctest style)""" def accept(f): # Workaround for https://github.com/DRMacIver/hypothesis/issues/206 # Fixed in version 1.13 (released 2015 october 29th) f.__module__ = '__anon__' try: given(*args, settings=Settings(max_examples=2000), **kwargs)(f)() except Exception: traceback.print_exc(file=sys.stdout) sys.exit(1) return accept def roundtrips(data, decode, encode): """helper to tests function that must do proper encode/decode roundtripping """ @given(data) def testroundtrips(value): encoded = encode(value) decoded = decode(encoded) if decoded != value: raise ValueError( "Round trip failed: %s(%r) -> %s(%r) -> %r" % ( encode.__name__, value, decode.__name__, encoded, decoded )) try: testroundtrips() except Exception: # heredoc swallow traceback, we work around it traceback.print_exc(file=sys.stdout) raise print("Round trip OK") # strategy for generating bytestring that might be an issue for Mercurial bytestrings = ( st.builds(lambda s, e: s.encode(e), st.text(), st.sampled_from([ 'utf-8', 'utf-16', ]))) | st.binary()