// 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.IO; using System.Linq; using System.Windows.Forms; using Core.Common.Base; using Core.Common.Base.Geometry; using Core.Common.Controls.TreeView; using Core.Common.Gui; using Core.Common.Gui.Commands; using Core.Common.Gui.ContextMenu; using Core.Common.Gui.Forms.MainWindow; using Core.Common.Gui.TestUtil.ContextMenu; using Core.Common.TestUtil; using NUnit.Extensions.Forms; using NUnit.Framework; using Rhino.Mocks; using Ringtoets.Common.Data; using Ringtoets.Common.Data.AssessmentSection; using Ringtoets.Common.Data.Calculation; using Ringtoets.Common.Data.FailureMechanism; using Ringtoets.Common.Forms.PresentationObjects; using Ringtoets.GrassCoverErosionInwards.Data; using Ringtoets.GrassCoverErosionInwards.Data.TestUtil; using Ringtoets.GrassCoverErosionInwards.Forms.PresentationObjects; using Ringtoets.GrassCoverErosionInwards.Plugin; using Ringtoets.HydraRing.Data; using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources; using GrassCoverErosionInwardsFormsResources = Ringtoets.GrassCoverErosionInwards.Forms.Properties.Resources; using CoreCommonGuiResources = Core.Common.Gui.Properties.Resources; using RingtoetsFormsResources = Ringtoets.Common.Forms.Properties.Resources; namespace Ringtoets.GrassCoverErosionInwards.Forms.Test.TreeNodeInfos { [TestFixture] public class GrassCoverErosionInwardsFailureMechanismContextTreeNodeInfoTest : NUnitFormTest { private MockRepository mocksRepository; private GrassCoverErosionInwardsGuiPlugin plugin; private TreeNodeInfo info; [SetUp] public void SetUp() { mocksRepository = new MockRepository(); plugin = new GrassCoverErosionInwardsGuiPlugin(); info = plugin.GetTreeNodeInfos().First(tni => tni.TagType == typeof(GrassCoverErosionInwardsFailureMechanismContext)); } [Test] public void Initialized_Always_ExpectedPropertiesSet() { // Assert Assert.AreEqual(typeof(GrassCoverErosionInwardsFailureMechanismContext), info.TagType); Assert.IsNotNull(info.ForeColor); Assert.IsNull(info.EnsureVisibleOnCreate); Assert.IsNull(info.CanRename); Assert.IsNull(info.OnNodeRenamed); Assert.IsNull(info.CanRemove); Assert.IsNull(info.OnNodeRemoved); Assert.IsNull(info.CanCheck); Assert.IsNull(info.IsChecked); Assert.IsNull(info.OnNodeChecked); Assert.IsNull(info.CanDrag); Assert.IsNull(info.CanDrop); Assert.IsNull(info.CanInsert); Assert.IsNull(info.OnDrop); } [Test] public void Text_Always_ReturnsName() { // Setup var assessmentSection = mocksRepository.Stub(); mocksRepository.ReplayAll(); var mechanism = new GrassCoverErosionInwardsFailureMechanism(); var mechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(mechanism, assessmentSection); // Call var text = info.Text(mechanismContext); // Assert const string expectedName = "Dijken en dammen - Grasbekleding erosie kruin en binnentalud"; Assert.AreEqual(expectedName, text); mocksRepository.VerifyAll(); } [Test] public void Image_Always_ReturnsFailureMechanismIcon() { // Call var image = info.Image(null); // Assert TestHelper.AssertImagesAreEqual(RingtoetsCommonFormsResources.FailureMechanismIcon, image); } [Test] public void ChildNodeObjects_FailureMechanismIsRelevant_ReturnChildDataNodes() { // Setup var assessmentSection = mocksRepository.Stub(); mocksRepository.ReplayAll(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); // Call var children = info.ChildNodeObjects(failureMechanismContext).ToArray(); // Assert Assert.AreEqual(3, children.Length); var inputsFolder = (CategoryTreeFolder) children[0]; Assert.AreEqual("Invoer", inputsFolder.Name); Assert.AreEqual(TreeFolderCategory.Input, inputsFolder.Category); Assert.AreEqual(2, inputsFolder.Contents.Count); var failureMechanismSectionsContext = (FailureMechanismSectionsContext) inputsFolder.Contents[0]; CollectionAssert.AreEqual(failureMechanism.Sections, failureMechanismSectionsContext.WrappedData); Assert.AreSame(failureMechanism, failureMechanismSectionsContext.ParentFailureMechanism); Assert.AreSame(assessmentSection, failureMechanismSectionsContext.ParentAssessmentSection); var commentContext = (CommentContext) inputsFolder.Contents[1]; Assert.AreSame(failureMechanism, commentContext.CommentContainer); var calculationsFolder = (GrassCoverErosionInwardsCalculationGroupContext) children[1]; Assert.AreEqual("Berekeningen", calculationsFolder.WrappedData.Name); CollectionAssert.AreEqual(failureMechanism.CalculationsGroup.Children, calculationsFolder.WrappedData.Children); Assert.AreSame(failureMechanism, calculationsFolder.FailureMechanism); var outputsFolder = (CategoryTreeFolder) children[2]; Assert.AreEqual("Uitvoer", outputsFolder.Name); Assert.AreEqual(TreeFolderCategory.Output, outputsFolder.Category); var failureMechanismResultsContext = (FailureMechanismSectionResultContext) outputsFolder.Contents[0]; Assert.AreSame(failureMechanism, failureMechanismResultsContext.FailureMechanism); Assert.AreSame(failureMechanism.SectionResults, failureMechanismResultsContext.SectionResults); mocksRepository.VerifyAll(); } [Test] public void ChildNodeObjects_FailureMechanismIsNotRelevant_ReturnOnlyFailureMechanismComments() { // Setup var assessmentSection = mocksRepository.Stub(); mocksRepository.ReplayAll(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism { IsRelevant = false }; var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); // Call var children = info.ChildNodeObjects(failureMechanismContext).ToArray(); // Assert Assert.AreEqual(1, children.Length); var commentContext = (CommentContext) children[0]; Assert.AreSame(failureMechanism, commentContext.CommentContainer); mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_FailureMechanismIsRelevant_CallsContextMenuBuilderMethods() { // Setup var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var assessmentSection = mocksRepository.Stub(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var guiMock = mocksRepository.StrictMock(); var treeViewControlMock = mocksRepository.StrictMock(); var menuBuilderMock = mocksRepository.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.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(failureMechanismContext, treeViewControlMock)).Return(menuBuilderMock); mocksRepository.ReplayAll(); plugin.Gui = guiMock; // Call info.ContextMenuStrip(failureMechanismContext, null, treeViewControlMock); // Assert mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_FailureMechanismIsNotRelevant_CallsContextMenuBuilderMethods() { // Setup var failureMechanism = new GrassCoverErosionInwardsFailureMechanism { IsRelevant = false }; var assessmentSection = mocksRepository.Stub(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var guiMock = mocksRepository.StrictMock(); var treeViewControlMock = mocksRepository.StrictMock(); var menuBuilderMock = mocksRepository.StrictMock(); menuBuilderMock.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().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.Build()).Return(null); guiMock.Expect(cmp => cmp.Get(failureMechanismContext, treeViewControlMock)).Return(menuBuilderMock); mocksRepository.ReplayAll(); plugin.Gui = guiMock; // Call info.ContextMenuStrip(failureMechanismContext, null, treeViewControlMock); // Assert mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_FailureMechanismIsRelevant_IsRelevantEnabledAddCalculationGroupAddCalculationItemDisabled() { // Setup using (var treeView = new TreeViewControl()) { var assessmentSection = mocksRepository.Stub(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var menuBuilderMock = new CustomItemsOnlyContextMenuBuilder(); var gui = mocksRepository.StrictMock(); gui.Expect(cmp => cmp.Get(failureMechanismContext, treeView)).Return(menuBuilderMock); gui.Stub(g => g.ProjectOpened += null).IgnoreArguments(); gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments(); mocksRepository.ReplayAll(); plugin.Gui = gui; // Call var menu = info.ContextMenuStrip(failureMechanismContext, assessmentSection, treeView); // Assert TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuRelevancyIndexWhenRelevant, RingtoetsCommonFormsResources.FailureMechanismContextMenuStrip_Is_relevant, RingtoetsCommonFormsResources.FailureMechanismContextMenuStrip_Is_relevant_Tooltip, RingtoetsCommonFormsResources.Checkbox_ticked); mocksRepository.VerifyAll(); } } [Test] public void ContextMenuStrip_FailureMechanismIsRelevantAndClickOnIsRelevantItem_MakeFailureMechanismNotRelevant() { // Setup var failureMechanismObserver = mocksRepository.Stub(); failureMechanismObserver.Expect(o => o.UpdateObserver()); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism { IsRelevant = true }; failureMechanism.Attach(failureMechanismObserver); var assessmentSection = mocksRepository.Stub(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var viewCommands = mocksRepository.StrictMock(); viewCommands.Expect(vs => vs.RemoveAllViewsForItem(failureMechanismContext)); var treeViewControl = mocksRepository.StrictMock(); var menuBuilder = new CustomItemsOnlyContextMenuBuilder(); var gui = mocksRepository.StrictMock(); gui.Stub(g => g.ViewCommands).Return(viewCommands); gui.Expect(g => g.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder); mocksRepository.ReplayAll(); plugin.Gui = gui; var contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl); // Call contextMenu.Items[contextMenuRelevancyIndexWhenRelevant].PerformClick(); // Assert Assert.IsFalse(failureMechanism.IsRelevant); mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_FailureMechanismIsNotRelevantAndClickOnIsRelevantItem_MakeFailureMechanismRelevant() { // Setup var failureMechanismObserver = mocksRepository.Stub(); failureMechanismObserver.Expect(o => o.UpdateObserver()); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism { IsRelevant = false }; failureMechanism.Attach(failureMechanismObserver); var assessmentSection = mocksRepository.Stub(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var treeViewControl = mocksRepository.StrictMock(); var menuBuilder = new CustomItemsOnlyContextMenuBuilder(); var gui = mocksRepository.StrictMock(); gui.Expect(g => g.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder); mocksRepository.ReplayAll(); plugin.Gui = gui; var contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl); // Call contextMenu.Items[contextMenuRelevancyIndexWhenNotRelevant].PerformClick(); // Assert Assert.IsTrue(failureMechanism.IsRelevant); mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_ClickOnCalculateAllItem_ScheduleAllChildCalculations() { // Setup var gui = mocksRepository.StrictMock(); var mainWindow = mocksRepository.Stub(); var treeViewControl = mocksRepository.StrictMock(); var menuBuilder = new CustomItemsOnlyContextMenuBuilder(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var section = new FailureMechanismSection("A", new[] { new Point2D(0, 0) }); failureMechanism.AddSection(section); var validCalculation = GrassCoverErosionInwardsCalculationFactory.CreateCalculationWithValidInput(); validCalculation.Name = "A"; var invalidCalculation = GrassCoverErosionInwardsCalculationFactory.CreateCalculationWithInvalidData(); invalidCalculation.Name = "B"; failureMechanism.CalculationsGroup.Children.Add(validCalculation); failureMechanism.CalculationsGroup.Children.Add(invalidCalculation); var assessmentSection = mocksRepository.Stub(); var hydraulicBoundaryDatabase = mocksRepository.Stub(); hydraulicBoundaryDatabase.FilePath = Path.GetTempPath(); assessmentSection.HydraulicBoundaryDatabase = hydraulicBoundaryDatabase; var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); gui.Expect(g => g.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder); gui.Expect(g => g.MainWindow).Return(mainWindow); mocksRepository.ReplayAll(); plugin.Gui = gui; var contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl); DialogBoxHandler = (name, wnd) => { // Don't care about dialogs in this test. }; // Call contextMenu.Items[contextMenuCalculateAllIndex].PerformClick(); // Assert mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_NoHydraulicDatabaseAndFailureMechanismSections_ReturnContextMenuWithCalculateAllDisabled() { // Setup var gui = mocksRepository.StrictMock(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var assessmentSectionMock = mocksRepository.StrictMock(); assessmentSectionMock.Expect(asm => asm.HydraulicBoundaryDatabase).Return(null); var nodeData = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSectionMock); var applicationFeatureCommandHandler = mocksRepository.Stub(); var exportImportHandler = mocksRepository.Stub(); var viewCommandsHandler = mocksRepository.StrictMock(); var treeViewControl = mocksRepository.StrictMock(); var menuBuilder = new ContextMenuBuilder(applicationFeatureCommandHandler, exportImportHandler, viewCommandsHandler, nodeData, treeViewControl); gui.Expect(g => g.Get(nodeData, treeViewControl)).Return(menuBuilder); treeViewControl.Expect(tvc => tvc.CanExpandOrCollapseForData(nodeData)).Repeat.Twice().Return(false); viewCommandsHandler.Expect(vc => vc.CanOpenViewFor(nodeData)).Return(false); mocksRepository.ReplayAll(); plugin.Gui = gui; // Call ContextMenuStrip menu = info.ContextMenuStrip(nodeData, null, treeViewControl); // Assert TestHelper.AssertContextMenuStripContainsItem(menu, 4, RingtoetsFormsResources.Calculate_all, RingtoetsFormsResources.Calculate_all_ToolTip, RingtoetsFormsResources.CalculateIcon, false); mocksRepository.VerifyAll(); } [Test] public void ContextMenuStrip_HydraulicDatabaseAndFailureMechanismSectionsSet_ReturnContextMenuWithCalculateAllEnabled() { // Setup var gui = mocksRepository.StrictMock(); var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); failureMechanism.AddSection(new FailureMechanismSection("test", new[] { new Point2D(0, 0) })); failureMechanism.CalculationsGroup.Children.Add(new GrassCoverErosionInwardsCalculation(new GeneralGrassCoverErosionInwardsInput())); var assessmentSectionMock = mocksRepository.StrictMock(); assessmentSectionMock.Expect(asm => asm.HydraulicBoundaryDatabase).Return(new HydraulicBoundaryDatabase()); var nodeData = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSectionMock); var applicationFeatureCommandHandler = mocksRepository.Stub(); var exportImportHandler = mocksRepository.Stub(); var viewCommandsHandler = mocksRepository.StrictMock(); var treeViewControl = mocksRepository.StrictMock(); var menuBuilder = new ContextMenuBuilder(applicationFeatureCommandHandler, exportImportHandler, viewCommandsHandler, nodeData, treeViewControl); gui.Expect(g => g.Get(nodeData, treeViewControl)).Return(menuBuilder); treeViewControl.Expect(tvc => tvc.CanExpandOrCollapseForData(nodeData)).Repeat.Twice().Return(false); viewCommandsHandler.Expect(vc => vc.CanOpenViewFor(nodeData)).Return(false); mocksRepository.ReplayAll(); plugin.Gui = gui; // Call ContextMenuStrip menu = info.ContextMenuStrip(nodeData, null, treeViewControl); // Assert TestHelper.AssertContextMenuStripContainsItem(menu, 4, RingtoetsFormsResources.Calculate_all, RingtoetsFormsResources.Calculate_all_ToolTip, RingtoetsFormsResources.CalculateIcon); mocksRepository.VerifyAll(); } [Test] [TestCase(true)] [TestCase(false)] public void GivenCalculationsWithOutput_WhenClearing_ThenCalculationsClearedAndNotified(bool confirm) { // Given var failureMechanism = new GrassCoverErosionInwardsFailureMechanism(); var assessmentSection = mocksRepository.Stub(); var failureMechanismContext = new GrassCoverErosionInwardsFailureMechanismContext(failureMechanism, assessmentSection); var validCalculation = GrassCoverErosionInwardsCalculationFactory.CreateCalculationWithValidInput(); validCalculation.Name = "A"; var invalidCalculation = GrassCoverErosionInwardsCalculationFactory.CreateCalculationWithInvalidData(); invalidCalculation.Name = "B"; failureMechanism.CalculationsGroup.Children.Add(validCalculation); failureMechanism.CalculationsGroup.Children.Add(invalidCalculation); var gui = mocksRepository.DynamicMock(); var observerMock = mocksRepository.StrictMock(); var treeViewControlMock = mocksRepository.StrictMock(); gui.Expect(cmp => cmp.Get(failureMechanismContext, treeViewControlMock)).Return(new CustomItemsOnlyContextMenuBuilder()); if (confirm) { observerMock.Expect(o => o.UpdateObserver()).Repeat.Twice(); } mocksRepository.ReplayAll(); plugin.Gui = gui; validCalculation.Output = new GrassCoverErosionInwardsOutput(0, 0, 0, 0, 0); validCalculation.Attach(observerMock); invalidCalculation.Output = new GrassCoverErosionInwardsOutput(0, 0, 0, 0, 0); invalidCalculation.Attach(observerMock); var contextMenuAdapter = info.ContextMenuStrip(failureMechanismContext, null, treeViewControlMock); string messageBoxText = null, messageBoxTitle = null; DialogBoxHandler = (name, wnd) => { var messageBox = new MessageBoxTester(wnd); messageBoxText = messageBox.Text; messageBoxTitle = messageBox.Title; if (confirm) { messageBox.ClickOk(); } else { messageBox.ClickCancel(); } }; // When contextMenuAdapter.Items[contextMenuClearAllIndex].PerformClick(); // Then foreach (var calculation in failureMechanism.CalculationsGroup.Children.OfType()) { Assert.AreNotEqual(confirm, calculation.HasOutput); } Assert.AreEqual("Bevestigen", messageBoxTitle); Assert.AreEqual("Weet u zeker dat u alle uitvoer wilt wissen?", messageBoxText); mocksRepository.VerifyAll(); } private const int contextMenuRelevancyIndexWhenRelevant = 1; private const int contextMenuRelevancyIndexWhenNotRelevant = 0; private const int contextMenuCalculateAllIndex = 3; private const int contextMenuClearAllIndex = 4; } }