about summary refs log tree commit diff
path: root/t/t0012-help.sh
diff options
context:
space:
mode:
authorVincent Ambo <Vincent Ambo>2020-01-11T23·36+0000
committerVincent Ambo <Vincent Ambo>2020-01-11T23·36+0000
commit1b593e1ea4d2af0f6444d9a7788d5d99abd6fde5 (patch)
treee3accb9beed5c4c1b5a05c99db71ab2841f0ed04 /t/t0012-help.sh
Squashed 'third_party/git/' content from commit cb71568594
git-subtree-dir: third_party/git
git-subtree-split: cb715685942260375e1eb8153b0768a376e4ece7
Diffstat (limited to 't/t0012-help.sh')
-rwxr-xr-xt/t0012-help.sh88
1 files changed, 88 insertions, 0 deletions
diff --git a/t/t0012-help.sh b/t/t0012-help.sh
new file mode 100755
index 000000000000..e8ef7300ecb8
--- /dev/null
+++ b/t/t0012-help.sh
@@ -0,0 +1,88 @@
+#!/bin/sh
+
+test_description='help'
+
+. ./test-lib.sh
+
+configure_help () {
+	test_config help.format html &&
+
+	# Unless the path has "://" in it, Git tries to make sure
+	# the documentation directory locally exists. Avoid it as
+	# we are only interested in seeing an attempt to correctly
+	# invoke a help browser in this test.
+	test_config help.htmlpath test://html &&
+
+	# Name a custom browser
+	test_config browser.test.cmd ./test-browser &&
+	test_config help.browser test
+}
+
+test_expect_success "setup" '
+	# Just write out which page gets requested
+	write_script test-browser <<-\EOF
+	echo "$*" >test-browser.log
+	EOF
+'
+
+# make sure to exercise these code paths, the output is a bit tricky
+# to verify
+test_expect_success 'basic help commands' '
+	git help >/dev/null &&
+	git help -a --no-verbose >/dev/null &&
+	git help -g >/dev/null &&
+	git help -a >/dev/null
+'
+
+test_expect_success "works for commands and guides by default" '
+	configure_help &&
+	git help status &&
+	echo "test://html/git-status.html" >expect &&
+	test_cmp expect test-browser.log &&
+	git help revisions &&
+	echo "test://html/gitrevisions.html" >expect &&
+	test_cmp expect test-browser.log
+'
+
+test_expect_success "--exclude-guides does not work for guides" '
+	>test-browser.log &&
+	test_must_fail git help --exclude-guides revisions &&
+	test_must_be_empty test-browser.log
+'
+
+test_expect_success "--help does not work for guides" "
+	cat <<-EOF >expect &&
+		git: 'revisions' is not a git command. See 'git --help'.
+	EOF
+	test_must_fail git revisions --help 2>actual &&
+	test_i18ncmp expect actual
+"
+
+test_expect_success 'git help' '
+	git help >help.output &&
+	test_i18ngrep "^   clone  " help.output &&
+	test_i18ngrep "^   add    " help.output &&
+	test_i18ngrep "^   log    " help.output &&
+	test_i18ngrep "^   commit " help.output &&
+	test_i18ngrep "^   fetch  " help.output
+'
+test_expect_success 'git help -g' '
+	git help -g >help.output &&
+	test_i18ngrep "^   attributes " help.output &&
+	test_i18ngrep "^   everyday   " help.output &&
+	test_i18ngrep "^   tutorial   " help.output
+'
+
+test_expect_success 'generate builtin list' '
+	git --list-cmds=builtins >builtins
+'
+
+while read builtin
+do
+	test_expect_success "$builtin can handle -h" '
+		test_expect_code 129 git $builtin -h >output 2>&1 &&
+		test_i18ngrep usage output
+	'
+done <builtins
+
+test_done