1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-19 11:18:40 +08:00

install(EXPORT): Check for missing file sets at generate time

Missing file sets were originally checked at configure time in
install(TARGETS ... EXPORT), but were not checked at generate time. If
a file set was added after install(TARGETS ... EXPORT) was called,
an abortion error was thrown. Check again at generate time to gracefully
display an error message instead of crashing.

Fixes: #23680
This commit is contained in:
Kyle Edwards
2022-06-28 14:15:19 -04:00
parent a8bd06dfd4
commit 3fee5398bd
10 changed files with 60 additions and 4 deletions

View File

@@ -2,10 +2,15 @@
file Copyright.txt or https://cmake.org/licensing for details. */ file Copyright.txt or https://cmake.org/licensing for details. */
#include "cmExportSet.h" #include "cmExportSet.h"
#include <algorithm>
#include <tuple> #include <tuple>
#include <utility> #include <utility>
#include "cmGeneratorTarget.h"
#include "cmLocalGenerator.h" #include "cmLocalGenerator.h"
#include "cmMessageType.h"
#include "cmStringAlgorithms.h"
#include "cmTarget.h"
#include "cmTargetExport.h" #include "cmTargetExport.h"
cmExportSet::cmExportSet(std::string name) cmExportSet::cmExportSet(std::string name)
@@ -15,11 +20,35 @@ cmExportSet::cmExportSet(std::string name)
cmExportSet::~cmExportSet() = default; cmExportSet::~cmExportSet() = default;
void cmExportSet::Compute(cmLocalGenerator* lg) bool cmExportSet::Compute(cmLocalGenerator* lg)
{ {
for (std::unique_ptr<cmTargetExport>& tgtExport : this->TargetExports) { for (std::unique_ptr<cmTargetExport>& tgtExport : this->TargetExports) {
tgtExport->Target = lg->FindGeneratorTargetToUse(tgtExport->TargetName); tgtExport->Target = lg->FindGeneratorTargetToUse(tgtExport->TargetName);
auto const interfaceFileSets =
tgtExport->Target->Target->GetAllInterfaceFileSets();
auto const fileSetInTargetExport =
[&tgtExport, lg](const std::string& fileSetName) -> bool {
auto* fileSet = tgtExport->Target->Target->GetFileSet(fileSetName);
if (!tgtExport->FileSetGenerators.count(fileSet)) {
lg->IssueMessage(MessageType::FATAL_ERROR,
cmStrCat("File set \"", fileSetName,
"\" is listed in interface file sets of ",
tgtExport->Target->GetName(),
" but has not been exported"));
return false;
}
return true;
};
if (!std::all_of(interfaceFileSets.begin(), interfaceFileSets.end(),
fileSetInTargetExport)) {
return false;
}
} }
return true;
} }
void cmExportSet::AddTargetExport(std::unique_ptr<cmTargetExport> te) void cmExportSet::AddTargetExport(std::unique_ptr<cmTargetExport> te)

View File

@@ -25,7 +25,7 @@ public:
cmExportSet(const cmExportSet&) = delete; cmExportSet(const cmExportSet&) = delete;
cmExportSet& operator=(const cmExportSet&) = delete; cmExportSet& operator=(const cmExportSet&) = delete;
void Compute(cmLocalGenerator* lg); bool Compute(cmLocalGenerator* lg);
void AddTargetExport(std::unique_ptr<cmTargetExport> tgt); void AddTargetExport(std::unique_ptr<cmTargetExport> tgt);

View File

@@ -49,8 +49,7 @@ cmInstallExportGenerator::~cmInstallExportGenerator() = default;
bool cmInstallExportGenerator::Compute(cmLocalGenerator* lg) bool cmInstallExportGenerator::Compute(cmLocalGenerator* lg)
{ {
this->LocalGenerator = lg; this->LocalGenerator = lg;
this->ExportSet->Compute(lg); return this->ExportSet->Compute(lg);
return true;
} }
void cmInstallExportGenerator::ComputeTempDir() void cmInstallExportGenerator::ComputeTempDir()

View File

@@ -0,0 +1,6 @@
^CMake Error in CMakeLists\.txt:
File set "a" is listed in interface file sets of lib1 but has not been
exported
CMake Generate step failed\. Build files cannot be regenerated correctly\.$

View File

@@ -0,0 +1,6 @@
enable_language(C)
add_library(lib1 STATIC empty.c)
install(TARGETS lib1 EXPORT a)
target_sources(lib1 INTERFACE FILE_SET a TYPE HEADERS BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR} FILES h1.h)
export(EXPORT a)

View File

@@ -0,0 +1,6 @@
^CMake Error in CMakeLists\.txt:
File set "a" is listed in interface file sets of lib1 but has not been
exported
CMake Generate step failed\. Build files cannot be regenerated correctly\.$

View File

@@ -0,0 +1,6 @@
enable_language(C)
add_library(lib1 STATIC empty.c)
install(TARGETS lib1 EXPORT a)
target_sources(lib1 INTERFACE FILE_SET a TYPE HEADERS BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR} FILES h1.h)
install(EXPORT a DESTINATION lib/cmake/test)

View File

@@ -33,6 +33,8 @@ run_cmake(FileSetWrongBaseDirsRelative)
run_cmake(FileSetOverlappingBaseDirs) run_cmake(FileSetOverlappingBaseDirs)
run_cmake(FileSetInstallMissingSetsPrivate) run_cmake(FileSetInstallMissingSetsPrivate)
run_cmake(FileSetInstallMissingSetsInterface) run_cmake(FileSetInstallMissingSetsInterface)
run_cmake(FileSetInstallMissingSetsInterfacePostInstall)
run_cmake(FileSetExportMissingSetsInterfacePostExport)
run_cmake(FileSetReadOnlyPrivate) run_cmake(FileSetReadOnlyPrivate)
run_cmake(FileSetReadOnlyInterface) run_cmake(FileSetReadOnlyInterface)
run_cmake(FileSetNoExistInstall) run_cmake(FileSetNoExistInstall)