[ament_cmake_lint_cmake] Add file exclude support (#458)

In the `ament_lint_cmake` CMake function, the optional list
argument `EXCLUDE` can now be used as an exclusion specifier.
The `ament_cmake_lint_cmake` respects the
`AMENT_LINT_AUTO_FILE_EXCLUDE` variable.

Signed-off-by: Guillaume Autran <[email protected]>

Author: guillaumeautran

ament_cmake_lint_cmake/cmake/ament_cmake_lint_cmake_lint_hook.cmake

@@ -18,5 +18,9 @@ file(GLOB_RECURSE _cmake_files FOLLOW_SYMLINKS
 )
 if(_cmake_files)
   message(STATUS "Added test 'lint_cmake' to check CMake code style")
-  ament_lint_cmake()
+  if(DEFINED AMENT_LINT_AUTO_FILE_EXCLUDE)
+    ament_lint_cmake(EXCLUDE ${AMENT_LINT_AUTO_FILE_EXCLUDE})
+  else()
+    ament_lint_cmake()
+  endif()
 endif()

ament_cmake_lint_cmake/cmake/ament_lint_cmake.cmake

@@ -20,13 +20,15 @@
 # :param MAX_LINE_LENGTH: override the maximum line length,
 #   the default is defined in ament_lint_cmake
 # :type MAX_LINE_LENGTH: integer
+# :param EXCLUDE: an optional list of exclude files or directories for cmake lint check
+# :type EXCLUDE: list
 # :param ARGN: the files or directories to check
 # :type ARGN: list of strings
 #
 # @public
 #
 function(ament_lint_cmake)
-  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 "lint_cmake")
   endif()
@@ -41,6 +43,9 @@ function(ament_lint_cmake)
   if(DEFINED ARG_MAX_LINE_LENGTH)
     list(APPEND cmd "--linelength" "${ARG_MAX_LINE_LENGTH}")
   endif()
+  if(ARG_EXCLUDE)
+    list(APPEND cmd "--exclude" "${ARG_EXCLUDE}")
+  endif()
   list(APPEND cmd ${ARG_UNPARSED_ARGUMENTS})
 
   file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/ament_lint_cmake")

ament_lint_cmake/ament_lint_cmake/main.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 import argparse
+import glob
 import os
 import sys
 import time
@@ -51,6 +52,13 @@ def main(argv=sys.argv[1:]):
     parser.add_argument(
         '--linelength', metavar='N', type=int, default=140,
         help='The maximum line length')
+    parser.add_argument(
+        '--exclude',
+        metavar='filename',
+        nargs='*',
+        default=[],
+        dest='excludes',
+        help='The filenames to exclude.')
     # not using a file handle directly
     # in order to prevent leaving an empty file when something fails early
     parser.add_argument(
@@ -61,7 +69,7 @@ def main(argv=sys.argv[1:]):
     if args.xunit_file:
         start_time = time.time()
 
-    files = get_files(args.paths)
+    files = get_files(args.paths, args.excludes)
     if not files:
         print('No files found', file=sys.stderr)
         return 1
@@ -125,7 +133,12 @@ def custom_error(filename, linenumber, category, message):
     return rc
 
 
-def get_files(paths):
+def get_files(paths, 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):
@@ -145,9 +158,12 @@ def get_files(paths):
                         fname_low.endswith('.cmake') or
                         fname_low.endswith('.cmake.in')
                     ):
-                        files.append(os.path.join(dirpath, filename))
+                        fname = os.path.join(dirpath, filename)
+                        if os.path.realpath(fname) not in excludes:
+                            files.append(fname)
         if os.path.isfile(path):
-            files.append(path)
+            if os.path.realpath(path) not in excludes:
+                files.append(path)
     return [os.path.normpath(f) for f in files]