From 9ee568e319c2acfc33ccf8dc7e13a840a23e97b0 Mon Sep 17 00:00:00 2001
From: Martine Lenders <m.lenders@fu-berlin.de>
Date: Tue, 15 Dec 2020 17:14:30 +0100
Subject: [PATCH] dist/tools/doccheck: annotate errors in Github Action

---
 dist/tools/doccheck/check.sh | 70 +++++++++++++++++++++++++++++-------
 1 file changed, 57 insertions(+), 13 deletions(-)

diff --git a/dist/tools/doccheck/check.sh b/dist/tools/doccheck/check.sh
index 4f551c0d29..0ad795b5ca 100755
--- a/dist/tools/doccheck/check.sh
+++ b/dist/tools/doccheck/check.sh
@@ -10,6 +10,10 @@
 
 RIOTBASE="$(cd $(dirname $0)/../../..; pwd)"
 
+. ${RIOTBASE}/dist/tools/ci/github_annotate.sh
+
+github_annotate_setup
+
 if tput colors &> /dev/null && [ $(tput colors) -ge 8 ]; then
     CERROR="\e[1;31m"
     CWARN="\033[1;33m"
@@ -32,8 +36,19 @@ if [ "${DOXY_ERRCODE}" -ne 0 ] ; then
 else
     ERRORS=$(echo "${DOXY_OUTPUT}" | grep '.*warning' | sed "s#${PWD}/\([^:]*\)#\1#g")
     if [ -n "${ERRORS}" ] ; then
-        echo -e "${CERROR}ERROR: Doxygen generates the following warnings:${CRESET}"
-        echo "${ERRORS}"
+        if github_annotate_is_on; then
+            echo "${ERRORS}" | grep "^.\+:[0-9]\+: warning:" | while read error_line
+            do
+                FILENAME=$(echo "${error_line}" | cut -d: -f1)
+                LINENR=$(echo "${error_line}" | cut -d: -f2)
+                DETAILS=$(echo "${error_line}" | cut -d: -f4- |
+                          sed -e 's/^[ \t]*//' -e 's/[ \t]*$//')
+                github_annotate_error "${FILENAME}" "${LINENR}" "${DETAILS}"
+            done
+        else
+            echo -e "${CERROR}ERROR: Doxygen generates the following warnings:${CRESET}"
+            echo "${ERRORS}"
+        fi
         RESULT=2
     fi
 fi
@@ -44,8 +59,8 @@ exclude_filter() {
 
 # Check groups are correctly defined (e.g. no undefined groups and no group
 # defined multiple times)
-ALL_RAW_DEFGROUP=$(git grep @defgroup -- '*.h' '*.c' '*.txt' | exclude_filter)
-ALL_RAW_INGROUP=$(git grep '@ingroup' -- '*.h' '*.c' '*.txt' | exclude_filter)
+ALL_RAW_DEFGROUP=$(git grep -n @defgroup -- '*.h' '*.c' '*.txt' | exclude_filter)
+ALL_RAW_INGROUP=$(git grep -n '@ingroup' -- '*.h' '*.c' '*.txt' | exclude_filter)
 DEFINED_GROUPS=$(echo "${ALL_RAW_DEFGROUP}" | \
                     grep -oE '@defgroup[ ]+[^ ]+' | \
                     grep -oE '[^ ]+$' | \
@@ -65,12 +80,26 @@ if [ -n "${UNDEFINED_GROUPS}" ]
 then
     COUNT=$(echo "${UNDEFINED_GROUPS}" | wc -l)
     echo -ne "\n\n${CERROR}ERROR${CRESET} "
-    echo -e "There are ${CWARN}${COUNT}${CRESET} undefined Doxygen groups:"
+    echo -ne "There are ${CWARN}${COUNT}${CRESET} undefined Doxygen groups"
+    if github_annotate_is_on; then
+        echo ""
+    else
+        echo ":"
+    fi
     for group in ${UNDEFINED_GROUPS};
     do
-        echo -e "\n${CWARN}${group}${CRESET} found in:";
-        echo "${ALL_RAW_INGROUP}" | grep "\<${group}\>$" | sort -u |
-                awk -F: '{ print "\t" $1 }';
+        INGROUPS=$(echo "${ALL_RAW_INGROUP}" | grep "\<${group}\>$" | sort -u)
+        if github_annotate_is_on; then
+            echo "${INGROUPS}" | while read ingroup;
+            do
+                github_annotate_error \
+                    $(echo ${ingroup} | awk -F: '{ print $1,$2 }') \
+                    "Undefined doxygen group '${group}'"
+            done
+        else
+            echo -e "\n${CWARN}${group}${CRESET} found in:";
+            echo "${INGROUPS}" | awk -F: '{ print "\t" $1 }';
+        fi
     done
     RESULT=2
 fi
@@ -82,15 +111,30 @@ if [ -n "${MULTIPLE_DEFINED_GROUPS}" ]
 then
     COUNT=$(echo "${MULTIPLE_DEFINED_GROUPS}" | wc -l)
     echo -ne "\n\n${CERROR}ERROR${CRESET} "
-    echo -e "There are ${CWARN}${COUNT}${CRESET} Doxygen groups defined multiple times:"
+    echo -ne "There are ${CWARN}${COUNT}${CRESET} Doxygen groups defined multiple times"
+    if github_annotate_is_on; then
+        echo ""
+    else
+        echo ":"
+    fi
     for group in ${MULTIPLE_DEFINED_GROUPS};
     do
-        echo -e "\n${CWARN}${group}${CRESET} defined in:";
-        echo "${ALL_RAW_DEFGROUP}" | \
+        DEFGROUPS=$(echo "${ALL_RAW_DEFGROUP}" |
             awk -F@ '{ split($2, end, " "); printf("%s%s\n",$1,end[2]) }' |
-            grep "\<${group}\>$" | sort -u |
-            awk -F: '{ print "\t" $1 }';
+            grep "\<${group}\>$" | sort -u)
+        DEFGROUPFILES=$(echo "${DEFGROUPS}" | awk -F: '{ print "\t" $1 }')
+        if github_annotate_is_on; then
+            echo "${DEFGROUPS}" | while read defgroup;
+            do
+                github_annotate_error $(echo ${defgroup} | awk -F: '{ print $1,$2 }') \
+                    "Multiple doxygen group definitions of '${group}' in\n${DEFGROUPFILES}"
+            done
+        else
+            echo -e "\n${CWARN}${group}${CRESET} defined in:";
+            echo "${DEFGROUPFILES}"
+        fi
     done
     RESULT=2
 fi
+github_annotate_teardown
 exit ${RESULT}