suricata
runmode-unittests.c
Go to the documentation of this file.
1 /* Copyright (C) 2013-2022 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /** \file
19  *
20  * \author Eric Leblond <eric@regit.org>
21  */
22 
23 #include "suricata-common.h"
24 #include "util-unittest.h"
25 #include "runmode-unittests.h"
26 
27 #ifdef UNITTESTS
28 
29 #include "detect-parse.h"
30 #include "detect-engine.h"
31 #include "detect-engine-address.h"
32 #include "detect-engine-proto.h"
33 #include "detect-engine-port.h"
34 #include "detect-engine-mpm.h"
35 #include "detect-engine-sigorder.h"
36 #include "detect-engine-payload.h"
38 #include "detect-engine-state.h"
39 #include "detect-engine-tag.h"
40 #include "detect-engine-enip.h"
41 #include "detect-fast-pattern.h"
42 #include "flow.h"
43 #include "flow-timeout.h"
44 #include "flow-manager.h"
45 #include "flow-var.h"
46 #include "flow-bit.h"
47 #include "pkt-var.h"
48 
49 #include "host.h"
50 #include "host-bit.h"
51 #include "ippair.h"
52 #include "ippair-bit.h"
53 #include "unix-manager.h"
54 
55 #include "stream-tcp.h"
56 
57 #include "app-layer-detect-proto.h"
58 #include "app-layer-parser.h"
59 #include "app-layer.h"
60 #include "app-layer-htp.h"
61 #include "app-layer-ftp.h"
62 #include "app-layer-ssl.h"
63 #include "app-layer-ssh.h"
64 #include "app-layer-smtp.h"
65 
66 #include "util-action.h"
67 #include "util-radix-tree.h"
68 #include "util-host-os-info.h"
69 #include "util-cidr.h"
70 #include "util-unittest-helper.h"
71 #include "util-time.h"
72 #include "util-rule-vars.h"
74 #include "util-threshold-config.h"
75 #include "util-reference-config.h"
76 #include "util-profiling.h"
77 #include "util-magic.h"
78 #include "util-memcmp.h"
79 #include "util-misc.h"
80 #include "util-signal.h"
81 
82 #include "reputation.h"
83 #include "util-atomic.h"
84 #include "util-spm.h"
85 #include "util-hash.h"
86 #include "util-hashlist.h"
87 #include "util-bloomfilter.h"
89 #include "util-pool.h"
90 #include "util-byte.h"
91 #include "util-proto-name.h"
92 #include "util-macset.h"
93 #include "util-memrchr.h"
94 
95 #include "util-mpm-ac.h"
96 #include "util-mpm-hs.h"
97 
98 #include "conf.h"
99 #include "conf-yaml-loader.h"
100 #include "tmqh-flow.h"
101 #include "defrag.h"
102 #include "detect-engine-siggroup.h"
103 
104 #include "util-streaming-buffer.h"
105 #include "util-lua.h"
106 
107 #ifdef OS_WIN32
108 #include "win32-syscall.h"
109 #endif
110 
111 #ifdef WINDIVERT
112 #include "source-windivert.h"
113 #endif
114 
115 #endif /* UNITTESTS */
116 
117 void TmqhSetup (void);
118 
119 #ifdef UNITTESTS
120 static void RegisterUnittests(void)
121 {
180 #ifdef PROFILING
182 #endif
191  DetectPortTests();
198 #ifdef OS_WIN32
199  Win32SyscallRegisterTests();
200 #endif
201 #ifdef WINDIVERT
202  SourceWinDivertRegisterTests();
203 #endif
205  UtilCIDRTests();
206 }
207 #endif
208 
209 /**
210  * Run or list unittests
211  *
212  * \param list_unittests If set to 1, list unittests. Run them if set to 0.
213  * \param regex_arg A regular expression to select unittests to run
214  *
215  * This function is terminal and will call exit after being called.
216  */
217 
218 void RunUnittests(int list_unittests, const char *regex_arg)
219 {
220 #ifdef UNITTESTS
221  /* Initializations for global vars, queues, etc (memsets, mutex init..) */
223 
224 #ifdef HAVE_LUAJIT
225  if (LuajitSetupStatesPool() != 0) {
226  exit(EXIT_FAILURE);
227  }
228 #endif
229 
231  /* load the pattern matchers */
232  MpmTableSetup();
233  SpmTableSetup();
234 
235  StorageInit();
236  AppLayerSetup();
237 
238  /* hardcoded initialization code */
239  SigTableSetup(); /* load the rule keywords */
240  TmqhSetup();
241 
242  TagInitCtx();
244  SCClassConfInit();
245 
246  UtInitialize();
247 
249 
250  HostBitInitCtx();
251 
252  StorageFinalize();
253  /* test and initialize the unittesting subsystem */
254  if (regex_arg == NULL){
255  regex_arg = ".*";
256  UtRunSelftest(regex_arg); /* inits and cleans up again */
257  }
258 
261 
262  RegisterUnittests();
263 
264  if (list_unittests) {
266  } else {
267  /* global packet pool */
268  extern intmax_t max_pending_packets;
269  max_pending_packets = 128;
270  PacketPoolInit();
271 
272  uint32_t failed = UtRunTests(regex_arg);
274  UtCleanup();
275 #ifdef BUILD_HYPERSCAN
277 #endif
278  if (failed) {
279  exit(EXIT_FAILURE);
280  }
281  }
282 
283 #ifdef HAVE_LUAJIT
284  LuajitFreeStatesPool();
285 #endif
286 
287  exit(EXIT_SUCCESS);
288 #else
289  FatalError(SC_ERR_FATAL, "Unittests are not build-in");
290 #endif /* UNITTESTS */
291 }
util-byte.h
host.h
SCProtoNameRegisterTests
void SCProtoNameRegisterTests(void)
Definition: util-proto-name.c:503
TagInitCtx
void TagInitCtx(void)
Definition: detect-engine-tag.c:51
DecodeUDPV4RegisterTests
void DecodeUDPV4RegisterTests(void)
Definition: decode-udp.c:221
ippair.h
AppLayerHtpNeedFileInspection
void AppLayerHtpNeedFileInspection(void)
Sets a flag that informs the HTP app layer that some module in the engine needs the http request file...
Definition: app-layer-htp.c:503
detect-engine.h
detect-engine-proto.h
SCReferenceConfInit
void SCReferenceConfInit(void)
Definition: util-reference-config.c:56
win32-syscall.h
DetectAddressTests
void DetectAddressTests(void)
DecodeESPRegisterTests
void DecodeESPRegisterTests(void)
Definition: decode-esp.c:195
app-layer-ssh.h
StorageInit
void StorageInit(void)
Definition: util-storage.c:67
MagicRegisterTests
void MagicRegisterTests(void)
Definition: util-magic.c:585
util-hashlist.h
detect-engine-siggroup.h
stream-tcp.h
BloomFilterCountingRegisterTests
void BloomFilterCountingRegisterTests(void)
Definition: util-bloomfilter-counting.c:393
runmode-unittests.h
TmqhSetup
void TmqhSetup(void)
Definition: tm-queuehandlers.c:39
regex_arg
const char * regex_arg
Definition: runmode-unittests.h:28
FlowRegisterTests
void FlowRegisterTests(void)
Function to register the Flow Unitests.
Definition: flow.c:1444
PoolRegisterTests
void PoolRegisterTests(void)
Definition: util-pool.c:720
SigTableSetup
void SigTableSetup(void)
Definition: detect-engine-register.c:444
DecodePPPRegisterTests
void DecodePPPRegisterTests(void)
Definition: decode-ppp.c:316
util-lua.h
IPPairRegisterUnittests
void IPPairRegisterUnittests(void)
Definition: ippair.c:776
ippair-bit.h
DcePayloadRegisterTests
void DcePayloadRegisterTests(void)
Definition: detect-engine-dcepayload.c:3189
util-macset.h
UtListTests
void UtListTests(const char *regex_arg)
List all registered unit tests.
Definition: util-unittest.c:158
util-hash.h
MpmRegisterTests
void MpmRegisterTests(void)
Definition: util-mpm.c:563
TmqhFlowRegisterTests
void TmqhFlowRegisterTests(void)
Definition: tmqh-flow.c:375
UtRunSelftest
int UtRunSelftest(const char *regex_arg)
Run self tests.
Definition: util-unittest.c:327
RegisterAllModules
void RegisterAllModules(void)
Definition: suricata.c:899
flow-bit.h
TmModuleRegisterTests
void TmModuleRegisterTests(void)
register all unittests for the tm modules
Definition: tm-modules.c:165
DecodeNSHRegisterTests
void DecodeNSHRegisterTests(void)
Definition: decode-nsh.c:283
util-bloomfilter-counting.h
SCSigRegisterSignatureOrderingTests
void SCSigRegisterSignatureOrderingTests(void)
Definition: detect-engine-sigorder.c:2152
AppLayerUnittestsRegister
void AppLayerUnittestsRegister(void)
Definition: app-layer.c:2788
GlobalsInitPreConfig
void GlobalsInitPreConfig(void)
Definition: suricata.c:373
MemrchrRegisterTests
void MemrchrRegisterTests(void)
Definition: util-memrchr.c:63
app-layer-ftp.h
detect-engine-payload.h
AppLayerParserRegisterUnittests
void AppLayerParserRegisterUnittests(void)
Definition: app-layer-parser.c:1910
HostBitInitCtx
void HostBitInitCtx(void)
Definition: host-bit.c:49
util-unittest.h
util-unittest-helper.h
SigGroupHeadRegisterTests
void SigGroupHeadRegisterTests(void)
Definition: detect-engine-siggroup.c:1107
PacketPoolInit
void PacketPoolInit(void)
Definition: tmqh-packetpool.c:302
SigRegisterTests
void SigRegisterTests(void)
Definition: detect.c:5172
SigTableRegisterTests
void SigTableRegisterTests(void)
Definition: detect-engine-register.c:680
UtilSpmSearchRegistertests
void UtilSpmSearchRegistertests(void)
Definition: util-spm.c:2675
FlowBitRegisterTests
void FlowBitRegisterTests(void)
Definition: flow-bit.c:402
DecodeMPLSRegisterTests
void DecodeMPLSRegisterTests(void)
Definition: decode-mpls.c:379
util-memcmp.h
detect-engine-enip.h
util-signal.h
DecodeEthernetRegisterTests
void DecodeEthernetRegisterTests(void)
Registers Ethernet unit tests.
Definition: decode-ethernet.c:176
AppLayerSetup
int AppLayerSetup(void)
Setup the app layer.
Definition: app-layer.c:937
app-layer-detect-proto.h
util-cidr.h
app-layer-htp.h
ByteRegisterTests
void ByteRegisterTests(void)
Definition: util-byte.c:1019
SCRadixRegisterTests
void SCRadixRegisterTests(void)
Definition: util-radix-tree.c:3749
DecodeCHDLCRegisterTests
void DecodeCHDLCRegisterTests(void)
Registers Ethernet unit tests.
Definition: decode-chdlc.c:105
DecodeVNTagRegisterTests
void DecodeVNTagRegisterTests(void)
Definition: decode-vntag.c:176
SpmTableSetup
void SpmTableSetup(void)
Definition: util-spm.c:123
UtInitialize
void UtInitialize(void)
Initialize unit test list.
Definition: util-unittest.c:261
UTHRegisterTests
void UTHRegisterTests(void)
Definition: util-unittest-helper.c:1198
SCRuleVarsRegisterTests
void SCRuleVarsRegisterTests(void)
Definition: util-rule-vars.c:520
SCLogRegisterTests
void SCLogRegisterTests()
Definition: util-debug.c:1711
AppLayerHtpEnableRequestBodyCallback
void AppLayerHtpEnableRequestBodyCallback(void)
Sets a flag that informs the HTP app layer that some module in the engine needs the http request body...
Definition: app-layer-htp.c:461
HashTableRegisterTests
void HashTableRegisterTests(void)
Definition: util-hash.c:427
util-reference-config.h
detect-engine-mpm.h
DefragRegisterTests
void DefragRegisterTests(void)
Definition: defrag.c:2469
pkt-var.h
SCHInfoRegisterTests
void SCHInfoRegisterTests(void)
Definition: util-host-os-info.c:1604
util-bloomfilter.h
detect-engine-port.h
util-atomic.h
util-time.h
app-layer-parser.h
detect-engine-tag.h
util-profiling.h
util-rule-vars.h
conf-yaml-loader.h
StreamTcpRegisterTests
void StreamTcpRegisterTests(void)
Definition: stream-tcp.c:4275
DecodeICMPV6RegisterTests
void DecodeICMPV6RegisterTests(void)
Registers ICMPV6 unit tests.
Definition: decode-icmpv6.c:1563
conf.h
util-magic.h
StorageFinalize
int StorageFinalize(void)
Definition: util-storage.c:139
util-radix-tree.h
source-windivert.h
SCAtomicRegisterTests
void SCAtomicRegisterTests(void)
Definition: util-atomic.c:67
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
flow-timeout.h
DecodeTCPRegisterTests
void DecodeTCPRegisterTests(void)
Definition: decode-tcp.c:570
reputation.h
util-action.h
UtRunTests
uint32_t UtRunTests(const char *regex_arg)
Run all registered unittests.
Definition: util-unittest.c:189
util-mpm-ac.h
util-proto-name.h
defrag.h
MpmTableSetup
void MpmTableSetup(void)
Definition: util-mpm.c:215
MacSetRegisterTests
void MacSetRegisterTests(void)
Definition: util-macset.c:437
DEFAULT_PACKET_SIZE
#define DEFAULT_PACKET_SIZE
Definition: decode.h:646
BloomFilterRegisterTests
void BloomFilterRegisterTests(void)
Definition: util-bloomfilter.c:275
util-host-os-info.h
UtilCIDRTests
void UtilCIDRTests(void)
Definition: util-cidr.c:147
HostBitRegisterTests
void HostBitRegisterTests(void)
Definition: host-bit.c:508
default_packet_size
uint32_t default_packet_size
Definition: decode.c:72
DecodeVLANRegisterTests
void DecodeVLANRegisterTests(void)
Definition: decode-vlan.c:268
detect-fast-pattern.h
ConfYamlRegisterTests
void ConfYamlRegisterTests(void)
Definition: conf-yaml-loader.c:1000
flow-manager.h
suricata-common.h
ConfRegisterTests
void ConfRegisterTests(void)
Definition: conf.c:1521
util-streaming-buffer.h
MimeDecRegisterTests
void MimeDecRegisterTests(void)
Definition: util-decode-mime.c:3389
util-spm.h
DecodePPPOERegisterTests
void DecodePPPOERegisterTests(void)
Registers PPPOE unit tests.
Definition: decode-pppoe.c:545
util-classification-config.h
FatalError
#define FatalError(x,...)
Definition: util-debug.h:532
SCClassConfInit
void SCClassConfInit(void)
Definition: util-classification-config.c:64
SCClassConfRegisterTests
void SCClassConfRegisterTests(void)
This function registers unit tests for Classification Config API.
Definition: util-classification-config.c:817
UtCleanup
void UtCleanup(void)
Cleanup unit test list.
Definition: util-unittest.c:270
detect-engine-sigorder.h
AppLayerProtoDetectUnittestsRegister
void AppLayerProtoDetectUnittestsRegister(void)
Register unittests for app layer proto detection module.
Definition: app-layer-detect-proto.c:3787
DecodeVXLANRegisterTests
void DecodeVXLANRegisterTests(void)
Definition: decode-vxlan.c:280
unix-manager.h
SCRConfRegisterTests
void SCRConfRegisterTests(void)
This function registers unit tests for Reference Config API.
Definition: util-reference-config.c:786
HashListTableRegisterTests
void HashListTableRegisterTests(void)
Definition: util-hashlist.c:501
max_pending_packets
int max_pending_packets
Definition: suricata.c:214
SC_ERR_FATAL
@ SC_ERR_FATAL
Definition: util-error.h:203
DecodeGRERegisterTests
void DecodeGRERegisterTests(void)
this function registers unit tests for GRE decoder
Definition: decode-gre.c:391
UtilMiscRegisterTests
void UtilMiscRegisterTests(void)
Definition: util-misc.c:1169
detect-parse.h
DecodeICMPV4RegisterTests
void DecodeICMPV4RegisterTests(void)
Registers ICMPV4 unit test.
Definition: decode-icmpv4.c:827
RunUnittests
void RunUnittests(int list_unittests, const char *regex_arg)
Definition: runmode-unittests.c:218
SCReputationRegisterTests
void SCReputationRegisterTests(void)
Definition: reputation.c:147
SCThresholdConfRegisterTests
void SCThresholdConfRegisterTests(void)
This function registers unit tests for Classification Config API.
Definition: util-threshold-config.c:2714
HostRegisterUnittests
void HostRegisterUnittests(void)
Definition: host.c:736
tmqh-flow.h
DecodeIPV4RegisterTests
void DecodeIPV4RegisterTests(void)
Definition: decode-ipv4.c:1650
util-mpm-hs.h
SCProfilingRegisterTests
void SCProfilingRegisterTests(void)
Definition: util-profiling.c:1450
IPPairBitRegisterTests
void IPPairBitRegisterTests(void)
Definition: ippair-bit.c:492
app-layer-smtp.h
DetectPortTests
void DetectPortTests(void)
UtilActionRegisterTests
void UtilActionRegisterTests(void)
Definition: util-action.c:1594
util-misc.h
PacketPoolDestroy
void PacketPoolDestroy(void)
Definition: tmqh-packetpool.c:335
flow.h
ThreadMacrosRegisterTests
void ThreadMacrosRegisterTests(void)
this function registers unit tests for DetectId
Definition: threads.c:145
MemcmpRegisterTests
void MemcmpRegisterTests(void)
Definition: util-memcmp.c:384
DeStateRegisterTests
void DeStateRegisterTests(void)
Definition: detect-engine-state.c:1413
detect-engine-dcepayload.h
util-pool.h
DecodeGeneveRegisterTests
void DecodeGeneveRegisterTests(void)
Definition: decode-geneve.c:495
flow-var.h
DetectEngineRegisterTests
void DetectEngineRegisterTests()
Definition: detect-engine.c:4861
util-memrchr.h
app-layer-ssl.h
DecodeIPV6RegisterTests
void DecodeIPV6RegisterTests(void)
this function registers unit tests for IPV6 decoder
Definition: decode-ipv6.c:907
detect-engine-address.h
StatsRegisterTests
void StatsRegisterTests(void)
Definition: counters.c:1551
util-threshold-config.h
host-bit.h
app-layer.h
StreamingBufferRegisterTests
void StreamingBufferRegisterTests(void)
Definition: util-streaming-buffer.c:1404
PayloadRegisterTests
void PayloadRegisterTests(void)
Definition: detect-engine-payload.c:1160
MpmHSGlobalCleanup
void MpmHSGlobalCleanup(void)
DecodeRawRegisterTests
void DecodeRawRegisterTests(void)
Registers Raw unit tests.
Definition: decode-raw.c:233
DetectProtoTests
void DetectProtoTests(void)
this function registers unit tests for DetectProto
Definition: detect-engine-proto.c:394