This test is dedicated to test the bundle2 container format

It test multiple existing parts to test different feature of the container. You

probably do not need to touch this test unless you change the binary encoding

of the bundle2 format itself.

Create an extension to test bundle2 API

  $ cat > bundle2.py << EOF

  > """A small extension to test bundle2 implementation

  > 

  > Current bundle2 implementation is far too limited to be used in any core

  > code. We still need to be able to test it while it grow up.

  > """

  > 

  > import sys, os

  > from mercurial import cmdutil

  > from mercurial import util

  > from mercurial import bundle2

  > from mercurial import scmutil

  > from mercurial import discovery

  > from mercurial import changegroup

  > from mercurial import error

  > from mercurial import obsolete

  > 

  > 

  > try:

  >     import msvcrt

  >     msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)

  >     msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)

  >     msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)

  > except ImportError:

  >     pass

  > 

  > cmdtable = {}

  > command = cmdutil.command(cmdtable)

  > 

  > ELEPHANTSSONG = """Patali Dirapata, Cromda Cromda Ripalo, Pata Pata, Ko Ko Ko

  > Bokoro Dipoulito, Rondi Rondi Pepino, Pata Pata, Ko Ko Ko

  > Emana Karassoli, Loucra Loucra Ponponto, Pata Pata, Ko Ko Ko."""

  > assert len(ELEPHANTSSONG) == 178 # future test say 178 bytes, trust it.

  > 

  > @bundle2.parthandler('test:song')

  > def songhandler(op, part):

  >     """handle a "test:song" bundle2 part, printing the lyrics on stdin"""

  >     op.ui.write('The choir starts singing:\n')

  >     verses = 0

  >     for line in part.read().split('\n'):

  >         op.ui.write('    %s\n' % line)

  >         verses += 1

  >     op.records.add('song', {'verses': verses})

  > 

  > @bundle2.parthandler('test:ping')

  > def pinghandler(op, part):

  >     op.ui.write('received ping request (id %i)\n' % part.id)

  >     if op.reply is not None and 'ping-pong' in op.reply.capabilities:

  >         op.ui.write_err('replying to ping request (id %i)\n' % part.id)

  >         op.reply.newpart('test:pong', [('in-reply-to', str(part.id))],

  >                          mandatory=False)

  > 

  > @bundle2.parthandler('test:debugreply')

  > def debugreply(op, part):

  >     """print data about the capacity of the bundle reply"""

  >     if op.reply is None:

  >         op.ui.write('debugreply: no reply\n')

  >     else:

  >         op.ui.write('debugreply: capabilities:\n')

  >         for cap in sorted(op.reply.capabilities):

  >             op.ui.write('debugreply:     %r\n' % cap)

  >             for val in op.reply.capabilities[cap]:

  >                 op.ui.write('debugreply:         %r\n' % val)

  > 

  > @command('bundle2',

  >          [('', 'param', [], 'stream level parameter'),

  >           ('', 'unknown', False, 'include an unknown mandatory part in the bundle'),

  >           ('', 'unknownparams', False, 'include an unknown part parameters in the bundle'),

  >           ('', 'parts', False, 'include some arbitrary parts to the bundle'),

  >           ('', 'reply', False, 'produce a reply bundle'),

  >           ('', 'pushrace', False, 'includes a check:head part with unknown nodes'),

  >           ('', 'genraise', False, 'includes a part that raise an exception during generation'),

  >           ('', 'timeout', False, 'emulate a timeout during bundle generation'),

  >           ('r', 'rev', [], 'includes those changeset in the bundle'),],

  >          '[OUTPUTFILE]')

  > def cmdbundle2(ui, repo, path=None, **opts):

  >     """write a bundle2 container on standard output"""

  >     bundler = bundle2.bundle20(ui)

  >     for p in opts['param']:

  >         p = p.split('=', 1)

  >         try:

  >             bundler.addparam(*p)

  >         except ValueError, exc:

  >             raise util.Abort('%s' % exc)

  > 

  >     if opts['reply']:

  >         capsstring = 'ping-pong\nelephants=babar,celeste\ncity%3D%21=celeste%2Cville'

  >         bundler.newpart('replycaps', data=capsstring)

  > 

  >     if opts['pushrace']:

  >         # also serve to test the assignement of data outside of init

  >         part = bundler.newpart('check:heads')

  >         part.data = '01234567890123456789'

  > 

  >     revs = opts['rev']

  >     if 'rev' in opts:

  >         revs = scmutil.revrange(repo, opts['rev'])

  >         if revs:

  >             # very crude version of a changegroup part creation

  >             bundled = repo.revs('%ld::%ld', revs, revs)

  >             headmissing = [c.node() for c in repo.set('heads(%ld)', revs)]

  >             headcommon  = [c.node() for c in repo.set('parents(%ld) - %ld', revs, revs)]

  >             outgoing = discovery.outgoing(repo.changelog, headcommon, headmissing)

  >             cg = changegroup.getlocalchangegroup(repo, 'test:bundle2', outgoing, None)

  >             bundler.newpart('changegroup', data=cg.getchunks(),

  >                             mandatory=False)

  > 

  >     if opts['parts']:

  >        bundler.newpart('test:empty', mandatory=False)

  >        # add a second one to make sure we handle multiple parts

  >        bundler.newpart('test:empty', mandatory=False)

  >        bundler.newpart('test:song', data=ELEPHANTSSONG, mandatory=False)

  >        bundler.newpart('test:debugreply', mandatory=False)

  >        mathpart = bundler.newpart('test:math')

  >        mathpart.addparam('pi', '3.14')

  >        mathpart.addparam('e', '2.72')

  >        mathpart.addparam('cooking', 'raw', mandatory=False)

  >        mathpart.data = '42'

  >        mathpart.mandatory = False

  >        # advisory known part with unknown mandatory param

  >        bundler.newpart('test:song', [('randomparam','')], mandatory=False)

  >     if opts['unknown']:

  >        bundler.newpart('test:unknown', data='some random content')

  >     if opts['unknownparams']:

  >        bundler.newpart('test:song', [('randomparams', '')])

  >     if opts['parts']:

  >        bundler.newpart('test:ping', mandatory=False)

  >     if opts['genraise']:

  >        def genraise():

  >            yield 'first line\n'

  >            raise RuntimeError('Someone set up us the bomb!')

  >        bundler.newpart('output', data=genraise(), mandatory=False)

  > 

  >     if path is None:

  >        file = sys.stdout

  >     else:

  >         file = open(path, 'wb')

  > 

  >     if opts['timeout']:

  >         bundler.newpart('test:song', data=ELEPHANTSSONG, mandatory=False)

  >         for idx, junk in enumerate(bundler.getchunks()):

  >             ui.write('%d chunk\n' % idx)

  >             if idx > 4:

  >                 # This throws a GeneratorExit inside the generator, which

  >                 # can cause problems if the exception-recovery code is

  >                 # too zealous. It's important for this test that the break

  >                 # occur while we're in the middle of a part.

  >                 break

  >         ui.write('fake timeout complete.\n')

  >         return

  >     try:

  >         for chunk in bundler.getchunks():

  >             file.write(chunk)

  >     except RuntimeError, exc:

  >         raise util.Abort(exc)

  > 

  > @command('unbundle2', [], '')

  > def cmdunbundle2(ui, repo, replypath=None):

  >     """process a bundle2 stream from stdin on the current repo"""

  >     try:

  >         tr = None

  >         lock = repo.lock()

  >         tr = repo.transaction('processbundle')

  >         try:

  >             unbundler = bundle2.getunbundler(ui, sys.stdin)

  >             op = bundle2.processbundle(repo, unbundler, lambda: tr)

  >             tr.close()

  >         except error.BundleValueError, exc:

  >             raise util.Abort('missing support for %s' % exc)

  >         except error.PushRaced, exc:

  >             raise util.Abort('push race: %s' % exc)

  >     finally:

  >         if tr is not None:

  >             tr.release()

  >         lock.release()

  >         remains = sys.stdin.read()

  >         ui.write('%i unread bytes\n' % len(remains))

  >     if op.records['song']:

  >         totalverses = sum(r['verses'] for r in op.records['song'])

  >         ui.write('%i total verses sung\n' % totalverses)

  >     for rec in op.records['changegroup']:

  >         ui.write('addchangegroup return: %i\n' % rec['return'])

  >     if op.reply is not None and replypath is not None:

  >         file = open(replypath, 'wb')

  >         for chunk in op.reply.getchunks():

  >             file.write(chunk)

  > 

  > @command('statbundle2', [], '')

  > def cmdstatbundle2(ui, repo):

  >     """print statistic on the bundle2 container read from stdin"""

  >     unbundler = bundle2.getunbundler(ui, sys.stdin)

  >     try:

  >         params = unbundler.params

  >     except error.BundleValueError, exc:

  >        raise util.Abort('unknown parameters: %s' % exc)

  >     ui.write('options count: %i\n' % len(params))

  >     for key in sorted(params):

  >         ui.write('- %s\n' % key)

  >         value = params[key]

  >         if value is not None:

  >             ui.write('    %s\n' % value)

  >     count = 0

  >     for p in unbundler.iterparts():

  >         count += 1

  >         ui.write('  :%s:\n' % p.type)

  >         ui.write('    mandatory: %i\n' % len(p.mandatoryparams))

  >         ui.write('    advisory: %i\n' % len(p.advisoryparams))

  >         ui.write('    payload: %i bytes\n' % len(p.read()))

  >     ui.write('parts count:   %i\n' % count)

  > EOF

  $ cat >> $HGRCPATH << EOF

  > [extensions]

  > bundle2=$TESTTMP/bundle2.py

  > [experimental]

  > bundle2-exp=True

  > evolution=createmarkers

  > [ui]

  > ssh=python "$TESTDIR/dummyssh"

  > logtemplate={rev}:{node|short} {phase} {author} {bookmarks} {desc|firstline}

  > [web]

  > push_ssl = false

  > allow_push = *

  > [phases]

  > publish=False

  > EOF

