projectmanagerdecorator.test.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  qt-mvvm: Model-view-view-model framework for large GUI applications
//
//! @file      mvvm/tests/testmodel/projectmanagerdecorator.test.cpp
//! @brief     Implements class CLASS?
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2020
//! @authors   Gennady Pospelov et al, Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "folderbasedtest.h"
#include "google_test.h"
#include "mvvm/model/propertyitem.h"
#include "mvvm/model/sessionmodel.h"
#include "mvvm/project/project_types.h"
#include "mvvm/project/projectmanagerdecorator.h"
#include "mvvm/utils/fileutils.h"
#include <cctype>
 
using namespace ModelView;
 
namespace {
const std::string samplemodel_name = "samplemodel";
 
} // namespace
 
//! Tests for ProjectManager class.
 
class ProjectManagerDecoratorTest : public FolderBasedTest {
public:
    ProjectManagerDecoratorTest()
        : FolderBasedTest("test_ProjectManagerDecorator")
        , sample_model(std::make_unique<ModelView::SessionModel>(samplemodel_name))
    {
    }
    ~ProjectManagerDecoratorTest();
 
    std::vector<SessionModel*> models() const { return {sample_model.get()}; };
 
    ProjectContext projectContext()
    {
        ProjectContext result;
        result.m_models_callback = [this]() { return models(); };
        return result;
    }
 
    UserInteractionContext userContext(const std::string& create_dir = {},
                                       const std::string& select_dir = {})
    {
        UserInteractionContext result;
        result.m_create_dir_callback = [create_dir]() -> std::string { return create_dir; };
        result.m_select_dir_callback = [select_dir]() -> std::string { return select_dir; };
        return result;
    }
 
    std::unique_ptr<SessionModel> sample_model;
};
 
ProjectManagerDecoratorTest::~ProjectManagerDecoratorTest() = default;
 
//! Initial state of ProjectManager. Project created, and not-saved.
 
TEST_F(ProjectManagerDecoratorTest, initialState)
{
    ProjectManagerDecorator manager(projectContext(), userContext());
    EXPECT_TRUE(manager.currentProjectDir().empty());
}
 
//! Starting from new document (without project dir defined).
//! Create new project in given directory.
 
TEST_F(ProjectManagerDecoratorTest, untitledEmptyCreateNew)
{
    const auto project_dir = createEmptyDir("Project_untitledEmptyCreateNew");
 
    ProjectManagerDecorator manager(projectContext(), userContext(project_dir, {}));
    EXPECT_TRUE(manager.currentProjectDir().empty());
 
    // saving new project to 'project_dir' directory.
    EXPECT_TRUE(manager.createNewProject());
 
    // checking that current projectDir has pointing to the right place
    EXPECT_EQ(manager.currentProjectDir(), project_dir);
 
    // project directory should contain a json file with the model
    auto model_json = Utils::join(project_dir, samplemodel_name + ".json");
    EXPECT_TRUE(Utils::exists(model_json));
}
 
//! Starting from new document (without project dir defined).
//! Saving project. Same behavior as SaveAs.
 
TEST_F(ProjectManagerDecoratorTest, untitledEmptySaveCurrentProject)
{
    const auto project_dir = createEmptyDir("Project_untitledEmptySaveCurrentProject");
 
    ProjectManagerDecorator manager(projectContext(), userContext(project_dir, {}));
    EXPECT_TRUE(manager.currentProjectDir().empty());
 
    // saving new project to 'project_dir' directory.
    EXPECT_TRUE(manager.saveCurrentProject());
 
    // checking thaxt current projectDir has pointing to the right place
    EXPECT_EQ(manager.currentProjectDir(), project_dir);
 
    // project directory should contain a json file with the model
    auto model_json = Utils::join(project_dir, samplemodel_name + ".json");
    EXPECT_TRUE(Utils::exists(model_json));
}
 
//! Starting from new document (without project dir defined).
//! Save under given name.
 
