aboutsummaryrefslogtreecommitdiffstats
path: root/host/tests/error_c_test.cpp
blob: c697ebac7904be920ad0b0fd57867fdbe2ecc638 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
//
// Copyright 2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#include <uhd/error.h>
#include <uhd/types/dict.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/assign.hpp>
#include <boost/format.hpp>
#include <boost/test/unit_test.hpp>

/*
 * Test our conversions from exceptions to C-level UHD error codes.
 * We use inline functions separate from the Boost test cases themselves
 * to test our C++ macro, which returns the error code.
 */

typedef struct
{
    std::string last_error;
} dummy_handle_t;

template <typename error_type>
UHD_INLINE uhd_error throw_uhd_exception(
    dummy_handle_t* handle, const uhd::exception* except)
{
    UHD_SAFE_C_SAVE_ERROR(handle, throw *dynamic_cast<const error_type*>(except);)
}

UHD_INLINE uhd_error throw_boost_exception(dummy_handle_t* handle)
{
    UHD_SAFE_C_SAVE_ERROR(
        handle,
        std::runtime_error except("This is a std::runtime_error, thrown by Boost.");
        BOOST_THROW_EXCEPTION(except);)
}

UHD_INLINE uhd_error throw_std_exception(dummy_handle_t* handle)
{
    UHD_SAFE_C_SAVE_ERROR(
        handle, throw std::runtime_error("This is a std::runtime_error.");)
}

UHD_INLINE uhd_error throw_unknown_exception(dummy_handle_t* handle)
{
    UHD_SAFE_C_SAVE_ERROR(handle, throw 1;)
}

// There are enough non-standard names that we can't just use a conversion function
static const uhd::dict<std::string, std::string> pretty_exception_names =
    boost::assign::map_list_of("assertion_error", "AssertionError")(
        "lookup_error", "LookupError")("index_error", "LookupError: IndexError")(
        "key_error", "LookupError: KeyError")("type_error", "TypeError")("value_error",
        "ValueError")("runtime_error", "RuntimeError")("not_implemented_error",
        "RuntimeError: NotImplementedError")("usb_error", "RuntimeError: USBError 1")(
        "environment_error", "EnvironmentError")("io_error", "EnvironmentError: IOError")(
        "os_error", "EnvironmentError: OSError")("system_error", "SystemError");

#define UHD_TEST_CHECK_ERROR_CODE(cpp_exception_type, c_error_code)                      \
    expected_msg =                                                                       \
        str(boost::format("This is a uhd::%s.") % BOOST_STRINGIZE(cpp_exception_type));  \
    uhd::cpp_exception_type cpp_exception_type##_foo(expected_msg);                      \
    error_code = throw_uhd_exception<uhd::cpp_exception_type>(                           \
        &handle, &cpp_exception_type##_foo);                                             \
    BOOST_CHECK_EQUAL(error_code, c_error_code);                                         \
    expected_msg = str(boost::format("%s: %s")                                           \
                       % pretty_exception_names.get(BOOST_STRINGIZE(cpp_exception_type)) \
                       % expected_msg);                                                  \
    BOOST_CHECK_EQUAL(handle.last_error, expected_msg);                                  \
    BOOST_CHECK_EQUAL(get_c_global_error_string(), expected_msg);

// uhd::usb_error has a different constructor
#define UHD_TEST_CHECK_USB_ERROR_CODE()                                                  \
    expected_msg = "This is a uhd::usb_error.";                                          \
    uhd::usb_error usb_error_foo(1, expected_msg);                                       \
    error_code = throw_uhd_exception<uhd::usb_error>(&handle, &usb_error_foo);           \
    BOOST_CHECK_EQUAL(error_code, UHD_ERROR_USB);                                        \
    expected_msg = str(boost::format("%s: %s") % pretty_exception_names.get("usb_error") \
                       % expected_msg);                                                  \
    BOOST_CHECK_EQUAL(handle.last_error, expected_msg);                                  \
    BOOST_CHECK_EQUAL(get_c_global_error_string(), expected_msg);

BOOST_AUTO_TEST_CASE(test_uhd_exception)
{
    dummy_handle_t handle;
    std::string expected_msg;
    uhd_error error_code;

    UHD_TEST_CHECK_ERROR_CODE(assertion_error, UHD_ERROR_ASSERTION);
    UHD_TEST_CHECK_ERROR_CODE(lookup_error, UHD_ERROR_LOOKUP);
    UHD_TEST_CHECK_ERROR_CODE(index_error, UHD_ERROR_INDEX);
    UHD_TEST_CHECK_ERROR_CODE(key_error, UHD_ERROR_KEY);
    UHD_TEST_CHECK_ERROR_CODE(type_error, UHD_ERROR_TYPE);
    UHD_TEST_CHECK_ERROR_CODE(value_error, UHD_ERROR_VALUE);
    UHD_TEST_CHECK_ERROR_CODE(runtime_error, UHD_ERROR_RUNTIME);
    UHD_TEST_CHECK_ERROR_CODE(not_implemented_error, UHD_ERROR_NOT_IMPLEMENTED);
    UHD_TEST_CHECK_ERROR_CODE(io_error, UHD_ERROR_IO);
    UHD_TEST_CHECK_ERROR_CODE(os_error, UHD_ERROR_OS);
    UHD_TEST_CHECK_ERROR_CODE(system_error, UHD_ERROR_SYSTEM);
    UHD_TEST_CHECK_USB_ERROR_CODE();
}

BOOST_AUTO_TEST_CASE(test_boost_exception)
{
    dummy_handle_t handle;
    uhd_error error_code = throw_boost_exception(&handle);

    // Boost error message cannot be determined here, so just check code
    BOOST_CHECK_EQUAL(error_code, UHD_ERROR_BOOSTEXCEPT);
}

BOOST_AUTO_TEST_CASE(test_std_exception)
{
    dummy_handle_t handle;
    uhd_error error_code = throw_std_exception(&handle);

    BOOST_CHECK_EQUAL(error_code, UHD_ERROR_STDEXCEPT);
    BOOST_CHECK_EQUAL(handle.last_error, "This is a std::runtime_error.");
}

BOOST_AUTO_TEST_CASE(test_unknown_exception)
{
    dummy_handle_t handle;
    uhd_error error_code = throw_unknown_exception(&handle);

    BOOST_CHECK_EQUAL(error_code, UHD_ERROR_UNKNOWN);
    BOOST_CHECK_EQUAL(handle.last_error, "Unrecognized exception caught.");
}