Source

xUnit++ / xUnit++.console / ConsoleReporter.cpp

Full commit
  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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
252
253
254
255
256
257
258
259
260
261
262
263
264
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
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
#include "ConsoleReporter.h"
#include <chrono>
#include <cstdio>
#include <iostream>
#include <memory>
#include <mutex>
#include <unordered_map>

#if defined (_WIN32)
#include <Windows.h>
#undef ReportEvent

namespace
{
    class ResetConsoleColors
    {
    public:
        ResetConsoleColors()
            : stdOut(GetStdHandle(STD_OUTPUT_HANDLE))
        {
            CONSOLE_SCREEN_BUFFER_INFO info;
            GetConsoleScreenBufferInfo(stdOut, &info);
            attributes = info.wAttributes;
        }

        ~ResetConsoleColors()
        {
            Reset();
        }

        void Reset()
        {
            SetConsoleTextAttribute(stdOut, attributes);
        }

    private:
        HANDLE stdOut;
        WORD attributes;
    } resetConsoleColors;
}

#else
#endif

#include "xUnit++/LineInfo.h"
#include "xUnit++/TestDetails.h"
#include "xUnit++/TestEvent.h"

namespace
{
    static const std::string TestSeparator = "\n            ";

    enum class Color : unsigned short
    {
        Default = 65535,

        Black = 0,
        DarkBlue,
        DarkGreen,
        DarkCyan,
        DarkRed,
        DarkMagenta,
        DarkYellow,
        LightGray,
        DarkGray,
        Blue,
        Green,
        Cyan,
        Red,
        Magenta,
        Yellow,
        White,

        Debug = DarkMagenta,
        Info = DarkCyan,
        Warning = Yellow,
        Check = Red,
        Assert = Red,
        Skip = Yellow,
        Suite = White,
        Separator = DarkGray,
        TestName = White,
        FileAndLine = Default,
        Success = Green,
        Failure = Red,
        TimeSummary = DarkGray,
        Call = White,
        Expected = Cyan,
        Actual = Cyan,

        // this value is to match the Win32 value
        // there is a special test in to_ansicode
        Fatal = (0x40 + White),
    };

    Color to_color(xUnitpp::EventLevel level)
    {
        switch (level)
        {
        case xUnitpp::EventLevel::Debug:
            return Color::Debug;
        case xUnitpp::EventLevel::Info:
            return Color::Info;
        case xUnitpp::EventLevel::Warning:
            return Color::Warning;
        case xUnitpp::EventLevel::Check:
            return Color::Check;
        case xUnitpp::EventLevel::Assert:
            return Color::Assert;
        case xUnitpp::EventLevel::Fatal:
            return Color::Fatal;
        }

        return Color::Default;
    }

    std::string to_ansicode(Color color)
    {
        static const std::string codes[] =
        {
            "\033[0;30m",
            "\033[0;34m",
            "\033[0;32m",
            "\033[0;36m",
            "\033[0;31m",
            "\033[0;35m",
            "\033[0;33m",
            "\033[0;37m",
            "\033[0;1;30m", // the 0 at the start clears the background color
            "\033[0;1;34m", // then the 1 sets the color to bold
            "\033[0;1;32m",
            "\033[0;1;36m",
            "\033[0;1;31m",
            "\033[0;1;35m",
            "\033[0;1;33m",
            "\033[0;1;37m",
        };

        if (color == Color::Fatal)
        {
            return "\033[1;37;41m";
        }

        if (color != Color::Default)
        {
            return codes[(int)color];
        }

        return "\033[m";
    }

    std::string FileAndLine(const xUnitpp::TestDetails &td, const xUnitpp::LineInfo &lineInfo)
    {
        auto result = to_string(lineInfo);
        if (result.empty())
        {
            result = to_string(td.LineInfo);
        }

        return result;
    }

    template<typename TStream>
    TStream &operator <<(TStream &stream, Color color)
    {
#if defined (_WIN32)
        stream.flush();
        if (color != Color::Default)
        {
            SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), (unsigned short)color);
        }
        else
        {
            resetConsoleColors.Reset();
        }
#else
        stream << to_ansicode(color);
#endif

        return stream;
    }
}

namespace xUnitpp
{

class ConsoleReporter::ReportCache
{
    class TestOutput
    {
    public:
        struct Fragment
        {
            Fragment(Color color, const std::string &message)
                : color(color)
                , message(message)
        {
        }

            friend std::ostream &operator <<(std::ostream &stream, const Fragment &fragment)
        {
                return stream << fragment.color << fragment.message;
        }

            Color color;
            std::string message;
        }; 

        TestOutput(const xUnitpp::TestDetails &td, bool verbose)
            : testDetails(td)
            , failed(false)
            , verbose(verbose)
        {
        }

        ~TestOutput()
        {
            if (failed || verbose)
            {
                if (failed)
                {
                    std::cout << Fragment(Color::Failure, "\n[ Failure ] ");
                }
                else
                {
                    std::cout << Fragment(Color::Success, "\n[ Success ] ");
                }

                if (!testDetails.Suite.empty())
                {
                    std::cout << Fragment(Color::Suite, testDetails.Suite);
                    std::cout << Fragment(Color::Separator, TestSeparator);
                }

                std::cout << Fragment(Color::TestName, testDetails.Name + "\n");
            }

            if (!fragments.empty())
            {
                for (auto &&msg : fragments)
                {
                    std::cout << msg;
                }
            } 
        }

