[Tarantool-patches] [PATCH v2] tools: fix luacheck invocation in different cases
Alexander Turenko
alexander.turenko at tarantool.org
Thu Feb 18 19:09:07 MSK 2021
Now `make luacheck` gracefully handles different cases: in-source and
out-of-source build (within the source tree or outside), current working
directory as a real path or with symlink components.
As result of looking into those problems I filed the issue [1] against
luacheck. It seems, there are problems around absolute paths with
symlinks components.
[1]: https://github.com/mpeterv/luacheck/issues/208
---
no issue
Totktonada/fix-luacheck-invocation
https://github.com/tarantool/tarantool/tree/Totktonada/fix-luacheck-invocation
Changes since v1:
* Moved the logic to CMake, dropped the shell wrapper.
* Shrink comments.
* Handled the case, when a build directory is in the source directory,
and cmake is called not like `cmake ..`, but `cmake /path/to/source`,
where the path is not a real path.
CMakeLists.txt | 28 ++++++++++++++++++++++++++--
cmake/utils.cmake | 22 ++++++++++++++++++++++
2 files changed, 48 insertions(+), 2 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4fbd19558..97cfff7ae 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -158,12 +158,36 @@ add_custom_target(ctags DEPENDS tags)
#
# Enable 'make luacheck' target.
#
-
+# The code looks tricky, because of luacheck side problems
+# (see [1]).
+#
+# The following circumstances may lead to missing of source files
+# or exclusions:
+#
+# * Calling `luacheck "${dir}/.luacheckrc" "${dir}"` from
+# outside of ${dir} or when ${dir} is not a real path.
+# * Using of a path with symlink components in --exclude-files.
+#
+# [1]: https://github.com/mpeterv/luacheck/issues/208
+#
+set(EXCLUDE_FILES)
+get_filename_component(BINARY_REALPATH "${PROJECT_BINARY_DIR}" REALPATH)
+get_filename_component(SOURCE_REALPATH "${PROJECT_SOURCE_DIR}" REALPATH)
+file_is_in_directory(BINARY_DIR_INSIDE_SOURCE_DIR "${BINARY_REALPATH}"
+ "${SOURCE_REALPATH}")
+if (BINARY_DIR_INSIDE_SOURCE_DIR)
+ set(EXCLUDE_FILES --exclude-files "${BINARY_REALPATH}/**/*.lua")
+endif()
add_custom_target(luacheck)
add_custom_command(TARGET luacheck
- COMMAND ${LUACHECK} --codes --config "${PROJECT_SOURCE_DIR}/.luacheckrc" "${PROJECT_SOURCE_DIR}"
+ COMMAND ${LUACHECK} --codes --config .luacheckrc . ${EXCLUDE_FILES}
+ WORKING_DIRECTORY ${SOURCE_REALPATH}
COMMENT "Perform static analysis of Lua code"
)
+unset(BINARY_REALPATH)
+unset(SOURCE_REALPATH)
+unset(BINARY_DIR_INSIDE_SOURCE_DIR)
+unset(EXCLUDE_FILES)
if (WITH_JEPSEN)
ExternalProject_Add(
diff --git a/cmake/utils.cmake b/cmake/utils.cmake
index eaec821b3..e9b5fed5d 100644
--- a/cmake/utils.cmake
+++ b/cmake/utils.cmake
@@ -86,3 +86,25 @@ function(bin_source varname srcfile dstfile)
endfunction()
+#
+# Whether a file is descendant to a directory.
+#
+# If the file is the directory itself, the answer is FALSE.
+#
+function(file_is_in_directory varname file dir)
+ file(RELATIVE_PATH file_relative "${dir}" "${file}")
+ if (file_relative STREQUAL "")
+ # <file> and <dir> is the same directory.
+ set(${varname} FALSE PARENT_SCOPE)
+ elseif (file_relative STREQUAL "..")
+ # <dir> inside a <file> (so it is a directory too), not
+ # vice versa.
+ set(${varname} FALSE PARENT_SCOPE)
+ elseif (file_relative MATCHES "^\\.\\./")
+ # <file> somewhere outside of the <dir>.
+ set(${varname} FALSE PARENT_SCOPE)
+ else()
+ # <file> is descendant to <dir>.
+ set(${varname} TRUE PARENT_SCOPE)
+ endif()
+endfunction()
--
2.30.0
More information about the Tarantool-patches
mailing list