Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some tests for pidfile(3).

Browse Source 
I want to touch this module to attempt a feature addition but I need some
tests beforehand!
This commit is contained in:
jmmv 2011-03-22 23:07:32 +00:00
parent a57374e0dd
commit f8d6f5f369
2 changed files with 262 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tests/lib/libutil/Makefile
View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.2 2010/12/20 16:23:01 njoly Exp $
# $NetBSD: Makefile,v 1.3 2011/03/22 23:07:32 jmmv Exp $
NOMAN= # defined
@ -10,6 +10,7 @@ DPADD+= ${LIBUTIL}
LDADD+= -lutil
TESTS_C= t_parsedate
TESTS_C+= t_pidfile
TESTS_C+= t_snprintb
TESTS_C+= t_sockaddr_snprintf

260
tests/lib/libutil/t_pidfile.c Normal file
View File

@ -0,0 +1,260 @@
/* $NetBSD: t_pidfile.c,v 1.1 2011/03/22 23:07:32 jmmv Exp $ */
/*
* Copyright (c) 2011 The NetBSD Foundation, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* This file implements tests for the pidfile(3) functions.
*
* The tests here are tricky because we need to validate that the atexit(3)
* handler registered by pidfile(3) correctly deletes the generated pidfile.
* To do so:
* 1) We spawn a subprocess in every test case,
* 2) Run our test code in such subprocesses. We cannot call any of the ATF
* primitives from inside these.
* 3) Wait for the subprocess to terminate and ensure it exited successfully.
* 4) Check that the pidfile(s) created in the subprocess are gone.
*
* Additionally, pidfile(3) hardcodes a path to a directory writable only by
* root (/var/run). This makes us require root privileges to execute these
* tests.
*/
#include <sys/cdefs.h>
__COPYRIGHT("@(#) Copyright (c) 2011\
The NetBSD Foundation, inc. All rights reserved.");
__RCSID("$NetBSD: t_pidfile.c,v 1.1 2011/03/22 23:07:32 jmmv Exp $");
#include <sys/wait.h>
#include <assert.h>
#include <err.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <paths.h>
#include <unistd.h>
#include <util.h>
#include <atf-c.h>
/* Used by routines that can be called both from the parent and the child
* code to implement proper error reporting. */
static bool in_child = false;
/* Callable from the test case child code. */
static void
check_pidfile(const char *path)
{
FILE *file;
int pid;
printf("Validating contents of pidfile '%s'\n", path);
if ((file = fopen(path, "r")) == NULL)
errx(EXIT_FAILURE, "Cannot open expected pidfile '%s'", path);
if (fscanf(file, "%d", &pid) == -1)
errx(EXIT_FAILURE, "Failed to read pid from pidfile '%s'",
path);
printf("Read pid %d, current pid %d\n", pid, getpid());
if (pid != getpid())
errx(EXIT_FAILURE, "Pid in pidfile (%d) does not match "
"current pid (%d)", pid, getpid());
}
/* Callable from the test case parent/child code. */
static void
ensure_deleted(const char *path)
{
printf("Ensuring pidfile %s does not exist any more\n", path);
if (access(path, R_OK) != -1) {
unlink(path);
if (in_child)
errx(EXIT_FAILURE, "The pidfile %s was not deleted",
path);
else
atf_tc_fail("The pidfile %s was not deleted", path);
}
}
/* Callable from the test case parent code. */
static void
run_child(void (*child)(const char *), const char *cookie)
{
pid_t pid;
pid = fork();
ATF_REQUIRE(pid != -1);
if (pid == 0) {
in_child = true;
child(cookie);
assert(false);
/* UNREACHABLE */
} else {
int status;
ATF_REQUIRE(waitpid(pid, &status, 0) != -1);
if (!WIFEXITED(status) || WEXITSTATUS(status) != EXIT_SUCCESS)
atf_tc_fail("See stderr for details");
}
}
/* Callable from the test case parent/child code. */
static void
generate_default_pidfile_path(char **path)
{
if (asprintf(path, "%s%s.pid", _PATH_VARRUN, getprogname()) == -1) {
if (in_child)
errx(EXIT_FAILURE, "Cannot allocate memory for path");
else
atf_tc_fail("Cannot allocate memory for path");
}
}
/* Callable from the test case parent/child code. */
static void
generate_custom_pidfile_path(char **path)
{
if (asprintf(path, "%scustom-basename.pid", _PATH_VARRUN) == -1) {
if (in_child)
errx(EXIT_FAILURE, "Cannot allocate memory for path");
else
atf_tc_fail("Cannot allocate memory for path");
}
}
static void
helper_default_basename(const char *path)
{
if (pidfile(NULL) == -1)
errx(EXIT_FAILURE, "Failed to create pidfile with default "
"basename");
check_pidfile(path);
exit(EXIT_SUCCESS);
}
ATF_TC(pidfile__default_basename);
ATF_TC_HEAD(pidfile__default_basename, tc)
{
atf_tc_set_md_var(tc, "require.user", "root");
}
ATF_TC_BODY(pidfile__default_basename, tc)
{
char *path;
generate_default_pidfile_path(&path);
run_child(helper_default_basename, path);
ensure_deleted(path);
}
static void
helper_custom_basename(const char *path)
{
if (pidfile("custom-basename") == -1)
errx(EXIT_FAILURE, "Failed to create pidfile with custom "
"basename");
check_pidfile(path);
exit(EXIT_SUCCESS);
}
ATF_TC(pidfile__custom_basename);
ATF_TC_HEAD(pidfile__custom_basename, tc)
{
atf_tc_set_md_var(tc, "require.user", "root");
}
ATF_TC_BODY(pidfile__custom_basename, tc)
{
char *path;
generate_custom_pidfile_path(&path);
run_child(helper_custom_basename, path);
ensure_deleted(path);
}
static void
helper_change_basenames(const char *unused_cookie)
{
char *default_path;
char *custom_path;
generate_default_pidfile_path(&default_path);
if (pidfile(NULL) == -1)
errx(EXIT_FAILURE, "Failed to create pidfile with default "
"basename");
check_pidfile(default_path);
if (pidfile(NULL) == -1)
errx(EXIT_FAILURE, "Failed to recreate pidfile with default "
"basename");
check_pidfile(default_path);
generate_custom_pidfile_path(&custom_path);
if (pidfile("custom-basename") == -1)
errx(EXIT_FAILURE, "Failed to create pidfile with custom "
"basename");
ensure_deleted(default_path);
check_pidfile(custom_path);
if (pidfile("custom-basename") == -1)
errx(EXIT_FAILURE, "Failed to recreate pidfile with custom "
"basename");
check_pidfile(custom_path);
exit(EXIT_SUCCESS);
}
ATF_TC(pidfile__change_basenames);
ATF_TC_HEAD(pidfile__change_basenames, tc)
{
atf_tc_set_md_var(tc, "require.user", "root");
}
ATF_TC_BODY(pidfile__change_basenames, tc)
{
char *default_path;
char *custom_path;
run_child(helper_change_basenames, NULL);
generate_default_pidfile_path(&default_path);
generate_custom_pidfile_path(&custom_path);
ensure_deleted(default_path);
ensure_deleted(custom_path);
}
ATF_TP_ADD_TCS(tp)
{
ATF_TP_ADD_TC(tp, pidfile__default_basename);
ATF_TP_ADD_TC(tp, pidfile__custom_basename);
ATF_TP_ADD_TC(tp, pidfile__change_basenames);
return atf_no_error();
}