1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-29 21:37:53 +01:00
git/t
Mark Wooding acb7257729 xdiff: Show function names in hunk headers.
The speed of the built-in diff generator is nice; but the function names
shown by `diff -p' are /really/ nice.  And I hate having to choose.  So,
we hack xdiff to find the function names and print them.

xdiff has grown a flag to say whether to dig up the function names.  The
builtin_diff function passes this flag unconditionally.  I suppose it
could parse GIT_DIFF_OPTS, but it doesn't at the moment.  I've also
reintroduced the `function name' into the test suite, from which it was
removed in commit 3ce8f089.

The function names are parsed by a particularly stupid algorithm at the
moment: it just tries to find a line in the `old' file, from before the
start of the hunk, whose first character looks plausible.  Still, it's
most definitely a start.

Signed-off-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-03-27 18:43:51 -08:00
..
t4100 [PATCH] git-apply: tests for --stat and --summary. 2005-06-22 10:23:49 -07:00
.gitignore gitignore: Ignore some more boring things. 2006-03-05 11:26:18 -08:00
annotate-tests.sh annotate-tests: override VISUAL when running tests. 2006-03-12 11:50:23 -08:00
diff-lib.sh Show original and resulting blob object info in diff output. 2005-10-07 03:42:00 -07:00
lib-read-tree-m-3way.sh Big tool rename. 2005-09-07 17:45:20 -07:00
Makefile Fixes for ancient versions of GNU make 2006-02-18 23:17:01 -08:00
README Big tool rename. 2005-09-07 17:45:20 -07:00
t0000-basic.sh Optionally work without python 2006-02-18 23:16:09 -08:00
t0010-racy-git.sh Racy GIT (part #2) 2005-12-20 12:12:18 -08:00
t1000-read-tree-m-3way.sh Update the case table in t/t1000. 2005-09-28 12:56:18 -07:00
t1001-read-tree-m-2way.sh Fix typo in test comment. 2005-09-17 11:57:50 -07:00
t1002-read-tree-m-u-2way.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t1100-commit-tree-options.sh [PATCH] fix null TZ problems on os/x 2005-08-13 18:28:54 -07:00
t1200-tutorial.sh Fix t1200 test for breakage caused by removal of full-stop at the end of fast-forward message. 2006-03-09 22:51:21 -08:00
t1300-repo-config.sh repo-config: give value_ a sane default so regexec won't segfault 2006-03-07 17:06:10 -08:00
t2000-checkout-cache-clash.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t2001-checkout-cache-clash.sh Fix typo in debug stanza of t2001 2006-01-07 18:13:44 -08:00
t2002-checkout-cache-u.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t2003-checkout-cache-mkdir.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t2004-checkout-cache-temp.sh Add --temp and --stage=all options to checkout-index. 2006-03-05 00:58:13 -08:00
t2100-update-cache-badpath.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t3000-ls-files-others.sh ls-files --others --directory: test 2006-01-07 21:34:03 -08:00
t3001-ls-files-others-exclude.sh avoid echo -e, there are systems where it does not work 2006-02-12 11:36:19 -08:00
t3002-ls-files-dashpath.sh [PATCH] Teach git-ls-files about '--' to denote end of options. 2005-10-02 10:31:18 -07:00
t3010-ls-files-killed-modified.sh Show modified files in git-ls-files 2005-09-20 15:07:53 -07:00
t3020-ls-files-error-unmatch.sh git-ls-files: Fix, document, and add test for --error-unmatch option. 2006-02-21 18:37:36 -08:00
t3100-ls-tree-restrict.sh t3100: add ls-tree -t and -d tests. 2005-12-01 22:49:52 -08:00
t3101-ls-tree-dirname.sh tests: make scripts executable 2005-12-19 18:27:04 -08:00
t3200-branch.sh t3200: branch --help does not die anymore. 2005-12-14 02:53:43 -08:00
t3300-funny-names.sh t3300: skip when filesystem does not like TAB in filenames. 2006-01-05 20:14:40 -08:00
t3400-rebase.sh git rebase loses author name/email if given bad email address 2005-12-14 17:04:47 -08:00
t3401-rebase-partial.sh Add a test for rebase when a change was picked upstream 2006-01-08 12:33:13 -08:00
t3500-cherry.sh Add a minimal test for git-cherry 2006-01-08 00:54:31 -08:00
t3600-rm.sh workaround fat/ntfs deficiencies for t3600-rm.sh (git-rm) 2006-03-03 11:28:33 -08:00
t3700-add.sh git-add: Add support for --, documentation, and test. 2006-02-21 17:33:43 -08:00
t4000-diff-format.sh trivial: use git-repo-config to detect if the test can be run on the repository 2006-01-05 17:23:44 -08:00
t4001-diff-rename.sh xdiff: Show function names in hunk headers. 2006-03-27 18:43:51 -08:00
t4002-diff-basic.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t4003-diff-rename-1.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t4004-diff-rename-symlink.sh Show original and resulting blob object info in diff output. 2005-10-07 03:42:00 -07:00
t4005-diff-rename-2.sh Retire diff-helper. 2005-09-22 01:54:13 -07:00
t4006-diff-mode.sh trivial: use git-repo-config to detect how to run tests in the test repository 2006-01-05 17:23:46 -08:00
t4007-rename-3.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t4008-diff-break-rewrite.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t4009-diff-rename-4.sh Retire diff-helper. 2005-09-22 01:54:13 -07:00
t4010-diff-pathspec.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t4011-diff-symlink.sh t4011: "sleep 1" is not enough on FAT 2006-01-21 19:33:22 -08:00
t4100-apply-stat.sh Adjust diff-raw tests to the status letter change. 2005-07-26 00:22:43 -07:00
t4101-apply-nonl.sh [PATCH] Missing test_done 2005-08-11 18:26:15 -07:00
t4102-apply-rename.sh trivial: use git-repo-config to detect how to run tests in the test repository 2006-01-05 17:23:46 -08:00
t4103-apply-binary.sh tests: make scripts executable 2005-12-19 18:27:04 -08:00
t4109-apply-multifrag.sh tests: make scripts executable 2005-12-19 18:27:04 -08:00
t4110-apply-scan.sh tests: make scripts executable 2005-12-19 18:27:04 -08:00
t4112-apply-renames.sh Big tool rename. 2005-09-07 17:45:20 -07:00
t5000-tar-tree.sh tar-tree: Use the prefix field of a tar header 2006-03-25 16:40:34 -08:00
t5300-pack-object.sh Guard a test against wc that pads its output with whitespace 2005-12-27 11:08:57 -08:00
t5400-send-pack.sh Make git-send-pack exit with error when some refs couldn't be pushed out 2005-12-13 18:15:02 -08:00
t5500-fetch-pack.sh t5500: adjust to change in pack-object reporting behaviour. 2006-02-11 23:08:23 -08:00
t5501-old-fetch-and-upload.sh Fix 5501 test 2005-12-05 19:12:26 -08:00
t5600-clone-fail-cleanup.sh New test to verify that when git-clone fails it cleans up the new directory. 2006-02-21 18:18:25 -08:00
t6000lib.sh t6000: fix a careless test library add-on. 2006-02-08 21:55:34 -08:00
t6002-rev-list-bisect.sh Use git-update-ref and git-symbolic-ref in tests 2005-10-11 15:15:15 -07:00
t6003-rev-list-topo-order.sh Fix bogus tests on rev-list output. 2005-12-27 11:08:57 -08:00
t6010-merge-base.sh name-rev: do not omit leading components of ref name. 2006-01-11 14:47:20 -08:00
t6020-merge-df.sh New test case: merge with directory/file conflicts 2005-12-03 12:29:05 -08:00
t6021-merge-criss-cross.sh Optionally work without python 2006-02-18 23:16:09 -08:00
t6022-merge-rename.sh Optionally work without python 2006-02-18 23:16:09 -08:00
t6101-rev-parse-parents.sh tests: adjust breakage by stricter rev-parse 2006-01-25 15:10:22 -08:00
t7001-mv.sh git-mv: fix moves into a subdir from outside 2006-03-03 11:28:28 -08:00
t7101-reset.sh Make git-reset delete empty directories 2006-02-17 23:52:57 -08:00
t8001-annotate.sh annotate-blame test: don't "source", but say "." 2006-03-05 22:10:26 -08:00
t8002-blame.sh annotate-blame test: don't "source", but say "." 2006-03-05 22:10:26 -08:00
test-lib.sh Merge part of jc/portable branch 2006-02-21 00:52:18 -08:00

Core GIT Tests
==============

This directory holds many test scripts for core GIT tools.  The
first part of this short document describes how to run the tests
and read their output.

When fixing the tools or adding enhancements, you are strongly
encouraged to add tests in this directory to cover what you are
trying to fix or enhance.  The later part of this short document
describes how your test scripts should be organized.


Running Tests
-------------

The easiest way to run tests is to say "make".  This runs all
the tests.

    *** t0000-basic.sh ***
    *   ok 1: .git/objects should be empty after git-init-db in an empty repo.
    *   ok 2: .git/objects should have 256 subdirectories.
    *   ok 3: git-update-index without --add should fail adding.
    ...
    *   ok 23: no diff after checkout and git-update-index --refresh.
    * passed all 23 test(s)
    *** t0100-environment-names.sh ***
    *   ok 1: using old names should issue warnings.
    *   ok 2: using old names but having new names should not issue warnings.
    ...

Or you can run each test individually from command line, like
this:

    $ sh ./t3001-ls-files-killed.sh
    *   ok 1: git-update-index --add to add various paths.
    *   ok 2: git-ls-files -k to show killed files.
    *   ok 3: validate git-ls-files -k output.
    * passed all 3 test(s)

You can pass --verbose (or -v), --debug (or -d), and --immediate
(or -i) command line argument to the test.

--verbose::
	This makes the test more verbose.  Specifically, the
	command being run and their output if any are also
	output.

--debug::
	This may help the person who is developing a new test.
	It causes the command defined with test_debug to run.

--immediate::
	This causes the test to immediately exit upon the first
	failed test.


Naming Tests
------------

The test files are named as:

	tNNNN-commandname-details.sh

where N is a decimal digit.

First digit tells the family:

	0 - the absolute basics and global stuff
	1 - the basic commands concerning database
	2 - the basic commands concerning the working tree
	3 - the other basic commands (e.g. ls-files)
	4 - the diff commands
	5 - the pull and exporting commands
	6 - the revision tree commands (even e.g. merge-base)

Second digit tells the particular command we are testing.

Third digit (optionally) tells the particular switch or group of switches
we are testing.

If you create files under t/ directory (i.e. here) that is not
the top-level test script, never name the file to match the above
pattern.  The Makefile here considers all such files as the
top-level test script and tries to run all of them.  A care is
especially needed if you are creating a common test library
file, similar to test-lib.sh, because such a library file may
not be suitable for standalone execution.


Writing Tests
-------------

The test script is written as a shell script.  It should start
with the standard "#!/bin/sh" with copyright notices, and an
assignment to variable 'test_description', like this:

	#!/bin/sh
	#
	# Copyright (c) 2005 Junio C Hamano
	#

	test_description='xxx test (option --frotz)

	This test registers the following structure in the cache
	and tries to run git-ls-files with option --frotz.'


Source 'test-lib.sh'
--------------------

After assigning test_description, the test script should source
test-lib.sh like this:

	. ./test-lib.sh

This test harness library does the following things:

 - If the script is invoked with command line argument --help
   (or -h), it shows the test_description and exits.

 - Creates an empty test directory with an empty .git/objects
   database and chdir(2) into it.  This directory is 't/trash'
   if you must know, but I do not think you care.

 - Defines standard test helper functions for your scripts to
   use.  These functions are designed to make all scripts behave
   consistently when command line arguments --verbose (or -v),
   --debug (or -d), and --immediate (or -i) is given.


End with test_done
------------------

Your script will be a sequence of tests, using helper functions
from the test harness library.  At the end of the script, call
'test_done'.


Test harness library
--------------------

There are a handful helper functions defined in the test harness
library for your script to use.

 - test_expect_success <message> <script>

   This takes two strings as parameter, and evaluates the
   <script>.  If it yields success, test is considered
   successful.  <message> should state what it is testing.

   Example:

	test_expect_success \
	    'git-write-tree should be able to write an empty tree.' \
	    'tree=$(git-write-tree)'

 - test_expect_failure <message> <script>

   This is the opposite of test_expect_success.  If <script>
   yields success, test is considered a failure.

   Example:

	test_expect_failure \
	    'git-update-index without --add should fail adding.' \
	    'git-update-index should-be-empty'

 - test_debug <script>

   This takes a single argument, <script>, and evaluates it only
   when the test script is started with --debug command line
   argument.  This is primarily meant for use during the
   development of a new test script.

 - test_done

   Your test script must have test_done at the end.  Its purpose
   is to summarize successes and failures in the test script and
   exit with an appropriate error code.


Tips for Writing Tests
----------------------

As with any programming projects, existing programs are the best
source of the information.  However, do _not_ emulate
t0000-basic.sh when writing your tests.  The test is special in
that it tries to validate the very core of GIT.  For example, it
knows that there will be 256 subdirectories under .git/objects/,
and it knows that the object ID of an empty tree is a certain
40-byte string.  This is deliberately done so in t0000-basic.sh
because the things the very basic core test tries to achieve is
to serve as a basis for people who are changing the GIT internal
drastically.  For these people, after making certain changes,
not seeing failures from the basic test _is_ a failure.  And
such drastic changes to the core GIT that even changes these
otherwise supposedly stable object IDs should be accompanied by
an update to t0000-basic.sh.

However, other tests that simply rely on basic parts of the core
GIT working properly should not have that level of intimate
knowledge of the core GIT internals.  If all the test scripts
hardcoded the object IDs like t0000-basic.sh does, that defeats
the purpose of t0000-basic.sh, which is to isolate that level of
validation in one place.  Your test also ends up needing
updating when such a change to the internal happens, so do _not_
do it and leave the low level of validation to t0000-basic.sh.