// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.
using System.Linq;
using System.Windows.Forms;
using Core.Common.Base;
using Core.Common.Controls.TreeView;
using Core.Common.Gui;
using Core.Common.Gui.ContextMenu;
using Core.Common.Gui.TestUtil.ContextMenu;
using Core.Common.TestUtil;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.Calculation;
using Ringtoets.HeightStructures.Data;
using Ringtoets.HeightStructures.Forms.PresentationObjects;
using Ringtoets.HeightStructures.Plugin;
using CoreCommonGuiResources = Core.Common.Gui.Properties.Resources;
using RingtoetsFormsResources = Ringtoets.Common.Forms.Properties.Resources;
namespace Ringtoets.HeightStructures.Forms.Test.TreeNodeInfos
{
[TestFixture]
public class HeightStructuresCalculationGroupContextTreeNodeInfoTest
{
private IGui guiMock;
private TreeNodeInfo info;
private MockRepository mocks;
private HeightStructuresGuiPlugin plugin;
[SetUp]
public void SetUp()
{
mocks = new MockRepository();
guiMock = mocks.StrictMock();
plugin = new HeightStructuresGuiPlugin
{
Gui = guiMock
};
info = plugin.GetTreeNodeInfos().First(tni => tni.TagType == typeof(HeightStructuresCalculationGroupContext));
}
[Test]
public void Initialized_Always_ExpectedPropertiesSet()
{
// Assert
Assert.AreEqual(typeof(HeightStructuresCalculationGroupContext), info.TagType);
Assert.IsNotNull(info.Text);
Assert.IsNotNull(info.Image);
Assert.IsNotNull(info.EnsureVisibleOnCreate);
Assert.IsNotNull(info.ChildNodeObjects);
Assert.IsNotNull(info.ContextMenuStrip);
Assert.IsNotNull(info.CanRename);
Assert.IsNotNull(info.OnNodeRenamed);
Assert.IsNotNull(info.CanRemove);
Assert.IsNotNull(info.OnNodeRemoved);
Assert.IsNotNull(info.CanDrag);
Assert.IsNotNull(info.CanInsert);
Assert.IsNotNull(info.CanDrop);
Assert.IsNotNull(info.OnDrop);
Assert.IsNull(info.ForeColor);
Assert.IsNull(info.CanCheck);
Assert.IsNull(info.IsChecked);
Assert.IsNull(info.OnNodeChecked);
}
[Test]
public void ChildNodeObjects_EmptyGroup_ReturnEmpty()
{
// Setup
var group = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
mocks.ReplayAll();
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
// Call
var children = info.ChildNodeObjects(groupContext);
// Assert
CollectionAssert.IsEmpty(children);
mocks.VerifyAll();
}
[Test]
public void ChildNodeObjects_GroupWithMixedContents_ReturnChildren()
{
// Setup
var assessmentSectionMock = mocks.StrictMock();
var calculationItemMock = mocks.StrictMock();
mocks.ReplayAll();
var failureMechanism = new HeightStructuresFailureMechanism();
var group = new CalculationGroup();
var childGroup = new CalculationGroup();
var childCalculation = new HeightStructuresCalculation(failureMechanism.GeneralInput);
group.Children.Add(childGroup);
group.Children.Add(calculationItemMock);
group.Children.Add(childCalculation);
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
// Call
var children = info.ChildNodeObjects(groupContext).ToArray();
// Assert
Assert.AreEqual(group.Children.Count, children.Length);
var calculationGroupContext = (HeightStructuresCalculationGroupContext) children[0];
Assert.AreSame(childGroup, calculationGroupContext.WrappedData);
Assert.AreSame(failureMechanism, calculationGroupContext.FailureMechanism);
Assert.AreSame(assessmentSectionMock, calculationGroupContext.AssessmentSection);
Assert.AreSame(calculationItemMock, children[1]);
var calculationContext = (HeightStructuresCalculationContext) children[2];
Assert.AreSame(childCalculation, calculationContext.WrappedData);
Assert.AreSame(assessmentSectionMock, calculationContext.AssessmentSection);
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_WithoutParentNodeDefaultBehavior_CallsContextMenuBuilderMethods()
{
// Setup
var group = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var treeViewControlMock = mocks.StrictMock();
var menuBuilderMock = mocks.StrictMock();
menuBuilderMock.Expect(mb => mb.AddOpenItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddImportItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddExportItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddExpandAllItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCollapseAllItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddPropertiesItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.Build()).Return(null);
guiMock.Expect(cmp => cmp.Get(groupContext, treeViewControlMock)).Return(menuBuilderMock);
mocks.ReplayAll();
// Call
info.ContextMenuStrip(groupContext, null, treeViewControlMock);
// Assert
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_WithoutParentNodeDefaultBehavior_AddCustomItems()
{
// Setup
var group = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var treeViewControlMock = mocks.StrictMock();
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
guiMock.Expect(g => g.Get(groupContext, treeViewControlMock)).Return(menuBuilder);
mocks.ReplayAll();
// Call
ContextMenuStrip menu = info.ContextMenuStrip(groupContext, null, treeViewControlMock);
// Assert
Assert.AreEqual(9, menu.Items.Count);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuAddCalculationGroupIndexRootGroup,
RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup,
RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup_Tooltip,
RingtoetsFormsResources.AddFolderIcon);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuAddCalculationIndexRootGroup,
RingtoetsFormsResources.CalculationGroup_Add_Calculation,
RingtoetsFormsResources.CalculationGroup_Add_Calculation_Tooltip,
RingtoetsFormsResources.FailureMechanismIcon);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuCalculateAllIndexRootGroup,
RingtoetsFormsResources.Calculate_all,
RingtoetsFormsResources.CalculationGroup_CalculateAll_No_calculations_to_run,
RingtoetsFormsResources.CalculateIcon,
false);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuClearAllIndexRootGroup,
RingtoetsFormsResources.Clear_all_output,
RingtoetsFormsResources.CalculationGroup_ClearOutput_No_calculation_with_output_to_clear,
RingtoetsFormsResources.ClearIcon,
false);
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_NestedCalculationGroup_CallsContextMenuBuilderMethods()
{
// Setup
var group = new CalculationGroup();
var parentGroup = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var parentGroupContext = new HeightStructuresCalculationGroupContext(parentGroup,
failureMechanism,
assessmentSectionMock);
var treeViewControlMock = mocks.StrictMock();
var menuBuilderMock = mocks.StrictMock();
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddRenameItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddDeleteItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddImportItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddExportItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddExpandAllItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddCollapseAllItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddSeparator()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.AddPropertiesItem()).Return(menuBuilderMock);
menuBuilderMock.Expect(mb => mb.Build()).Return(null);
guiMock.Expect(cmp => cmp.Get(groupContext, treeViewControlMock)).Return(menuBuilderMock);
mocks.ReplayAll();
// Call
info.ContextMenuStrip(groupContext, parentGroupContext, treeViewControlMock);
// Assert
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_NestedCalculationGroup_AddCustomItems()
{
// Setup
var group = new CalculationGroup();
var parentGroup = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var groupContext = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var parentGroupContext = new HeightStructuresCalculationGroupContext(parentGroup,
failureMechanism,
assessmentSectionMock);
var treeViewControlMock = mocks.StrictMock();
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
guiMock.Expect(g => g.Get(groupContext, treeViewControlMock)).Return(menuBuilder);
mocks.ReplayAll();
// Call
ContextMenuStrip menu = info.ContextMenuStrip(groupContext, parentGroupContext, treeViewControlMock);
// Assert
Assert.AreEqual(9, menu.Items.Count);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuAddCalculationGroupIndexNestedGroup,
RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup,
RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup_Tooltip,
RingtoetsFormsResources.AddFolderIcon);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuAddCalculationIndexNestedGroup,
RingtoetsFormsResources.CalculationGroup_Add_Calculation,
RingtoetsFormsResources.CalculationGroup_Add_Calculation_Tooltip,
RingtoetsFormsResources.FailureMechanismIcon);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuCalculateAllIndexNestedGroup,
RingtoetsFormsResources.Calculate_all,
RingtoetsFormsResources.CalculationGroup_CalculateAll_No_calculations_to_run,
RingtoetsFormsResources.CalculateIcon,
false);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuClearAllIndexNestedGroup,
RingtoetsFormsResources.Clear_all_output,
RingtoetsFormsResources.CalculationGroup_ClearOutput_No_calculation_with_output_to_clear,
RingtoetsFormsResources.ClearIcon,
false);
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_ClickOnAddGroupItem_AddGroupToCalculationGroupAndNotifyObservers()
{
// Setup
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
var group = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var nodeData = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var calculationGroup = new CalculationGroup
{
Name = "Nieuwe map"
};
var observerMock = mocks.StrictMock();
var treeViewControlMock = mocks.StrictMock();
observerMock.Expect(o => o.UpdateObserver());
guiMock.Expect(cmp => cmp.Get(nodeData, treeViewControlMock)).Return(menuBuilder);
mocks.ReplayAll();
group.Children.Add(calculationGroup);
nodeData.Attach(observerMock);
ContextMenuStrip contextMenu = info.ContextMenuStrip(nodeData, null, treeViewControlMock);
// Precondition
Assert.AreEqual(1, group.Children.Count);
// Call
contextMenu.Items[contextMenuAddCalculationGroupIndexRootGroup].PerformClick();
// Assert
Assert.AreEqual(2, group.Children.Count);
var newlyAddedItem = group.Children.Last();
Assert.IsInstanceOf(newlyAddedItem);
Assert.AreEqual("Nieuwe map (1)", newlyAddedItem.Name,
"An item with the same name default name already exists, therefore '(1)' needs to be appended.");
mocks.VerifyAll();
}
[Test]
public void ContextMenuStrip_ClickOnAddCalculationItem_AddCalculationToCalculationGroupAndNotifyObservers()
{
// Setup
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
var group = new CalculationGroup();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var nodeData = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var calculation = new HeightStructuresCalculation(failureMechanism.GeneralInput)
{
Name = "Nieuwe berekening"
};
var observerMock = mocks.StrictMock();
var treeViewControlMock = mocks.StrictMock();
observerMock.Expect(o => o.UpdateObserver());
guiMock.Expect(cmp => cmp.Get(nodeData, treeViewControlMock)).Return(menuBuilder);
mocks.ReplayAll();
group.Children.Add(calculation);
nodeData.Attach(observerMock);
var contextMenu = info.ContextMenuStrip(nodeData, null, treeViewControlMock);
// Precondition
Assert.AreEqual(1, group.Children.Count);
// Call
contextMenu.Items[contextMenuAddCalculationIndexRootGroup].PerformClick();
// Assert
Assert.AreEqual(2, group.Children.Count);
var newlyAddedItem = group.Children.Last();
Assert.IsInstanceOf(newlyAddedItem);
Assert.AreEqual("Nieuwe berekening (1)", newlyAddedItem.Name,
"An item with the same name default name already exists, therefore '(1)' needs to be appended.");
mocks.VerifyAll();
}
[Test]
public void OnNodeRemoved_NestedCalculationGroup_RemoveGroupAndNotifyObservers()
{
// Setup
var observerMock = mocks.StrictMock();
var failureMechanism = new HeightStructuresFailureMechanism();
var assessmentSectionMock = mocks.StrictMock();
var group = new CalculationGroup();
var parentGroup = new CalculationGroup();
var nodeData = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var parentNodeData = new HeightStructuresCalculationGroupContext(parentGroup,
failureMechanism,
assessmentSectionMock);
observerMock.Expect(o => o.UpdateObserver());
mocks.ReplayAll();
parentGroup.Children.Add(group);
parentNodeData.Attach(observerMock);
// Precondition
Assert.IsTrue(info.CanRemove(nodeData, parentNodeData));
// Call
info.OnNodeRemoved(nodeData, parentNodeData);
// Assert
CollectionAssert.DoesNotContain(parentGroup.Children, group);
mocks.VerifyAll();
}
[Test]
public void OnNodeRemoved_NestedCalculationGroupContainingCalculations_RemoveGroupAndCalculationsAndNotifyObservers()
{
// Setup
var observerMock = mocks.StrictMock();
var assessmentSectionMock = mocks.StrictMock();
var failureMechanism = new HeightStructuresFailureMechanism();
var group = new CalculationGroup();
var parentGroup = new CalculationGroup();
var nodeData = new HeightStructuresCalculationGroupContext(group,
failureMechanism,
assessmentSectionMock);
var parentNodeData = new HeightStructuresCalculationGroupContext(parentGroup,
failureMechanism,
assessmentSectionMock);
var calculation = new HeightStructuresCalculation(failureMechanism.GeneralInput);
observerMock.Expect(o => o.UpdateObserver());
mocks.ReplayAll();
group.Children.Add(calculation);
parentGroup.Children.Add(group);
parentNodeData.Attach(observerMock);
// Precondition
Assert.IsTrue(info.CanRemove(nodeData, parentNodeData));
// Call
info.OnNodeRemoved(nodeData, parentNodeData);
// Assert
CollectionAssert.DoesNotContain(parentGroup.Children, group);
mocks.VerifyAll();
}
private const int contextMenuAddCalculationGroupIndexRootGroup = 1;
private const int contextMenuAddCalculationIndexRootGroup = 2;
private const int contextMenuCalculateAllIndexRootGroup = 4;
private const int contextMenuClearAllIndexRootGroup = 5;
private const int contextMenuAddCalculationGroupIndexNestedGroup = 0;
private const int contextMenuAddCalculationIndexNestedGroup = 1;
private const int contextMenuCalculateAllIndexNestedGroup = 3;
private const int contextMenuClearAllIndexNestedGroup = 4;
}
}