itemmapper.test.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  qt-mvvm: Model-view-view-model framework for large GUI applications
//
//! @file      mvvm/tests/testmodel/itemmapper.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 "google_test.h"
#include "mockwidgets.h"
#include "mvvm/model/compounditem.h"
#include "mvvm/model/sessionitem.h"
#include "mvvm/model/sessionmodel.h"
#include "mvvm/signals/itemmapper.h"
#include <stdexcept>
 
using namespace ModelView;
using ::testing::_;
 
class ItemMapperTest : public ::testing::Test {
public:
    ~ItemMapperTest();
};
 
ItemMapperTest::~ItemMapperTest() = default;
 
//! Check that mapper works only in model context.
 
TEST(ItemMapperTest, initialState)
{
    // item outside model context can't have a mapper
    auto item = std::make_unique<SessionItem>();
    EXPECT_THROW(item->mapper(), std::runtime_error);
 
    // item in model context does have a mapper
    SessionModel model;
    auto item2 = model.insertItem<SessionItem>(model.rootItem());
    EXPECT_NO_THROW(item2->mapper());
}
 
//! Destroying item, expecting single call of onItemDestroy in MockWidget.
 
TEST(ItemMapperTest, onItemDestroy)
{
    SessionModel model;
    auto item = model.insertItem<SessionItem>(model.rootItem());
 
    MockWidgetForItem widget(item);
 
    auto expected_item = item;
    EXPECT_CALL(widget, onItemDestroy(expected_item)).Times(1);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // performing action
    model.removeItem(model.rootItem(), {"", 0});
}
 
//! Setting data to item, expecting onDataChange callback.
 
TEST(ItemMapperTest, onDataChange)
{
    SessionModel model;
    auto item = model.insertItem<SessionItem>(model.rootItem());
 
    MockWidgetForItem widget(item);
 
    auto expected_role = ItemDataRole::DATA;
    auto expected_item = item;
    EXPECT_CALL(widget, onDataChange(expected_item, expected_role)).Times(1);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform action
    item->setData(42.0);
}
 
//! Setting same data to item, expecting no callbacks on onDataChange.
 
TEST(ItemMapperTest, onDataChangeDuplicate)
{
    SessionModel model;
    auto item = model.insertItem<SessionItem>(model.rootItem());
 
    MockWidgetForItem widget(item);
 
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(1);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform actions, only one call should be triggered
    item->setData(42.0);
    item->setData(42.0); // same data
}
 
//! Setting mapper activity to false, change the data, expect no callbacks.
 
TEST(ItemMapperTest, setActivity)
{
    SessionModel model;
    auto item = model.insertItem<SessionItem>(model.rootItem());
 
    MockWidgetForItem widget(item);
 
    item->mapper()->setActive(false);
 
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform actions, no calls should be triggered
    item->setData(42.0);
}
 
//! Unsubscribing from item, expecting no callbacks.
 
TEST(ItemMapperTest, unsubscribe)
{
    SessionModel model;
    auto item = model.insertItem<SessionItem>(model.rootItem());
 
    MockWidgetForItem widget1(item);
    MockWidgetForItem widget2(item);
 
    item->mapper()->unsubscribe(&widget1);
 
    EXPECT_CALL(widget1, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget2, onDataChange(_, _)).Times(1);
 
    // perform action, only one widget should be triggered
    item->setData(42.0);
}
 
//! Changing item property.
 
TEST(ItemMapperTest, onPropertyChange)
{
    SessionModel model;
    auto item = model.insertItem<CompoundItem>();
    EXPECT_TRUE(item != nullptr);
 
    auto property = item->addProperty("height", 42.0);
 
    MockWidgetForItem widget(item);
 
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(item, "height")).Times(1);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform action
    item->setProperty("height", 43.0);
    EXPECT_EQ(item->property<double>("height"), 43.0);
    EXPECT_EQ(property->data<double>(), 43.0);
}
 
//! Changing item property.
 
TEST(ItemMapperTest, onChildPropertyChange)
{
    SessionModel model;
    auto compound1 = model.insertItem<CompoundItem>();
    compound1->registerTag(TagInfo::universalTag("tag1"), /*set_as_default*/ true);
    auto compound2 = model.insertItem<CompoundItem>(compound1);
 
    auto property = compound2->addProperty("height", 42.0);
 
    MockWidgetForItem widget(compound1);
 
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(compound2, "height")).Times(1);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform action
    compound2->setProperty("height", 43.0);
    EXPECT_EQ(compound2->property<double>("height"), 43.0);
    EXPECT_EQ(property->data<double>(), 43.0);
}
 
//! Inserting item to item.
 
TEST(ItemMapperTest, onItemInsert)
{
    SessionModel model;
    auto compound1 = model.insertItem<CompoundItem>();
    compound1->registerTag(TagInfo::universalTag("tag1"), /*set_as_default*/ true);
 
    MockWidgetForItem widget(compound1);
 
    const TagRow expected_tagrow{"tag1", 0};
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(compound1, expected_tagrow)).Times(1);
    EXPECT_CALL(widget, onItemRemoved(_, _)).Times(0);
    EXPECT_CALL(widget, onAboutToRemoveItem(_, _)).Times(0);
 
    // perform action
    model.insertItem<CompoundItem>(compound1, expected_tagrow);
}
 
//! Inserting item to item.
 
TEST(ItemMapperTest, onAboutToRemoveItem)
{
    const TagRow expected_tagrow = {"tag1", 0};
 
    SessionModel model;
    auto compound1 = model.insertItem<CompoundItem>();
    compound1->registerTag(TagInfo::universalTag("tag1"), /*set_as_default*/ true);
    model.insertItem<CompoundItem>(compound1, expected_tagrow);
 
    MockWidgetForItem widget(compound1);
 
    EXPECT_CALL(widget, onItemDestroy(_)).Times(0);
    EXPECT_CALL(widget, onDataChange(_, _)).Times(0);
    EXPECT_CALL(widget, onPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onChildPropertyChange(_, _)).Times(0);
    EXPECT_CALL(widget, onItemInserted(_, _)).Times(0);
    EXPECT_CALL(widget, onItemRemoved(compound1, expected_tagrow)).Times(1);
    EXPECT_CALL(widget, onAboutToRemoveItem(compound1, expected_tagrow)).Times(1);
 
    // perform action
    model.removeItem(compound1, expected_tagrow);
}