[ament_cmake_xmllint] Add file exclude support (#458)

The `ament_cmake_xmllit` respects the `AMENT_LINT_AUTO_FILE_EXCLUDE` variable.

Author: guillaumeautran

ament_cmake_xmllint/cmake/ament_cmake_xmllint_lint_hook.cmake

@@ -15,5 +15,10 @@
 file(GLOB_RECURSE _source_files FOLLOW_SYMLINKS "*.xml")
 if(_source_files)
   message(STATUS "Added test 'xmllint' to check XML markup files")
-  ament_xmllint()
+
+  if(DEFINED AMENT_LINT_AUTO_FILE_EXCLUDE)
+    ament_xmllint(EXCLUDE ${AMENT_LINT_AUTO_FILE_EXCLUDE})
+  else()
+    ament_xmllint()
+  endif()
 endif()

ament_cmake_xmllint/cmake/ament_xmllint.cmake

@@ -17,13 +17,15 @@
 #
 # :param TESTNAME: the name of the test, default: "xmllint"
 # :type TESTNAME: string
+# :param EXCLUDE: an optional list of exclude files or directories for xmllint check
+# :type EXCLUDE: list
 # :param ARGN: the files or directories to check
 # :type ARGN: list of strings
 #
 # @public
 #
 function(ament_xmllint)
-  cmake_parse_arguments(ARG "" "MAX_LINE_LENGTH;TESTNAME" "" ${ARGN})
+  cmake_parse_arguments(ARG "" "MAX_LINE_LENGTH;TESTNAME" "EXCLUDE" ${ARGN})
   if(NOT ARG_TESTNAME)
     set(ARG_TESTNAME "xmllint")
   endif()
@@ -35,6 +37,9 @@ function(ament_xmllint)
 
   set(result_file "${AMENT_TEST_RESULTS_DIR}/${PROJECT_NAME}/${ARG_TESTNAME}.xunit.xml")
   set(cmd "${ament_xmllint_BIN}" "--xunit-file" "${result_file}")
+  if(ARG_EXCLUDE)
+    list(APPEND cmd "--exclude" "${ARG_EXCLUDE}")
+  endif()
   list(APPEND cmd ${ARG_UNPARSED_ARGUMENTS})
 
   find_program(xmllint_BIN NAMES "xmllint")

ament_xmllint/ament_xmllint/main.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 import argparse
+import glob
 import os
 import shutil
 import subprocess
@@ -46,6 +47,7 @@ def main(argv=sys.argv[1:]):
         '--exclude',
         nargs='*',
         default=[],
+        dest='excludes',
         help='Exclude specific file names and directory names from the check')
     # not using a file handle directly
     # in order to prevent leaving an empty file when something fails early
@@ -62,7 +64,7 @@ def main(argv=sys.argv[1:]):
     if args.xunit_file:
         start_time = time.time()
 
-    files = get_files(args.paths, args.extensions, args.exclude)
+    files = get_files(args.paths, args.extensions, args.excludes)
     if not files:
         print('No files found', file=sys.stderr)
         return 1
@@ -158,7 +160,12 @@ def main(argv=sys.argv[1:]):
     return rc
 
 
-def get_files(paths, extensions, excludes=[]):
+def get_files(paths, extensions, exclude_patterns):
+    excludes = []
+    for exclude_pattern in exclude_patterns:
+        excludes.extend(glob.glob(exclude_pattern))
+    excludes = {os.path.realpath(x) for x in excludes}
+
     files = []
     for path in paths:
         if os.path.isdir(path):
@@ -169,12 +176,12 @@ def get_files(paths, extensions, excludes=[]):
                 # ignore folder starting with . or _
                 dirnames[:] = [d for d in dirnames if d[0] not in ['.', '_']]
                 # ignore excluded folders
-                dirnames[:] = [d for d in dirnames if d not in excludes]
+                dirnames[:] = [d for d in dirnames if os.path.realpath(d) not in excludes]
                 dirnames.sort()
 
                 # select files by extension
                 for filename in sorted(filenames):
-                    if filename in excludes:
+                    if os.path.realpath(os.path.join(dirpath, filename)) in excludes:
                         continue
                     _, ext = os.path.splitext(filename)
                     if ext not in ['.%s' % e for e in extensions]: