command_output.h

Go to the documentation of this file.

// ============================================================= //
//                                                               //
//   File      : command_output.h                                //
//   Purpose   :                                                 //
//                                                               //
//   Coded by Ralf Westram (coder@reallysoft.de) in March 2012   //
//   Institute of Microbiology (Technical University Munich)     //
//   http://www.arb-home.de/                                     //
//                                                               //
// ============================================================= //

#ifndef COMMAND_OUTPUT_H
#define COMMAND_OUTPUT_H

#ifndef UNIT_TESTS
#error currently only used inside unittest-code. need refactoring to be used generally
#endif

#ifndef ARB_FILE_H
#include <arb_file.h>
#endif
#ifndef ARBDBT_H
#include <arbdbt.h>
#endif
#ifndef UT_VALGRINDED_H
#include <ut_valgrinded.h>
#endif
#ifndef _UNISTD_H
#include <unistd.h>
#endif

// --------------------------------------------------------------------------------

class CommandOutput : virtual Noncopyable {
    // support class to test CLI of arb-tools

    char     *stdoutput; // output from command
    char     *stderrput;
    GB_ERROR  error;
    bool      expect_failure;

    void appendError(GB_ERROR err) {
        if (!error) error = err;
        else error = GBS_global_string("%s\n%s", error, err);
    }

    char *readAndUnlink(const char *file) {
        char *content = GB_read_file(file);
        if (!content) appendError(GB_await_error());
        int res = GB_unlink(file);
        if (res == -1) appendError(GB_await_error());
        return content;
    }
    void add_failure_expection(arb_test::expectation_group& expected) {
        using namespace arb_test;
        if (expect_failure) expected.add(that(error).does_differ_from_NULL());
        else                expected.add(that(error).is_equal_to_NULL());
    }

public:
    CommandOutput(const char *command, bool try_valgrind, bool expect_failure_ = false) : // @@@ remove parameter try_valgrind - see ./ut_valgrinded.h@make_valgrinded_call
        stdoutput(NULp),
        stderrput(NULp),
        error(NULp),
        expect_failure(expect_failure_)
    {
        char *escaped = GBS_string_eval(command, "'=\\\\'"); // @@@ use GBK_singlequote?
        if (!escaped) {
            appendError(GB_await_error());
        }
        else {
            if (try_valgrind) make_valgrinded_call(escaped); // @@@ extract part of valgrinded_system to create command

            pid_t pid = getpid();

            char *stdout_log = GBS_global_string_copy("stdout_%i.log", pid);
            char *stderr_log = GBS_global_string_copy("stderr_%i.log", pid);

            char *cmd = GBS_global_string_copy("bash -c '%s >%s 2>%s'", escaped, stdout_log, stderr_log);

            appendError(GBK_system(cmd));
            free(cmd);

            stdoutput = readAndUnlink(stdout_log);
            stderrput = readAndUnlink(stderr_log);

            free(stderr_log);
            free(stdout_log);
        }
        if (error) {
            printf("command '%s'\n"
                   "escaped command '%s'\n"
                   "stdout='%s'\n"
                   "stderr='%s'\n",
                   command, escaped, stdoutput, stderrput);
        }
        free(escaped);
    }
    ~CommandOutput() {
        free(stderrput);
        free(stdoutput);
    }

    const char *get_stdoutput() const { return stdoutput; }
    const char *get_stderrput() const { return stderrput; }
    GB_ERROR get_error() const { return error; }

    arb_test::match_expectation Equals(const char *expected_std, const char *expected_err) {
        using namespace   arb_test;
        expectation_group expected; add_failure_expection(expected);
        if (expected_std) expected.add(that(stdoutput).is_equal_to(expected_std));
        if (expected_err) expected.add(that(stderrput).is_equal_to(expected_err));
        return all().ofgroup(expected);
    }
    arb_test::match_expectation Contains(const char *expected_std, const char *expected_err) {
        using namespace   arb_test;
        expectation_group expected; add_failure_expection(expected);
        if (expected_std) expected.add(that(stdoutput).does_contain(expected_std));
        if (expected_err) expected.add(that(stderrput).does_contain(expected_err));
        return all().ofgroup(expected);
    }
    arb_test::match_expectation has_checksum(uint32_t expected_checksum) {
        uint32_t css      = GBS_checksum(stdoutput, false, "");
        uint32_t cse      = GBS_checksum(stderrput, false, "");
        uint32_t checksum = css^cse;

        using namespace   arb_test;
        expectation_group expected; add_failure_expection(expected);
        expected.add(that(checksum).is_equal_to(expected_checksum));
        return all().ofgroup(expected);
    }
};

// --------------------------------------------------------------------------------

#define TEST_OUTPUT_EQUALS(cmd, expected_std, expected_err)                                     \
    do {                                                                                        \
        bool try_valgrind = false;                                                              \
        TEST_EXPECTATION(CommandOutput(cmd, try_valgrind).Equals(expected_std, expected_err));  \
    } while(0)

#define TEST_OUTPUT_EQUALS__BROKEN(cmd, expected_std, expected_err)                                            \
    do {                                                                                                       \
        bool try_valgrind = false;                                                                             \
        TEST_EXPECTATION__BROKEN_SIMPLE(CommandOutput(cmd, try_valgrind).Equals(expected_std, expected_err));  \
    } while(0)

#define TEST_OUTPUT_CONTAINS(cmd, expected_std, expected_err)                                           \
    do {                                                                                                \
        bool try_valgrind = false;                                                                      \
        TEST_EXPECTATION(CommandOutput(cmd, try_valgrind).Contains(expected_std, expected_err));        \
    } while(0)

#define TEST_OUTPUT_CONTAINS__BROKEN(cmd, expected_std, expected_err)                                                  \
    do {                                                                                                               \
        bool try_valgrind = false;                                                                                     \
        TEST_EXPECTATION__BROKEN_SIMPLE(CommandOutput(cmd, try_valgrind).Contains(expected_std, expected_err));        \
    } while(0)

#define TEST_FAILURE_OUTPUT_CONTAINS(cmd, expected_std, expected_err)                                   \
    do {                                                                                                \
        TEST_EXPECTATION(CommandOutput(cmd, false, true).Contains(expected_std, expected_err));         \
    } while(0)

#define TEST_FAILURE_OUTPUT_CONTAINS__BROKEN(cmd, expected_std, expected_err)                                  \
    do {                                                                                                       \
        TEST_EXPECTATION__BROKEN_SIMPLE(CommandOutput(cmd, false, true).Contains(expected_std, expected_err)); \
    } while(0)


#define TEST_OUTPUT_HAS_CHECKSUM(cmd,checksum)         TEST_EXPECTATION               (CommandOutput(cmd, false).has_checksum(checksum))
#define TEST_OUTPUT_HAS_CHECKSUM__BROKEN(cmd,checksum) TEST_EXPECTATION__BROKEN_SIMPLE(CommandOutput(cmd, false).has_checksum(checksum))

#define TEST_STDOUT_EQUALS(cmd, expected_std) TEST_OUTPUT_EQUALS(cmd, expected_std, (const char *)NULp)
#define TEST_STDERR_EQUALS(cmd, expected_err) TEST_OUTPUT_EQUALS(cmd, (const char *)NULp, expected_err)

#define TEST_STDOUT_CONTAINS(cmd, part) TEST_OUTPUT_CONTAINS(cmd, part, (const char *)NULp)
#define TEST_STDERR_CONTAINS(cmd, part) TEST_OUTPUT_CONTAINS(cmd, (const char *)NULp, part)

#else
#error command_output.h included twice
#endif // COMMAND_OUTPUT_H