index : cgit

#!/bin/sh

# Checks the per repository statistics page, which stays off until max-stats
# turns it on and then counts each author's commits over the last four
# periods, busiest first. A second config sets a finer max-stats so that what
# it takes out of the period selector is covered as well.

test_description='Check the statistics page'
. ./setup.sh

# The shared test config sets no max-stats, so this is what an untouched
# install does.
test_expect_success 'stats are off by default' '
	cgit_url "foo/stats" >tmp &&
	grep "^Status: 404" tmp &&
	grep "<div class=.error.>Stats are disabled</div>" tmp &&
	cgit_ok_url "foo" >tmp &&
	grep ">log</a>" tmp &&
	! grep ">stats</a>" tmp
'

# A word that names no period leaves the page off rather than picking one.
test_expect_success 'a max-stats naming no period leaves stats off' '
	cgitrc_repo badrc foo max-stats=decade &&
	cgit_rc badrc "url=foo/stats/" >tmp &&
	grep "^Status: 404" tmp &&
	grep "<div class=.error.>Stats are disabled</div>" tmp
'

# Asks for a stats page into tmp, and fails when the day turned during the
# request, since cgit reads the clock for itself and a new day can open a new
# period. The day read is left in now as year, month, day, ISO week and its
# year, for the caller to work out the labels from.
stats_today() {
	now=$(date -u "+%Y %m %d W%V %G") &&
	cgit_ok "$@" >tmp &&
	test "$(date -u "+%Y %m %d W%V %G")" = "$now"
}

# The column labels of the stats table in tmp, one to a line.
period_labels() {
	sed -n "s/^<tr><th scope=.col.>Author<\/th>\(.*\)<th scope=.col.>Total<\/th><\/tr>$/\1/p" tmp |
	sed -e "s/<th scope=.col.>//g" -e "s/<\/th>/;/g" | tr ";" "\n" | sed "/^$/d"
}

# Makes the given number of empty commits by the named author.
author_commits() {
	i=0 &&
	while test $i -lt $2
	do
		GIT_AUTHOR_NAME="$1" git commit --allow-empty -m "$1 $i" &&
		i=$((i + 1)) || return 1
	done
}

# The authors table counts only recent periods, so beside the 2005 commits of
# mkrepo the fixture has commits stamped now. Each author makes a different
# number of them, in the reverse of the order of their names, so the table
# has to sort by count. One of Gil's commits comes in through a merge, which
# counts for nobody. The walk releases each commit as it goes, which a commit
# read from a commit graph has to survive, so the fixture writes one.
test_expect_success 'set up a stats config' '
	mkrepo repos/pulse 2 &&
	(
		cd repos/pulse &&
		unset GIT_AUTHOR_DATE GIT_COMMITTER_DATE &&
		git checkout -b side &&
		author_commits "Gil Seven" 1 &&
		git checkout - &&
		echo ada >ada.txt &&
		git add ada.txt &&
		GIT_AUTHOR_NAME="Ada One" git commit -m "add ada.txt" &&
		author_commits "Ben Two" 2 &&
		author_commits "Cy Three" 3 &&
		author_commits "Di Four" 4 &&
		author_commits "Ed Five" 5 &&
		author_commits "Flo Six" 6 &&
		author_commits "Gil Seven" 6 &&
		GIT_AUTHOR_NAME="Mo Merger" git merge --no-ff -m merge side &&
		git commit-graph write --reachable
	) &&
	cgitrc_repo statsrc stat max-stats=year "repo.path=$PWD/repos/pulse/.git" &&
	cgitrc_repo statmaxrc stat max-stats=month "repo.path=$PWD/repos/pulse/.git"
'

test_expect_success 'stats tab appears when enabled' '
	cgit_ok statsrc "url=stat/" >tmp &&
	grep ">stats</a>" tmp
'

test_expect_success 'stats page renders the authors table' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	grep "<h2>Commits per author per week</h2>" tmp
'