TEST_F(ProjectManagerDecoratorTest, untitledEmptySaveAs)
{
    const auto project_dir = createEmptyDir("Project_untitledEmptySaveAs");
 
    ProjectManagerDecorator manager(projectContext(), userContext(project_dir, {}));
    EXPECT_TRUE(manager.currentProjectDir().empty());
 
    // saving new project to "project_dir" directory.
    EXPECT_TRUE(manager.saveProjectAs());
 
    // checking that current projectDir has pointing to the right place
    EXPECT_EQ(manager.currentProjectDir(), project_dir);
 
    // project directory should contain a json file with the model
    auto model_json = Utils::join(project_dir, samplemodel_name + ".json");
    EXPECT_TRUE(Utils::exists(model_json));
}
 
//! Starting from new document (without project dir defined).
//! Attempt to save under empty name, immitating the user canceled directory selection dialog.
 
TEST_F(ProjectManagerDecoratorTest, untitledEmptySaveAsCancel)
{
    ProjectManagerDecorator manager(projectContext(), userContext({}, {})); // immitates canceling
    EXPECT_TRUE(manager.currentProjectDir().empty());
 
    // saving new project to "project_dir" directory.
    EXPECT_FALSE(manager.saveProjectAs());
    EXPECT_TRUE(manager.currentProjectDir().empty());
}
 
//! Starting from new document (without project dir defined).
//! Attempt to save in the non-existing directory.
 
TEST_F(ProjectManagerDecoratorTest, untitledEmptySaveAsWrongDir)
{
    ProjectManagerDecorator manager(projectContext(), userContext("non-existing", {}));
 
    // saving new project to "project_dir" directory.
    EXPECT_FALSE(manager.saveProjectAs());
    EXPECT_TRUE(manager.currentProjectDir().empty());
}
 
//! Untitled, modified document. Attempt to open existing project will lead to
//! the dialog save/discard/cancel. As a result of whole exersize, existing project
//! should be opened, previous project saved.
 
TEST_F(ProjectManagerDecoratorTest, untitledModifiedOpenExisting)
{
    const auto existing_project_dir = createEmptyDir("Project_untitledModifiedOpenExisting1");
    const auto unsaved_project_dir = createEmptyDir("Project_untitledModifiedOpenExisting2");
 
    // create "existing project"
    {
        ProjectManagerDecorator manager(projectContext(), userContext(existing_project_dir, {}));
        manager.saveProjectAs();
    }
 
    // preparing manager with untitled, unmodified project
    auto open_dir = [&existing_project_dir]() -> std::string { return existing_project_dir; };
    auto create_dir = [&unsaved_project_dir]() -> std::string { return unsaved_project_dir; };
    auto result = SaveChangesAnswer::DISCARD;
    auto ask_create = [&result]() {
        result = SaveChangesAnswer::SAVE;
        return SaveChangesAnswer::SAVE;
    };
    auto user_context = userContext({}, {});
    user_context.m_create_dir_callback = create_dir;
    user_context.m_select_dir_callback = open_dir;
    user_context.m_answer_callback = ask_create;
    ProjectManagerDecorator manager(projectContext(), user_context);
 
    // modifying untitled project
    sample_model->insertItem<PropertyItem>();
    EXPECT_TRUE(manager.isModified());
    EXPECT_TRUE(manager.currentProjectDir().empty());
 
    // attempt to open existing project
    manager.openExistingProject();
 
    // check if user was asked and his answer coincide with expectation
    EXPECT_EQ(result, SaveChangesAnswer::SAVE);
 
    // check that previous project was saved
    auto model_json = Utils::join(unsaved_project_dir, samplemodel_name + ".json");
    EXPECT_TRUE(Utils::exists(model_json));
 
    // currently manager is pointing to existing project
    EXPECT_FALSE(manager.isModified());
    EXPECT_EQ(manager.currentProjectDir(), existing_project_dir);
}