glib/glib/tests/testing-helper.c
Philip Withnall 4da8b7b35a gtestutils: Add g_test_summary() to add summary metadata to unit tests
This is a new function along the same lines as g_test_bug(): to allow
developers to annotate unit tests with information about the test (what
it tests, how it tests it) for future developers to read and learn from.

It will also output this summary as a comment in the test’s TAP output,
which might clarify test results.

Includes a unit test.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Fixes: #1450
2019-05-21 12:33:15 +01:00

136 lines
3.3 KiB
C

/*
* Copyright 2018 Collabora Ltd.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, see
* <http://www.gnu.org/licenses/>.
*/
#include <glib.h>
#include <locale.h>
#ifdef G_OS_WIN32
#include <fcntl.h>
#include <io.h>
#include <stdio.h>
#endif
static void
test_pass (void)
{
}
static void
test_skip (void)
{
g_test_skip ("not enough tea");
}
static void
test_fail (void)
{
g_test_fail ();
}
static void
test_incomplete (void)
{
g_test_incomplete ("mind reading not implemented yet");
}
static void
test_summary (void)
{
g_test_summary ("Tests that g_test_summary() works with TAP, by outputting a "
"known summary message in testing-helper, and checking for "
"it in the TAP output later.");
}
int
main (int argc,
char *argv[])
{
char *argv1;
setlocale (LC_ALL, "");
#ifdef G_OS_WIN32
/* Windows opens std streams in text mode, with \r\n EOLs.
* Sometimes it's easier to force a switch to binary mode than
* to account for extra \r in testcases.
*/
setmode (fileno (stdout), O_BINARY);
#endif
g_return_val_if_fail (argc > 1, 1);
argv1 = argv[1];
if (argc > 2)
memmove (&argv[1], &argv[2], (argc - 2) * sizeof (char *));
argc -= 1;
argv[argc] = NULL;
g_test_init (&argc, &argv, NULL);
g_test_set_nonfatal_assertions ();
if (g_strcmp0 (argv1, "pass") == 0)
{
g_test_add_func ("/pass", test_pass);
}
else if (g_strcmp0 (argv1, "skip") == 0)
{
g_test_add_func ("/skip", test_skip);
}
else if (g_strcmp0 (argv1, "incomplete") == 0)
{
g_test_add_func ("/incomplete", test_incomplete);
}
else if (g_strcmp0 (argv1, "fail") == 0)
{
g_test_add_func ("/fail", test_fail);
}
else if (g_strcmp0 (argv1, "all-non-failures") == 0)
{
g_test_add_func ("/pass", test_pass);
g_test_add_func ("/skip", test_skip);
g_test_add_func ("/incomplete", test_incomplete);
}
else if (g_strcmp0 (argv1, "all") == 0)
{
g_test_add_func ("/pass", test_pass);
g_test_add_func ("/skip", test_skip);
g_test_add_func ("/incomplete", test_incomplete);
g_test_add_func ("/fail", test_fail);
}
else if (g_strcmp0 (argv1, "skip-options") == 0)
{
/* The caller is expected to skip some of these with
* -p, -s and/or --GTestSkipCount */
g_test_add_func ("/a", test_pass);
g_test_add_func ("/b/a", test_pass);
g_test_add_func ("/b/b", test_pass);
g_test_add_func ("/c/a", test_pass);
g_test_add_func ("/d/a", test_pass);
}
else if (g_strcmp0 (argv1, "summary") == 0)
{
g_test_add_func ("/summary", test_summary);
}
else
{
g_assert_not_reached ();
}
return g_test_run ();
}