# Only the sums are compared, since a run that crosses into a new week moves
# the commits from one column to the next.
test_expect_success 'each author is counted and the busiest comes first' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	sed -n "s/^<tr><td class=.left.>\([^<]*\)<\/td>.*<td class=.sum.>\([0-9]*\)<\/td><\/tr>$/\1 \2/p" tmp >actual &&
	test_write_lines "Gil Seven 7" "Flo Six 6" "Ed Five 5" "Di Four 4" \
		"Cy Three 3" "Ben Two 2" "Ada One 1" >expect &&
	test_cmp expect actual &&
	grep "^<tr><td class=.left.>Ada One</td>\(<td>[0-9]*</td>\)\{4\}<td class=.sum.>1</td></tr>$" tmp &&
	grep "^<tr><td class=.total.>Total</td>\(<td class=.sum.>[0-9]*</td>\)\{4\}<td class=.sum.>28</td></tr>$" tmp
'

test_expect_success 'a merge counts for nobody' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	grep "<td class=.left.>Gil Seven</td>.*<td class=.sum.>7</td>" tmp &&
	! grep ">Mo Merger<" tmp
'

test_expect_success 'the authors past the row count share one row' '
	cgit_ok statsrc "url=stat/stats/&ofs=1" >tmp &&
	sed -n "s/^<tr><td class=.left.>\([^<]*\)<\/td>.*<td class=.sum.>\([0-9]*\)<\/td><\/tr>$/\1 \2/p" tmp >actual &&
	test_write_lines "Gil Seven 7" "Others (6) 21" >expect &&
	test_cmp expect actual
'

# The table scrolls sideways on a narrow window with nothing in it a keyboard
# can reach, so the table itself takes focus, and the focus ring links have.
test_expect_success 'the authors table can take keyboard focus' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	grep "<table class=.stats. tabindex=.0. aria-label=.Commits per author.>" tmp &&
	sed -n "/^div#cgit a:focus-visible,$/,/^}/p" \
		"$TEST_OUTPUT_DIRECTORY/../assets/cgit.css" >rule &&
	grep "^div#cgit table.stats:focus-visible {$" rule &&
	grep "^  outline: solid 2px var(--link);$" rule
'

test_expect_success 'stat options sit above the content' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	tr -d "\n" <tmp | sed "s/<h2>Commits per author.*//" | grep "cgit-panel"
'

# Only Ada touched ada.txt, and in a commit inside the window.
test_expect_success 'stats below a path count that path alone' '
	cgit_ok statsrc "url=stat/stats/ada.txt" >tmp &&
	grep "<h2>Commits per author per week (path .ada.txt.)</h2>" tmp &&
	grep "<td class=.left.>Ada One</td>" tmp &&
	! grep ">Gil Seven<" tmp
'

test_expect_success 'max-stats=year offers all four periods' '
	cgit_ok statsrc "url=stat/stats/" >tmp &&
	grep "<option value=.w." tmp &&
	grep "<option value=.m." tmp &&
	grep "<option value=.q." tmp &&
	grep "<option value=.y." tmp
'

test_expect_success 'max-stats bounds the selectable periods' '
	cgit_rc statmaxrc "url=stat/stats/&period=y" >tmp &&
	grep "^Status: 400" tmp &&
	grep "<div class=.error.>Statistics type disabled: year</div>" tmp &&
	cgit_ok statmaxrc "url=stat/stats/" >tmp &&
	grep "<option value=.w." tmp &&
	grep "<option value=.m." tmp &&
	! grep "<option value=.q." tmp &&
	! grep "<option value=.y." tmp
'

test_expect_success 'max-stats=week leaves no period to choose' '
	cgitrc_repo weekrc stat max-stats=week "repo.path=$PWD/repos/pulse/.git" &&
	cgit_ok weekrc "url=stat/stats/" >tmp &&
	grep "<select id=.stats-authors. name=.ofs.>" tmp &&
	! grep "stats-period" tmp
'

test_expect_success 'a period that is not one is refused' '
	cgit_rc statsrc "url=stat/stats/&period=x" >tmp &&
	grep "^Status: 404" tmp &&
	grep "<div class=.error.>Unknown statistics type: x</div>" tmp
