@matheusbsbs / matheus-bagliano / commits / ee9e66e4e7

cmake: avoid editing t/test-lib.sh

In 7f5397a07c6c (cmake: support for testing git when building out of the source tree, 2020-06-26), we implemented support for running Git's test scripts even after building Git in a different directory than the source directory. The way we did this was to edit the file `t/test-lib.sh` to override `GIT_BUILD_DIR` to point somewhere else than the parent of the `t/` directory. This is unideal because it always leaves a tracked file marked as modified, and it is all too easy to commit that change by mistake. Let's change the strategy by teaching `t/test-lib.sh` to detect the presence of a file called `GIT-BUILD-DIR` in the source directory. If it exists, the contents are interpreted as the location to the _actual_ build directory. We then write this file as part of the CTest definition. To support building Git via a regular `make` invocation after building it using CMake, we ensure that the `GIT-BUILD-DIR` file is deleted (for convenience, this is done as part of the Makefile rule that is already run with every `make` invocation to ensure that `GIT-BUILD-OPTIONS` is up to date). Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Johannes Schindelin committed Oct 18, 2022 at 10:59 UTC ee9e66e4e762075f882ec18ed51270099723cfc9

4 files changed +13 -6

.gitignore

@@ -2,6 +2,7 @@

2 /fuzz_corpora

3 /fuzz-pack-headers

4 /fuzz-pack-idx

5 +/GIT-BUILD-DIR

6 /GIT-BUILD-OPTIONS

7 /GIT-CFLAGS

8 /GIT-LDFLAGS

Makefile

@@ -3028,6 +3028,7 @@ else

3028 @echo RUNTIME_PREFIX=\'false\' >>$@+

3029 endif

3030 @if cmp $@+ $@ >/dev/null 2>&1; then $(RM) $@+; else mv $@+ $@; fi

3031 + @if test -f GIT-BUILD-DIR; then rm GIT-BUILD-DIR; fi

3032

3033 ### Detect Python interpreter path changes

3034 ifndef NO_PYTHON

contrib/buildsystems/CMakeLists.txt

+1 -6

@@ -1067,14 +1067,9 @@ endif()

1067 #Make the tests work when building out of the source tree

1068 get_filename_component(CACHE_PATH ${CMAKE_CURRENT_LIST_DIR}/../../CMakeCache.txt ABSOLUTE)

1069 if(NOT ${CMAKE_BINARY_DIR}/CMakeCache.txt STREQUAL ${CACHE_PATH})

1070 - file(RELATIVE_PATH BUILD_DIR_RELATIVE ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR}/CMakeCache.txt)

1071 - string(REPLACE "/CMakeCache.txt" "" BUILD_DIR_RELATIVE ${BUILD_DIR_RELATIVE})

1070 #Setting the build directory in test-lib.sh before running tests

1071 file(WRITE ${CMAKE_BINARY_DIR}/CTestCustom.cmake

1074 - "file(STRINGS ${CMAKE_SOURCE_DIR}/t/test-lib.sh GIT_BUILD_DIR_REPL REGEX \"GIT_BUILD_DIR=(.*)\")\n"

1075 - "file(STRINGS ${CMAKE_SOURCE_DIR}/t/test-lib.sh content NEWLINE_CONSUME)\n"

1076 - "string(REPLACE \"\${GIT_BUILD_DIR_REPL}\" \"GIT_BUILD_DIR=\\\"$TEST_DIRECTORY/../${BUILD_DIR_RELATIVE}\\\"\" content \"\${content}\")\n"

1077 - "file(WRITE ${CMAKE_SOURCE_DIR}/t/test-lib.sh \${content})")

1072 + "file(WRITE ${CMAKE_SOURCE_DIR}/GIT-BUILD-DIR \"${CMAKE_BINARY_DIR}\")")

1073 #misc copies

1074 file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.sed DESTINATION ${CMAKE_BINARY_DIR}/t/)

1075 file(COPY ${CMAKE_SOURCE_DIR}/po/is.po DESTINATION ${CMAKE_BINARY_DIR}/po/)

t/test-lib.sh

+10

@@ -47,6 +47,16 @@ then

47 echo "PANIC: Running in a $TEST_DIRECTORY that doesn't end in '/t'?" >&2

48 exit 1

49 fi

50 +if test -f "$GIT_BUILD_DIR/GIT-BUILD-DIR"

51 +then

52 + GIT_BUILD_DIR="$(cat "$GIT_BUILD_DIR/GIT-BUILD-DIR")" || exit 1

53 + # On Windows, we must convert Windows paths lest they contain a colon

54 + case "$(uname -s)" in

55 + *MINGW*)

56 + GIT_BUILD_DIR="$(cygpath -au "$GIT_BUILD_DIR")"

57 + ;;

58 + esac

59 +fi

61 # Prepend a string to a VAR using an arbitrary ":" delimiter, not

62 # adding the delimiter if VAR or VALUE is empty. I.e. a generalized: