Project

General

Profile

Actions

Task #2975

open

convert unittests to new FAIL/PASS API

Added by Victor Julien about 5 years ago. Updated about 2 months ago.

Status:
Assigned
Priority:
Normal
Target version:
Effort:
Difficulty:
Label:

Description

Convert existing tests to use the FAIL/PASS API. The idea is that every step in a test is checked and that the test should not leak memory on its success path.

There are many tests, some of which have lots of duplication. Consider per test whether the test can be improved (cleaned up) further.
This is not something meant to be done in one step. A commit per source file is ok. PRs can include multiple commits.

More explanations and context:

Initially, a lot of tests were written just like any other method: there were multiple conditionals for failure (return 0) and one pass condition (return 1), e.g.:

/**
 * \test MarkTestParse01 is a test for a valid mark value
 *
 *  \retval 1 on succces
 *  \retval 0 on failure
 */
static int MarkTestParse01 (void)
{
    DetectMarkData *data;

    data = DetectMarkParse("1/1");

    if (data == NULL) {
        return 0;
    }

    DetectMarkDataFree(NULL, data);
    return 1;
}

While there was nothing wrong with this approach, we found it would be much cleaner if we used conditional macros that clearly say whether the test "fails" or "passes" on a certain condition. So, we introduced a lot of well-defined macros (see https://github.com/OISF/suricata/blob/master/src/util-unittest.h) to make the tests more legible and clear.

There are macros for almost all failing conditionals e.g., fail if something is null (FAIL_IF_NULL), fail if something
exists (>0) (FAIL_IF), etc. There are also macros PASS and PASS_IF which mean all the conditionals were met properly and the test has passed.

Your job as a part of this task is to remove the old style of tests, i.e. returning values on failure/passing
conditionals, and use this FAIL/PASS API instead. One good example could be
https://github.com/OISF/suricata/commit/3cf8b4629f2cf523c3f82604d93b8fd4a0888109:

There, all the conditionals were converted to the FAIL/PASS API in a manner that there is NO memory leak on the success path (PASS). It is OK to have memleaks on failure paths.


Subtasks 74 (29 open45 closed)

Task #4019: Convert unittests to new FAIL/PASS API - detect-detection-filter.cClosedHaleema KhanActions
Task #4020: Convert unittests to new FAIL/PASS API - detect-distance.cClosedHaleema KhanActions
Task #4021: Convert unittests to new FAIL/PASS API - detect-dsize.cClosedJuliana Fajardini ReichowActions
Task #4022: Convert unittests to new FAIL/PASS API - detect-engine-address-ipv4.cNewCommunity TicketActions
Task #4023: Convert unittests to new FAIL/PASS API: detect-engine-address-ipv6.cNewCommunity TicketActions
Task #4024: Convert unittests to new FAIL/PASS API: detect-engine.cClosedSam MohammadActions
Task #4025: Convert unittests to new FAIL/PASS API: detect-engine-event.cClosedSam MohammadActions
Task #4026: Convert unittests to new FAIL/PASS API: detect-engine-payload.cClosedSam MohammadActions
Task #4027: Convert unittests to new FAIL/PASS API: detect-engine-proto.cClosedSam MohammadActions
Task #4028: Convert unittests to new FAIL/PASS API: detect-engine-siggroup.cClosedSam MohammadActions
Task #4029: Convert unittests to new FAIL/PASS API: detect-engine-sigorder.cClosedHaleema KhanActions
Task #4030: Convert unittests to new FAIL/PASS API: detect-engine-tag.cClosedBazzan DonActions
Task #4031: Convert unittests to new FAIL/PASS API: detect-fast-pattern.cClosedVictor JulienActions
Task #4032: Convert unittests to new FAIL/PASS API: detect-file-data.cClosedVictor JulienActions
Task #4033: Convert unittests to new FAIL/PASS API: detect-fileext.cClosedHaleema KhanActions
Task #4034: Convert unittests to new FAIL/PASS API: detect-filemagic.cClosedAlice da Silva AkakiActions
Task #4035: Convert unittests to new FAIL/PASS API: detect-filemd5.cClosedAlice da Silva AkakiActions
Task #4036: Convert unittests to new FAIL/PASS API: detect-filename.cClosedAlice da Silva AkakiActions
Task #4037: Convert unittests to new FAIL/PASS API: detect-filesha1.cClosedSumera PriyadarsiniActions
Task #4038: Convert unittests to new FAIL/PASS API: detect-filesha256.cClosedAlice da Silva AkakiActions
Task #4039: Convert unittests to new FAIL/PASS API: detect-filesize.cClosedHaleema KhanActions
Task #4040: Convert unittests to new FAIL/PASS API: detect-fragoffset.cClosedModupe FalodunActions
Task #4041: Convert unittests to new FAIL/PASS API: detect-gid.cClosedModupe FalodunActions
Task #4042: Convert unittests to new FAIL/PASS API: detect-icmp-id.cClosedAlice da Silva AkakiActions
Task #4043: Convert unittests to new FAIL/PASS API: detect-icmp-seq.cClosedAlice da Silva AkakiActions
Task #4044: Convert unittests to new FAIL/PASS API: detect-icmp-seq.cRejectedCommunity TicketActions
Task #4045: Convert unittests to new FAIL/PASS API: detect-icode.cClosedModupe FalodunActions
Task #4046: Convert unittests to new FAIL/PASS API: detect-id.cClosedModupe FalodunActions
Task #4047: Convert unittests to new FAIL/PASS API: detect-ipopts.cClosedModupe FalodunActions
Task #4048: Convert unittests to new FAIL/PASS API: detect-iprep.cClosedJuliana Fajardini ReichowActions
Task #4049: Convert unittests to new FAIL/PASS API: detect-itype.cClosedHaleema KhanActions
Task #4050: Convert unittests to new FAIL/PASS API: detect-l3proto.cClosedHaleema KhanActions
Task #4051: Convert unittests to new FAIL/PASS API: detect-lua.cClosedGabriel Lima LuzActions
Task #4052: Convert unittests to new FAIL/PASS API: detect-mark.cClosedJanani RamjeeActions
Task #4053: Convert unittests to new FAIL/PASS API: detect-msg.cClosedJuliana Fajardini ReichowActions
Task #4054: Convert unittests to new FAIL/PASS API: detect-replace.cClosedGabriel Lima LuzActions
Task #4055: Convert unittests to new FAIL/PASS API: detect-rfb-secresult.cClosedModupe FalodunActions
Task #4056: Convert unittests to new FAIL/PASS API: detect-rpc.cClosedJuliana Fajardini ReichowActions
Task #4057: Convert unittests to new FAIL/PASS API: detect-sameip.cClosedModupe FalodunActions
Task #4058: Convert unittests to new FAIL/PASS API: detect-sid.cClosedJuliana Fajardini ReichowActions
Task #6107: Convert unittests to new FAIL/PASS API - util-memcmp.cClosedComfort AmaechiActions
Task #6314: Convert unittests to new FAIL/PASS API - tests/detect-http-client-body.cNewCommunity TicketActions
Task #6315: Convert unittests to new FAIL/PASS API - ippair-storage.cNewCommunity TicketActions
Task #6316: Convert unittests to new FAIL/PASS API - app-layer-detect-proto.cNewCommunity TicketActions
Task #6317: Convert unittests to new FAIL/PASS API - detect-filestore.cNewCommunity TicketActions
Task #6318: Convert unittests to new FAIL/PASS API - detect-engine-address-ipv4.cNewCommunity TicketActions
Task #6319: Convert unittests to new FAIL/PASS API - util-bloomfilter.cNewCommunity TicketActions
Task #6320: Convert unittests to new FAIL/PASS API - detect-base64-data.cNewCommunity TicketActions
Task #6321: Convert unittests to new FAIL/PASS API - decode-raw.cNewCommunity TicketActions
Task #6322: Convert unittests to new FAIL/PASS API - util-pool.cNewCommunity TicketActions
Task #6323: Convert unittests to new FAIL/PASS API - ippair-bit.cNewCommunity TicketActions
Task #6324: Convert unittests to new FAIL/PASS API - stream-tcp-reassemble.cNewCommunity TicketActions
Task #6325: Convert unittests to new FAIL/PASS API - detect-urilen.cNewCommunity TicketActions
Task #6326: Convert unittests to new FAIL/PASS API - detect-ssh-software-version.cNewCommunity TicketActions
Task #6327: Convert unittests to new FAIL/PASS API - threads.cNewCommunity TicketActions
Task #6328: Convert unittests to new FAIL/PASS API - detect-bytejump.cClosedDaniel OlatunjiActions
Task #6329: Convert unittests to new FAIL/PASS API - flow-bit.cClosedHadiqa Alamdar BukhariActions
Task #6330: Convert unittests to new FAIL/PASS API - tests/stream-tcp-list.cIn ProgressCommunity TicketActions
Task #6331: Convert unittests to new FAIL/PASS API - util-bloomfilter-counting.cNewCommunity TicketActions
Task #6332: Convert unittests to new FAIL/PASS API - detect-bytetest.cClosedDaniel OlatunjiActions
Task #6333: Convert unittests to new FAIL/PASS API - util-rule-vars.cNewCommunity TicketActions
Task #6334: Convert unittests to new FAIL/PASS API - util-spm.cNewCommunity TicketActions
Task #6335: Convert unittests to new FAIL/PASS API - decode-tcp.cNewCommunity TicketActions
Task #6336: Convert unittests to new FAIL/PASS API - tests/detect-http-stat-code.cNewCommunity TicketActions
Task #6337: Convert unittests to new FAIL/PASS API - detect-ssh-proto-version.cClosedBruno FrancaActions
Task #6338: Convert unittests to new FAIL/PASS API - tests/detect-http-stat-msg.cNewCommunity TicketActions
Task #6339: Convert unittests to new FAIL/PASS API - detect-tcp-window.cClosedHadiqa Alamdar BukhariActions
Task #6340: Convert unittests to new FAIL/PASS API - tests/detect-http-method.cNewCommunity TicketActions
Task #6341: Convert unittests to new FAIL/PASS API - decode-ethernet.cNewCommunity TicketActions
Task #6343: Convert unittests to new FAIL/PASS API - tests/stream-tcp.cNewCommunity TicketActions
Task #6344: Convert unittests to new FAIL/PASS API - detect-pcre.cNewCommunity TicketActions
Task #6345: Convert unittests to new FAIL/PASS API - util-misc.cClosedHadiqa Alamdar BukhariActions
Task #6346: Convert unittests to new FAIL/PASS API - detect-engine-dcepayload.cNewCommunity TicketActions
Task #6935: Convert unittests to new FAIL/PASS API - src/app-layer-htp.cNewCommunity TicketActions

Related issues 1 (1 open0 closed)

Related to Suricata - Feature #1025: seperate #ifdef UNITTEST code into their own filesNewOISF DevActions
Actions #1

Updated by Victor Julien over 4 years ago

  • Related to Feature #1025: seperate #ifdef UNITTEST code into their own files added
Actions #2

Updated by Victor Julien over 3 years ago

  • Assignee changed from Shivani Bhardwaj to Community Ticket
Actions #3

Updated by Juliana Fajardini Reichow over 2 years ago

  • Description updated (diff)
Actions #4

Updated by Juliana Fajardini Reichow over 2 years ago

  • Description updated (diff)

updated description with a code snippet, as the example code has been updated to the new API and therefore the suggested example didn't work

Actions #5

Updated by lipeng hao about 1 year ago

I can pick it up,please assign this tick to me,thks

Actions #6

Updated by Andreas Herz about 1 year ago

  • Assignee changed from Community Ticket to lipeng hao
Actions #7

Updated by Andreas Herz about 1 year ago

  • Assignee changed from lipeng hao to Community Ticket
Actions #8

Updated by Andreas Herz about 1 year ago

lipeng hao wrote in #note-5:

I can pick it up,please assign this tick to me,thks

this is the meta ticket, but feel free to work on the remaining subtickets, one is already assigned to you.

Actions #9

Updated by Juliana Fajardini Reichow 12 months ago

  • Subtask #6107 added
Actions #10

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6314 added
Actions #11

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6315 added
Actions #12

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6316 added
Actions #13

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6317 added
Actions #14

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6318 added
Actions #15

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6319 added
Actions #16

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6320 added
Actions #17

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6321 added
Actions #18

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6322 added
Actions #19

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6323 added
Actions #20

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6324 added
Actions #21

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6325 added
Actions #22

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6326 added
Actions #23

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6327 added
Actions #24

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6328 added
Actions #25

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6329 added
Actions #26

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6330 added
Actions #27

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6331 added
Actions #28

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6332 added
Actions #29

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6333 added
Actions #30

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6334 added
Actions #31

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6335 added
Actions #32

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6336 added
Actions #33

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6337 added
Actions #34

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6338 added
Actions #35

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6339 added
Actions #36

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6340 added
Actions #37

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6341 added
Actions #38

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6343 added
Actions #39

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6344 added
Actions #40

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6345 added
Actions #41

Updated by Juliana Fajardini Reichow 9 months ago

  • Subtask #6346 added
Actions #42

Updated by Juliana Fajardini Reichow about 2 months ago

  • Subtask #6935 added
Actions

Also available in: Atom PDF