Adds negative tests and an exit function handler

Author: Alomir

events.c

@@ -135,16 +135,15 @@ EventNode** readEventData(char *eventFile, int numLocs) {
     printf("Error: unknown event type %s\n", eventTypeStr);
     exit(1);
   }
-  printf("Found event type %d (%s)\n", eventType, eventTypeStr);
 
   next = createEventNode(loc, year, day, eventType, eventParamsStr);
   events[loc] = next;
   currLoc = loc;
   currYear = year;
   currDay = day;
 
-  printf("Found events:\n");
-  printEvent(next);
+  //printf("Found events:\n");
+  //printEvent(next);
 
   while (fgets(line, EVENT_LINE_SIZE, in) != NULL) {
     // We have another event
@@ -172,7 +171,7 @@ EventNode** readEventData(char *eventFile, int numLocs) {
     }
 
     next = createEventNode(loc, year, day, eventType, eventParamsStr);
-    printEvent(next);
+    //printEvent(next);
     if (currLoc == loc) {
       // Same location, add the new event to this location's list
       curr->nextEvent = next;

tests/sipnet/exitHandler.c

@@ -0,0 +1,47 @@
+#include <setjmp.h>
+#include <unistd.h>
+
+static int expected_code = 1;  // the expected value a tested function passes to exit
+static int should_exit = 1;    // 1 if exit should have been called
+static int really_exit = 0;           // set to 1 to prevent stubbing behavior and actually exit
+
+static jmp_buf jump_env;
+
+static int exit_result = 1;
+#define test_assert(x) (exit_result = exit_result && (x))
+
+// set should_exit=0 when code SHOULDN'T exit(), e.g.:
+//
+// should_exit = 0;
+// if (!(jmp_rval=setjmp(jump_env)))
+// {
+//   call_to_non_exiting_code();
+// }
+// test_assert(jmp_rval==0);
+//
+// set should_exit=1 when exit(0 is expected:
+//
+// should_exit = 1;
+// expected_code = 1; // or whatever the exit code should be
+// if (!(jmp_rval=setjmp(jump_env)))
+// {
+//   call_to_exiting_code();
+// }
+//
+// test_assert(jmp_rval==1);
+
+// stub function
+void exit(int code)
+{
+  if (!really_exit)
+  {
+    printf("Mocking the exit call\n");
+    test_assert(should_exit==1);
+    test_assert(expected_code==code);
+    longjmp(jump_env, 1);
+  }
+  else
+  {
+    _exit(code);
+  }
+}

tests/sipnet/test_events/Makefile

@@ -5,7 +5,9 @@ LDFLAGS=-L../../..
 LDLIBS=-lsipnet -lm
 
 # List test files in this directory here
-TEST_CFILES=testEventInfra.c
+TEST_CFILES=testEventInfra.c testEventInfraNeg.c
+
+# The rest is boilerplate, likely copyable as is to a new test directory
 TEST_OBJ_FILES=$(TEST_CFILES:%.c=%.o)
 TEST_EXECUTABLES:=$(basename $(TEST_CFILES))
 RUN_EXECUTABLES:= $(addsuffix .run, $(TEST_EXECUTABLES))
@@ -17,7 +19,7 @@ tests: $(TEST_EXECUTABLES)
 $(TEST_EXECUTABLES): %: %.o
 	$(CC) $(LDFLAGS) $< $(LDLIBS) -o $@
 
-$(TEST_OBJ_FILES): ../utils.h ../../../libsipnet.a
+$(TEST_OBJ_FILES): ../utils.h ../../../libsipnet.a ../exitHandler.c
 $(TEST_OBJ_FILES): %.o: %.c
 	$(CC) $(CFLAGS) -c -o $@ $<
 

tests/sipnet/test_events/infra_events_date_ooo.in

@@ -0,0 +1,2 @@
+0  2024  60  till   0.1 0.2 0.3
+0  2024  55  plant  15 20 5

tests/sipnet/test_events/infra_events_loc_ooo.in

@@ -0,0 +1,3 @@
+0  2024  60  till   0.1 0.2 0.3
+1  2024  65  plant  15 20 5
+0  2024  70  irrig  5 1

tests/sipnet/test_events/infra_events_multi.in

@@ -0,0 +1,15 @@
+0  2024  60  till   0.1 0.2 0.3
+0  2024  65  plant  15 20 5
+0  2024  70  irrig  5 1
+0  2024  75  fert   15 10 5
+0  2024  250 harv   0.1 0.2 0.3 0.4
+1  2024  59  till   0.2 0.3 0.1
+1  2024  64  plant  15 20 5
+1  2024  69  irrig  5 0
+1  2024  74  fert   5 15 10
+1  2024  249 harv   0.2 0.3 0.4 0.1
+2  2024  58  till   0.3 0.1 0.2
+2  2024  63  plant  15 20 5
+2  2024  68  irrig  6 1
+2  2024  73  fert   5 10 15
+2  2024  248 harv   0.3 0.4 0.1 0.2

tests/sipnet/test_events/infra_events.in renamed to tests/sipnet/test_events/infra_events_simple.in

@@ -1,4 +1,4 @@
-0  2022  40 irrig   5   0           # 5cm canopy irrigation on day 40
+0  2022  40  irrig  5   0           # 5cm canopy irrigation on day 40
 0  2022  40  fert   15 5 10         # fertilized with 15 g/m2 organic N, 5 g/m2 organic C, and 10 g/m2 mineral N on day 40
 0  2022  45  till   0.1 0.2 0.3     # tilled on day 45, 10% of surface litter transferred to soil pool, soil organic matter pool decomposition rate increases by 20% and soil litter pool decomposition rate increases by 30%
 0  2022  46  plant  10 10 1         # planting - planting occurs on day 40, after 10 days the plants have emerged with a size of 10 g C/m2 and 1 g N / m2

tests/sipnet/test_events/infra_events_unknown.in

@@ -0,0 +1 @@
+0  2022  40  blarg  5   0

tests/sipnet/test_events/testEventInfra.c

@@ -1,7 +1,6 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <unistd.h>
 
 #include "../utils.h"
 #include "../../../events.c"
@@ -82,7 +81,7 @@ int checkTillageParams(
 }
 
 int init() {
-  // char * filename = "infra_events.in";
+  // char * filename = "infra_events_simple.in";
   // if (access(filename, F_OK) == -1) {
   //   return 1;
   // }
@@ -91,9 +90,10 @@ int init() {
   return 0;
 }
 
-int run() {
+int runTestSimple() {
+  // Simple test with one loc, one event per type
   int numLocs = 1;
-  EventNode** output = readEventData("infra_events.in", numLocs);
+  EventNode** output = readEventData("infra_events_simple.in", numLocs);
 
   if (!output) {
     return 1;
@@ -117,6 +117,84 @@ int run() {
   status |= checkEvent(event, 0, 2022, 250, HARVEST);
   status |= checkHarvestParams((HarvestParams*)event->eventParams, 0.4, 0.1, 0.2, 0.3);
 
+  return status;
+}
+
+int runTestMulti() {
+  // More complex test; multiple locations
+  int numLocs = 1;
+  EventNode** output = readEventData("infra_events_multi.in", numLocs);
+
+  if (!output) {
+    return 1;
+  }
+
+  // check output is correct
+  int status = 0;
+  int loc = 0;
+  EventNode *event = output[loc];
+  status |= checkEvent(event, loc, 2024, 60, TILLAGE);
+  status |= checkTillageParams((TillageParams*)event->eventParams, 0.1, 0.2, 0.3);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 65, PLANTING);
+  status |= checkPlantingParams((PlantingParams*)event->eventParams, 15, 20, 5);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 70, IRRIGATION);
+  status |= checkIrrigationParams((IrrigationParams*)event->eventParams, 5, 1);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 75, FERTILIZATION);
+  status |= checkFertilizationParams((FertilizationParams*)event->eventParams, 15, 10,5);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 250, HARVEST);
+  status |= checkHarvestParams((HarvestParams*)event->eventParams, 0.1, 0.2, 0.3, 0.4);
+
+  loc++;
+  event = output[loc];
+  status |= checkEvent(event, loc, 2024, 59, TILLAGE);
+  status |= checkTillageParams((TillageParams*)event->eventParams, 0.2, 0.3, 0.1);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 64, PLANTING);
+  status |= checkPlantingParams((PlantingParams*)event->eventParams, 15, 20, 5);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 69, IRRIGATION);
+  status |= checkIrrigationParams((IrrigationParams*)event->eventParams, 5, 0);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 74, FERTILIZATION);
+  status |= checkFertilizationParams((FertilizationParams*)event->eventParams, 5, 15,10);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 249, HARVEST);
+  status |= checkHarvestParams((HarvestParams*)event->eventParams, 0.2, 0.3, 0.4, 0.1);
+
+  loc++;
+  event = output[loc];
+  status |= checkEvent(event, loc, 2024, 58, TILLAGE);
+  status |= checkTillageParams((TillageParams*)event->eventParams, 0.3, 0.1, 0.2);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 63, PLANTING);
+  status |= checkPlantingParams((PlantingParams*)event->eventParams, 15, 20, 5);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 68, IRRIGATION);
+  status |= checkIrrigationParams((IrrigationParams*)event->eventParams, 6, 1);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 73, FERTILIZATION);
+  status |= checkFertilizationParams((FertilizationParams*)event->eventParams, 5, 10,15);
+  event = event->nextEvent;
+  status |= checkEvent(event, loc, 2024, 248, HARVEST);
+  status |= checkHarvestParams((HarvestParams*)event->eventParams, 0.3, 0.4, 0.1, 0.2);
+
+  return status;
+}
+
+int run() {
+
+  int status;
+
+  status = runTestSimple();
+  if (status) {
+    return 1;
+  }
+
+  status = runTestMulti();
   if (status) {
     return 1;
   }

tests/sipnet/test_events/testEventInfraNeg.c

@@ -0,0 +1,68 @@
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "../../../events.c"
+#include "../exitHandler.c"
+
+int run() {
+  int status = 0;
+
+  // exit() handling params
+  int jmp_rval;
+  expected_code = 1;
+  exit_result = 1;
+
+  // Step 0: make sure that we don't have a false positive on good data
+  should_exit = 0;
+  jmp_rval = setjmp(jump_env);
+  if (!jmp_rval) {
+    readEventData("infra_events_simple.in", 1);
+  }
+  test_assert(jmp_rval==0);
+  status |= !exit_result;
+
+  // First test
+  should_exit = 1;
+  jmp_rval = setjmp(jump_env);
+  if (!jmp_rval) {
+    readEventData("infra_events_unknown.in", 1);
+  }
+  printf("status %d exit_res %d jmp_rval %d\n", status, exit_result, jmp_rval);
+  test_assert(jmp_rval==1);
+  status |= !exit_result;
+
+  // Second test
+  jmp_rval = setjmp(jump_env);
+  if (!jmp_rval) {
+    readEventData("infra_events_loc_ooo.in", 1);
+  }
+  test_assert(jmp_rval==1);
+  status |= !exit_result;
+
+  // Third test
+  jmp_rval = setjmp(jump_env);
+  if (!jmp_rval) {
+    readEventData("infra_events_date_ooo.in", 1);
+  }
+  test_assert(jmp_rval==1);
+  status |= !exit_result;
+
+  // Allow a real exit, not that this is really needed
+  really_exit = 1;
+
+  return status;
+}
+
+int main() {
+  int status;
+
+  printf("Starting testEventInfraNeg:run()\n");
+  status = run();
+  if (status) {
+    printf("Test run failed with status %d\n", status);
+    exit(status);
+  }
+
+  printf("testEventInfra PASSED\n");
+}