dist/tools/headerguards: use regex to check include guard name

[crasbe]

Contribution description

The headerguard check tried to find if classic header guards were used by matching the beginning of the line with #ifndef $(filename_with_underscores). So for drivers/abp2/include/abp2_params.h it would try to find #ifndef ABP2_PARAMS_H*.

The issue arises when you have a parameter that has a word starting with H, for example #ifndef ABP2_PARAMS_HWTIMER, creating a false positive.

Instead of matching the line start, I changed it to a RegEx to match either #ifndef ABP2_PARAMS_H or #ifndef ABP2_PARAMS_H_, but nothing else.

Testing procedure

Test for Bug Fixed

Add #ifndef ABP2_PARAMS_HWTIMER to drivers/abp2/include/abp2_params.h and it should not still complain.

Behavior on master, it complains:

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..84ea69d97b 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -20,6 +20,10 @@
 #include "saul_reg.h"
 #include "abp2.h"

+#ifndef ABP2_PARAMS_HWTIMER
+#  define ABP2_PARAMS_HWTIMER
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ ./dist/tools/headerguards/check.sh
drivers/abp2/include/abp2_params.h: #pragma once and classic header guards used in the same file

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ echo $?
1

Behavior with this PR, it does not complain:

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..84ea69d97b 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -20,6 +20,10 @@
 #include "saul_reg.h"
 #include "abp2.h"

+#ifndef ABP2_PARAMS_HWTIMER
+#  define ABP2_PARAMS_HWTIMER
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ ./dist/tools/headerguards/check.sh

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ echo $?
0

Test for Regression

1. Add #ifndef ABP2_PARAMS_H to drivers/abp2/include/abp2_params.h and it should still complain:

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..9e32af8eee 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -20,6 +20,10 @@
 #include "saul_reg.h"
 #include "abp2.h"

+#ifndef ABP2_PARAMS_H
+#  define ABP2_PARAMS_H
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ ./dist/tools/headerguards/check.sh
drivers/abp2/include/abp2_params.h: #pragma once and classic header guards used in the same file

2. Add #ifndef ABP2_PARAMS_H_ to drivers/abp2/include/abp2_params.h and it should still complain:

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..694ab39b57 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -20,6 +20,10 @@
 #include "saul_reg.h"
 #include "abp2.h"

+#ifndef ABP2_PARAMS_H_
+#  define ABP2_PARAMS_H_
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif

cbuec@W11nMate:~/RIOTstuff/riot-vanillaice/RIOT$ ./dist/tools/headerguards/check.sh
drivers/abp2/include/abp2_params.h: #pragma once and classic header guards used in the same file

Issues/PRs references

Found in #19848.

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

• none

[riot-ci]

Murdock results

✔️ PASSED

3ccd898 dist/tools/headerguards: use regex to check include guard name

Success	Failures	Total	Runtime
1	0	1	01m:17s

Artifacts

• Documentation preview

[Enoch247]

I trust the test cases you already checked, and did not re-run them. I did run a few of my own though:

This should pass, and does:

josh@dragonkite:fix_headerguard_check$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..652eed3fd4 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -3,7 +3,8 @@
  * SPDX-License-Identifier: LGPL-2.1-only
  */
 
-#pragma once
+#ifndef ABP2_PARAMS_H
+#define ABP2_PARAMS_H
 
 /**
  * @ingroup     drivers_abp2
@@ -112,3 +113,5 @@ static const saul_reg_info_t abp2_saul_info[][2] =
 #endif
 
 /** @} */
+
+#endif /* ABP2_PARAMS_H */
josh@dragonkite:fix_headerguard_check$ ./dist/tools/headerguards/check.sh
josh@dragonkite:fix_headerguard_check$

This should fail, and does:

josh@dragonkite:fix_headerguard_check$ git diff
diff --git a/drivers/abp2/include/abp2_params.h b/drivers/abp2/include/abp2_params.h
index b5def22f3b..252b86809d 100644
--- a/drivers/abp2/include/abp2_params.h
+++ b/drivers/abp2/include/abp2_params.h
@@ -5,6 +5,9 @@
 
 #pragma once
 
+#ifndef ABP2_PARAMS_H
+#define ABP2_PARAMS_H
+
 /**
  * @ingroup     drivers_abp2
  * @{
@@ -112,3 +115,5 @@ static const saul_reg_info_t abp2_saul_info[][2] =
 #endif
 
 /** @} */
+
+#endif /* ABP2_PARAMS_H */
josh@dragonkite:fix_headerguard_check$ ./dist/tools/headerguards/check.sh
drivers/abp2/include/abp2_params.h: #pragma once and classic header guards used in the same file

[Enoch247]

I should learn to read more carefully. You already provided tests for regression.