test.hpp 17.8 KB
Newer Older
Paul's avatar
Paul committed
1

2
#include <algorithm>
Paul's avatar
Paul committed
3
4
5
#include <cassert>
#include <cstdio>
#include <cstdlib>
Paul's avatar
Paul committed
6
#include <functional>
Paul's avatar
Paul committed
7
#include <iostream>
8
#include <sstream>
9
#include <type_traits>
Paul's avatar
Paul committed
10
11
#include <unordered_map>
#include <vector>
Paul's avatar
Paul committed
12

13
14
15
16
#ifdef __linux__
#include <unistd.h>
#endif

Paul's avatar
Paul committed
17
18
#ifndef MIGRAPHX_GUARD_TEST_TEST_HPP
#define MIGRAPHX_GUARD_TEST_TEST_HPP
Paul's avatar
Paul committed
19

Paul's avatar
Paul committed
20
namespace test {
21
// clang-format off
Paul's avatar
Paul committed
22
// NOLINTNEXTLINE
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#define TEST_FOREACH_BINARY_OPERATORS(m) \
    m(==, equal) \
    m(!=, not_equal) \
    m(<=, less_than_equal) \
    m(>=, greater_than_equal) \
    m(<, less_than) \
    m(>, greater_than) \
    m(and, and_op) \
    m(or, or_op)
// clang-format on

// clang-format off
// NOLINTNEXTLINE
#define TEST_FOREACH_UNARY_OPERATORS(m) \
    m(not, not_op)
// clang-format on
Paul's avatar
Paul committed
39
40

// NOLINTNEXTLINE
41
#define TEST_EACH_BINARY_OPERATOR_OBJECT(op, name)     \
Paul's avatar
Paul committed
42
43
44
45
46
47
48
49
50
    struct name                                        \
    {                                                  \
        static std::string as_string() { return #op; } \
        template <class T, class U>                    \
        static decltype(auto) call(T&& x, U&& y)       \
        {                                              \
            return x op y;                             \
        }                                              \
    };
Paul's avatar
Paul committed
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
// NOLINTNEXTLINE
#define TEST_EACH_UNARY_OPERATOR_OBJECT(op, name)      \
    struct name                                        \
    {                                                  \
        static std::string as_string() { return #op; } \
        template <class T>                             \
        static decltype(auto) call(T&& x)              \
        {                                              \
            return op x;                               \
        }                                              \
    };

TEST_FOREACH_BINARY_OPERATORS(TEST_EACH_BINARY_OPERATOR_OBJECT)
TEST_FOREACH_UNARY_OPERATORS(TEST_EACH_UNARY_OPERATOR_OBJECT)

struct nop
{
    static std::string as_string() { return ""; }
    template <class T>
    static decltype(auto) call(T&& x)
    {
        return x;
    }
};
Paul's avatar
Paul committed
76

77
78
79
80
81
82
83
84
85
86
struct function
{
    static std::string as_string() { return ""; }
    template <class T>
    static decltype(auto) call(T&& x)
    {
        return x();
    }
};

87
88
template <class Stream, class Iterator>
inline Stream& stream_range(Stream& s, Iterator start, Iterator last)
89
90
91
92
93
94
95
96
97
{
    if(start != last)
    {
        s << *start;
        std::for_each(std::next(start), last, [&](auto&& x) { s << ", " << x; });
    }
    return s;
}

98
99
template <class Stream>
inline Stream& operator<<(Stream& s, std::nullptr_t)
Paul's avatar
Paul committed
100
101
102
103
104
{
    s << "nullptr";
    return s;
}

105
106
107
template <class Stream,
          class Range,
          class = typename std::enable_if<not std::is_convertible<Range, std::string>{}>::type>
108
inline auto operator<<(Stream& s, const Range& v) -> decltype(stream_range(s, v.begin(), v.end()))
109
110
{
    s << "{ ";
111
    stream_range(s, v.begin(), v.end());
112
113
114
115
    s << "}";
    return s;
}

Paul's avatar
Paul committed
116
template <class T, class U, class Operator>
Paul's avatar
Paul committed
117
struct expression
Paul's avatar
Paul committed
118
{
Paul's avatar
Paul committed
119
120
121
122
    T lhs;
    U rhs;

    friend std::ostream& operator<<(std::ostream& s, const expression& self)
Paul's avatar
Paul committed
123
    {
124
        s << self.lhs << " " << Operator::as_string() << " " << self.rhs;
Paul's avatar
Paul committed
125
        return s;
Paul's avatar
Paul committed
126
    }
Paul's avatar
Paul committed
127

Paul's avatar
Paul committed
128
129
130
    decltype(auto) value() const { return Operator::call(lhs, rhs); };
};

Paul's avatar
Paul committed
131
// TODO: Remove rvalue references
Paul's avatar
Paul committed
132
template <class T, class U, class Operator>
Paul's avatar
Paul committed
133
expression<T, U, Operator> make_expression(T&& rhs, U&& lhs, Operator)
Paul's avatar
Paul committed
134
{
Paul's avatar
Paul committed
135
    return {std::forward<T>(rhs), std::forward<U>(lhs)};
Paul's avatar
Paul committed
136
}
Paul's avatar
Paul committed
137

138
template <class T, class Operator = nop>
Paul's avatar
Paul committed
139
140
struct lhs_expression;

Paul's avatar
Paul committed
141
// TODO: Remove rvalue reference
Paul's avatar
Paul committed
142
template <class T>
Paul's avatar
Paul committed
143
lhs_expression<T> make_lhs_expression(T&& lhs)
Paul's avatar
Paul committed
144
{
Paul's avatar
Paul committed
145
    return lhs_expression<T>{std::forward<T>(lhs)};
Paul's avatar
Paul committed
146
147
}

148
149
150
151
152
153
154
template <class T, class Operator>
lhs_expression<T, Operator> make_lhs_expression(T&& lhs, Operator)
{
    return lhs_expression<T, Operator>{std::forward<T>(lhs)};
}

template <class T, class Operator>
Paul's avatar
Paul committed
155
156
157
struct lhs_expression
{
    T lhs;
Paul's avatar
Paul committed
158
    explicit lhs_expression(T e) : lhs(e) {}
Paul's avatar
Paul committed
159
160
161

