Improves test_edgesec.c

[aloisklink]

Improves test_edgesec.c by making the following changes:

• test(edgesec): use threads.h in test_edgesec

  Use #include <threads.h> (aka ISO C11 standard threads) instead of #include <pthreads.h> in test_edgesec.c
  Using C11 standard threads caught a double-free error, so it's already
  better!

• test(edgesec): stop eloop threads gracefully
  Currently, the eloop threads are never actually stopped. We call edge_eloop_terminate(), but this is not thread-safe.

  To fix this, we can use a threadsafe atomic from <stdatomic.h>, which is constantly checked by eloop, which then automatically closes the eloop when the atomic is set.

  This also allows us to call thrd_join() on the threads and check their return code.

  Basically, before this PR, calling edge_eloop_terminate() from the main test thread did nothing.

• test(edgesec): store error msg from ap thread

  Currently, in test_edgesec, if the AP thread has an error, fail_msg() is called, which normally fails the CMocka test with the given error message. However, CMocka is not thread safe.

  Instead, we can make the AP Thread store the error message in a buffer, and call thrd_exit(EXIT_FAILURE) to exit the thread with an error exit code.

  We can then check for this thread exitcode later on, when we call thrd_join(), e.g. in teardown_edgesec_test().

• test(edgesec): test ap server thread failures

  Add a test that tests whether the AP server thread fails correctly.

  Previously, our test code wasn't correctly failing on errors.

  This should also help fix flakey code-coverage results in test_edgesec.c, see tests/test_edgesec.c code-coverage is inconsistent #435.

  This test is pretty slow, as we need to wait 10 seconds for writeread_domain_data_str() to timeout. In the future, we should find a way to speed up this test (maybe by using a different function to send data to the AP server socket).

---

@mereacre, if you've got any idea how we can easily replace this line, without having to wait 10 seconds for a timeout, let me know!

edgesec/tests/test_edgesec.c

Lines 376 to 381 in 43f5b52

	// confirm that sending an invalid command results in an timeout error, since
	// we don't get a reply
	// TODO: we need to wait for 10 seconds until we get a timeout.
	// Can we somehow make this timeout faster, or use a different function?:
	assert_int_equal(
	writeread_domain_data_str(socket_path, "INVALID COMMAND", &reply), -1);

Edit: Fixed in d6c0a99

[codecov]

Codecov Report

Merging #453 (79710b9) into main (57cea87) will increase coverage by 0.16%.
The diff coverage is 97.08%.

@@            Coverage Diff             @@
##             main     #453      +/-   ##
==========================================
+ Coverage   53.08%   53.24%   +0.16%     
==========================================
  Files         144      144              
  Lines       19871    19937      +66     
==========================================
+ Hits        10548    10616      +68     
+ Misses       9323     9321       -2     

Impacted Files	Coverage Δ
tests/test_edgesec.c	96.75% <97.08%> (+1.79%)	⬆️
src/utils/sockctl.c	66.66% <0.00%> (+0.80%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[mereacre]

Great work. Indeed we will have to replace the timeouts eventually.

[aloisklink]

Great work. Indeed we will have to replace the timeouts eventually.

Yah, even 1 second is quite a lot when I'm running the tests 1000s of times when git rebase-ing :)

Plus, think about all of the CO2 we'd save by using less of Microsoft's/GitHub's server time 🤣 !!