// Copyright (C) Stichting Deltares 2017. 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;
using System.IO;
using System.Linq;
using System.Windows.Forms;
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.Forms.ViewHost;
using Core.Common.Gui.TestUtil.ContextMenu;
using Core.Common.TestUtil;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.AssemblyTool.KernelWrapper.Calculators;
using Ringtoets.AssemblyTool.KernelWrapper.TestUtil.Calculators;
using Ringtoets.AssemblyTool.KernelWrapper.TestUtil.Calculators.Categories;
using Ringtoets.Common.Data;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.TestUtil;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Plugin.TestUtil;
using Ringtoets.DuneErosion.Data;
using Ringtoets.DuneErosion.Data.TestUtil;
using Ringtoets.DuneErosion.Forms.PresentationObjects;
using Ringtoets.HydraRing.Calculation.Calculator.Factory;
using Ringtoets.HydraRing.Calculation.TestUtil.Calculator;
using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources;
namespace Ringtoets.DuneErosion.Plugin.Test.TreeNodeInfos
{
[TestFixture]
public class DuneErosionFailureMechanismContextTreeNodeInfoTest
{
private const int contextMenuRelevancyIndexWhenRelevant = 2;
private const int contextMenuRelevancyIndexWhenNotRelevant = 0;
private const int contextMenuCalculateAllIndex = 4;
private readonly string testDataPath = TestHelper.GetTestDataPath(TestDataPath.Ringtoets.Integration.Forms, "HydraulicBoundaryDatabase");
private MockRepository mocksRepository;
private DuneErosionPlugin plugin;
private TreeNodeInfo info;
[SetUp]
public void SetUp()
{
mocksRepository = new MockRepository();
plugin = new DuneErosionPlugin();
info = plugin.GetTreeNodeInfos().First(tni => tni.TagType == typeof(DuneErosionFailureMechanismContext));
}
[TearDown]
public void TearDown()
{
plugin.Dispose();
mocksRepository.VerifyAll();
}
[Test]
public void Initialized_Always_ExpectedPropertiesSet()
{
// Setup
mocksRepository.ReplayAll();
// Assert
Assert.IsNotNull(info.Text);
Assert.IsNotNull(info.ForeColor);
Assert.IsNotNull(info.Image);
Assert.IsNotNull(info.ContextMenuStrip);
Assert.IsNull(info.EnsureVisibleOnCreate);
Assert.IsNull(info.ExpandOnCreate);
Assert.IsNotNull(info.ChildNodeObjects);
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 ChildNodeObjects_FailureMechanismIsRelevant_ReturnChildDataNodes()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new DuneErosionFailureMechanism();
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
// Call
object[] 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 = (DuneErosionFailureMechanismSectionsContext) inputsFolder.Contents.ElementAt(0);
Assert.AreSame(failureMechanism, failureMechanismSectionsContext.WrappedData);
Assert.AreSame(assessmentSection, failureMechanismSectionsContext.AssessmentSection);
var inputComment = (Comment) inputsFolder.Contents.ElementAt(1);
Assert.AreSame(failureMechanism.InputComments, inputComment);
var duneLocationCalculationsGroupContext = (DuneLocationCalculationsGroupContext) children[1];
Assert.AreSame(failureMechanism.DuneLocations, duneLocationCalculationsGroupContext.WrappedData);
Assert.AreSame(failureMechanism, duneLocationCalculationsGroupContext.FailureMechanism);
Assert.AreSame(assessmentSection, duneLocationCalculationsGroupContext.AssessmentSection);
var outputsFolder = (CategoryTreeFolder) children[2];
Assert.AreEqual("Oordeel", outputsFolder.Name);
Assert.AreEqual(TreeFolderCategory.Output, outputsFolder.Category);
Assert.AreEqual(3, outputsFolder.Contents.Count());
var failureMechanismAssemblyCategoriesContext = (FailureMechanismAssemblyCategoriesContext) outputsFolder.Contents.ElementAt(0);
Assert.AreSame(failureMechanism, failureMechanismAssemblyCategoriesContext.WrappedData);
Assert.AreSame(assessmentSection, failureMechanismAssemblyCategoriesContext.AssessmentSection);
using (new AssemblyToolCalculatorFactoryConfig())
{
var calculatorFactory = (TestAssemblyToolCalculatorFactory) AssemblyToolCalculatorFactory.Instance;
AssemblyCategoriesCalculatorStub calculator = calculatorFactory.LastCreatedAssemblyCategoriesCalculator;
failureMechanismAssemblyCategoriesContext.GetFailureMechanismSectionAssemblyCategoriesFunc();
Assert.AreEqual(failureMechanism.GeneralInput.N, calculator.AssemblyCategoriesInput.N);
}
var failureMechanismResultsContext = (FailureMechanismSectionResultContext) outputsFolder.Contents.ElementAt(1);
Assert.AreSame(failureMechanism, failureMechanismResultsContext.FailureMechanism);
Assert.AreSame(failureMechanism.SectionResults, failureMechanismResultsContext.WrappedData);
var outputComment = (Comment) outputsFolder.Contents.ElementAt(2);
Assert.AreSame(failureMechanism.OutputComments, outputComment);
}
[Test]
public void ChildNodeObjects_FailureMechanismIsNotRelevant_ReturnOnlyFailureMechanismNotRelevantComments()
{
// Setup
var assessmentSection = mocksRepository.Stub();
mocksRepository.ReplayAll();
var failureMechanism = new DuneErosionFailureMechanism
{
IsRelevant = false
};
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
// Call
object[] children = info.ChildNodeObjects(failureMechanismContext).ToArray();
// Assert
Assert.AreEqual(1, children.Length);
var comment = (Comment) children[0];
Assert.AreSame(failureMechanism.NotRelevantComments, comment);
}
[Test]
public void ContextMenuStrip_FailureMechanismIsRelevant_CallsContextMenuBuilderMethods()
{
// Setup
var failureMechanism = new DuneErosionFailureMechanism();
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mocksRepository);
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var orderMocksRepository = new MockRepository();
var menuBuilder = orderMocksRepository.StrictMock();
using (orderMocksRepository.Ordered())
{
menuBuilder.Expect(mb => mb.AddOpenItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddSeparator()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddSeparator()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddSeparator()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddCollapseAllItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddExpandAllItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddSeparator()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddPropertiesItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.Build()).Return(null);
}
orderMocksRepository.ReplayAll();
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder);
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
info.ContextMenuStrip(failureMechanismContext, null, treeViewControl);
}
// Assert
orderMocksRepository.VerifyAll();
}
[Test]
public void ContextMenuStrip_FailureMechanismIsNotRelevant_CallsContextMenuBuilderMethods()
{
// Setup
var failureMechanism = new DuneErosionFailureMechanism
{
IsRelevant = false
};
var assessmentSection = mocksRepository.Stub();
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var menuBuilder = mocksRepository.StrictMock();
using (mocksRepository.Ordered())
{
menuBuilder.Expect(mb => mb.AddCustomItem(null)).IgnoreArguments().Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddSeparator()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddCollapseAllItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.AddExpandAllItem()).Return(menuBuilder);
menuBuilder.Expect(mb => mb.Build()).Return(null);
}
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder);
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
info.ContextMenuStrip(failureMechanismContext, null, treeViewControl);
}
// Assert
// Assert is done in TearDown
}
[Test]
public void ContextMenuStrip_FailureMechanismIsRelevant_AddCustomItems()
{
// Setup
using (var treeView = new TreeViewControl())
{
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mocksRepository);
var failureMechanism = new DuneErosionFailureMechanism();
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
var gui = mocksRepository.Stub();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeView)).Return(menuBuilder);
gui.Stub(g => g.ProjectOpened += null).IgnoreArguments();
gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments();
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
using (ContextMenuStrip menu = info.ContextMenuStrip(failureMechanismContext, assessmentSection, treeView))
{
// Assert
Assert.AreEqual(10, menu.Items.Count);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuRelevancyIndexWhenRelevant,
"I&s relevant",
"Geeft aan of dit toetsspoor relevant is of niet.",
RingtoetsCommonFormsResources.Checkbox_ticked);
}
}
}
[Test]
public void ContextMenuStrip_FailureMechanismIsNotRelevant_AddCustomItems()
{
// Setup
using (var treeView = new TreeViewControl())
{
var assessmentSection = mocksRepository.Stub();
var failureMechanism = new DuneErosionFailureMechanism
{
IsRelevant = false
};
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
var gui = mocksRepository.Stub();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeView)).Return(menuBuilder);
gui.Stub(g => g.ProjectOpened += null).IgnoreArguments();
gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments();
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
using (ContextMenuStrip menu = info.ContextMenuStrip(failureMechanismContext, assessmentSection, treeView))
{
// Assert
Assert.AreEqual(4, menu.Items.Count);
TestHelper.AssertContextMenuStripContainsItem(menu, contextMenuRelevancyIndexWhenNotRelevant,
"I&s relevant",
"Geeft aan of dit toetsspoor relevant is of niet.",
RingtoetsCommonFormsResources.Checkbox_empty);
}
}
}
[Test]
public void ContextMenuStrip_FailureMechanismIsRelevantAndClickOnIsRelevantItem_MakeFailureMechanismNotRelevantAndRemovesAllViewsForItem()
{
// Setup
var failureMechanism = new DuneErosionFailureMechanism();
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mocksRepository);
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var viewCommands = mocksRepository.StrictMock();
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
viewCommands.Expect(vs => vs.RemoveAllViewsForItem(failureMechanismContext));
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(g => g.ViewCommands).Return(viewCommands);
gui.Stub(g => g.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder);
mocksRepository.ReplayAll();
plugin.Gui = gui;
using (ContextMenuStrip contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl))
{
// Call
contextMenu.Items[contextMenuRelevancyIndexWhenRelevant].PerformClick();
// Assert
Assert.IsFalse(failureMechanism.IsRelevant);
}
}
}
[Test]
public void ContextMenuStrip_FailureMechanismIsNotRelevantAndClickOnIsRelevantItem_MakeFailureMechanismRelevantAndRemovesAllViewsForItem()
{
// Setup
var failureMechanism = new DuneErosionFailureMechanism
{
IsRelevant = false
};
var assessmentSection = mocksRepository.Stub();
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var viewCommands = mocksRepository.StrictMock();
var menuBuilder = new CustomItemsOnlyContextMenuBuilder();
viewCommands.Expect(vs => vs.RemoveAllViewsForItem(failureMechanismContext));
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(g => g.ViewCommands).Return(viewCommands);
gui.Stub(g => g.Get(failureMechanismContext, treeViewControl)).Return(menuBuilder);
mocksRepository.ReplayAll();
plugin.Gui = gui;
using (ContextMenuStrip contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl))
{
// Call
contextMenu.Items[contextMenuRelevancyIndexWhenNotRelevant].PerformClick();
// Assert
Assert.IsTrue(failureMechanism.IsRelevant);
}
}
}
[Test]
public void ContextMenuStrip_HydraulicBoundaryDatabaseNotLinked_ContextMenuItemCalculateAllDisabledAndTooltipSet()
{
// Setup
var duneLocation = new TestDuneLocation("Test");
var failureMechanism = new DuneErosionFailureMechanism();
var assessmentSection = new AssessmentSectionStub();
failureMechanism.SetDuneLocations(new[]
{
duneLocation
});
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(g => g.ProjectOpened += null).IgnoreArguments();
gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeViewControl)).Return(new CustomItemsOnlyContextMenuBuilder());
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
using (ContextMenuStrip contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl))
{
// Assert
ToolStripItem contextMenuItem = contextMenu.Items[contextMenuCalculateAllIndex];
Assert.AreEqual("Alles be&rekenen", contextMenuItem.Text);
StringAssert.Contains("Er is geen hydraulische belastingendatabase geïmporteerd.", contextMenuItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsCommonFormsResources.CalculateAllIcon, contextMenuItem.Image);
Assert.IsFalse(contextMenuItem.Enabled);
}
}
}
[Test]
public void ContextMenuStrip_NoDuneLocationsPresent_ContextMenuItemCalculateAllDisabledAndTooltipSet()
{
// Setup
var failureMechanism = new DuneErosionFailureMechanism();
var assessmentSection = new AssessmentSectionStub
{
HydraulicBoundaryDatabase =
{
FilePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite")
}
};
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
var mocks = new MockRepository();
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(g => g.ProjectOpened += null).IgnoreArguments();
gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeViewControl)).Return(new CustomItemsOnlyContextMenuBuilder());
mocksRepository.ReplayAll();
plugin.Gui = gui;
// Call
using (ContextMenuStrip contextMenu = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl))
{
// Assert
ToolStripItem contextMenuItem = contextMenu.Items[contextMenuCalculateAllIndex];
Assert.AreEqual("Alles be&rekenen", contextMenuItem.Text);
StringAssert.Contains("Geen van de locaties is geschikt voor een hydraulische belastingen berekening.", contextMenuItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsCommonFormsResources.CalculateAllIcon, contextMenuItem.Image);
Assert.IsFalse(contextMenuItem.Enabled);
}
}
mocks.VerifyAll();
}
[Test]
public void GivenValidCalculations_WhenCalculatingAllFromContextMenu_ThenAllCalculationsScheduled()
{
// Given
var assessmentSection = new AssessmentSectionStub
{
HydraulicBoundaryDatabase =
{
FilePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite")
}
};
var failureMechanism = new DuneErosionFailureMechanism
{
Contribution = 5
};
var duneLocation = new TestDuneLocation("Test");
failureMechanism.SetDuneLocations(new[]
{
duneLocation
});
var failureMechanismContext = new DuneErosionFailureMechanismContext(failureMechanism, assessmentSection);
using (var treeViewControl = new TreeViewControl())
{
var gui = mocksRepository.Stub();
gui.Stub(g => g.MainWindow).Return(mocksRepository.Stub());
gui.Stub(g => g.ProjectOpened += null).IgnoreArguments();
gui.Stub(g => g.ProjectOpened -= null).IgnoreArguments();
gui.Stub(cmp => cmp.Get(failureMechanismContext, treeViewControl)).Return(new CustomItemsOnlyContextMenuBuilder());
gui.Stub(g => g.DocumentViewController).Return(mocksRepository.Stub());
var calculatorFactory = mocksRepository.Stub();
var dunesBoundaryConditionsCalculator = new TestDunesBoundaryConditionsCalculator
{
Converged = false
};
calculatorFactory.Expect(cf => cf.CreateDunesBoundaryConditionsCalculator(testDataPath, string.Empty)).Return(dunesBoundaryConditionsCalculator).Repeat.Times(5);
mocksRepository.ReplayAll();
plugin.Gui = gui;
plugin.Activate();
using (ContextMenuStrip contextMenuAdapter = info.ContextMenuStrip(failureMechanismContext, null, treeViewControl))
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
// When
Action call = () => contextMenuAdapter.Items[contextMenuCalculateAllIndex].PerformClick();
// Then
TestHelper.AssertLogMessages(call, messages =>
{
string[] msgs = messages.ToArray();
Assert.AreEqual(40, msgs.Length);
const string duneCalculationName = "Hydraulische randvoorwaarden";
HydraulicBoundaryLocationCalculationActivityLogTestHelper.AssertHydraulicBoundaryLocationCalculationMessages(
duneLocation.Name, duneCalculationName, "Iv->IIv", msgs, 0);
HydraulicBoundaryLocationCalculationActivityLogTestHelper.AssertHydraulicBoundaryLocationCalculationMessages(
duneLocation.Name, duneCalculationName, "IIv->IIIv", msgs, 8);
HydraulicBoundaryLocationCalculationActivityLogTestHelper.AssertHydraulicBoundaryLocationCalculationMessages(
duneLocation.Name, duneCalculationName, "IIIv->IVv", msgs, 16);
HydraulicBoundaryLocationCalculationActivityLogTestHelper.AssertHydraulicBoundaryLocationCalculationMessages(
duneLocation.Name, duneCalculationName, "IVv->Vv", msgs, 24);
HydraulicBoundaryLocationCalculationActivityLogTestHelper.AssertHydraulicBoundaryLocationCalculationMessages(
duneLocation.Name, duneCalculationName, "Vv->VIv", msgs, 32);
});
}
}
}
}
}