    friend std::ostream& operator<<(std::ostream& s, const lhs_expression& self)
    {
162
163
164
165
        std::string op = Operator::as_string();
        if(not op.empty())
            s << Operator::as_string() << " ";
        s << self.lhs;
Paul's avatar
Paul committed
166
167
168
        return s;
    }

169
    decltype(auto) value() const { return Operator::call(lhs); }
Paul's avatar
Paul committed
170
// NOLINTNEXTLINE
171
#define TEST_LHS_BINARY_OPERATOR(op, name)                     \
Paul's avatar
Paul committed
172
173
174
    template <class U>                                         \
    auto operator op(const U& rhs) const                       \
    {                                                          \
Paul's avatar
Paul committed
175
        return make_expression(lhs, rhs, name{}); /* NOLINT */ \
Paul's avatar
Paul committed
176
    }
Paul's avatar
Paul committed
177

178
179
180
181
182
183
184
185
    TEST_FOREACH_BINARY_OPERATORS(TEST_LHS_BINARY_OPERATOR)

// NOLINTNEXTLINE
#define TEST_LHS_UNARY_OPERATOR(op, name) \
    auto operator op() const { return make_lhs_expression(lhs, name{}); /* NOLINT */ }

    TEST_FOREACH_UNARY_OPERATORS(TEST_LHS_UNARY_OPERATOR)

Paul's avatar
Paul committed
186
// NOLINTNEXTLINE
Paul's avatar
Paul committed
187
188
189
190
191
192
193
194
195
196
197
198
199
#define TEST_LHS_REOPERATOR(op)                 \
    template <class U>                          \
    auto operator op(const U& rhs) const        \
    {                                           \
        return make_lhs_expression(lhs op rhs); \
    }
    TEST_LHS_REOPERATOR(+)
    TEST_LHS_REOPERATOR(-)
    TEST_LHS_REOPERATOR(*)
    TEST_LHS_REOPERATOR(/)
    TEST_LHS_REOPERATOR(%)
    TEST_LHS_REOPERATOR(&)
    TEST_LHS_REOPERATOR(|)
200
    TEST_LHS_REOPERATOR (^)
Paul's avatar
Paul committed
201
202
};

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
template <class F>
struct predicate
{
    std::string msg;
    F f;

