qt-creator/tests/unit/unittest/builddependenciesstorage-test.cpp

/****************************************************************************
**
** Copyright (C) 2017 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 "mockfilepathcaching.h"
#include "sqlitedatabasemock.h"

#include <builddependenciesstorage.h>
#include <refactoringdatabaseinitializer.h>
#include <sqlitedatabase.h>
#include <sqlitereadstatement.h>
#include <sqlitewritestatement.h>

#include <utils/optional.h>

namespace {

using ClangBackEnd::FilePathCachingInterface;
using ClangBackEnd::FilePathId;
using ClangBackEnd::ProjectPartId;
using ClangBackEnd::SourceEntries;
using ClangBackEnd::SourceType;
using ClangBackEnd::UsedMacro;
using Sqlite::Database;
using Sqlite::Table;
using Utils::PathString;

using Storage = ClangBackEnd::BuildDependenciesStorage<SqliteDatabaseMock>;

class BuildDependenciesStorage : public testing::Test
{
protected:
    NiceMock<SqliteDatabaseMock> databaseMock;
    template<int ResultCount>
    using ReadStatement = NiceMock<SqliteDatabaseMock>::ReadStatement<ResultCount>;
    using WriteStatement = NiceMock<SqliteDatabaseMock>::WriteStatement;
    Storage storage{databaseMock};
    WriteStatement &insertIntoNewUsedMacrosStatement = storage.insertIntoNewUsedMacrosStatement;
    WriteStatement &syncNewUsedMacrosStatement = storage.syncNewUsedMacrosStatement;
    WriteStatement &deleteOutdatedUsedMacrosStatement = storage.deleteOutdatedUsedMacrosStatement;
    WriteStatement &deleteNewUsedMacrosTableStatement = storage.deleteNewUsedMacrosTableStatement;
    WriteStatement &insertOrUpdateFileStatusesStatement = storage.insertOrUpdateFileStatusesStatement;
    WriteStatement &insertIntoNewSourceDependenciesStatement = storage.insertIntoNewSourceDependenciesStatement;
    WriteStatement &syncNewSourceDependenciesStatement = storage.syncNewSourceDependenciesStatement;
    WriteStatement &deleteOutdatedSourceDependenciesStatement = storage.deleteOutdatedSourceDependenciesStatement;
    WriteStatement &deleteNewSourceDependenciesStatement = storage.deleteNewSourceDependenciesStatement;
    ReadStatement<1> &getLowestLastModifiedTimeOfDependencies = storage.getLowestLastModifiedTimeOfDependencies;
    WriteStatement &insertOrUpdateProjectPartsFilesStatement = storage.insertOrUpdateProjectPartsFilesStatement;
    ReadStatement<4> &fetchSourceDependenciesStatement = storage.fetchSourceDependenciesStatement;
    ReadStatement<1> &fetchProjectPartIdStatement = storage.fetchProjectPartIdStatement;
    ReadStatement<2> &fetchUsedMacrosStatement = storage.fetchUsedMacrosStatement;
    WriteStatement &insertProjectPartNameStatement = storage.insertProjectPartNameStatement;
    WriteStatement &updatePchCreationTimeStampStatement = storage.updatePchCreationTimeStampStatement;
    WriteStatement &deleteAllProjectPartsFilesWithProjectPartNameStatement
        = storage.deleteAllProjectPartsFilesWithProjectPartNameStatement;
    ReadStatement<1> &fetchPchSourcesStatement = storage.fetchPchSourcesStatement;
    ReadStatement<1> &fetchSourcesStatement = storage.fetchSourcesStatement;
    WriteStatement &inserOrUpdateIndexingTimesStampStatement = storage.inserOrUpdateIndexingTimesStampStatement;
    ReadStatement<2> &fetchIndexingTimeStampsStatement = storage.fetchIndexingTimeStampsStatement;
    ReadStatement<2> &fetchIncludedIndexingTimeStampsStatement = storage.fetchIncludedIndexingTimeStampsStatement;
    ReadStatement<1> &fetchDependentSourceIdsStatement = storage.fetchDependentSourceIdsStatement;
};

TEST_F(BuildDependenciesStorage, ConvertStringsToJson)
{
    Utils::SmallStringVector strings{"foo", "bar", "foo"};

    auto jsonText = storage.toJson(strings);

    ASSERT_THAT(jsonText, Eq("[\"foo\",\"bar\",\"foo\"]"));
}

TEST_F(BuildDependenciesStorage, InsertOrUpdateUsedMacros)
{
    InSequence sequence;

    EXPECT_CALL(insertIntoNewUsedMacrosStatement,
                write(TypedEq<int>(42), TypedEq<Utils::SmallStringView>("FOO")));
    EXPECT_CALL(insertIntoNewUsedMacrosStatement,
                write(TypedEq<int>(43), TypedEq<Utils::SmallStringView>("BAR")));
    EXPECT_CALL(syncNewUsedMacrosStatement, execute());
    EXPECT_CALL(deleteOutdatedUsedMacrosStatement, execute());
    EXPECT_CALL(deleteNewUsedMacrosTableStatement, execute());

    storage.insertOrUpdateUsedMacros({{"FOO", 42}, {"BAR", 43}});
}

TEST_F(BuildDependenciesStorage, InsertOrUpdateFileStatuses)
{
    EXPECT_CALL(insertOrUpdateFileStatusesStatement,
                write(TypedEq<int>(42), TypedEq<off_t>(1), TypedEq<time_t>(2)));
    EXPECT_CALL(insertOrUpdateFileStatusesStatement,
                write(TypedEq<int>(43), TypedEq<off_t>(4), TypedEq<time_t>(5)));

    storage.insertOrUpdateFileStatuses({{42, 1, 2}, {43, 4, 5}});
}

TEST_F(BuildDependenciesStorage, InsertOrUpdateSourceDependencies)
{
    InSequence sequence;

    EXPECT_CALL(insertIntoNewSourceDependenciesStatement, write(TypedEq<int>(42), TypedEq<int>(1)));
    EXPECT_CALL(insertIntoNewSourceDependenciesStatement, write(TypedEq<int>(42), TypedEq<int>(2)));
    EXPECT_CALL(syncNewSourceDependenciesStatement, execute());
    EXPECT_CALL(deleteOutdatedSourceDependenciesStatement, execute());
    EXPECT_CALL(deleteNewSourceDependenciesStatement, execute());

    storage.insertOrUpdateSourceDependencies({{42, 1}, {42, 2}});
}

TEST_F(BuildDependenciesStorage, AddTablesInConstructor)
{
    InSequence s;

    EXPECT_CALL(databaseMock, immediateBegin());
    EXPECT_CALL(databaseMock,
                execute(
                    Eq("CREATE TEMPORARY TABLE newUsedMacros(sourceId INTEGER, macroName TEXT)")));
    EXPECT_CALL(databaseMock,
                execute(Eq("CREATE INDEX IF NOT EXISTS index_newUsedMacros_sourceId_macroName ON "
                           "newUsedMacros(sourceId, macroName)")));
    EXPECT_CALL(databaseMock,
                execute(Eq("CREATE TEMPORARY TABLE newSourceDependencies(sourceId INTEGER, "
                           "dependencySourceId TEXT)")));
    EXPECT_CALL(
        databaseMock,
        execute(
            Eq("CREATE INDEX IF NOT EXISTS index_newSourceDependencies_sourceId_dependencySourceId "
               "ON newSourceDependencies(sourceId, dependencySourceId)")));
    EXPECT_CALL(databaseMock, commit());

    Storage storage{databaseMock};
}

TEST_F(BuildDependenciesStorage, FetchLowestLastModifiedTimeIfNoModificationTimeExists)
{
    EXPECT_CALL(getLowestLastModifiedTimeOfDependencies, valueReturnInt64(Eq(1)));

    auto lowestLastModified = storage.fetchLowestLastModifiedTime(1);

    ASSERT_THAT(lowestLastModified, Eq(0));
}

TEST_F(BuildDependenciesStorage, FetchLowestLastModifiedTime)
{
    EXPECT_CALL(getLowestLastModifiedTimeOfDependencies, valueReturnInt64(Eq(21)))
            .WillRepeatedly(Return(12));

    auto lowestLastModified = storage.fetchLowestLastModifiedTime(21);

    ASSERT_THAT(lowestLastModified, Eq(12));
}

TEST_F(BuildDependenciesStorage, AddNewUsedMacroTable)
{
    InSequence s;

    EXPECT_CALL(databaseMock,
                execute(
                    Eq("CREATE TEMPORARY TABLE newUsedMacros(sourceId INTEGER, macroName TEXT)")));
    EXPECT_CALL(databaseMock,
                execute(Eq("CREATE INDEX IF NOT EXISTS index_newUsedMacros_sourceId_macroName ON "
                           "newUsedMacros(sourceId, macroName)")));

    storage.createNewUsedMacrosTable();
}

TEST_F(BuildDependenciesStorage, AddNewSourceDependenciesTable)
{
    InSequence s;

    EXPECT_CALL(databaseMock,
                execute(Eq("CREATE TEMPORARY TABLE newSourceDependencies(sourceId INTEGER, "
                           "dependencySourceId TEXT)")));
    EXPECT_CALL(
        databaseMock,
        execute(
            Eq("CREATE INDEX IF NOT EXISTS index_newSourceDependencies_sourceId_dependencySourceId "
               "ON newSourceDependencies(sourceId, dependencySourceId)")));

    storage.createNewSourceDependenciesTable();
}

TEST_F(BuildDependenciesStorage, UpdateSources)
{
    InSequence s;
    SourceEntries entries{{1, SourceType::TopProjectInclude, 10, ClangBackEnd::HasMissingIncludes::Yes},
                          {2, SourceType::TopSystemInclude, 20}};

    EXPECT_CALL(deleteAllProjectPartsFilesWithProjectPartNameStatement, write(TypedEq<int>(22)));
    EXPECT_CALL(insertOrUpdateProjectPartsFilesStatement,
                write(TypedEq<int>(1), TypedEq<int>(22), TypedEq<uchar>(0), TypedEq<uchar>(1)));
    EXPECT_CALL(insertOrUpdateProjectPartsFilesStatement,
                write(TypedEq<int>(2), TypedEq<int>(22), TypedEq<uchar>(1), TypedEq<uchar>(0)));

    storage.insertOrUpdateSources(entries, 22);
}

TEST_F(BuildDependenciesStorage, UpdatePchCreationTimeStamp)
{
    InSequence s;

    EXPECT_CALL(databaseMock, immediateBegin());
    EXPECT_CALL(updatePchCreationTimeStampStatement, write(TypedEq<long long>(101), TypedEq<int>(1)));
    EXPECT_CALL(databaseMock, commit());

    storage.updatePchCreationTimeStamp(101, 1);
}

TEST_F(BuildDependenciesStorage, CallsFetchDependSources)
{
    EXPECT_CALL(fetchSourceDependenciesStatement, valuesReturnSourceEntries(_, 22, 20));

    storage.fetchDependSources(22, 20);
}

TEST_F(BuildDependenciesStorage, FetchDependSources)
{
    SourceEntries sourceEntries{{1, SourceType::TopProjectInclude, 10}, {2, SourceType::TopSystemInclude, 20}};
    EXPECT_CALL(fetchSourceDependenciesStatement, valuesReturnSourceEntries(_, 22, 20)).WillOnce(Return(sourceEntries));

    auto entries = storage.fetchDependSources(22, 20);

    ASSERT_THAT(entries, sourceEntries);
}

TEST_F(BuildDependenciesStorage, CallsFetchUsedMacros)
{
    EXPECT_CALL(fetchUsedMacrosStatement, valuesReturnUsedMacros(_, 22));

    storage.fetchUsedMacros(22);
}

TEST_F(BuildDependenciesStorage, FetchUsedMacros)
{
    ClangBackEnd::UsedMacros result{UsedMacro{"YI", 1}, UsedMacro{"ER", 2}};
    EXPECT_CALL(fetchUsedMacrosStatement, valuesReturnUsedMacros(_, 22)).WillOnce(Return(result));

    auto usedMacros = storage.fetchUsedMacros(22);

    ASSERT_THAT(usedMacros, result);
}

TEST_F(BuildDependenciesStorage, FetchPchSources)
{
    ClangBackEnd::FilePathIds result{3, 5, 7};
    EXPECT_CALL(fetchPchSourcesStatement, valuesReturnFilePathIds(_, 22)).WillOnce(Return(result));

    auto sources = storage.fetchPchSources(22);

    ASSERT_THAT(sources, result);
}

TEST_F(BuildDependenciesStorage, FetchPchSourcesCalls)
{
    InSequence s;

    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchPchSourcesStatement, valuesReturnFilePathIds(_, 22));
    EXPECT_CALL(databaseMock, commit());

    auto sources = storage.fetchPchSources(22);
}

TEST_F(BuildDependenciesStorage, FetchPchSourcesCallsIsBusy)
{
    InSequence s;

    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchPchSourcesStatement, valuesReturnFilePathIds(_, 22))
        .WillOnce(Throw(Sqlite::StatementIsBusy{""}));
    EXPECT_CALL(databaseMock, rollback());
    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchPchSourcesStatement, valuesReturnFilePathIds(_, 22));
    EXPECT_CALL(databaseMock, commit());

    auto sources = storage.fetchPchSources(22);
}

TEST_F(BuildDependenciesStorage, FetchSources)
{
    ClangBackEnd::FilePathIds result{3, 5, 7};
    EXPECT_CALL(fetchSourcesStatement, valuesReturnFilePathIds(_, 22)).WillOnce(Return(result));

    auto sources = storage.fetchSources(22);

    ASSERT_THAT(sources, result);
}

TEST_F(BuildDependenciesStorage, FetchIndexingTimeStampsIsBusy)
{
    InSequence s;

    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchIndexingTimeStampsStatement, valuesReturnSourceTimeStamps(1024))
        .WillOnce(Throw(Sqlite::StatementIsBusy{""}));
    EXPECT_CALL(databaseMock, rollback());
    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchIndexingTimeStampsStatement, valuesReturnSourceTimeStamps(1024));
    EXPECT_CALL(databaseMock, commit());

    storage.fetchIndexingTimeStamps();
}

TEST_F(BuildDependenciesStorage, InsertIndexingTimeStampWithoutTransaction)
{
    InSequence s;

    EXPECT_CALL(databaseMock, immediateBegin()).Times(0);
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(1), TypedEq<long long>(34)));
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(2), TypedEq<long long>(34)));
    EXPECT_CALL(databaseMock, commit()).Times(0);

    storage.insertOrUpdateIndexingTimeStampsWithoutTransaction({1, 2}, 34);
}

TEST_F(BuildDependenciesStorage, InsertIndexingTimeStamp)
{
    InSequence s;

    EXPECT_CALL(databaseMock, immediateBegin());
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(1), TypedEq<long long>(34)));
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(2), TypedEq<long long>(34)));
    EXPECT_CALL(databaseMock, commit());

    storage.insertOrUpdateIndexingTimeStamps({1, 2}, 34);
}

TEST_F(BuildDependenciesStorage, InsertIndexingTimeStampsIsBusy)
{
    InSequence s;

    EXPECT_CALL(databaseMock, immediateBegin()).WillOnce(Throw(Sqlite::StatementIsBusy{""}));
    EXPECT_CALL(databaseMock, immediateBegin());
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(1), TypedEq<long long>(34)));
    EXPECT_CALL(inserOrUpdateIndexingTimesStampStatement,
                write(TypedEq<int>(2), TypedEq<long long>(34)));
    EXPECT_CALL(databaseMock, commit());

    storage.insertOrUpdateIndexingTimeStamps({1, 2}, 34);
}

TEST_F(BuildDependenciesStorage, FetchIncludedIndexingTimeStampsIsBusy)
{
    InSequence s;

    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchIncludedIndexingTimeStampsStatement,
                valuesReturnSourceTimeStamps(1024, TypedEq<int>(1)))
        .WillOnce(Throw(Sqlite::StatementIsBusy{""}));
    EXPECT_CALL(databaseMock, rollback());
    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchIncludedIndexingTimeStampsStatement,
                valuesReturnSourceTimeStamps(1024, TypedEq<int>(1)));
    EXPECT_CALL(databaseMock, commit());

    storage.fetchIncludedIndexingTimeStamps(1);
}

TEST_F(BuildDependenciesStorage, FetchDependentSourceIdsIsBusy)
{
    InSequence s;

    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchDependentSourceIdsStatement, valuesReturnFilePathIds(1024, TypedEq<int>(3)));
    EXPECT_CALL(fetchDependentSourceIdsStatement, valuesReturnFilePathIds(1024, TypedEq<int>(2)))
        .WillOnce(Throw(Sqlite::StatementIsBusy{""}));
    EXPECT_CALL(databaseMock, rollback());
    EXPECT_CALL(databaseMock, deferredBegin());
    EXPECT_CALL(fetchDependentSourceIdsStatement, valuesReturnFilePathIds(1024, TypedEq<int>(3)));
    EXPECT_CALL(fetchDependentSourceIdsStatement, valuesReturnFilePathIds(1024, TypedEq<int>(2)));
    EXPECT_CALL(fetchDependentSourceIdsStatement, valuesReturnFilePathIds(1024, TypedEq<int>(7)));
    EXPECT_CALL(databaseMock, commit());

    storage.fetchDependentSourceIds({3, 2, 7});
}

class BuildDependenciesStorageSlow : public testing::Test
{
protected:
    Sqlite::Database database{":memory:", Sqlite::JournalMode::Memory};
    ClangBackEnd::RefactoringDatabaseInitializer<Sqlite::Database> databaseInitializer{database};
    ClangBackEnd::BuildDependenciesStorage<> storage{database};
};

TEST_F(BuildDependenciesStorageSlow, InsertIndexingTimeStamps)
{
    storage.insertOrUpdateIndexingTimeStamps({1, 2}, 34);

    ASSERT_THAT(storage.fetchIndexingTimeStamps(),
                ElementsAre(SourceTimeStamp{1, 34}, SourceTimeStamp{2, 34}));
}

TEST_F(BuildDependenciesStorageSlow, UpdateIndexingTimeStamps)
{
    storage.insertOrUpdateIndexingTimeStamps({1, 2}, 34);

    storage.insertOrUpdateIndexingTimeStamps({1}, 37);

    ASSERT_THAT(storage.fetchIndexingTimeStamps(),
                ElementsAre(SourceTimeStamp{1, 37}, SourceTimeStamp{2, 34}));
}

TEST_F(BuildDependenciesStorageSlow, UpdateIndexingTimeStamp)
{
    storage.insertOrUpdateIndexingTimeStamps({1, 2}, 34);

    storage.insertOrUpdateIndexingTimeStamps({2}, 37);

    ASSERT_THAT(storage.fetchIndexingTimeStamps(),
                ElementsAre(SourceTimeStamp{1, 34}, SourceTimeStamp{2, 37}));
}

TEST_F(BuildDependenciesStorageSlow, FetchIncludedIndexingTimeStamps)
{
    storage.insertOrUpdateIndexingTimeStamps({1, 2, 3, 4, 5}, 34);
    storage.insertOrUpdateSourceDependencies({{1, 2}, {1, 3}, {2, 3}, {3, 4}, {5, 3}});

    auto timeStamps = storage.fetchIncludedIndexingTimeStamps(1);

    ASSERT_THAT(timeStamps,
                ElementsAre(SourceTimeStamp{1, 34},
                            SourceTimeStamp{2, 34},
                            SourceTimeStamp{3, 34},
                            SourceTimeStamp{4, 34}));
}

TEST_F(BuildDependenciesStorageSlow, FetchDependentSourceIds)
{
    storage.insertOrUpdateSourceDependencies({{1, 2}, {1, 3}, {2, 3}, {4, 2}, {5, 6}, {7, 6}});

    auto sourceIds = storage.fetchDependentSourceIds({3, 2, 7});

    ASSERT_THAT(sourceIds, ElementsAre(FilePathId{1}, FilePathId{4}, FilePathId{7}));
}
} // namespace