forked from qt-creator/qt-creator
The project part ids are now already created very early in the database. This removes some checks because we can assume that an id already exists. The project part are now completely persistent, so we can read them from the database and compare them with new generated from a new creator session. This should help to not recreate the same PCH again and again. Task-number: QTCREATORBUG-21151 Change-Id: Iced818ff9f7431eaed3e37978087cc0a43b9afda Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
280 lines
11 KiB
C++
280 lines
11 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "googletest.h"
|
|
|
|
#include "mockclangpathwatcher.h"
|
|
#include "mockpchmanagerclient.h"
|
|
#include "mockpchtaskgenerator.h"
|
|
#include "mockprojectpartsmanager.h"
|
|
#include "mockgeneratedfiles.h"
|
|
|
|
#include <filepathcaching.h>
|
|
#include <pchmanagerserver.h>
|
|
#include <precompiledheadersupdatedmessage.h>
|
|
#include <progressmessage.h>
|
|
#include <refactoringdatabaseinitializer.h>
|
|
#include <removegeneratedfilesmessage.h>
|
|
#include <removeprojectpartsmessage.h>
|
|
#include <updategeneratedfilesmessage.h>
|
|
#include <updateprojectpartsmessage.h>
|
|
|
|
namespace {
|
|
using Utils::PathString;
|
|
using Utils::SmallString;
|
|
using ClangBackEnd::V2::FileContainer;
|
|
using ClangBackEnd::V2::FileContainers;
|
|
using ClangBackEnd::ProjectPartContainer;
|
|
using ClangBackEnd::ProjectPartContainers;
|
|
|
|
class PchManagerServer : public ::testing::Test
|
|
{
|
|
void SetUp() override
|
|
{
|
|
server.setClient(&mockPchManagerClient);
|
|
|
|
ON_CALL(mockProjectPartsManager, update(projectParts)).WillByDefault(Return(projectParts));
|
|
ON_CALL(mockGeneratedFiles, isValid()).WillByDefault(Return(true));
|
|
}
|
|
|
|
ClangBackEnd::FilePathId id(Utils::SmallStringView path) const
|
|
{
|
|
return filePathCache.filePathId(ClangBackEnd::FilePathView(path));
|
|
}
|
|
|
|
protected:
|
|
NiceMock<MockPchTaskGenerator> mockPchTaskGenerator;
|
|
NiceMock<MockClangPathWatcher> mockClangPathWatcher;
|
|
NiceMock<MockProjectPartsManager> mockProjectPartsManager;
|
|
NiceMock<MockGeneratedFiles> mockGeneratedFiles;
|
|
Sqlite::Database database{":memory:", Sqlite::JournalMode::Memory};
|
|
ClangBackEnd::RefactoringDatabaseInitializer<Sqlite::Database> initializer{database};
|
|
ClangBackEnd::FilePathCaching filePathCache{database};
|
|
ClangBackEnd::PchManagerServer server{mockClangPathWatcher,
|
|
mockPchTaskGenerator,
|
|
mockProjectPartsManager,
|
|
mockGeneratedFiles};
|
|
NiceMock<MockPchManagerClient> mockPchManagerClient;
|
|
ClangBackEnd::ProjectPartId projectPartId1{1};
|
|
ClangBackEnd::ProjectPartId projectPartId2{2};
|
|
PathString main1Path = TESTDATA_DIR "/BuildDependencyCollector_main3.cpp";
|
|
PathString main2Path = TESTDATA_DIR "/BuildDependencyCollector_main2.cpp";
|
|
PathString header1Path = TESTDATA_DIR "/BuildDependencyCollector_header1.h";
|
|
PathString header2Path = TESTDATA_DIR "/BuildDependencyCollector_header2.h";
|
|
ClangBackEnd::IdPaths idPath{projectPartId1, {1, 2}};
|
|
ProjectPartContainer projectPart1{
|
|
projectPartId1,
|
|
{"-I", TESTDATA_DIR, "-Wno-pragma-once-outside-header"},
|
|
{{"DEFINE", "1", 1}},
|
|
{{"/includes", 1, ClangBackEnd::IncludeSearchPathType::BuiltIn}},
|
|
{{"/project/includes", 1, ClangBackEnd::IncludeSearchPathType::User}},
|
|
{id(header1Path)},
|
|
{id(main1Path)},
|
|
Utils::Language::C,
|
|
Utils::LanguageVersion::C11,
|
|
Utils::LanguageExtension::All};
|
|
ProjectPartContainer projectPart2{
|
|
projectPartId2,
|
|
{"-x", "c++-header", "-Wno-pragma-once-outside-header"},
|
|
{{"DEFINE", "1", 1}},
|
|
{{"/includes", 1, ClangBackEnd::IncludeSearchPathType::BuiltIn}},
|
|
{{"/project/includes", 1, ClangBackEnd::IncludeSearchPathType::User}},
|
|
{id(header2Path)},
|
|
{id(main2Path)},
|
|
Utils::Language::C,
|
|
Utils::LanguageVersion::C11,
|
|
Utils::LanguageExtension::All};
|
|
std::vector<ProjectPartContainer> projectParts{projectPart1, projectPart2};
|
|
std::vector<ProjectPartContainer> projectParts2{projectPart2};
|
|
FileContainer generatedFile{{"/path/to/", "file"}, "content", {}};
|
|
ClangBackEnd::UpdateProjectPartsMessage updateProjectPartsMessage{
|
|
Utils::clone(projectParts), {"toolChainArgument"}};
|
|
ClangBackEnd::RemoveProjectPartsMessage removeProjectPartsMessage{
|
|
{projectPart1.projectPartId, projectPart2.projectPartId}};
|
|
};
|
|
|
|
TEST_F(PchManagerServer, FilterProjectPartsAndSendThemToQueue)
|
|
{
|
|
InSequence s;
|
|
|
|
EXPECT_CALL(mockProjectPartsManager, update(updateProjectPartsMessage.projectsParts))
|
|
.WillOnce(Return(projectParts2));
|
|
EXPECT_CALL(
|
|
mockPchTaskGenerator, addProjectParts(Eq(projectParts2), ElementsAre("toolChainArgument")));
|
|
|
|
server.updateProjectParts(updateProjectPartsMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, UpdateGeneratedFilesCallsUpdate)
|
|
{
|
|
ClangBackEnd::UpdateGeneratedFilesMessage updateGeneratedFilesMessage{{generatedFile}};
|
|
|
|
EXPECT_CALL(mockGeneratedFiles, update(updateGeneratedFilesMessage.generatedFiles));
|
|
|
|
server.updateGeneratedFiles(updateGeneratedFilesMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, RemoveGeneratedFilesCallsRemove)
|
|
{
|
|
ClangBackEnd::RemoveGeneratedFilesMessage removeGeneratedFilesMessage{{generatedFile.filePath}};
|
|
|
|
EXPECT_CALL(mockGeneratedFiles, remove(Utils::clone(removeGeneratedFilesMessage.generatedFiles)));
|
|
|
|
server.removeGeneratedFiles(removeGeneratedFilesMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, RemoveIncludesFromFileWatcher)
|
|
{
|
|
EXPECT_CALL(mockClangPathWatcher, removeIds(removeProjectPartsMessage.projectsPartIds));
|
|
|
|
server.removeProjectParts(removeProjectPartsMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, RemoveProjectPartsFromProjectParts)
|
|
{
|
|
EXPECT_CALL(mockProjectPartsManager, remove(removeProjectPartsMessage.projectsPartIds));
|
|
|
|
server.removeProjectParts(removeProjectPartsMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, SetPathWatcherNotifier)
|
|
{
|
|
EXPECT_CALL(mockClangPathWatcher, setNotifier(_));
|
|
|
|
ClangBackEnd::PchManagerServer server{mockClangPathWatcher,
|
|
mockPchTaskGenerator,
|
|
mockProjectPartsManager,
|
|
mockGeneratedFiles};
|
|
}
|
|
|
|
TEST_F(PchManagerServer, UpdateProjectPartQueueByPathIds)
|
|
{
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
|
|
EXPECT_CALL(mockProjectPartsManager, projects(ElementsAre(projectPart1.projectPartId)))
|
|
.WillOnce(Return(std::vector<ClangBackEnd::ProjectPartContainer>{{projectPart1}}));
|
|
EXPECT_CALL(mockPchTaskGenerator, addProjectParts(ElementsAre(projectPart1), ElementsAre("toolChainArgument")));
|
|
|
|
server.pathsWithIdsChanged({projectPartId1});
|
|
}
|
|
|
|
TEST_F(PchManagerServer, SetPchCreationProgress)
|
|
{
|
|
EXPECT_CALL(mockPchManagerClient,
|
|
progress(AllOf(Field(&ClangBackEnd::ProgressMessage::progressType,
|
|
ClangBackEnd::ProgressType::PrecompiledHeader),
|
|
Field(&ClangBackEnd::ProgressMessage::progress, 20),
|
|
Field(&ClangBackEnd::ProgressMessage::total, 30))));
|
|
|
|
server.setPchCreationProgress(20, 30);
|
|
}
|
|
|
|
TEST_F(PchManagerServer, SetDependencyCreationProgress)
|
|
{
|
|
EXPECT_CALL(mockPchManagerClient,
|
|
progress(AllOf(Field(&ClangBackEnd::ProgressMessage::progressType,
|
|
ClangBackEnd::ProgressType::DependencyCreation),
|
|
Field(&ClangBackEnd::ProgressMessage::progress, 20),
|
|
Field(&ClangBackEnd::ProgressMessage::total, 30))));
|
|
|
|
server.setDependencyCreationProgress(20, 30);
|
|
}
|
|
|
|
TEST_F(PchManagerServer, RemoveToolChainsArguments)
|
|
{
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
|
|
EXPECT_CALL(mockPchTaskGenerator, addProjectParts(_, _)).Times(0);
|
|
server.removeProjectParts(removeProjectPartsMessage.clone());
|
|
|
|
server.pathsWithIdsChanged({projectPart1.projectPartId});
|
|
}
|
|
|
|
TEST_F(PchManagerServer, DontGeneratePchIfGeneratedFilesAreNotValid)
|
|
{
|
|
InSequence s;
|
|
|
|
EXPECT_CALL(mockProjectPartsManager, update(ElementsAre(projectPart1)))
|
|
.WillOnce(Return(ProjectPartContainers{projectPart1}));
|
|
EXPECT_CALL(mockGeneratedFiles, isValid()).WillOnce(Return(false));
|
|
EXPECT_CALL(mockPchTaskGenerator, addProjectParts(_, _)).Times(0);
|
|
EXPECT_CALL(mockProjectPartsManager, updateDeferred(ElementsAre(projectPart1)));
|
|
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
}
|
|
|
|
TEST_F(PchManagerServer, GeneratePchIfGeneratedFilesAreValid)
|
|
{
|
|
InSequence s;
|
|
|
|
EXPECT_CALL(mockProjectPartsManager, update(ElementsAre(projectPart1)))
|
|
.WillOnce(Return(ProjectPartContainers{projectPart1}));
|
|
EXPECT_CALL(mockGeneratedFiles, isValid()).WillOnce(Return(true));
|
|
EXPECT_CALL(mockPchTaskGenerator, addProjectParts(_, _));
|
|
EXPECT_CALL(mockProjectPartsManager, updateDeferred(_)).Times(0);
|
|
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
}
|
|
|
|
TEST_F(PchManagerServer, AfterUpdatingGeneratedFilesAreValidSoGeneratePchs)
|
|
{
|
|
InSequence s;
|
|
ClangBackEnd::UpdateGeneratedFilesMessage updateGeneratedFilesMessage{{generatedFile}};
|
|
ON_CALL(mockGeneratedFiles, isValid()).WillByDefault(Return(false));
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
|
|
EXPECT_CALL(mockGeneratedFiles, update(updateGeneratedFilesMessage.generatedFiles));
|
|
EXPECT_CALL(mockGeneratedFiles, isValid()).WillOnce(Return(true));
|
|
EXPECT_CALL(mockProjectPartsManager, deferredUpdates())
|
|
.WillOnce(Return(ClangBackEnd::ProjectPartContainers{projectPart1}));
|
|
EXPECT_CALL(mockPchTaskGenerator,
|
|
addProjectParts(ElementsAre(projectPart1), ElementsAre("toolChainArgument")));
|
|
|
|
server.updateGeneratedFiles(updateGeneratedFilesMessage.clone());
|
|
}
|
|
|
|
TEST_F(PchManagerServer, AfterUpdatingGeneratedFilesAreStillInvalidSoNoPchsGeneration)
|
|
{
|
|
InSequence s;
|
|
ClangBackEnd::UpdateGeneratedFilesMessage updateGeneratedFilesMessage{{generatedFile}};
|
|
ON_CALL(mockGeneratedFiles, isValid()).WillByDefault(Return(false));
|
|
server.updateProjectParts(
|
|
ClangBackEnd::UpdateProjectPartsMessage{{projectPart1}, {"toolChainArgument"}});
|
|
|
|
EXPECT_CALL(mockGeneratedFiles, update(updateGeneratedFilesMessage.generatedFiles));
|
|
EXPECT_CALL(mockGeneratedFiles, isValid()).WillOnce(Return(false));
|
|
EXPECT_CALL(mockProjectPartsManager, deferredUpdates()).Times(0);
|
|
EXPECT_CALL(mockPchTaskGenerator, addProjectParts(_, _)).Times(0);
|
|
|
|
server.updateGeneratedFiles(updateGeneratedFilesMessage.clone());
|
|
}
|
|
|
|
}
|