upstream/mercurial-mirror Files · tests/wireprotohelpers.sh

internals: extract frame-based protocol docs to own document...

internals: extract frame-based protocol docs to own document wireprotocol.txt is quite long and difficult to digest. The frame-based protocol is effectively a standalone concept (and could even be used outside of Mercurial). So this commit extracts its docs to a standalone file. The first few paragraphs were rewritten as part of the extraction. Sections headers were adjusted accordingly. Existing referalls in wireprotocol.txt were updated to refer to the new doc / concept, which I've started referring to as `hgrpc`. I'm on the fence as to whether to move the HTTP and SSH transport details to the new doc as well. For now, I'm leaving them in wireprotocol.txt. Differential Revision: https://phab.mercurial-scm.org/D4443

Augie Fackler - - Load All Authors

File last commit:

r39096:b3c6c194 default


                r39594:b0e0db15

default

Download file

             wireprotohelpers.sh
        
                    58 lines
            
             | 1.5 KiB
            
                | application/x-sh
            
             |
                BashLexer
            
             / tests / wireprotohelpers.sh
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      HTTPV2=exp-http-v2-0001

      MEDIATYPE=application/mercurial-exp-framing-0005

      sendhttpraw() {

        hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/

      }

      sendhttpv2peer() {

        hg --verbose debugwireproto --nologhandshake --peer http2 http://$LOCALIP:$HGPORT/

      }

      sendhttpv2peerhandshake() {

        hg --verbose debugwireproto --peer http2 http://$LOCALIP:$HGPORT/

      }

      cat > dummycommands.py << EOF

      from mercurial import (

          wireprototypes,

          wireprotov1server,

          wireprotov2server,

      )

      @wireprotov1server.wireprotocommand(b'customreadonly', permission=b'pull')

      def customreadonlyv1(repo, proto):

          return wireprototypes.bytesresponse(b'customreadonly bytes response')

      @wireprotov2server.wireprotocommand(b'customreadonly', permission=b'pull')

      def customreadonlyv2(repo, proto):

          return wireprototypes.cborresponse(b'customreadonly bytes response')

      @wireprotov1server.wireprotocommand(b'customreadwrite', permission=b'push')

      def customreadwrite(repo, proto):

          return wireprototypes.bytesresponse(b'customreadwrite bytes response')

      @wireprotov2server.wireprotocommand(b'customreadwrite', permission=b'push')

      def customreadwritev2(repo, proto):

          return wireprototypes.cborresponse(b'customreadwrite bytes response')

      EOF

      cat >> $HGRCPATH << EOF

      [extensions]

      drawdag = $TESTDIR/drawdag.py

      EOF

      enabledummycommands() {

        cat >> $HGRCPATH << EOF

      [extensions]

      dummycommands = $TESTTMP/dummycommands.py

      EOF

      }

      enablehttpv2() {

        cat >> $1/.hg/hgrc << EOF

      [experimental]

      web.apiserver = true

      web.api.http-v2 = true

      EOF

      }

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				HTTPV2=exp-http-v2-0001
				MEDIATYPE=application/mercurial-exp-framing-0005

				sendhttpraw() {
				hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/
				}

				sendhttpv2peer() {
				hg --verbose debugwireproto --nologhandshake --peer http2 http://$LOCALIP:$HGPORT/
				}

				sendhttpv2peerhandshake() {
				hg --verbose debugwireproto --peer http2 http://$LOCALIP:$HGPORT/
				}

				cat > dummycommands.py << EOF
				from mercurial import (
				wireprototypes,
				wireprotov1server,
				wireprotov2server,
				)

				@wireprotov1server.wireprotocommand(b'customreadonly', permission=b'pull')
				def customreadonlyv1(repo, proto):
				return wireprototypes.bytesresponse(b'customreadonly bytes response')

				@wireprotov2server.wireprotocommand(b'customreadonly', permission=b'pull')
				def customreadonlyv2(repo, proto):
				return wireprototypes.cborresponse(b'customreadonly bytes response')

				@wireprotov1server.wireprotocommand(b'customreadwrite', permission=b'push')
				def customreadwrite(repo, proto):
				return wireprototypes.bytesresponse(b'customreadwrite bytes response')

				@wireprotov2server.wireprotocommand(b'customreadwrite', permission=b'push')
				def customreadwritev2(repo, proto):
				return wireprototypes.cborresponse(b'customreadwrite bytes response')
				EOF

				cat >> $HGRCPATH << EOF
				[extensions]
				drawdag = $TESTDIR/drawdag.py
				EOF

				enabledummycommands() {
				cat >> $HGRCPATH << EOF
				[extensions]
				dummycommands = $TESTTMP/dummycommands.py
				EOF
				}

				enablehttpv2() {
				cat >> $1/.hg/hgrc << EOF
				[experimental]
				web.apiserver = true
				web.api.http-v2 = true
				EOF
				}