Skip to content

Commit

Permalink
stats: Add unittest for basic stats serialization
Browse files Browse the repository at this point in the history
Main purpose is to validate that the 30 of bond0.30 isn't expanded into
a nested object during serialization.
  • Loading branch information
awelzel authored and victorjulien committed Feb 14, 2024
1 parent b8b8aa6 commit 08db0f3
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,8 @@ EXTRA_DIST = \
tests/detect-tls-version.c \
tests/detect-ipaddr.c \
tests/detect.c \
tests/stream-tcp.c
tests/stream-tcp.c \
tests/output-json-stats.c

install-headers:
mkdir -p $(DESTDIR)${includedir}/suricata
Expand Down
4 changes: 4 additions & 0 deletions src/output-json-stats.c
Original file line number Diff line number Diff line change
Expand Up @@ -483,3 +483,7 @@ void JsonStatsLogRegister(void) {
"eve-log.stats", OutputStatsLogInitSub, JsonStatsLogger,
JsonStatsLogThreadInit, JsonStatsLogThreadDeinit, NULL);
}

#ifdef UNITTESTS
#include "tests/output-json-stats.c"
#endif
2 changes: 2 additions & 0 deletions src/output-json-stats.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@ TmEcode OutputEngineStatsReloadTime(json_t **jdata);
TmEcode OutputEngineStatsRuleset(json_t **jdata);
void JsonStatsLogRegister(void);

void OutputJsonStatsRegisterTests(void);

#endif /* __OUTPUT_JSON_COUNTERS_H__ */
3 changes: 3 additions & 0 deletions src/runmode-unittests.c
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@
#include "decode-vntag.h"
#include "decode-vxlan.h"

#include "output-json-stats.h"

#ifdef OS_WIN32
#include "win32-syscall.h"
#endif
Expand Down Expand Up @@ -215,6 +217,7 @@ static void RegisterUnittests(void)
#endif
SCProtoNameRegisterTests();
UtilCIDRTests();
OutputJsonStatsRegisterTests();
}
#endif

Expand Down
70 changes: 70 additions & 0 deletions src/tests/output-json-stats.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/* Copyright (C) 2024 Open Information Security Foundation
*
* You can copy, redistribute or modify this Program under the terms of
* the GNU General Public License version 2 as published by the Free
* Software Foundation.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/

#include "../suricata-common.h"

#include "../output-json-stats.h"

#include "../util-unittest.h"

static int OutputJsonStatsTest01(void)
{
StatsRecord global_records[] = { { 0 }, { 0 } };
StatsRecord thread_records[2];
thread_records[0].name = "capture.kernel_packets";
thread_records[0].short_name = "kernel_packets";
thread_records[0].tm_name = "W#01-bond0.30";
thread_records[0].value = 42;
thread_records[1].name = "capture.kernel_drops";
thread_records[1].short_name = "kernel_drops";
thread_records[1].tm_name = "W#01-bond0.30";
thread_records[1].value = 4711;

StatsTable table = {
.nstats = 2,
.stats = &global_records[0],
.ntstats = 1,
.tstats = &thread_records[0],
};

json_t *r = StatsToJSON(&table, JSON_STATS_TOTALS | JSON_STATS_THREADS);
if (!r)
return 0;

// Remove variable content
json_object_del(r, "uptime");

char *serialized = json_dumps(r, 0);

// Cheesy comparison
const char *expected = "{\"threads\": {\"W#01-bond0.30\": {\"capture\": {\"kernel_packets\": "
"42, \"kernel_drops\": 4711}}}}";

int cmp_result = strcmp(expected, serialized);
if (cmp_result != 0)
printf("unexpected result\nexpected=%s\ngot=%s\n", expected, serialized);

free(serialized);
json_decref(r);

return cmp_result == 0;
}

void OutputJsonStatsRegisterTests(void)
{
UtRegisterTest("OutputJsonStatsTest01", OutputJsonStatsTest01);
}

0 comments on commit 08db0f3

Please sign in to comment.