xref: /src/external/bsd/atf/dist/atf-c/check.c

/*
 * Automated Testing Framework (atf)
 *
 * Copyright (c) 2008 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.
 */

#include <sys/wait.h>

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "atf-c/check.h"
#include "atf-c/config.h"
#include "atf-c/dynstr.h"
#include "atf-c/error.h"
#include "atf-c/fs.h"
#include "atf-c/process.h"
#include "atf-c/sanity.h"

/* Only needed for testing, so not in the public header. */
atf_error_t atf_check_result_init(atf_check_result_t *);

/* ---------------------------------------------------------------------
 * Auxiliary functions.
 * --------------------------------------------------------------------- */

static
atf_error_t
create_files(atf_check_result_t *r, int *fdout, int *fderr)
{
    atf_error_t err;

    err = atf_fs_mkstemp(&r->m_stdout, fdout);
    if (atf_is_error(err))
        goto out;

    err = atf_fs_mkstemp(&r->m_stderr, fderr);
    if (atf_is_error(err))
        goto err_fdout;

    INV(!atf_is_error(err));
    goto out;

err_fdout:
    close(*fdout);
    atf_fs_unlink(&r->m_stdout);
out:
    return err;
}

static
void
cleanup_files(const atf_check_result_t *r, int fdout, int fderr)
{
    int ret;

    ret = close(fdout);
    INV(ret == 0);
    ret = close(fderr);
    INV(ret == 0);

    atf_fs_unlink(&r->m_stdout);
    atf_fs_unlink(&r->m_stderr);
}

static
atf_error_t
fork_and_wait(char *const *argv, int fdout, int fderr, int *estatus)
{
    atf_error_t err;
    int status;
    pid_t pid;

    err = atf_process_fork(&pid);
    if (atf_is_error(err))
        goto out;

    if (pid == 0) {
        atf_disable_exit_checks();
        /* XXX No error handling at all? */
        dup2(fdout, STDOUT_FILENO);
        dup2(fderr, STDERR_FILENO);
        execvp(argv[0], argv);
        fprintf(stderr, "execvp(%s) failed: %s", argv[0], strerror(errno));
        exit(127);
        UNREACHABLE;
    } else {
        if (waitpid(pid, &status, 0) == -1) {
            err = atf_libc_error(errno, "Error waiting for "
                                 "child process: %d", pid);
        } else {
            *estatus = status;
        }
    }

out:
    return err;
}

/* ---------------------------------------------------------------------
 * The "atf_check_result" type.
 * --------------------------------------------------------------------- */

atf_error_t
atf_check_result_init(atf_check_result_t *r)
{
    atf_error_t err;
    const char *workdir;

    atf_object_init(&r->m_object);

    workdir = atf_config_get("atf_workdir");

    err = atf_fs_path_init_fmt(&r->m_stdout, "%s/%s",
                               workdir, "stdout.XXXXXX");
    if (atf_is_error(err))
        goto out;

    err = atf_fs_path_init_fmt(&r->m_stderr, "%s/%s",
                               workdir, "stderr.XXXXXX");
    if (atf_is_error(err))
        goto err_stdout;

    INV(!atf_is_error(err));
    goto out;

err_stdout:
    atf_fs_path_fini(&r->m_stdout);
out:
    return err;
}

void
atf_check_result_fini(atf_check_result_t *r)
{
    atf_fs_unlink(&r->m_stdout);
    atf_fs_path_fini(&r->m_stdout);

    atf_fs_unlink(&r->m_stderr);
    atf_fs_path_fini(&r->m_stderr);

    atf_object_fini(&r->m_object);
}

const atf_fs_path_t *
atf_check_result_stdout(const atf_check_result_t *r)
{
    return &r->m_stdout;
}

const atf_fs_path_t *
atf_check_result_stderr(const atf_check_result_t *r)
{
    return &r->m_stderr;
}

bool
atf_check_result_exited(const atf_check_result_t *r)
{
    int estatus = r->m_estatus;
    return WIFEXITED(estatus);
}

int
atf_check_result_exitcode(const atf_check_result_t *r)
{
    int estatus = r->m_estatus;
    return WEXITSTATUS(estatus);
}

/* ---------------------------------------------------------------------
 * Free functions.
 * --------------------------------------------------------------------- */

atf_error_t
atf_check_exec(char *const *argv, atf_check_result_t *r)
{
    atf_error_t err;
    int fdout, fderr;

    err = atf_check_result_init(r);
    if (atf_is_error(err))
        goto out;

    err = create_files(r, &fdout, &fderr);
    if (atf_is_error(err))
        goto err_r;

    err = fork_and_wait(argv, fdout, fderr, &r->m_estatus);
    if (atf_is_error(err))
        goto err_files;

    INV(!atf_is_error(err));
    goto out;

err_files:
    cleanup_files(r, fdout, fderr);
err_r:
    atf_check_result_fini(r);
out:
    return err;
}