qt-creator/tests/unit/unittest/translationunittest.cpp

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 Digia.  For licensing terms and
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include <filecontainer.h>
#include <projectpart.h>
#include <projects.h>
#include <translationunitdoesnotexistexception.h>
#include <translationunitfilenotexitexception.h>
#include <translationunit.h>
#include <translationunitisnullexception.h>
#include <translationunitparseerrorexception.h>
#include <translationunits.h>
#include <unsavedfiles.h>
#include <utf8string.h>

#include <clang-c/Index.h>

#include <gmock/gmock.h>
#include <gmock/gmock-matchers.h>
#include <gtest/gtest.h>
#include "gtest-qt-printing.h"

#include <chrono>
#include <thread>


using ClangBackEnd::TranslationUnit;
using ClangBackEnd::UnsavedFiles;
using ClangBackEnd::ProjectPart;

using testing::IsNull;
using testing::NotNull;
using testing::Gt;

namespace {

TEST(TranslationUnit, DefaultTranslationUnitIsInvalid)
{
    TranslationUnit translationUnit;

    ASSERT_TRUE(translationUnit.isNull());
}

TEST(TranslationUnit, ThrowExceptionForNonExistingFilePath)
{
    ASSERT_THROW(TranslationUnit(Utf8StringLiteral("file.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile"))),
                 ClangBackEnd::TranslationUnitFileNotExitsException);
}

TEST(TranslationUnit, ThrowNoExceptionForNonExistingFilePathIfDoNotCheckIfFileExistsIsSet)
{
    ASSERT_NO_THROW(TranslationUnit(Utf8StringLiteral("file.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile")), TranslationUnit::DoNotCheckIfFileExists));
}

TEST(TranslationUnit, TranslationUnitIsValid)
{
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile")));

    ASSERT_FALSE(translationUnit.isNull());
}


TEST(TranslationUnit, ThrowExceptionForGettingIndexForInvalidUnit)
{
    TranslationUnit translationUnit;

    ASSERT_THROW(translationUnit.index(), ClangBackEnd::TranslationUnitIsNullException);
}

TEST(TranslationUnit, IndexGetterIsNonNullForValidUnit)
{
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile")));

    ASSERT_THAT(translationUnit.index(), NotNull());
}

TEST(TranslationUnit, ThrowExceptionForGettingCxTranslationUnitForInvalidUnit)
{
    TranslationUnit translationUnit;

    ASSERT_THROW(translationUnit.cxTranslationUnit(), ClangBackEnd::TranslationUnitIsNullException);
}

TEST(TranslationUnit, CxTranslationUnitGetterIsNonNullForValidUnit)
{
    UnsavedFiles unsavedFiles;
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), unsavedFiles, ProjectPart(Utf8StringLiteral("/path/to/projectfile")));

    ASSERT_THAT(translationUnit.cxTranslationUnit(), NotNull());
}

TEST(TranslationUnit, ThrowExceptionIfGettingFilePathForNullUnit)
{
    TranslationUnit translationUnit;

    ASSERT_THROW(translationUnit.filePath(), ClangBackEnd::TranslationUnitIsNullException);
}

TEST(TranslationUnit, ResetedTranslationUnitIsNull)
{
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile")));

    translationUnit.reset();

    ASSERT_TRUE(translationUnit.isNull());
}

TEST(TranslationUnit, TimeStampForProjectPartChangeIsUpdatedAsNewCxTranslationUnitIsGenerated)
{
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), ProjectPart(Utf8StringLiteral("/path/to/projectfile")));
    auto lastChangeTimePoint = translationUnit.lastProjectPartChangeTimePoint();
    std::this_thread::sleep_for(std::chrono::steady_clock::duration(1));

    translationUnit.cxTranslationUnit();

    ASSERT_THAT(translationUnit.lastProjectPartChangeTimePoint(), Gt(lastChangeTimePoint));
}

TEST(TranslationUnit, TimeStampForProjectPartChangeIsUpdatedAsProjectPartIsCleared)
{
    ProjectPart projectPart(Utf8StringLiteral("/path/to/projectfile"));
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), projectPart);
    translationUnit.cxTranslationUnit();
    auto lastChangeTimePoint = translationUnit.lastProjectPartChangeTimePoint();
    std::this_thread::sleep_for(std::chrono::steady_clock::duration(1));

    projectPart.clear();
    translationUnit.cxTranslationUnit();

    ASSERT_THAT(translationUnit.lastProjectPartChangeTimePoint(), Gt(lastChangeTimePoint));
}

TEST(TranslationUnit, ReparseIsNeededAfterUnsavedFilesAreChanged)
{
    UnsavedFiles unsavedFiles;
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"),
                                    unsavedFiles,
                                    ProjectPart(Utf8StringLiteral("/path/to/projectfile")));
    translationUnit.cxTranslationUnit();
    unsavedFiles.clear();
    translationUnit.cxTranslationUnit();

    unsavedFiles.clear();

    ASSERT_TRUE(translationUnit.isNeedingReparse());
}

TEST(TranslationUnit, NeedsNoReparseAfterUnsavedFilesAreNotChanged)
{
    UnsavedFiles unsavedFiles;
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"),
                                    unsavedFiles,
                                    ProjectPart(Utf8StringLiteral("/path/to/projectfile")));
    translationUnit.cxTranslationUnit();
    unsavedFiles.clear();
    translationUnit.cxTranslationUnit();

    ASSERT_FALSE(translationUnit.isNeedingReparse());
}

TEST(TranslationUnit, TimeStampForUnsavedFilesChange)
{
    UnsavedFiles unsavedFiles;
    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"),
                                    unsavedFiles,
                                    ProjectPart(Utf8StringLiteral("/path/to/projectfile")));
    translationUnit.cxTranslationUnit();
    unsavedFiles.clear();
    translationUnit.cxTranslationUnit();
    auto lastChangeTimePoint = translationUnit.lastUnsavedFilesChangeTimePoint();
    std::this_thread::sleep_for(std::chrono::steady_clock::duration(1));

    unsavedFiles.clear();
    translationUnit.cxTranslationUnit();

    ASSERT_THAT(translationUnit.lastUnsavedFilesChangeTimePoint(), Gt(lastChangeTimePoint));
}


//TEST(TranslationUnit, ThrowParseErrorForWrongArguments)
//{
//    ProjectPart project(Utf8StringLiteral("/path/to/projectfile"));
//    project.setArguments({Utf8StringLiteral("-fblah")});
//    TranslationUnit translationUnit(Utf8StringLiteral(TESTDATA_DIR"/complete_testfile_1.cpp"), UnsavedFiles(), project);

//    ASSERT_THROW(translationUnit.cxTranslationUnit(), ClangBackEnd::TranslationUnitParseErrorException);
//}

}