forked from qt-creator/qt-creator
		
	If the PCH creation was successful we want to watch the PCH to update the PCH. Task-number: QTCREATORBUG-21800 Change-Id: Ic84901bde23f60ce2f4e2781ddd1e4f895354ab1 Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
		
			
				
	
	
		
			369 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			369 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
/****************************************************************************
 | 
						|
**
 | 
						|
** Copyright (C) 2018 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 "mockpchcreator.h"
 | 
						|
#include "mockprecompiledheaderstorage.h"
 | 
						|
#include "mocksqlitetransactionbackend.h"
 | 
						|
#include "mocktaskscheduler.h"
 | 
						|
 | 
						|
#include <pchtaskqueue.h>
 | 
						|
#include <progresscounter.h>
 | 
						|
 | 
						|
namespace {
 | 
						|
 | 
						|
using ClangBackEnd::IncludeSearchPath;
 | 
						|
using ClangBackEnd::IncludeSearchPaths;
 | 
						|
using ClangBackEnd::IncludeSearchPathType;
 | 
						|
using ClangBackEnd::PchTask;
 | 
						|
using ClangBackEnd::SlotUsage;
 | 
						|
 | 
						|
class PchTaskQueue : public testing::Test
 | 
						|
{
 | 
						|
protected:
 | 
						|
    NiceMock<MockTaskScheduler<ClangBackEnd::PchTaskQueue::Task>> mockSytemPchTaskScheduler;
 | 
						|
    NiceMock<MockTaskScheduler<ClangBackEnd::PchTaskQueue::Task>> mockProjectPchTaskScheduler;
 | 
						|
    MockPrecompiledHeaderStorage mockPrecompiledHeaderStorage;
 | 
						|
    MockSqliteTransactionBackend mockSqliteTransactionBackend;
 | 
						|
    NiceMock<MockFunction<void(int, int)>> mockSetProgressCallback;
 | 
						|
    ClangBackEnd::ProgressCounter progressCounter{mockSetProgressCallback.AsStdFunction()};
 | 
						|
    ClangBackEnd::PchTaskQueue queue{mockSytemPchTaskScheduler,
 | 
						|
                                     mockProjectPchTaskScheduler,
 | 
						|
                                     progressCounter,
 | 
						|
                                     mockPrecompiledHeaderStorage,
 | 
						|
                                     mockSqliteTransactionBackend};
 | 
						|
    IncludeSearchPaths systemIncludeSearchPaths{
 | 
						|
        {"/includes", 1, IncludeSearchPathType::BuiltIn},
 | 
						|
        {"/other/includes", 2, IncludeSearchPathType::System}};
 | 
						|
    IncludeSearchPaths projectIncludeSearchPaths{
 | 
						|
        {"/project/includes", 1, IncludeSearchPathType::User},
 | 
						|
        {"/other/project/includes", 2, IncludeSearchPathType::User}};
 | 
						|
    PchTask systemTask1{"ProjectPart1",
 | 
						|
                        {1, 2},
 | 
						|
                        {1, 2},
 | 
						|
                        {{"YI", "1", 1}, {"SAN", "3", 3}},
 | 
						|
                        {{"LIANG", 0}, {"YI", 1}},
 | 
						|
                        {"--yi"},
 | 
						|
                        systemIncludeSearchPaths,
 | 
						|
                        projectIncludeSearchPaths};
 | 
						|
    PchTask systemTask2{"ProjectPart2",
 | 
						|
                        {1, 2},
 | 
						|
                        {1, 2},
 | 
						|
                        {{"YI", "1", 1}, {"SAN", "3", 3}},
 | 
						|
                        {{"LIANG", 0}, {"YI", 1}},
 | 
						|
                        {"--yi"},
 | 
						|
                        systemIncludeSearchPaths,
 | 
						|
                        projectIncludeSearchPaths};
 | 
						|
    PchTask systemTask2b{"ProjectPart2",
 | 
						|
                         {3, 4},
 | 
						|
                         {3, 4},
 | 
						|
                         {{"YI", "1", 1}, {"SAN", "3", 3}},
 | 
						|
                         {{"LIANG", 0}, {"YI", 1}},
 | 
						|
                         {"--yi"},
 | 
						|
                         systemIncludeSearchPaths,
 | 
						|
                         projectIncludeSearchPaths};
 | 
						|
    PchTask systemTask3{"ProjectPart3",
 | 
						|
                        {1, 2},
 | 
						|
                        {1, 2},
 | 
						|
                        {{"YI", "1", 1}, {"SAN", "3", 3}},
 | 
						|
                        {{"LIANG", 0}, {"YI", 1}},
 | 
						|
                        {"--yi"},
 | 
						|
                        systemIncludeSearchPaths,
 | 
						|
                        projectIncludeSearchPaths};
 | 
						|
    PchTask projectTask1{"ProjectPart1",
 | 
						|
                         {11, 12},
 | 
						|
                         {11, 12},
 | 
						|
                         {{"SE", "4", 4}, {"WU", "5", 5}},
 | 
						|
                         {{"ER", 2}, {"SAN", 3}},
 | 
						|
                         {"--yi"},
 | 
						|
                         systemIncludeSearchPaths,
 | 
						|
                         projectIncludeSearchPaths};
 | 
						|
    PchTask projectTask2{"ProjectPart2",
 | 
						|
                         {11, 12},
 | 
						|
                         {11, 12},
 | 
						|
                         {{"SE", "4", 4}, {"WU", "5", 5}},
 | 
						|
                         {{"ER", 2}, {"SAN", 3}},
 | 
						|
                         {"--yi"},
 | 
						|
                         systemIncludeSearchPaths,
 | 
						|
                         projectIncludeSearchPaths};
 | 
						|
    PchTask projectTask2b{"ProjectPart2",
 | 
						|
                          {21, 22},
 | 
						|
                          {11, 12},
 | 
						|
                          {{"SE", "4", 4}, {"WU", "5", 5}},
 | 
						|
                          {{"ER", 2}, {"SAN", 3}},
 | 
						|
                          {"--yi"},
 | 
						|
                          systemIncludeSearchPaths,
 | 
						|
                          projectIncludeSearchPaths};
 | 
						|
    PchTask projectTask3{"ProjectPart3",
 | 
						|
                         {21, 22},
 | 
						|
                         {21, 22},
 | 
						|
                         {{"SE", "4", 4}, {"WU", "5", 5}},
 | 
						|
                         {{"ER", 2}, {"SAN", 3}},
 | 
						|
                         {"--yi"},
 | 
						|
                         systemIncludeSearchPaths,
 | 
						|
                         projectIncludeSearchPaths};
 | 
						|
    PchTask systemTask4{Utils::SmallStringVector{"ProjectPart1", "ProjectPart3"},
 | 
						|
                        {1, 2},
 | 
						|
                        {1, 2},
 | 
						|
                        {{"YI", "1", 1}, {"SAN", "3", 3}},
 | 
						|
                        {{"LIANG", 0}, {"YI", 1}},
 | 
						|
                        {"--yi"},
 | 
						|
                        systemIncludeSearchPaths,
 | 
						|
                        projectIncludeSearchPaths};
 | 
						|
};
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddProjectPchTask)
 | 
						|
{
 | 
						|
    queue.addProjectPchTasks({projectTask1});
 | 
						|
 | 
						|
    queue.addProjectPchTasks({projectTask2});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.projectPchTasks(), ElementsAre(projectTask1, projectTask2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddSystemPchTask)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1});
 | 
						|
 | 
						|
    queue.addSystemPchTasks({systemTask2});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.systemPchTasks(), ElementsAre(systemTask1, systemTask2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddProjectPchTasksCallsProcessEntriesForSystemTaskSchedulerIsNotBusy)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSytemPchTaskScheduler, slotUsage()).WillRepeatedly(Return(SlotUsage{2, 0}));
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, slotUsage()).WillRepeatedly(Return(SlotUsage{2, 0}));
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, addTasks(SizeIs(2)));
 | 
						|
 | 
						|
    queue.processEntries();
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddProjectPchTasksCallsProcessEntriesForSystemTaskSchedulerIsBusy)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSytemPchTaskScheduler, slotUsage()).WillRepeatedly(Return(SlotUsage{2, 1}));
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, slotUsage()).Times(0);
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, addTasks(_)).Times(0);
 | 
						|
 | 
						|
    queue.processEntries();
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddSystemPchTasksCallsProcessEntries)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    queue.addSystemPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSytemPchTaskScheduler, slotUsage()).WillRepeatedly(Return(SlotUsage{2, 0}));
 | 
						|
    EXPECT_CALL(mockSytemPchTaskScheduler, addTasks(SizeIs(2)));
 | 
						|
    EXPECT_CALL(mockSytemPchTaskScheduler, slotUsage()).WillRepeatedly(Return(SlotUsage{2, 1}));
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, slotUsage()).Times(0);
 | 
						|
    EXPECT_CALL(mockProjectPchTaskScheduler, addTasks(_)).Times(0);
 | 
						|
 | 
						|
    queue.processEntries();
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddProjectPchTasksCallsProgressCounter)
 | 
						|
{
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSetProgressCallback, Call(0, 3));
 | 
						|
 | 
						|
    queue.addProjectPchTasks({projectTask2b, projectTask3});
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddSystemPchTasksCallsProgressCounter)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSetProgressCallback, Call(0, 3));
 | 
						|
 | 
						|
    queue.addSystemPchTasks({systemTask2b, systemTask3});
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, AddPchCallsProgressCounter)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSetProgressCallback, Call(0, 3));
 | 
						|
 | 
						|
    queue.addSystemPchTasks({systemTask2b, systemTask3});
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, ReplaceIdenticalProjectPchTasks)
 | 
						|
{
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.projectPchTasks(), ElementsAre(projectTask1, projectTask2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, ReplaceIdenticalSystemPchTasks)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.systemPchTasks(), ElementsAre(systemTask1, systemTask2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, ReplaceProjectPchTasksWithSameId)
 | 
						|
{
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2});
 | 
						|
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2b, projectTask3});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.projectPchTasks(), ElementsAre(projectTask1, projectTask2b, projectTask3));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, ReplaceSystemPchTasksWithSameId)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2b, systemTask3});
 | 
						|
 | 
						|
    ASSERT_THAT(queue.systemPchTasks(), ElementsAre(systemTask1, systemTask2b, systemTask3));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, RemoveProjectPchTasksByProjectPartId)
 | 
						|
{
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2, projectTask3});
 | 
						|
 | 
						|
    queue.removePchTasks(projectTask2.projectPartIds);
 | 
						|
 | 
						|
    ASSERT_THAT(queue.projectPchTasks(), ElementsAre(projectTask1, projectTask3));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, DontRemoveSystemPchTasksByProjectPartId)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2, systemTask3});
 | 
						|
 | 
						|
    queue.removePchTasks(systemTask2.projectPartIds);
 | 
						|
 | 
						|
    ASSERT_THAT(queue.systemPchTasks(), ElementsAre(systemTask1, systemTask2, systemTask3));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, RemovePchTasksCallsProgressCounter)
 | 
						|
{
 | 
						|
    queue.addSystemPchTasks({systemTask1, systemTask2, systemTask3});
 | 
						|
    queue.addProjectPchTasks({projectTask1, projectTask2, projectTask3});
 | 
						|
 | 
						|
    EXPECT_CALL(mockSetProgressCallback, Call(0, 5));
 | 
						|
 | 
						|
    queue.removePchTasks(systemTask2.projectPartIds);
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, CreateProjectTasksSizeEqualsInputSize)
 | 
						|
{
 | 
						|
    auto tasks = queue.createProjectTasks({projectTask1, projectTask1});
 | 
						|
 | 
						|
    ASSERT_THAT(tasks, SizeIs(2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, CreateProjectTaskFromPchTask)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    MockPchCreator mockPchCreator;
 | 
						|
    ClangBackEnd::ProjectPartPch projectPartPch{"", "/path/to/pch", 99};
 | 
						|
    auto tasks = queue.createProjectTasks({projectTask1});
 | 
						|
    auto projectTask = projectTask1;
 | 
						|
    projectTask.systemPchPath = "/path/to/pch";
 | 
						|
 | 
						|
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage, fetchSystemPrecompiledHeaderPath(Eq("ProjectPart1")))
 | 
						|
        .WillOnce(Return(ClangBackEnd::FilePath{"/path/to/pch"}));
 | 
						|
    EXPECT_CALL(mockPchCreator, generatePch(Eq(projectTask)));
 | 
						|
    EXPECT_CALL(mockPchCreator, projectPartPch()).WillOnce(ReturnRef(projectPartPch));
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage,
 | 
						|
                insertProjectPrecompiledHeader(Eq("ProjectPart1"), Eq("/path/to/pch"), 99));
 | 
						|
 | 
						|
    tasks.front()(mockPchCreator);
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, DeleteProjectPchEntryInDatabaseIfNoPchIsGenerated)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    MockPchCreator mockPchCreator;
 | 
						|
    ClangBackEnd::ProjectPartPch projectPartPch{"", "", 0};
 | 
						|
    auto tasks = queue.createProjectTasks({projectTask1});
 | 
						|
    auto projectTask = projectTask1;
 | 
						|
    projectTask.systemPchPath = "/path/to/pch";
 | 
						|
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage, fetchSystemPrecompiledHeaderPath(Eq("ProjectPart1")))
 | 
						|
        .WillOnce(Return(ClangBackEnd::FilePath{"/path/to/pch"}));
 | 
						|
    EXPECT_CALL(mockPchCreator, generatePch(Eq(projectTask)));
 | 
						|
    EXPECT_CALL(mockPchCreator, projectPartPch()).WillOnce(ReturnRef(projectPartPch));
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage, deleteProjectPrecompiledHeader(Eq("ProjectPart1")));
 | 
						|
 | 
						|
    tasks.front()(mockPchCreator);
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, CreateSystemTasksSizeEqualsInputSize)
 | 
						|
{
 | 
						|
    auto tasks = queue.createSystemTasks({systemTask1, systemTask2});
 | 
						|
 | 
						|
    ASSERT_THAT(tasks, SizeIs(2));
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, CreateSystemTaskFromPchTask)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    MockPchCreator mockPchCreator;
 | 
						|
    ClangBackEnd::ProjectPartPch projectPartPch{"", "/path/to/pch", 99};
 | 
						|
    auto tasks = queue.createSystemTasks({systemTask4});
 | 
						|
 | 
						|
    EXPECT_CALL(mockPchCreator, generatePch(Eq(systemTask4)));
 | 
						|
    EXPECT_CALL(mockPchCreator, projectPartPch()).WillOnce(ReturnRef(projectPartPch));
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage,
 | 
						|
                insertSystemPrecompiledHeaders(UnorderedElementsAre("ProjectPart1", "ProjectPart3"),
 | 
						|
                                               Eq("/path/to/pch"),
 | 
						|
                                               99));
 | 
						|
 | 
						|
    tasks.front()(mockPchCreator);
 | 
						|
}
 | 
						|
 | 
						|
TEST_F(PchTaskQueue, DeleteSystemPchEntryInDatabaseIfNoPchIsGenerated)
 | 
						|
{
 | 
						|
    InSequence s;
 | 
						|
    MockPchCreator mockPchCreator;
 | 
						|
    ClangBackEnd::ProjectPartPch projectPartPch{"", "", 0};
 | 
						|
    auto tasks = queue.createSystemTasks({systemTask4});
 | 
						|
 | 
						|
    EXPECT_CALL(mockPchCreator, generatePch(Eq(systemTask4)));
 | 
						|
    EXPECT_CALL(mockPchCreator, projectPartPch()).WillOnce(ReturnRef(projectPartPch));
 | 
						|
    EXPECT_CALL(mockPrecompiledHeaderStorage,
 | 
						|
                deleteSystemPrecompiledHeaders(UnorderedElementsAre("ProjectPart1", "ProjectPart3")));
 | 
						|
 | 
						|
    tasks.front()(mockPchCreator);
 | 
						|
}
 | 
						|
} // namespace
 |