Add stats unit test

Add a simple stats unit test that tests the existing library functions
isc_stats_ncounters, isc_stats_increment, isc_stats_decrement,
isc_stats_set, and isc_stats_update_if_greater.

diff --git a/doc/dev/copyrights b/doc/dev/copyrights
index 33b7151e9b27b52eb36522ae2103a43564e15ef4..e18d4a45ba9d60c2e3411db8becdce8048989344 100644 (file)
--- a/doc/dev/copyrights
+++ b/doc/dev/copyrights
@@ -5,10 +5,10 @@ perl util/merge_copyrights
 diff util/copyrights util/newcopyrights
 ... examine output, particularly any files with the "?" type, and
 ... then edit util/newcopyrights if necessary
-$ mv util/newcopyrights util/copyrights
-$ perl util/update_copyrights < util/copyrights
-$ git diff
+mv util/newcopyrights util/copyrights
+perl util/update_copyrights < util/copyrights
+git diff
 ... examine output, edit as necessary.  mail me about anything that
 ... the script should have been able to do itself. :-)
-$ git add util/copyrights
-$ git commit -m 'update_copyrights'
+git add util/copyrights
+git commit -m 'update_copyrights'

diff --git a/lib/isc/tests/Makefile.am b/lib/isc/tests/Makefile.am
index a8b81fc256705868d99fd1f0295daaed8353e0dc..de488951abe981c731010216b4ac328e506c98d7 100644 (file)
--- a/lib/isc/tests/Makefile.am
+++ b/lib/isc/tests/Makefile.am
@@ -41,6 +41,7 @@ check_PROGRAMS =      \
        siphash_test    \
        sockaddr_test   \
        socket_test     \
+       stats_test      \
        symtab_test     \
        task_test       \
        taskpool_test   \

diff --git a/lib/isc/tests/stats_test.c b/lib/isc/tests/stats_test.c
new file mode 100644 (file)
index 0000000..a212613
--- /dev/null
+++ b/lib/isc/tests/stats_test.c
@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, you can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See the COPYRIGHT file distributed with this work for additional
+ * information regarding copyright ownership.
+ */
+
+#if HAVE_CMOCKA
+
+#include <sched.h> /* IWYU pragma: keep */
+#include <setjmp.h>
+#include <stdarg.h>
+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define UNIT_TESTING
+#include <cmocka.h>
+
+#include <isc/mem.h>
+#include <isc/result.h>
+#include <isc/stats.h>
+#include <isc/util.h>
+
+#include "isctest.h"
+
+static int
+_setup(void **state) {
+       isc_result_t result;
+
+       UNUSED(state);
+
+       result = isc_test_begin(NULL, true, 0);
+       assert_int_equal(result, ISC_R_SUCCESS);
+
+       return (0);
+}
+
+static int
+_teardown(void **state) {
+       UNUSED(state);
+
+       isc_test_end();
+
+       return (0);
+}
+
+/* test stats */
+static void
+isc_stats_basic_test(void **state) {
+       isc_stats_t *stats = NULL;
+       isc_result_t result;
+
+       UNUSED(state);
+
+       result = isc_stats_create(test_mctx, &stats, 4);
+       assert_int_equal(result, ISC_R_SUCCESS);
+       assert_int_equal(isc_stats_ncounters(stats), 4);
+
+       /* Default all 0. */
+       for (int i = 0; i < isc_stats_ncounters(stats); i++) {
+               assert_int_equal(isc_stats_get_counter(stats, i), 0);
+       }
+
+       /* Test increment. */
+       for (int i = 0; i < isc_stats_ncounters(stats); i++) {
+               isc_stats_increment(stats, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), 1);
+               isc_stats_increment(stats, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), 2);
+       }
+
+       /* Test decrement. */
+       for (int i = 0; i < isc_stats_ncounters(stats); i++) {
+               isc_stats_decrement(stats, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), 1);
+               isc_stats_decrement(stats, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), 0);
+       }
+
+       /* Test set. */
+       for (int i = 0; i < isc_stats_ncounters(stats); i++) {
+               isc_stats_set(stats, i, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), i);
+       }
+
+       /* Test update if greater. */
+       for (int i = 0; i < isc_stats_ncounters(stats); i++) {
+               isc_stats_update_if_greater(stats, i, i);
+               assert_int_equal(isc_stats_get_counter(stats, i), i);
+               isc_stats_update_if_greater(stats, i, i + 1);
+               assert_int_equal(isc_stats_get_counter(stats, i), i + 1);
+       }
+
+       isc_stats_detach(&stats);
+}
+
+int
+main(void) {
+       const struct CMUnitTest tests[] = {
+               cmocka_unit_test_setup_teardown(isc_stats_basic_test, _setup,
+                                               _teardown),
+       };
+
+       return (cmocka_run_group_tests(tests, NULL, NULL));
+}
+
+#else /* HAVE_CMOCKA */
+
+#include <stdio.h>
+
+int
+main(void) {
+       printf("1..0 # Skipped: cmocka not available\n");
+       return (SKIPPED_TEST_EXIT_CODE);
+}
+
+#endif /* if HAVE_CMOCKA */

diff --git a/util/copyrights b/util/copyrights
index 0f4dab432d231a95e5c0fb3bd009e2835ad53821..490b788e8af8944257f7e1b4448f70aed74539c6 100644 (file)
--- a/util/copyrights
+++ b/util/copyrights
@@ -1882,6 +1882,7 @@
 ./lib/isc/tests/siphash_test.c                 C       2019,2020,2021
 ./lib/isc/tests/sockaddr_test.c                        C       2012,2015,2016,2017,2018,2019,2020,2021
 ./lib/isc/tests/socket_test.c                  C       2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021
+./lib/isc/tests/stats_test.c                   C       2021
 ./lib/isc/tests/symtab_test.c                  C       2011,2012,2013,2016,2018,2019,2020,2021
 ./lib/isc/tests/task_test.c                    C       2011,2012,2016,2017,2018,2019,2020,2021
 ./lib/isc/tests/taskpool_test.c                        C       2011,2012,2016,2018,2019,2020,2021