'

# Each period buckets commits and labels its columns its own way, so every one
# gets a page of its own here, with the current period last. The weeks before
# this one take date arithmetic the shell lacks, so only their shape is
# checked.
test_expect_success 'the weekly columns end with this week' '
	{
		stats_today statsrc "url=stat/stats/&period=w" ||
		stats_today statsrc "url=stat/stats/&period=w"
	} &&
	period_labels >actual &&
	test_line_count = 4 actual &&
	test $(grep -c "^W[0-9][0-9] [0-9][0-9][0-9][0-9]$" actual) -eq 4 &&
	test "$(sed -n 4p actual)" = "${now#* * * }"
'

test_expect_success 'the monthly columns are the last four months' '
	{
		stats_today statsrc "url=stat/stats/&period=m" ||
		stats_today statsrc "url=stat/stats/&period=m"
	} &&
	set -- $now &&
	month=$(($1 * 12 + ${2#0} - 1)) &&
	for back in 3 2 1 0
	do
		n=$((month - back)) &&
		printf "%s %d\n" $(echo Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec |
			cut -d " " -f $((n % 12 + 1))) $((n / 12)) || return 1
	done >expect &&
	period_labels >actual &&
	test_cmp expect actual
'

test_expect_success 'the quarterly columns are the last four quarters' '
	{
		stats_today statsrc "url=stat/stats/&period=q" ||
		stats_today statsrc "url=stat/stats/&period=q"
	} &&
	set -- $now &&
	quarter=$(($1 * 4 + (${2#0} - 1) / 3)) &&
	for back in 3 2 1 0
	do
		n=$((quarter - back)) &&
		echo "Q$((n % 4 + 1)) $((n / 4))" || return 1
	done >expect &&
	period_labels >actual &&
	test_cmp expect actual
'

test_expect_success 'the yearly columns are the last four years' '
	{
		stats_today statsrc "url=stat/stats/&period=y" ||
		stats_today statsrc "url=stat/stats/&period=y"
	} &&
	year=${now%% *} &&
	test_write_lines $((year - 3)) $((year - 2)) $((year - 1)) $year >expect &&
	period_labels >actual &&
	test_cmp expect actual
'

# Builds a repository with a commit either side of midnight on the first of
# January three years back, where the yearly window opens, and asks for its
# stats into tmp. cgit reads the clock for itself, so this fails when the
# year turned during the request, and the caller asks again.
edge_stats() {
	year=$(date -u +%Y) &&
	first=$((year - 3)) &&
	rm -rf repos/edge &&
	test_create_repo repos/edge &&
	(
		cd repos/edge &&
		GIT_AUTHOR_NAME="Too Early" \
		GIT_AUTHOR_DATE="$((first - 1))-12-31 23:59:59 +0000" \
		GIT_COMMITTER_DATE="$((first - 1))-12-31 23:59:59 +0000" \
			git commit --allow-empty -m before &&
		GIT_AUTHOR_NAME="Early Bird" \
		GIT_AUTHOR_DATE="$first-01-01 00:00:00 +0000" \
		GIT_COMMITTER_DATE="$first-01-01 00:00:00 +0000" \
			git commit --allow-empty -m first
	) &&
	cgitrc_repo edgerc edge max-stats=year &&
	cgit_ok edgerc "url=edge/stats/&period=y" >tmp &&
	test "$(date -u +%Y)" = "$year"
}

test_expect_success 'the window opens at midnight on its first day' '
	{ edge_stats || edge_stats; } &&
	grep ">Early Bird<" tmp &&
	! grep ">Too Early<" tmp
'

# A path starting with a colon would reach git as pathspec magic, which the
# log, the feed and the patch page refuse as well.
test_expect_success 'a path with pathspec magic is refused' '
	cgit_rc statsrc "url=stat/stats/%3A%28icase%29FILE-1" >tmp &&
	grep "^Status: 400" tmp &&
	cgit_ok statsrc "url=stat/stats/file-1" >tmp &&
	grep "<h2>Commits per author per week (path .file-1.)</h2>" tmp
'

test_done