openmpi/test/util/ompi_session_dir.c

/*
 * $HEADER$
 */

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <libgen.h>
#include <sys/param.h>
#include <sys/stat.h>

#include "ompi_config.h"
#include "include/constants.h"
#include "util/sys_info.h"
#include "util/os_path.h"
#include "util/session_dir.h"
#include "support.h"

struct ompi_proc_info_t {
    bool init;             /**< Certifies that values have been filled.
			    * Certifies that the ompi_sys_info() function has been
			    * called at least once so fields have valid values
			    */
    char *universe_session_dir;  /**< Location of universe  temp dir.
			    * The session directory has the form
			    * <prefix><openmpi-sessions-user><universe>, where the prefix
			    * can either be provided by the user via the
			    * --tmpdir command-line flag, the use of one of several
			    * environmental variables, or else a default location.
			    */

    char *job_session_dir;  /**< Session directory for job */

    char *proc_session_dir;    /**< Session directory for the process */
};
typedef struct ompi_proc_info_t ompi_proc_info_t;

ompi_proc_info_t ompi_process_info;

static bool test1(void);   /* given prefix, both one that works and one that fails */
static bool test2(void);   /* no prefix given, OMPI_PREFIX_ENV set, one good and one bad */
static bool test3(void);   /* no prefix given, TMPDIR set, one good and one bad */
static bool test4(void);   /* no prefix given, TMP set, one good and one bad */
static bool test5(void);   /* no prefix given, HOME set, one good and one bad */
static bool test6(void);   /* no prefix given, nothing set, one good and one bad */


int main(int argc, char* argv[])
{
    ompi_sys_info(); /* initialize system */

    test_init("ompi_session_dir_t");
 

    if (test1()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test1 failed");
    }

    if (test2()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test2 failed");
    }

    if (test3()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test3 failed");
    }

    if (test4()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test4 failed");
    }

    if (test5()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test5 failed");
    }

    if (test6()) {
        test_success();
    }
    else {
      test_failure("ompi_session_dir_t test6 failed");
    }

    test_finalize();
    return 0;
}


static bool test1(void)
{
    /* Test proper action when given a prefix */

    char *prefix, *tmp, *tmp2;

    /* see if we can create a specified path */

    prefix = ompi_os_path(false, "tmp", NULL);
    if (OMPI_ERROR == ompi_session_dir(true, prefix, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	printf("test1 - couldn't create specified path\n");
        free(prefix);
        return(false);
    }
    /* see if it can access an existing path */

    if (OMPI_ERROR == ompi_session_dir(false, prefix, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	printf("test1 - couldn't access existing path\n");
        free(prefix);
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);
    free(ompi_process_info.universe_session_dir);
    free(prefix);
    free(tmp);

    /* check what happens when given prefix that won't allow access */
    tmp2 = ompi_os_path(false, "test", NULL); /* assume we don't have root privileges */
    if (OMPI_SUCCESS == ompi_session_dir(true, tmp2, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
        printf("created temp directory in %s - shouldn't have been able to do so\n", tmp2);
	rmdir(ompi_process_info.universe_session_dir);
	tmp = strdup(dirname(ompi_process_info.universe_session_dir));
	rmdir(tmp);
	free(tmp);
        free(tmp2);
        return(false);
    }

    return true;
}


static bool test2(void)
{
    char *tmp;

    /* use the OMPI_PREFIX_ENV variable */

    setenv("OMPI_PREFIX_ENV", "/tmp/trythis", 1);

    if (OMPI_ERROR == ompi_session_dir(true, NULL, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	unsetenv("OMPI_PREFIX_ENV");
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);
    free(tmp);

    unsetenv("OMPI_PREFIX_ENV");

    return(true);

}


static bool test3(void)
{
    /* use the TMPDIR enviro variable */
    char *tmp;

    setenv("TMPDIR", "/tmp/trythis", 1);

    if (OMPI_ERROR == ompi_session_dir(true, NULL, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	unsetenv("TMPDIR");
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);
    free(tmp);

    unsetenv("TMPDIR");

    return(true);
}


static bool test4(void)
{
    /* use the TMP enviro variable */
    char *tmp;

    setenv("TMP", "/tmp/trythis", 1);

    if (OMPI_ERROR == ompi_session_dir(true, NULL, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	unsetenv("TMP");
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);
    free(tmp);

    unsetenv("TMP");

    return(true);
}


static bool test5(void)
{
    /* use the HOME enviro variable */
    char *tmp;

    setenv("HOME", "/tmp/trythis", 1);

    if (OMPI_ERROR == ompi_session_dir(true, NULL, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
	unsetenv("HOME");
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);
    free(tmp);

    unsetenv("HOME");

    return(true);
}


static bool test6(void)
{
    char *tmp;

    /* no enviro variables set, no prefix given 
    * Program should turn to default of /tmp (where "/" is whatever
    * top-level directory is appropriate for given system)
    */
    if (OMPI_ERROR == ompi_session_dir(true, NULL, ompi_system_info.user, NULL, NULL, "test-universe", NULL, NULL)) {
        return(false);
    }

    rmdir(ompi_process_info.universe_session_dir);
    tmp = strdup(dirname(ompi_process_info.universe_session_dir));
    rmdir(tmp);

    return(true);
}