forked from qt-creator/qt-creator
IncludeCollector is renamed to BuildDependencyCollector. It is now returning a BuildDependency instead of individual getter. The test coverage is improved too. Task-number: QTCREATORBUG-21379 Change-Id: Ifc2d1c40c85772cf498c21968de526f4408b6023 Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
324 lines
13 KiB
C++
324 lines
13 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 "fakeprocess.h"
|
|
|
|
#include "mockclangpathwatcher.h"
|
|
#include "mockpchmanagerclient.h"
|
|
#include "testenvironment.h"
|
|
|
|
#include <refactoringdatabaseinitializer.h>
|
|
#include <filepathcaching.h>
|
|
#include <generatedfiles.h>
|
|
#include <pchcreator.h>
|
|
#include <precompiledheadersupdatedmessage.h>
|
|
|
|
#include <sqlitedatabase.h>
|
|
|
|
#include <QFileInfo>
|
|
|
|
namespace {
|
|
|
|
using ClangBackEnd::FilePath;
|
|
using ClangBackEnd::FilePathId;
|
|
using ClangBackEnd::FilePathIds;
|
|
using ClangBackEnd::FilePathView;
|
|
using ClangBackEnd::GeneratedFiles;
|
|
using ClangBackEnd::IdPaths;
|
|
using ClangBackEnd::ProjectPartPch;
|
|
using ClangBackEnd::SourceEntries;
|
|
using ClangBackEnd::SourceEntry;
|
|
using ClangBackEnd::SourceType;
|
|
using ClangBackEnd::V2::FileContainer;
|
|
using ClangBackEnd::V2::ProjectPartContainer;
|
|
|
|
using Utils::PathString;
|
|
using Utils::SmallString;
|
|
|
|
using UnitTests::EndsWith;
|
|
|
|
MATCHER_P2(HasIdAndType, sourceId, sourceType,
|
|
std::string(negation ? "hasn't" : "has") +
|
|
PrintToString(ClangBackEnd::SourceEntry(sourceId, sourceType,
|
|
-1)))
|
|
{
|
|
const ClangBackEnd::SourceEntry &entry = arg;
|
|
return entry.sourceId == sourceId && entry.sourceType == sourceType;
|
|
}
|
|
|
|
class PchCreator: public ::testing::Test
|
|
{
|
|
protected:
|
|
void SetUp()
|
|
{
|
|
creator.setUnsavedFiles({generatedFile});
|
|
}
|
|
|
|
ClangBackEnd::FilePathId id(ClangBackEnd::FilePathView path)
|
|
{
|
|
return creator.filePathCache().filePathId(path);
|
|
}
|
|
|
|
protected:
|
|
Sqlite::Database database{":memory:", Sqlite::JournalMode::Memory};
|
|
ClangBackEnd::RefactoringDatabaseInitializer<Sqlite::Database> databaseInitializer{database};
|
|
FilePath main1Path = TESTDATA_DIR "/builddependencycollector/project/main3.cpp";
|
|
FilePath main2Path = TESTDATA_DIR "/builddependencycollector/project/main2.cpp";
|
|
FilePath header1Path = TESTDATA_DIR "/builddependencycollector/project/header1.h";
|
|
FilePath header2Path = TESTDATA_DIR "/builddependencycollector/project/header2.h";
|
|
Utils::SmallStringView generatedFileName = "builddependencycollector/project/generated_file.h";
|
|
FilePath generatedFilePath = TESTDATA_DIR "/builddependencycollector/project/generated_file.h";
|
|
TestEnvironment environment;
|
|
FileContainer generatedFile{{TESTDATA_DIR, generatedFileName}, "#pragma once", {}};
|
|
NiceMock<MockPchManagerClient> mockPchManagerClient;
|
|
NiceMock<MockClangPathWatcher> mockClangPathWatcher;
|
|
ClangBackEnd::PchCreator creator{environment, database, mockPchManagerClient, mockClangPathWatcher};
|
|
ProjectPartContainer projectPart1{"project1",
|
|
{"-I", TESTDATA_DIR, "-I", TESTDATA_DIR "/builddependencycollector/external", "-I", TESTDATA_DIR "/builddependencycollector/project", "-isystem", TESTDATA_DIR "/builddependencycollector/system", "-Wno-pragma-once-outside-header"},
|
|
{{"DEFINE", "1"}},
|
|
{TESTDATA_DIR "/builddependencycollector/external", TESTDATA_DIR "/builddependencycollector/project"},
|
|
{id(header1Path)},
|
|
{id(main1Path)}};
|
|
ProjectPartContainer projectPart2{"project2",
|
|
{"-I", TESTDATA_DIR, "-I", TESTDATA_DIR "/builddependencycollector/external", "-I", TESTDATA_DIR "/builddependencycollector/project", "-x", "c++-header", "-Wno-pragma-once-outside-header"},
|
|
{{"DEFINE", "1"}},
|
|
{TESTDATA_DIR "/builddependencycollector/external", TESTDATA_DIR "/builddependencycollector/project"},
|
|
{id(header2Path)},
|
|
{id(main2Path)}};
|
|
};
|
|
using PchCreatorSlowTest = PchCreator;
|
|
using PchCreatorVerySlowTest = PchCreator;
|
|
|
|
TEST_F(PchCreator, ConvertToQStringList)
|
|
{
|
|
auto arguments = creator.convertToQStringList({"-I", TESTDATA_DIR});
|
|
|
|
ASSERT_THAT(arguments, ElementsAre(QString("-I"), QString(TESTDATA_DIR)));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartCommandLine)
|
|
{
|
|
auto commandLine = creator.generateProjectPartCommandLine(projectPart1);
|
|
|
|
ASSERT_THAT(commandLine, ElementsAre(environment.clangCompilerPath(), "-I", TESTDATA_DIR, "-I", TESTDATA_DIR "/builddependencycollector/external", "-I", TESTDATA_DIR "/builddependencycollector/project", "-isystem", TESTDATA_DIR "/builddependencycollector/system", "-Wno-pragma-once-outside-header"));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartHeaders)
|
|
{
|
|
auto includeIds = creator.generateProjectPartHeaders(projectPart1);
|
|
|
|
ASSERT_THAT(includeIds, UnorderedElementsAre(header1Path, generatedFilePath));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartSources)
|
|
{
|
|
auto includeIds = creator.generateProjectPartSourcePaths(projectPart1);
|
|
|
|
ASSERT_THAT(includeIds, UnorderedElementsAre(main1Path));
|
|
}
|
|
|
|
TEST_F(PchCreatorSlowTest, CreateProjectPartPchIncludes)
|
|
{
|
|
using ClangBackEnd::PchCreatorIncludes;
|
|
|
|
auto includeIds = creator.generateProjectPartPchIncludes(projectPart1);
|
|
|
|
ASSERT_THAT(
|
|
includeIds,
|
|
AllOf(
|
|
Contains(HasIdAndType(
|
|
id(TESTDATA_DIR "/builddependencycollector/project/header2.h"),
|
|
SourceType::TopInclude)),
|
|
Contains(HasIdAndType(
|
|
id(TESTDATA_DIR "/builddependencycollector/system/system1.h"),
|
|
SourceType::TopSystemInclude)),
|
|
Contains(HasIdAndType(
|
|
id(TESTDATA_DIR
|
|
"/builddependencycollector/system/indirect_system.h"),
|
|
SourceType::SystemInclude)),
|
|
Contains(HasIdAndType(
|
|
id(TESTDATA_DIR
|
|
"/builddependencycollector/external/external1.h"),
|
|
SourceType::TopInclude)),
|
|
Contains(HasIdAndType(
|
|
id(TESTDATA_DIR
|
|
"/builddependencycollector/external/external2.h"),
|
|
SourceType::TopInclude))));
|
|
}
|
|
|
|
TEST_F(PchCreatorSlowTest, CreateProjectPartPchFileContent)
|
|
{
|
|
auto includes = creator.generateProjectPartPchIncludes(projectPart1);
|
|
|
|
auto content = creator.generatePchIncludeFileContent(creator.topIncludeIds(includes));
|
|
|
|
ASSERT_THAT(std::string(content),
|
|
AllOf(HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/project/header2.h\"\n"),
|
|
HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/external/external1.h\"\n"),
|
|
HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/external/external2.h\"\n")));
|
|
}
|
|
|
|
TEST_F(PchCreatorSlowTest, CreateProjectPartPchIncludeFile)
|
|
{
|
|
auto includes = creator.generateProjectPartPchIncludes(projectPart1);
|
|
auto content = creator.generatePchIncludeFileContent(creator.topIncludeIds(includes));
|
|
auto pchIncludeFilePath = creator.generateProjectPathPchHeaderFilePath(projectPart1);
|
|
auto file = creator.generateFileWithContent(pchIncludeFilePath, content);
|
|
file->open(QIODevice::ReadOnly);
|
|
|
|
auto fileContent = file->readAll();
|
|
|
|
ASSERT_THAT(fileContent.toStdString(),
|
|
AllOf(HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/project/header2.h\"\n"),
|
|
HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/external/external1.h\"\n"),
|
|
HasSubstr("#include \"" TESTDATA_DIR "/builddependencycollector/external/external2.h\"\n")));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartPchCompilerArguments)
|
|
{
|
|
auto arguments = creator.generateProjectPartPchCompilerArguments(projectPart1);
|
|
|
|
ASSERT_THAT(arguments, AllOf(Contains("-x"),
|
|
Contains("c++-header"),
|
|
Contains("-Xclang"),
|
|
Contains("-emit-pch"),
|
|
Contains("-o"),
|
|
Contains(EndsWith(".pch"))));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartClangCompilerArguments)
|
|
{
|
|
auto arguments = creator.generateProjectPartClangCompilerArguments(projectPart1);
|
|
|
|
ASSERT_THAT(arguments, AllOf(Contains(TESTDATA_DIR),
|
|
Contains("-emit-pch"),
|
|
Contains("-o"),
|
|
Not(Contains(environment.clangCompilerPath()))));
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, IncludesForCreatePchsForProjectParts)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
ASSERT_THAT(creator.takeProjectIncludes().id, "project1");
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, ProjectPartPchsSendToPchManagerClient)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
EXPECT_CALL(mockPchManagerClient,
|
|
precompiledHeadersUpdated(
|
|
Field(&ClangBackEnd::PrecompiledHeadersUpdatedMessage::projectPartPchs,
|
|
ElementsAre(Eq(creator.projectPartPch())))));
|
|
|
|
creator.doInMainThreadAfterFinished();
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, UpdateFileWatcherIncludes)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
EXPECT_CALL(mockClangPathWatcher,
|
|
updateIdPaths(ElementsAre(creator.projectIncludes())));
|
|
|
|
creator.doInMainThreadAfterFinished();
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, IdPathsForCreatePchsForProjectParts)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
ASSERT_THAT(creator.takeProjectIncludes(),
|
|
AllOf(Field(&IdPaths::id, "project1"),
|
|
Field(&IdPaths::filePathIds, AllOf(Contains(id(TESTDATA_DIR "/builddependencycollector/project/header2.h")),
|
|
Contains(id(TESTDATA_DIR "/builddependencycollector/external/external1.h")),
|
|
Contains(id(TESTDATA_DIR "/builddependencycollector/external/external2.h"))))));
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, ProjectPartPchForCreatesPchForProjectPart)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
ASSERT_THAT(creator.projectPartPch(),
|
|
AllOf(Field(&ProjectPartPch::projectPartId, Eq("project1")),
|
|
Field(&ProjectPartPch::pchPath, Not(IsEmpty())),
|
|
Field(&ProjectPartPch::lastModified, Not(Eq(-1)))));
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, ProjectPartPchCleared)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
creator.clear();
|
|
|
|
ASSERT_THAT(creator.projectPartPch(), ClangBackEnd::ProjectPartPch{});
|
|
}
|
|
|
|
|
|
TEST_F(PchCreatorVerySlowTest, ProjectIncludesCleared)
|
|
{
|
|
creator.generatePch(projectPart1);
|
|
|
|
creator.clear();
|
|
|
|
ASSERT_THAT(creator.projectIncludes(), ClangBackEnd::IdPaths{});
|
|
}
|
|
|
|
TEST_F(PchCreatorVerySlowTest, FaultyProjectPartPchForCreatesNoPchForProjectPart)
|
|
{
|
|
ProjectPartContainer faultyProjectPart{"faultyProject",
|
|
{"-I", TESTDATA_DIR},
|
|
{{"DEFINE", "1"}},
|
|
{"/includes"},
|
|
{},
|
|
{id(TESTDATA_DIR "/builddependencycollector/project/faulty.cpp")}};
|
|
|
|
creator.generatePch(faultyProjectPart);
|
|
|
|
ASSERT_THAT(creator.projectPartPch(),
|
|
AllOf(Field(&ProjectPartPch::projectPartId, Eq("faultyProject")),
|
|
Field(&ProjectPartPch::pchPath, IsEmpty()),
|
|
Field(&ProjectPartPch::lastModified, Eq(-1))));
|
|
}
|
|
|
|
TEST_F(PchCreator, CreateProjectPartSourcesContent)
|
|
{
|
|
auto content = creator.generateProjectPartSourcesContent(projectPart1);
|
|
|
|
ASSERT_THAT(content, Eq("#include \"" TESTDATA_DIR "/builddependencycollector/project/main3.cpp\"\n"));
|
|
}
|
|
|
|
TEST_F(PchCreator, Call)
|
|
{
|
|
auto content = creator.generateProjectPartSourcesContent(projectPart1);
|
|
|
|
ASSERT_THAT(content, Eq("#include \"" TESTDATA_DIR "/builddependencycollector/project/main3.cpp\"\n"));
|
|
}
|
|
|
|
}
|