Mercurial > hg
view tests/test-alias.t @ 24545:9e0c67e84896
json: implement {tags} template
Tags is pretty easy to implement. Let's start there.
The output is slightly different from `hg tags -Tjson`. For reference,
the CLI has the following output:
[
{
"node": "e2049974f9a23176c2addb61d8f5b86e0d620490",
"rev": 29880,
"tag": "tip",
"type": ""
},
...
]
Our output has the format:
{
"node": "0aeb19ea57a6d223bacddda3871cb78f24b06510",
"tags": [
{
"node": "e2049974f9a23176c2addb61d8f5b86e0d620490",
"tag": "tag1",
"date": [1427775457.0, 25200]
},
...
]
}
"rev" is omitted because it isn't a reliable identifier. We shouldn't
be exposing them in web APIs and giving the impression it remotely
resembles a stable identifier. Perhaps we could one day hide this behind
a config option (it might be useful to expose when running servers
locally).
The "type" of the tag isn't defined because this information isn't yet
exposed to the hgweb templater (it could be in a follow-up) and because
it is questionable whether different types should be exposed at all.
(Should the web interface really be exposing "local" tags?)
We use an object for the outer type instead of Array for a few reasons.
First, it is extensible. If we ever need to throw more global properties
into the output, we can do that without breaking backwards compatibility
(property additions should be backwards compatible). Second, uniformity
in web APIs is nice. Having everything return objects seems much saner than
a mix of array and object. Third, there are security issues with arrays
in older browsers. The JSON web services world almost never uses arrays
as the main type for this reason.
Another possibly controversial part about this patch is how dates are
defined. While JSON has a Date type, it is based on the JavaScript Date
type, which is widely considered a pile of garbage. It is a non-starter
for this reason.
Many of Mercurial's built-in date filters drop seconds resolution. So
that's a non-starter as well, since we want the API to be lossless where
possible. rfc3339date, rfc822date, isodatesec, and date are all lossless.
However, they each require the client to perform string parsing on top of
JSON decoding. While date parsing libraries are pretty ubiquitous, some
languages don't have them out of the box. However, pretty much every
programming language can deal with UNIX timestamps (which are just
integers or floats). So, we choose to use Mercurial's internal date
representation, which in JSON is modeled as float seconds since UNIX
epoch and an integer timezone offset from UTC (keep in mind
JavaScript/JSON models all "Numbers" as double prevision floating point
numbers, so there isn't a difference between ints and floats in JSON).
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 31 Mar 2015 14:52:21 -0700 |
parents | 02d7b5cd373b |
children | b3376fba4ab9 |
line wrap: on
line source
$ HGFOO=BAR; export HGFOO $ cat >> $HGRCPATH <<EOF > [alias] > # should clobber ci but not commit (issue2993) > ci = version > myinit = init > mycommit = commit > optionalrepo = showconfig alias.myinit > cleanstatus = status -c > unknown = bargle > ambiguous = s > recursive = recursive > disabled = email > nodefinition = > noclosingquotation = ' > no--cwd = status --cwd elsewhere > no-R = status -R elsewhere > no--repo = status --repo elsewhere > no--repository = status --repository elsewhere > no--config = status --config a.config=1 > mylog = log > lognull = log -r null > shortlog = log --template '{rev} {node|short} | {date|isodate}\n' > positional = log --template '{\$2} {\$1} | {date|isodate}\n' > dln = lognull --debug > nousage = rollback > put = export -r 0 -o "\$FOO/%R.diff" > blank = !printf '\n' > self = !printf '\$0\n' > echoall = !printf '\$@\n' > echo1 = !printf '\$1\n' > echo2 = !printf '\$2\n' > echo13 = !printf '\$1 \$3\n' > echotokens = !printf "%s\n" "\$@" > count = !hg log -r "\$@" --template=. | wc -c | sed -e 's/ //g' > mcount = !hg log \$@ --template=. | wc -c | sed -e 's/ //g' > rt = root > tglog = log -G --template "{rev}:{node|short}: '{desc}' {branches}\n" > idalias = id > idaliaslong = id > idaliasshell = !echo test > parentsshell1 = !echo one > parentsshell2 = !echo two > escaped1 = !printf 'test\$\$test\n' > escaped2 = !sh -c 'echo "HGFOO is \$\$HGFOO"' > escaped3 = !sh -c 'echo "\$1 is \$\$\$1"' > escaped4 = !printf '\$\$0 \$\$@\n' > exit1 = !sh -c 'exit 1' > > [defaults] > mylog = -q > lognull = -q > log = -v > EOF basic $ hg myinit alias unknown $ hg unknown abort: alias 'unknown' resolves to unknown command 'bargle' [255] $ hg help unknown alias 'unknown' resolves to unknown command 'bargle' ambiguous $ hg ambiguous abort: alias 'ambiguous' resolves to ambiguous command 's' [255] $ hg help ambiguous alias 'ambiguous' resolves to ambiguous command 's' recursive $ hg recursive abort: alias 'recursive' resolves to unknown command 'recursive' [255] $ hg help recursive alias 'recursive' resolves to unknown command 'recursive' disabled $ hg disabled abort: alias 'disabled' resolves to unknown command 'email' ('email' is provided by 'patchbomb' extension) [255] $ hg help disabled alias 'disabled' resolves to unknown command 'email' 'email' is provided by the following extension: patchbomb command to send changesets as (a series of) patch emails (use "hg help extensions" for information on enabling extensions) no definition $ hg nodef abort: no definition for alias 'nodefinition' [255] $ hg help nodef no definition for alias 'nodefinition' no closing quotation $ hg noclosing abort: error in definition for alias 'noclosingquotation': No closing quotation [255] $ hg help noclosing error in definition for alias 'noclosingquotation': No closing quotation invalid options $ hg no--cwd abort: error in definition for alias 'no--cwd': --cwd may only be given on the command line [255] $ hg help no--cwd error in definition for alias 'no--cwd': --cwd may only be given on the command line $ hg no-R abort: error in definition for alias 'no-R': -R may only be given on the command line [255] $ hg help no-R error in definition for alias 'no-R': -R may only be given on the command line $ hg no--repo abort: error in definition for alias 'no--repo': --repo may only be given on the command line [255] $ hg help no--repo error in definition for alias 'no--repo': --repo may only be given on the command line $ hg no--repository abort: error in definition for alias 'no--repository': --repository may only be given on the command line [255] $ hg help no--repository error in definition for alias 'no--repository': --repository may only be given on the command line $ hg no--config abort: error in definition for alias 'no--config': --config may only be given on the command line [255] optional repository #if no-outer-repo $ hg optionalrepo init #endif $ cd alias $ cat > .hg/hgrc <<EOF > [alias] > myinit = init -q > EOF $ hg optionalrepo init -q no usage $ hg nousage no rollback information available [1] $ echo foo > foo $ hg commit -Amfoo adding foo with opts $ hg cleanst C foo with opts and whitespace $ hg shortlog 0 e63c23eaa88a | 1970-01-01 00:00 +0000 positional arguments $ hg positional abort: too few arguments for command alias [255] $ hg positional a abort: too few arguments for command alias [255] $ hg positional 'node|short' rev 0 e63c23eaa88a | 1970-01-01 00:00 +0000 interaction with defaults $ hg mylog 0:e63c23eaa88a $ hg lognull -1:000000000000 properly recursive $ hg dln changeset: -1:0000000000000000000000000000000000000000 phase: public parent: -1:0000000000000000000000000000000000000000 parent: -1:0000000000000000000000000000000000000000 manifest: -1:0000000000000000000000000000000000000000 user: date: Thu Jan 01 00:00:00 1970 +0000 extra: branch=default path expanding $ FOO=`pwd` hg put $ cat 0.diff # HG changeset patch # User test # Date 0 0 # Thu Jan 01 00:00:00 1970 +0000 # Node ID e63c23eaa88ae77967edcf4ea194d31167c478b0 # Parent 0000000000000000000000000000000000000000 foo diff -r 000000000000 -r e63c23eaa88a foo --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/foo Thu Jan 01 00:00:00 1970 +0000 @@ -0,0 +1,1 @@ +foo simple shell aliases $ hg blank $ hg blank foo $ hg self self $ hg echoall $ hg echoall foo foo $ hg echoall 'test $2' foo test $2 foo $ hg echoall 'test $@' foo '$@' test $@ foo $@ $ hg echoall 'test "$@"' foo '"$@"' test "$@" foo "$@" $ hg echo1 foo bar baz foo $ hg echo2 foo bar baz bar $ hg echo13 foo bar baz test foo baz $ hg echo2 foo $ hg echotokens $ hg echotokens foo 'bar $1 baz' foo bar $1 baz $ hg echotokens 'test $2' foo test $2 foo $ hg echotokens 'test $@' foo '$@' test $@ foo $@ $ hg echotokens 'test "$@"' foo '"$@"' test "$@" foo "$@" $ echo bar > bar $ hg commit -qA -m bar $ hg count . 1 $ hg count 'branch(default)' 2 $ hg mcount -r '"branch(default)"' 2 $ hg tglog @ 1:042423737847: 'bar' | o 0:e63c23eaa88a: 'foo' shadowing $ hg i hg: command 'i' is ambiguous: idalias idaliaslong idaliasshell identify import incoming init [255] $ hg id 042423737847 tip $ hg ida hg: command 'ida' is ambiguous: idalias idaliaslong idaliasshell [255] $ hg idalias 042423737847 tip $ hg idaliasl 042423737847 tip $ hg idaliass test $ hg parentsshell hg: command 'parentsshell' is ambiguous: parentsshell1 parentsshell2 [255] $ hg parentsshell1 one $ hg parentsshell2 two shell aliases with global options $ hg init sub $ cd sub $ hg count 'branch(default)' abort: unknown revision 'default'! 0 $ hg -v count 'branch(default)' abort: unknown revision 'default'! 0 $ hg -R .. count 'branch(default)' abort: unknown revision 'default'! 0 $ hg --cwd .. count 'branch(default)' 2 $ hg echoall --cwd .. repo specific shell aliases $ cat >> .hg/hgrc <<EOF > [alias] > subalias = !echo sub > EOF $ cat >> ../.hg/hgrc <<EOF > [alias] > mainalias = !echo main > EOF shell alias defined in current repo $ hg subalias sub $ hg --cwd .. subalias > /dev/null hg: unknown command 'subalias' (did you mean one of idalias?) [255] $ hg -R .. subalias > /dev/null hg: unknown command 'subalias' (did you mean one of idalias?) [255] shell alias defined in other repo $ hg mainalias > /dev/null hg: unknown command 'mainalias' (did you mean one of idalias?) [255] $ hg -R .. mainalias main $ hg --cwd .. mainalias main typos get useful suggestions $ hg --cwd .. manalias hg: unknown command 'manalias' (did you mean one of idalias, mainalias, manifest?) [255] shell aliases with escaped $ chars $ hg escaped1 test$test $ hg escaped2 HGFOO is BAR $ hg escaped3 HGFOO HGFOO is BAR $ hg escaped4 test $0 $@ abbreviated name, which matches against both shell alias and the command provided extension, should be aborted. $ cat >> .hg/hgrc <<EOF > [extensions] > hgext.rebase = > EOF #if windows $ cat >> .hg/hgrc <<EOF > [alias] > rebate = !echo this is %HG_ARGS% > EOF #else $ cat >> .hg/hgrc <<EOF > [alias] > rebate = !echo this is \$HG_ARGS > EOF #endif $ hg reba hg: command 'reba' is ambiguous: rebase rebate [255] $ hg rebat this is rebate $ hg rebat --foo-bar this is rebate --foo-bar invalid arguments $ hg rt foo hg rt: invalid arguments hg rt alias for: hg root (use "hg rt -h" to show more help) [255] invalid global arguments for normal commands, aliases, and shell aliases $ hg --invalid root hg: option --invalid not recognized Mercurial Distributed SCM basic commands: add add the specified files on the next commit annotate show changeset information by line for each file clone make a copy of an existing repository commit commit the specified files or all outstanding changes diff diff repository (or selected files) export dump the header and diffs for one or more changesets forget forget the specified files on the next commit init create a new repository in the given directory log show revision history of entire repository or files merge merge another revision into working directory pull pull changes from the specified source push push changes to the specified destination remove remove the specified files on the next commit serve start stand-alone webserver status show changed files in the working directory summary summarize working directory state update update working directory (or switch revisions) (use "hg help" for the full list of commands or "hg -v" for details) [255] $ hg --invalid mylog hg: option --invalid not recognized Mercurial Distributed SCM basic commands: add add the specified files on the next commit annotate show changeset information by line for each file clone make a copy of an existing repository commit commit the specified files or all outstanding changes diff diff repository (or selected files) export dump the header and diffs for one or more changesets forget forget the specified files on the next commit init create a new repository in the given directory log show revision history of entire repository or files merge merge another revision into working directory pull pull changes from the specified source push push changes to the specified destination remove remove the specified files on the next commit serve start stand-alone webserver status show changed files in the working directory summary summarize working directory state update update working directory (or switch revisions) (use "hg help" for the full list of commands or "hg -v" for details) [255] $ hg --invalid blank hg: option --invalid not recognized Mercurial Distributed SCM basic commands: add add the specified files on the next commit annotate show changeset information by line for each file clone make a copy of an existing repository commit commit the specified files or all outstanding changes diff diff repository (or selected files) export dump the header and diffs for one or more changesets forget forget the specified files on the next commit init create a new repository in the given directory log show revision history of entire repository or files merge merge another revision into working directory pull pull changes from the specified source push push changes to the specified destination remove remove the specified files on the next commit serve start stand-alone webserver status show changed files in the working directory summary summarize working directory state update update working directory (or switch revisions) (use "hg help" for the full list of commands or "hg -v" for details) [255] This should show id: $ hg --config alias.log='id' log 000000000000 tip This shouldn't: $ hg --config alias.log='id' history $ cd ../.. return code of command and shell aliases: $ hg mycommit -R alias nothing changed [1] $ hg exit1 [1] #if no-outer-repo $ hg root abort: no repository found in '$TESTTMP' (.hg not found)! [255] $ hg --config alias.hgroot='!hg root' hgroot abort: no repository found in '$TESTTMP' (.hg not found)! [255] #endif