The extension requires a repo (currently unused)

  $ hg init main

  $ cd main

  $ touch a

  $ hg add a

  $ hg commit -m 'a'

Empty bundle

=================

- no option

- no parts

Test bundling

Test timeouts during bundling

  $ hg bundle2 --timeout --debug --config devel.bundle2.debug=yes

  bundle2-output-bundle: "HG20", 1 parts total

  bundle2-output: start emission of HG20 stream

  0 chunk

  bundle2-output: bundle parameter: 

  1 chunk

  bundle2-output: start of parts

  bundle2-output: bundle part: "test:song"

  bundle2-output-part: "test:song" (advisory) 178 bytes payload

  bundle2-output: part 0: "test:song"

  bundle2-output: header chunk size: 16

  2 chunk

  3 chunk

  bundle2-output: payload chunk size: 178

  4 chunk

  5 chunk

  bundle2-generatorexit

  fake timeout complete.

Test unbundling

  $ hg bundle2 | hg statbundle2

  options count: 0

  parts count:   0

Test old style bundle are detected and refused

  $ hg bundle --all ../bundle.hg

  1 changesets found

  $ hg statbundle2 < ../bundle.hg

  abort: unknown bundle version 10

  [255]

Test parameters

=================

- some options

- no parts

advisory parameters, no value

-------------------------------

Simplest possible parameters form

Test generation simple option

Test unbundling

  $ hg bundle2 --param 'caution' | hg statbundle2

  options count: 1

  - caution

  parts count:   0

Test generation multiple option

Test unbundling

  $ hg bundle2 --param 'caution' --param 'meal' | hg statbundle2

  options count: 2

  - caution

  - meal

  parts count:   0

advisory parameters, with value

-------------------------------

Test generation

Test unbundling

  $ hg bundle2 --param 'caution' --param 'meal=vegan' --param 'elephants' | hg statbundle2