xref: /freebsd/libexec/pkg-serve/tests/pkg_serve_test.sh (revision b42e852e89cb04cceb6e0226d6a08cab13fb6e90)

#-
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2026 Baptiste Daroussin <bapt@FreeBSD.org>

PKG_SERVE="${PKG_SERVE:-/usr/libexec/pkg-serve}"

serve()
{
	printf "$1" | "${PKG_SERVE}" "$2"
}

check_output()
{
	local pattern="$1" ; shift
	output=$(serve "$@")
	case "$output" in
	*${pattern}*)
		return 0
		;;
	*)
		echo "Expected pattern: ${pattern}"
		echo "Got: ${output}"
		return 1
		;;
	esac
}

atf_test_case greeting
greeting_head()
{
	atf_set "descr" "Server sends greeting on connect"
}
greeting_body()
{
	mkdir repo
	check_output "ok: pkg-serve " "quit\n" repo ||
	    atf_fail "greeting not found"
}

atf_test_case unknown_command
unknown_command_head()
{
	atf_set "descr" "Unknown commands get ko response"
}
unknown_command_body()
{
	mkdir repo
	check_output "ko: unknown command 'plop'" "plop\nquit\n" repo ||
	    atf_fail "expected ko for unknown command"
}

atf_test_case get_missing_file
get_missing_file_head()
{
	atf_set "descr" "Requesting a missing file returns ko"
}
get_missing_file_body()
{
	mkdir repo
	check_output "ko: file not found" "get nonexistent.pkg 0\nquit\n" repo ||
	    atf_fail "expected file not found"
}

atf_test_case get_file
get_file_head()
{
	atf_set "descr" "Requesting an existing file returns its content"
}
get_file_body()
{
	mkdir repo
	echo "testcontent" > repo/test.pkg
	output=$(serve "get test.pkg 0\nquit\n" repo)
	echo "$output" | grep -q "ok: 12" ||
	    atf_fail "expected ok: 12, got: ${output}"
	echo "$output" | grep -q "testcontent" ||
	    atf_fail "expected testcontent in output"
}

atf_test_case get_file_leading_slash
get_file_leading_slash_head()
{
	atf_set "descr" "Leading slash in path is stripped"
}
get_file_leading_slash_body()
{
	mkdir repo
	echo "testcontent" > repo/test.pkg
	check_output "ok: 12" "get /test.pkg 0\nquit\n" repo ||
	    atf_fail "leading slash not stripped"
}

atf_test_case get_file_uptodate
get_file_uptodate_head()
{
	atf_set "descr" "File with old mtime returns ok: 0"
}
get_file_uptodate_body()
{
	mkdir repo
	echo "testcontent" > repo/test.pkg
	check_output "ok: 0" "get test.pkg 9999999999\nquit\n" repo ||
	    atf_fail "expected ok: 0 for up-to-date file"
}

atf_test_case get_directory
get_directory_head()
{
	atf_set "descr" "Requesting a directory returns ko"
}
get_directory_body()
{
	mkdir -p repo/subdir
	check_output "ko: not a file" "get subdir 0\nquit\n" repo ||
	    atf_fail "expected not a file"
}

atf_test_case get_missing_age
get_missing_age_head()
{
	atf_set "descr" "get without age argument returns error"
}
get_missing_age_body()
{
	mkdir repo
	check_output "ko: bad command get" "get test.pkg\nquit\n" repo ||
	    atf_fail "expected bad command get"
}

atf_test_case get_bad_age
get_bad_age_head()
{
	atf_set "descr" "get with non-numeric age returns error"
}
get_bad_age_body()
{
	mkdir repo
	check_output "ko: bad number" "get test.pkg notanumber\nquit\n" repo ||
	    atf_fail "expected bad number"
}

atf_test_case get_empty_arg
get_empty_arg_head()
{
	atf_set "descr" "get with no arguments returns error"
}
get_empty_arg_body()
{
	mkdir repo
	check_output "ko: bad command get" "get \nquit\n" repo ||
	    atf_fail "expected bad command get"
}

atf_test_case path_traversal
path_traversal_head()
{
	atf_set "descr" "Path traversal with .. is rejected"
}
path_traversal_body()
{
	mkdir repo
	check_output "ko: file not found" \
	    "get ../etc/passwd 0\nquit\n" repo ||
	    atf_fail "path traversal not rejected"
}

atf_test_case get_subdir_file
get_subdir_file_head()
{
	atf_set "descr" "Files in subdirectories are served"
}
get_subdir_file_body()
{
	mkdir -p repo/sub
	echo "subcontent" > repo/sub/file.pkg
	output=$(serve "get sub/file.pkg 0\nquit\n" repo)
	echo "$output" | grep -q "ok: 11" ||
	    atf_fail "expected ok: 11, got: ${output}"
	echo "$output" | grep -q "subcontent" ||
	    atf_fail "expected subcontent in output"
}

atf_test_case multiple_gets
multiple_gets_head()
{
	atf_set "descr" "Multiple get commands in one session"
}
multiple_gets_body()
{
	mkdir repo
	echo "aaa" > repo/a.pkg
	echo "bbb" > repo/b.pkg
	output=$(serve "get a.pkg 0\nget b.pkg 0\nquit\n" repo)
	echo "$output" | grep -q "ok: 4" ||
	    atf_fail "expected ok: 4 for a.pkg"
	echo "$output" | grep -q "aaa" ||
	    atf_fail "expected content of a.pkg"
	echo "$output" | grep -q "bbb" ||
	    atf_fail "expected content of b.pkg"
}

atf_test_case bad_basedir
bad_basedir_head()
{
	atf_set "descr" "Non-existent basedir causes exit failure"
}
bad_basedir_body()
{
	atf_check -s not-exit:0 -e match:"open" \
	    "${PKG_SERVE}" /nonexistent/path
}

atf_init_test_cases()
{
	atf_add_test_case greeting
	atf_add_test_case unknown_command
	atf_add_test_case get_missing_file
	atf_add_test_case get_file
	atf_add_test_case get_file_leading_slash
	atf_add_test_case get_file_uptodate
	atf_add_test_case get_directory
	atf_add_test_case get_missing_age
	atf_add_test_case get_bad_age
	atf_add_test_case get_empty_arg
	atf_add_test_case path_traversal
	atf_add_test_case get_subdir_file
	atf_add_test_case multiple_gets
	atf_add_test_case bad_basedir
}