index : cgit

#!/bin/sh

# Checks what the configuration parser reports on stderr.

test_description='Check configuration diagnostics'
. ./setup.sh

test_expect_success 'set up configs' '
	write_script drain-filter <<-\EOF &&
	cat >/dev/null
	EOF
	cgitrc_repo diagrc diag no-such-key=1 "repo.path=$PWD/repos/foo/.git" repo.no-such-repo-key=1 &&
	{
		echo "virtual-root=/" &&
		echo "cache-size=0" &&
		echo "repo.desc=early" &&
		echo "repo.url=diag" &&
		echo "repo.path=$PWD/repos/foo/.git" &&
		echo "repo.readme=:file-1" &&
		echo "repo.about-filter=exec:$PWD/drain-filter"
	} >earlyrc
'

test_expect_success 'unknown keys are reported and the page still renders' '
	cgit_rc diagrc "url=diag/" >tmp 2>err &&
	grep "Status: 200" tmp &&
	grep "Unknown config key: no-such-key" err &&
	grep "Unknown repo config key: no-such-repo-key" err
'

test_expect_success 'a repo key before any repo.url is reported' '
	cgit_rc earlyrc "url=diag/" >tmp 2>err &&
	grep "Status: 200" tmp &&
	grep "Ignoring repo.desc before any repo.url" err
'

test_expect_success 'a filter in a scanned repository is reported without its flag' '
	git clone -q --bare repos/foo/.git scan/foo.git &&
	echo "commit-filter=exec:$FILTER_DIRECTORY/dump.sh" >scan/foo.git/cgitrc &&
	{
		echo "virtual-root=/" &&
		echo "cache-size=0" &&
		echo "scan-path=$PWD/scan"
	} >scanrc &&
	cgit_rc scanrc "url=foo.git/commit/" >tmp 2>err &&
	grep "<div class=.commit-subject.>commit 5" tmp &&
	grep "Ignoring commit-filter in $PWD/scan/foo.git/: trust-scan-config is not set" err
'

test_expect_success 'the flag lets a scanned repository set its filters' '
	{
		echo "trust-scan-config=1" &&
		cat scanrc
	} >scanrc-on &&
	cgit_rc scanrc-on "url=foo.git/commit/" >tmp 2>err &&
	grep "<div class=.commit-subject.>COMMIT 5" tmp &&
	! grep "Ignoring" err
'

# The filter prints nothing, so an empty about div shows that it ran in place
# of the readme. It reads its input first, so its exit cannot race cgit's
# write.
test_expect_success 'a repo filter in the main cgitrc needs no flag' '
	cgit_rc earlyrc "url=diag/about/" >tmp 2>err &&
	grep "<div id=.about.></div>" tmp &&
	! grep "about-filter" err
'

test_expect_success 'a repository whose path is missing answers 404' '
	{
		echo "virtual-root=/" &&
		echo "cache-size=1021" &&
		echo "cache-root=$PWD/gone-cache" &&
		echo "repo.url=gone" &&
		echo "repo.path=$PWD/no/such/repo/.git"
	} >gonerc &&
	mkdir -p gone-cache &&
	for page in "" log/ commit/ "tag/&h=x" atom/ plain/f
	do
		cgit_rc gonerc "url=gone/$page" >tmp 2>err &&
		grep "^Status: 404 Not Found" tmp &&
		grep "Failed to open gone: No such file or directory" tmp || return 1
	done &&
	test -z "$(ls gone-cache)"
'

test_expect_success 'a fully understood config stays silent' '
	cgit_url "foo/" >tmp 2>err &&
	grep "Status: 200" tmp &&
	! grep "\[cgit\]" err
'

# A comment runs to the end of its line, whatever bytes it holds, so nothing
# after a NUL inside one is read as a setting.
test_expect_success 'a NUL inside a comment does not end it' '
	{
		echo "virtual-root=/" &&
		echo "cache-size=0" &&
		printf "# note\\000root-title=Smuggled\\n" &&
		echo "repo.url=foo" &&
		echo "repo.path=$PWD/repos/foo/.git"
	} >nulrc &&
	grep -c Smuggled nulrc &&
	cgit_rc nulrc "url=" >tmp &&
	grep "</html>" tmp &&
	! grep Smuggled tmp
'

# cgitrc and the files it includes are meant to be there, so one that cannot
# be read is logged rather than left to show an empty index.
test_expect_success 'a config file that cannot be read is reported' '
	CGIT_CONFIG="$PWD/no-such-rc" QUERY_STRING="url=" cgit >tmp 2>err &&
	grep "No repositories found" tmp &&
	grep "Unable to read config file $PWD/no-such-rc: No such file or directory" err &&
	mkdir rc-dir &&
	CGIT_CONFIG="$PWD/rc-dir" QUERY_STRING="url=" cgit >tmp 2>err &&
	grep "Unable to read config file $PWD/rc-dir: Is a directory" err &&
	{
		echo "include=$PWD/no-such-include" &&
		cat diagrc
	} >includerc &&
	cgit_rc includerc "url=diag/" >tmp 2>err &&
	grep "Status: 200" tmp &&
	grep "Unable to read config file $PWD/no-such-include: No such file or directory" err
'

# A scanned repository's own cgitrc is optional, so a scan says nothing when
# one is missing, and neither does reading the scan back from the cache.
test_expect_success 'a scan says nothing of the files it may lack' '
	git clone -q --bare repos/foo/.git quiet/foo.git &&
	mkdir quiet-cache &&
	{
		echo "virtual-root=/" &&
		echo "cache-root=$PWD/quiet-cache" &&
		echo "cache-size=64" &&
		echo "cache-index-ttl=0" &&
		echo "scan-path=$PWD/quiet"
	} >quietrc &&
	cgit_rc quietrc "url=" >tmp 2>err &&
	grep ">foo.git</a>" tmp &&
	cgit_rc quietrc "url=" >tmp 2>>err &&
	grep ">foo.git</a>" tmp &&
	test_must_be_empty err
'

test_done