    friend std::ostream& operator<<(std::ostream& s, const predicate& self)
    {
        s << self.msg;
        return s;
    }

    decltype(auto) operator()() const { return f(); }

    operator decltype(auto)() const { return f(); }
};

template <class F>
auto make_predicate(const std::string& msg, F f)
{
    return make_lhs_expression(predicate<F>{msg, f}, function{});
}

template <class T>
std::string as_string(const T& x)
{
    std::stringstream ss;
    ss << x;
    return ss.str();
}

template <class Iterator>
std::string as_string(Iterator start, Iterator last)
{
    std::stringstream ss;
    stream_range(ss, start, last);
    return ss.str();
}

template <class F>
auto make_function(const std::string& name, F f)
{
    return [=](auto&&... xs) {
        std::vector<std::string> args = {as_string(xs)...};
        return make_predicate(name + "(" + as_string(args.begin(), args.end()) + ")",
                              [=] { return f(xs...); });
    };
}

Paul's avatar
Paul committed
252
struct capture
Paul's avatar
Paul committed
253
{
Paul's avatar
Paul committed
254
    template <class T>
Paul's avatar
Paul committed
255
    auto operator->*(const T& x) const
Paul's avatar
Paul committed
256
257
258
    {
        return make_lhs_expression(x);
    }
259
260
261
262
263
264

    template <class T, class Operator>
    auto operator->*(const lhs_expression<T, Operator>& x) const
    {
        return x;
    }
Paul's avatar
Paul committed
265
266
};

267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
enum class color
{
    reset      = 0,
    bold       = 1,
    underlined = 4,
    fg_red     = 31,
    fg_green   = 32,
    fg_yellow  = 33,
    fg_blue    = 34,
    fg_default = 39,
    bg_red     = 41,
    bg_green   = 42,
    bg_yellow  = 43,
    bg_blue    = 44,
    bg_default = 49
};
inline std::ostream& operator<<(std::ostream& os, const color& c)
{
#ifndef _WIN32
    static const bool use_color = isatty(STDOUT_FILENO) != 0;
    if(use_color)
        return os << "\033[" << static_cast<std::size_t>(c) << "m";
#endif
    return os;
}

Paul's avatar
Paul committed
293
template <class T, class F>
Paul's avatar
Paul committed
294
void failed(T x, const char* msg, const char* func, const char* file, int line, F f)
Paul's avatar
Paul committed
295
{
296
    if(!bool(x.value()))
Paul's avatar
Paul committed
297
    {
Paul's avatar
Paul committed
298
        std::cout << func << std::endl;
Paul's avatar
Paul committed
299
        std::cout << file << ":" << line << ":" << std::endl;
300
        std::cout << color::bold << color::fg_red << "    FAILED: " << color::reset << msg << " "
301
                  << "[ " << x << " ]" << std::endl;
Paul's avatar
Paul committed
302
303
304
        f();
    }
}
Paul's avatar
Paul committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

template <class F>
bool throws(F f)
{
    try
    {
        f();
        return false;
    }
    catch(...)
    {
        return true;
    }
}

Khalique's avatar
Khalique committed
320
template <class Exception, class F>
Paul's avatar
Paul committed
321
bool throws(F f, const std::string& msg = "")
Paul's avatar
Paul committed
322
323
324
325
326
327
328
329
330
331
332
333
{
    try
    {
        f();
        return false;
    }
    catch(const Exception& ex)
    {
        return std::string(ex.what()).find(msg) != std::string::npos;
    }
}

334
335
336
337
338
339
340
template <class T, class U>
auto near(T px, U py, double ptol = 1e-6f)
{
    return make_function("near", [](auto x, auto y, auto tol) { return std::abs(x - y) < tol; })(
        px, py, ptol);
}

Paul's avatar
Paul committed
341
342
343
using string_map = std::unordered_map<std::string, std::vector<std::string>>;

template <class Keyword>
344
string_map generic_parse(std::vector<std::string> as, Keyword keyword)
Paul's avatar
Paul committed
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
{
    string_map result;

    std::string flag;
    for(auto&& x : as)
    {
        auto f = keyword(x);
        if(f.empty())
        {
            result[flag].push_back(x);
        }
        else
        {
            flag = f.front();
            result[flag]; // Ensure the flag exists
360
            flag = f.back();
Paul's avatar
Paul committed
361
362
363
364
365
        }
    }
    return result;
}

366
367
using test_case = std::function<void()>;

Paul's avatar
Paul committed
368
369
inline auto& get_test_cases()
{
370
    // NOLINTNEXTLINE
371
    static std::vector<std::pair<std::string, test_case>> cases;
Paul's avatar
Paul committed
372
373
374
    return cases;
}

375
inline void add_test_case(std::string name, test_case f)
Paul's avatar
Paul committed
376
{
Paul's avatar
Paul committed
377
    get_test_cases().emplace_back(std::move(name), std::move(f));
Paul's avatar
Paul committed
378
379
}

Paul's avatar
Paul committed
380
struct auto_register_test_case
Paul's avatar
Paul committed
381
{
Paul's avatar
Paul committed
382
    template <class F>
Paul's avatar
Paul committed
383
    auto_register_test_case(const char* name, F f) noexcept
Paul's avatar
Paul committed
384
385
386
    {
        add_test_case(name, f);
    }
Paul's avatar
Paul committed
387
388
};

389
struct failure_error
Paul's avatar
Paul committed
390
{
391
};
Paul's avatar
Paul committed
392

393
394
395
[[noreturn]] inline void fail() { throw failure_error{}; }

struct driver
Paul's avatar
Paul committed
396
{
397
398
399
400
401
402
403
404
405
406
407
408
409
    driver()
    {
        add_flag({"--help", "-h"}, "Show help");
        add_flag({"--list", "-l"}, "List all test cases");
        add_flag({"--continue", "-c"}, "Continue after failure");
        add_flag({"--quiet", "-q"}, "Don't print out extra output");
    }
    struct argument
    {
        std::vector<std::string> flags = {};
        std::string help               = "";
        int nargs                      = 1;
    };
Paul's avatar
Paul committed
410

411
    void add_arg(const std::vector<std::string>& flags, const std::string& help = "")
Paul's avatar
Paul committed
412
    {
413
        arguments.push_back(argument{flags, help, 1});
Paul's avatar
Paul committed
414
    }
415
416

    void add_flag(const std::vector<std::string>& flags, const std::string& help = "")
Paul's avatar
Paul committed
417
    {
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
        arguments.push_back(argument{flags, help, 0});
    }

    void show_help(const std::string& exe) const
    {
        std::cout << std::endl;
        std::cout << color::fg_yellow << "USAGE:" << color::reset << std::endl;
        std::cout << "    ";
        std::cout << exe << " <test-case>... <options>" << std::endl;
        std::cout << std::endl;

        std::cout << color::fg_yellow << "ARGS:" << color::reset << std::endl;
        std::cout << "    ";
        std::cout << color::fg_green << "<test-case>..." << color::reset;
        std::cout << std::endl;
        std::cout << "        "
                  << "Test case name to run" << std::endl;
        std::cout << std::endl;
        std::cout << color::fg_yellow << "OPTIONS:" << color::reset << std::endl;
        for(auto&& arg : arguments)
        {
            std::string prefix = "    ";
            std::cout << color::fg_green;
            for(const std::string& a : arg.flags)
            {
                std::cout << prefix;
                std::cout << a;
                prefix = ", ";
            }
            std::cout << color::reset << std::endl;
            std::cout << "        " << arg.help << std::endl;
        }
    }

    std::ostream& out() const
    {
        struct null_buffer : std::streambuf
        {
            virtual int overflow(int c) override { return c; }
        };
        static null_buffer buffer;
        static std::ostream null_stream(&buffer);
        if(quiet)
            return null_stream;
        return std::cout;
    }

    string_map parse(int argc, const char* argv[]) const
    {
        std::vector<std::string> args(argv + 1, argv + argc);
        string_map keys;
        for(auto&& arg : arguments)
Paul's avatar
Paul committed
470
        {
471
472
473
474
475
476
477
478
479
480
            for(auto&& flag : arg.flags)
            {
                keys[flag] = {arg.flags.front()};
                if(arg.nargs == 0)
                    keys[flag].push_back("");
            }
        }
        auto result = generic_parse(args, [&](auto&& s) -> std::vector<std::string> {
            if(keys.count(s) > 0)
                return keys[s];
Paul's avatar
Paul committed
481
            else
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
                return {};
        });
        result["__exe__"].push_back(argv[0]);
        return result;
    }

    static std::string create_command(const string_map& args)
    {
        std::stringstream ss;
        ss << args.at("__exe__").front();
        if(args.count("") > 0)
        {
            for(auto&& arg : args.at(""))
                ss << " \"" << arg << "\"";
        }
        for(auto&& p : args)
        {
            if(p.first == "__exe__")
                continue;
            if(p.first.empty())
                continue;
            ss << " " << p.first;
            for(auto&& arg : p.second)
                ss << " \"" << arg << "\"";
Paul's avatar
Paul committed
506
        }
507
        return ss.str();
Paul's avatar
Paul committed
508
    }
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625

    static std::string fork(const std::string& name, string_map args)
    {
        std::string msg;
        args[""] = {name};
        args.erase("--continue");
        args["--quiet"];
        auto cmd = create_command(args);
        auto r   = std::system(cmd.c_str()); // NOLINT
        if(r != 0)
            msg = "Exited with " + std::to_string(r);
        return msg;
    }

    void run_test_case(const std::string& name, const test_case& f, const string_map& args)
    {
        ran++;
        out() << color::fg_green << "[   RUN    ] " << color::reset << color::bold << name
              << color::reset << std::endl;
        std::string msg;
        if(args.count("--continue") > 0)
        {
            msg = fork(name, args);
        }
        else
        {
            try
            {
                f();
            }
            catch(const failure_error&)
            {
                msg = "Test failure";
            }
        }
        if(msg.empty())
        {
            out() << color::fg_green << "[ COMPLETE ] " << color::reset << color::bold << name
                  << color::reset << std::endl;
        }
        else
        {
            failed.push_back(name);
            out() << color::fg_red << "[  FAILED  ] " << color::reset << color::bold << name
                  << color::reset << ": " << color::fg_yellow << msg << color::reset << std::endl;
        }
    }

    void run(int argc, const char* argv[])
    {
        auto args = parse(argc, argv);
        if(args.count("--help") > 0)
        {
            show_help(args.at("__exe__").front());
            return;
        }
        if(args.count("--list") > 0)
        {
            for(auto&& tc : get_test_cases())
                out() << tc.first << std::endl;
            return;
        }

        if(args.count("--quiet") > 0)
            quiet = true;

        auto cases = args[""];
        if(cases.empty())
        {
            for(auto&& tc : get_test_cases())
                run_test_case(tc.first, tc.second, args);
        }
        else
        {
            std::unordered_map<std::string, test_case> m(get_test_cases().begin(),
                                                         get_test_cases().end());
            for(auto&& iname : cases)
            {
                for(auto&& name : get_case_names(iname))
                {
                    auto f = m.find(name);
                    if(f == m.end())
                    {
                        out() << color::fg_red << "[  ERROR   ] Test case '" << name
                              << "' not found." << color::reset << std::endl;
                        failed.push_back(name);
                    }
                    else
                        run_test_case(name, f->second, args);
                }
            }
        }
        out() << color::fg_green << "[==========] " << color::fg_yellow << ran << " tests ran"
              << color::reset << std::endl;
        if(not failed.empty())
        {
            out() << color::fg_red << "[  FAILED  ] " << color::fg_yellow << failed.size()
                  << " tests failed" << color::reset << std::endl;
            for(auto&& name : failed)
                out() << color::fg_red << "[  FAILED  ] " << color::fg_yellow << name
                      << color::reset << std::endl;
            std::exit(1);
        }
    }

    std::function<std::vector<std::string>(const std::string&)> get_case_names =
        [](const std::string& name) -> std::vector<std::string> { return {name}; };
    std::vector<argument> arguments = {};
    std::vector<std::string> failed = {};
    std::size_t ran                 = 0;
    bool quiet                      = false;
};

inline void run(int argc, const char* argv[])
{
    driver d{};
    d.run(argc, argv);
Paul's avatar
Paul committed
626
627
}

Paul's avatar
Paul committed
628
629
630
} // namespace test

// NOLINTNEXTLINE
Paul's avatar
Paul committed
631
632
633
634
#define CHECK(...)                                                                                 \
    test::failed(                                                                                  \
        test::capture{}->*__VA_ARGS__, #__VA_ARGS__, __PRETTY_FUNCTION__, __FILE__, __LINE__, [] { \
        })
Paul's avatar
Paul committed
635
// NOLINTNEXTLINE
Paul's avatar
Paul committed
636
637
638
639
640
641
#define EXPECT(...)                             \
    test::failed(test::capture{}->*__VA_ARGS__, \
                 #__VA_ARGS__,                  \
                 __PRETTY_FUNCTION__,           \
                 __FILE__,                      \
                 __LINE__,                      \
642
                 &test::fail)
Paul's avatar
Paul committed
643
644
645
// NOLINTNEXTLINE
#define STATUS(...) EXPECT((__VA_ARGS__) == 0)

Paul's avatar
Paul committed
646
647
// NOLINTNEXTLINE
#define TEST_CAT(x, ...) TEST_PRIMITIVE_CAT(x, __VA_ARGS__)
Paul's avatar
Paul committed
648
// NOLINTNEXTLINE
Paul's avatar
Paul committed
649
#define TEST_PRIMITIVE_CAT(x, ...) x##__VA_ARGS__
Paul's avatar
Paul committed
650
651

// NOLINTNEXTLINE
Paul's avatar
Paul committed
652
#define TEST_CASE_REGISTER(...)                                                    \
Paul's avatar
Paul committed
653
654
    static test::auto_register_test_case TEST_CAT(register_test_case_, __LINE__) = \
        test::auto_register_test_case(#__VA_ARGS__, &__VA_ARGS__);
Paul's avatar
Paul committed
655

Paul's avatar
Paul committed
656
// NOLINTNEXTLINE
Paul's avatar
Paul committed
657
658
#define TEST_CASE(...)              \
    void __VA_ARGS__();             \
Paul's avatar
Paul committed
659
    TEST_CASE_REGISTER(__VA_ARGS__) \
Paul's avatar
Paul committed
660
    void __VA_ARGS__()
Paul's avatar
Paul committed
661
662
663
664
665
666

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wglobal-constructors"
#endif

Paul's avatar
Paul committed
667
#endif