etr / libhttpserver

C++ library for creating an embedded Rest HTTP server (and more)
GNU Lesser General Public License v2.1
884 stars 185 forks source link

Using full path for includes #260

Closed etr closed 2 years ago

etr commented 2 years ago

Identify the Bug

cppcheck introduced a new check that requires paths to be specified in local includes.

Description of the Change

Fixed paths of all includes.

Alternate Designs

Two alternatives: (1) ignore the check and disable it and (2) use the root path in the test Makefile.am thus allowing to pass actual paths (not relative).

(1) is sub-optimal as the check is justified for most of the codebase. (2) would have worked but might have caused more issues of polluting the include path for tests.

Possible Drawbacks

Tests use includes from the root-src and root-test. These are included with a prefix like './'.

This might lead to issues if those files are moved in the codebase. Given this happens only for 'httpserver.hpp' and 'littletest.hpp' the issue seems unlikely.

Verification Process

Test execution in local and through github actions.

Release Notes

Using full path on includes.