        TestOutput &operator <<(const xUnitpp::TestEvent &event)
        {
            if (event.IsFailure())
            {
                failed = true;
            }

            fragments.emplace_back(Color::FileAndLine, FileAndLine(testDetails, event.LineInfo()));
            fragments.emplace_back(Color::Separator, ": ");
            fragments.emplace_back(to_color(event.Level()), to_string(event.Level()));
            fragments.emplace_back(Color::Separator, ": ");

            // unfortunately, this code should almost completely match the to_string(const TestEvent &)
            // function found in TestEvent.cpp, but is kept separate because of the color coding
            if (event.IsAssertType())
            {
                auto &&assert = event.Assert();

                fragments.emplace_back(Color::Call, assert.Call() + "()");

                std::string message = " failure";

                std::string userMessage = assert.UserMessage();
                if (!userMessage.empty())
                {
                    message += ": " + userMessage;

                    if (!assert.CustomMessage().empty())
                    {
                        message += "\n     " + assert.CustomMessage();
                    }
                }
                else if (!assert.CustomMessage().empty())
                {
                    message += ": " + assert.CustomMessage();
                }
                else
                {
                    message += ".";
                }

                fragments.emplace_back(Color::Default, message);

                if (!assert.Expected().empty() || !assert.Actual().empty())
                {
                    fragments.emplace_back(Color::Expected, "\n     Expected: ");
                    fragments.emplace_back(Color::Default, assert.Expected());
                    fragments.emplace_back(Color::Actual, "\n       Actual: ");
                    fragments.emplace_back(Color::Default, assert.Actual());
                }
            }
            else
            {
                fragments.emplace_back(Color::Default, event.Message());
            }

            fragments.emplace_back(Color::Default, "\n");
            return *this;
        }

        TestOutput &operator <<(xUnitpp::Time::Duration time)
        {
            if (verbose)
            {
                fragments.emplace_back(Color::TimeSummary, "Test completed in " + xUnitpp::Time::to_string(time) + ".\n");
            }

            return *this;
        }

    private:
        TestOutput(const TestOutput &) /* = delete */;
        TestOutput &operator =(TestOutput) /* = delete */;

    private:
        const xUnitpp::TestDetails &testDetails;
        std::vector<Fragment> fragments;
        bool failed;
        bool verbose;
    };

    typedef std::unordered_map<int, std::shared_ptr<TestOutput>> OutputCache;
    
public:
    ReportCache(bool verbose)
        : verbose(verbose)
    {
    }

    void Instant(Color color, const std::string &message)
    {
        std::cout << TestOutput::Fragment(color, message);
    }

    TestOutput &Cache(const xUnitpp::TestDetails &td)
    {
            auto it = cache.find(td.Id);
            if (it == cache.end())
            {
            cache.insert(std::make_pair(td.Id, std::make_shared<TestOutput>(td, verbose)));
            }

            return *cache[td.Id];
        }

    void Finish(const xUnitpp::TestDetails &td)
        {
            auto it = cache.find(td.Id);
            if (it != cache.end())
            {
                cache.erase(it);
            }
        }

    private:
    OutputCache cache;
    bool verbose;
    };

ConsoleReporter::ConsoleReporter(bool verbose)
    : cache(new ReportCache(verbose))
{
}

void ConsoleReporter::ReportStart(const TestDetails &)
{
}

void ConsoleReporter::ReportEvent(const TestDetails &testDetails, const TestEvent &evt)
{
    cache->Cache(testDetails) << evt;
}

void ConsoleReporter::ReportSkip(const TestDetails &testDetails, const std::string &reason)
{
    cache->Instant(Color::Skip, "\n[ Skipped ] ");

    if (!testDetails.Suite.empty())
    {
        cache->Instant(Color::Suite, testDetails.Suite);
        cache->Instant(Color::Separator, TestSeparator);
    }

    cache->Instant(Color::TestName, testDetails.ShortName + "\n");
    cache->Instant(Color::FileAndLine, to_string(testDetails.LineInfo) + ": ");
    cache->Instant(Color::Skip, reason);
    cache->Instant(Color::Default, "\n");
}

void ConsoleReporter::ReportFinish(const TestDetails &testDetails, Time::Duration timeTaken)
{
    cache->Cache(testDetails) << timeTaken;
    cache->Finish(testDetails);
}

void ConsoleReporter::ReportAllTestsComplete(size_t testCount, size_t skipped, size_t failureCount, Time::Duration totalTime)
{
    Color failColor = Color::Default;
    Color skipColor = Color::Default;
    if (failureCount > 0)
    {
        failColor = Color::Failure;
        cache->Instant(failColor, "\nFAILURE");
    }
    else if (skipped > 0)
    {
        skipColor = Color::Warning;
        cache->Instant(skipColor, "\nWARNING");
    }
    else
    {
        cache->Instant(Color::Success, "\nSuccess");
    }

    cache->Instant(Color::Default, ": " + std::to_string(testCount) + " tests, ");
    cache->Instant(failColor, std::to_string(failureCount) + " failed");
    cache->Instant(Color::Default, ", ");
    cache->Instant(skipColor, std::to_string(skipped) + " skipped");
    cache->Instant(Color::Default, ".");

    std::string report = "\nTest time: ";

    auto ms = Time::ToMilliseconds(totalTime);

    if (ms.count() > 500)
    {
        report += std::to_string(Time::ToSeconds(totalTime).count()) + " seconds.";
    }
    else
    {
        report += std::to_string(ms.count()) + " milliseconds.";
    }

    cache->Instant(Color::TimeSummary, report);
    cache->Instant(Color::Default, "\n");
}

}