mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-26 10:48:38 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'cmake-empty-cmd-line-arg' into release-3.23

Browse Source 
f73457ca2e cmake: Ignore any empty "" command line arguments
67f97f5478 Tests: Add RunCMake helper to run cmake with raw execute_process args

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6980
This commit is contained in:
Brad King
2022-02-17 13:45:45 +00:00
committed by Kitware Robot
parent ed9e7a2732 f73457ca2e
commit 9c81f2cb8b
15 changed files with 60 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Source/cmake.cxx
View File

@@ -544,6 +544,10 @@ bool cmake::SetCacheArgs(const std::vector<std::string>& args)
"-C", "-C must be followed by a file name.",
CommandArgument::Values::One, CommandArgument::RequiresSeparator::No,
[&](std::string const& value, cmake* state) -> bool {
if (value.empty()) {
cmSystemTools::Error("No file name specified for -C");
return false;
}
cmSystemTools::Stdout("loading initial cache file " + value + "\n");
// Resolve script path specified on command line
// relative to $PWD.
@@ -800,7 +804,18 @@ void cmake::SetArgs(const std::vector<std::string>& args)
ListPresets listPresets = ListPresets::None;
#endif
auto EmptyStringArgLambda = [](std::string const&, cmake* state) -> bool {
state->IssueMessage(
MessageType::WARNING,
"Ignoring empty string (\"\") provided on the command line.");
return true;
};
auto SourceArgLambda = [](std::string const& value, cmake* state) -> bool {
if (value.empty()) {
cmSystemTools::Error("No source directory specified for -S");
return false;
}
std::string path = cmSystemTools::CollapseFullPath(value);
cmSystemTools::ConvertToUnixSlashes(path);
state->SetHomeDirectory(path);
@@ -808,6 +823,10 @@ void cmake::SetArgs(const std::vector<std::string>& args)
};
auto BuildArgLambda = [&](std::string const& value, cmake* state) -> bool {
if (value.empty()) {
cmSystemTools::Error("No build directory specified for -B");
return false;
}
std::string path = cmSystemTools::CollapseFullPath(value);
cmSystemTools::ConvertToUnixSlashes(path);
state->SetHomeOutputDirectory(path);
@@ -836,6 +855,7 @@ void cmake::SetArgs(const std::vector<std::string>& args)
};
std::vector<CommandArgument> arguments = {
CommandArgument{ "", CommandArgument::Values::Zero, EmptyStringArgLambda },
CommandArgument{ "-S", "No source directory specified for -S",
CommandArgument::Values::One,
CommandArgument::RequiresSeparator::No, SourceArgLambda },
@@ -1179,8 +1199,8 @@ void cmake::SetArgs(const std::vector<std::string>& args)
if (!extraProvidedPath.empty() && !scriptMode) {
this->IssueMessage(MessageType::WARNING,
cmStrCat("Ignoring extra path from command line:\n ",
extraProvidedPath));
cmStrCat("Ignoring extra path from command line:\n \"",
extraProvidedPath, "\""));
}
if (!possibleUnknownArg.empty() && !scriptMode) {
cmSystemTools::Error(cmStrCat("Unknown argument ", possibleUnknownArg));

2
Tests/RunCMake/CommandLine/B-S-extra-path-stderr.txt
View File

@@ -1,4 +1,4 @@
^CMake Warning:
Ignoring extra path from command line:
/extra/path/$
"/extra/path/"$

1
Tests/RunCMake/CommandLine/B-no-arg3-result.txt Normal file
View File

@@ -0,0 +1 @@
1

1
Tests/RunCMake/CommandLine/B-no-arg3-stderr.txt Normal file
View File

@@ -0,0 +1 @@
^CMake Error: No build directory specified for -B

1
Tests/RunCMake/CommandLine/C-no-arg2-result.txt Normal file
View File

@@ -0,0 +1 @@
1

2
Tests/RunCMake/CommandLine/C-no-arg2-stderr.txt Normal file
View File

@@ -0,0 +1,2 @@
^CMake Error: -C must be followed by a file name.
CMake Error: Run 'cmake --help' for all supported options.$

1
Tests/RunCMake/CommandLine/C-no-arg3-result.txt Normal file
View File

@@ -0,0 +1 @@
1

1
Tests/RunCMake/CommandLine/C-no-arg3-stderr.txt Normal file
View File

@@ -0,0 +1 @@
^CMake Error: No file name specified for -C

8
Tests/RunCMake/CommandLine/RunCMakeTest.cmake
View File

@@ -7,6 +7,10 @@ run_cmake_command(InvalidArg1 ${CMAKE_COMMAND} -invalid)
run_cmake_command(InvalidArg2 ${CMAKE_COMMAND} --invalid)
run_cmake_command(Wizard ${CMAKE_COMMAND} -i)
run_cmake_command(C-no-arg ${CMAKE_COMMAND} -B DummyBuildDir -C)
run_cmake_command(C-no-arg2 ${CMAKE_COMMAND} -B DummyBuildDir -C -T)
set(RunCMake_TEST_RAW_ARGS [[-C ""]])
run_cmake_command(C-no-arg3 ${CMAKE_COMMAND} -B DummyBuildDir)
unset(RunCMake_TEST_RAW_ARGS)
run_cmake_command(C-no-file ${CMAKE_COMMAND} -B DummyBuildDir -C nosuchcachefile.txt)
run_cmake_command(Cno-file ${CMAKE_COMMAND} -B DummyBuildDir -Cnosuchcachefile.txt)
run_cmake_command(cache-no-file ${CMAKE_COMMAND} nosuchsubdir/CMakeCache.txt)
@@ -158,8 +162,11 @@ endif()
run_cmake_with_options(S-arg-reverse-order ${binary_dir} -S${source_dir} )
run_cmake_with_options(S-no-arg -S )
run_cmake_with_options(S-no-arg2 -S -T)
run_cmake_with_raw_args(S-no-arg3 [[-S ""]])
run_cmake_with_options(S-B -S ${source_dir} -B ${binary_dir})
run_cmake_with_options(S-B-extra-path -S ${source_dir} -B ${binary_dir} /extra/path/)
run_cmake_with_raw_args(S-B-non-path "-S \"${source_dir}\" -B \"${binary_dir}\" \"\"")
run_cmake_with_raw_args(S-B-non-path2 "-S \"${source_dir}\" \"\" -B \"${binary_dir}\"")
# make sure that -B can explicitly construct build directories
file(REMOVE_RECURSE "${binary_dir}")
@@ -168,6 +175,7 @@ endif()
run_cmake_with_options(B-arg-reverse-order ${source_dir} -B${binary_dir})
run_cmake_with_options(B-no-arg -B )
run_cmake_with_options(B-no-arg2 -B -T)
run_cmake_with_raw_args(B-no-arg3 [[-B ""]])
file(REMOVE_RECURSE "${binary_dir}")
run_cmake_with_options(B-S -B${binary_dir} -S${source_dir})
run_cmake_with_options(B-S-extra-path -B${binary_dir} -S${source_dir} /extra/path/)

2
Tests/RunCMake/CommandLine/S-B-extra-path-stderr.txt
View File

@@ -1,4 +1,4 @@
^CMake Warning:
Ignoring extra path from command line:
/extra/path/$
"/extra/path/"$

2
Tests/RunCMake/CommandLine/S-B-non-path-stderr.txt Normal file
View File

@@ -0,0 +1,2 @@
^CMake Warning:
Ignoring empty string \(""\) provided on the command line\.$

2
Tests/RunCMake/CommandLine/S-B-non-path2-stderr.txt Normal file
View File

@@ -0,0 +1,2 @@
^CMake Warning:
Ignoring empty string \(""\) provided on the command line\.$

1
Tests/RunCMake/CommandLine/S-no-arg3-result.txt Normal file
View File

@@ -0,0 +1 @@
1

1
Tests/RunCMake/CommandLine/S-no-arg3-stderr.txt Normal file
View File

@@ -0,0 +1 @@
^CMake Error: No source directory specified for -S

17
Tests/RunCMake/RunCMake.cmake
View File

@@ -119,12 +119,16 @@ function(run_cmake test)
else()
set(RunCMake_TEST_OPTIONS "")
endif()
if(NOT DEFINED RunCMake_TEST_RAW_ARGS)
set(RunCMake_TEST_RAW_ARGS "")
endif()
if(NOT RunCMake_TEST_COMMAND_WORKING_DIRECTORY)
set(RunCMake_TEST_COMMAND_WORKING_DIRECTORY "${RunCMake_TEST_BINARY_DIR}")
endif()
execute_process(
string(CONCAT _code [[execute_process(
COMMAND ${RunCMake_TEST_COMMAND}
${RunCMake_TEST_OPTIONS}
]] "${RunCMake_TEST_RAW_ARGS}\n" [[
WORKING_DIRECTORY "${RunCMake_TEST_COMMAND_WORKING_DIRECTORY}"
OUTPUT_VARIABLE actual_stdout
ERROR_VARIABLE ${actual_stderr_var}
@@ -132,7 +136,8 @@ function(run_cmake test)
ENCODING UTF8
${maybe_timeout}
${maybe_input_file}
)
)]])
cmake_language(EVAL CODE "${_code}")
set(msg "")
if(NOT "${actual_result}" MATCHES "${expect_result}")
string(APPEND msg "Result is [${actual_result}], not [${expect_result}].\n")
@@ -196,6 +201,9 @@ function(run_cmake test)
string(REPLACE ";" "\" \"" options "\"${RunCMake_TEST_OPTIONS}\"")
string(APPEND command " ${options}")
endif()
if(RunCMake_TEST_RAW_ARGS)
string(APPEND command " ${RunCMake_TEST_RAW_ARGS}")
endif()
string(APPEND msg "Command was:\n command> ${command}\n")
endif()
if(msg)
@@ -228,6 +236,11 @@ function(run_cmake_with_options test)
run_cmake(${test})
endfunction()
function(run_cmake_with_raw_args test args)
set(RunCMake_TEST_RAW_ARGS "${args}")
run_cmake(${test})
endfunction()
function(ensure_files_match expected_file actual_file)
if(NOT EXISTS "${expected_file}")
message(FATAL_ERROR "Expected file does not exist:\n ${expected_file}")