// 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 Core.Common.Base;
using Core.Common.TestUtil;
using NUnit.Extensions.Forms;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Data.Calculation;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Forms.TreeNodeInfos;
using BaseResources = Core.Common.Base.Properties.Resources;
using RingtoetsDataResources = Ringtoets.Common.Data.Properties.Resources;
using RingtoetsFormsResources = Ringtoets.Common.Forms.Properties.Resources;
namespace Ringtoets.Common.Forms.Test.TreeNodeInfos
{
[TestFixture]
public class RingtoetsContextMenuItemFactoryTest : NUnitFormTest
{
private RingtoetsContextMenuItemFactory factory;
[TestFixtureSetUp]
public void TestFixtureSetUp()
{
factory = new RingtoetsContextMenuItemFactory();
}
[Test]
public void CreateAddCalculationGroupItem_Always_CreatesDecoratedItem()
{
// Setup
var calculationGroup = new CalculationGroup();
// Call
var toolStripItem = factory.CreateAddCalculationGroupItem(calculationGroup);
// Assert
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_Add_CalculationGroup_Tooltip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.AddFolderIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
}
[Test]
public void CreateAddCalculationGroupItem_PerformClickOnCreatedItem_CalculationGroupWithUniqueNameAdded()
{
// Setup
var calculationGroup = new CalculationGroup
{
Children =
{
new CalculationGroup()
}
};
// Precondition
Assert.AreEqual(1, calculationGroup.Children.Count);
var toolStripItem = factory.CreateAddCalculationGroupItem(calculationGroup);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(2, calculationGroup.Children.Count);
var newGroup = calculationGroup.Children[1] as CalculationGroup;
Assert.IsNotNull(newGroup);
Assert.AreEqual(string.Format("{0} (1)", RingtoetsDataResources.CalculationGroup_DefaultName), newGroup.Name);
}
[Test]
public void CreateAddCalculationItem_Always_CreatesDecoratedItem()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var calculationGroup = new CalculationGroup();
var calculationGroupContext = new TestCalculationGroupContext(calculationGroup, failureMechanismMock);
// Call
var toolStripItem = factory.CreateAddCalculationItem(calculationGroupContext, context => { });
// Assert
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_Add_Calculation, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_Add_Calculation_Tooltip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.FailureMechanismIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateAddCalculationItem_PerformClickOnCreatedItem_AddCalculationMethodPerformed()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var counter = 0;
var calculationGroup = new CalculationGroup();
var calculationGroupContext = new TestCalculationGroupContext(calculationGroup, failureMechanismMock);
var toolStripItem = factory.CreateAddCalculationItem(calculationGroupContext, context => counter++);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(1, counter);
mocks.VerifyAll();
}
[Test]
public void CreateClearAllCalculationOutputInGroupItem_GroupWithCalculationOutput_CreatesDecoratedAndEnabledItem()
{
// Setup
var mocks = new MockRepository();
var calculationWithOutputMock = mocks.StrictMock();
calculationWithOutputMock.Expect(c => c.HasOutput).Return(true);
mocks.ReplayAll();
var calculationGroup = new CalculationGroup
{
Children =
{
calculationWithOutputMock
}
};
// Call
var toolStripItem = factory.CreateClearAllCalculationOutputInGroupItem(calculationGroup);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Clear_all_output, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_ClearOutput_ToolTip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.ClearIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateClearAllCalculationOutputInGroupItem_GroupWithoutCalculationOutput_CreatesDecoratedAndDisabledItem()
{
// Setup
var mocks = new MockRepository();
var calculationWithoutOutputMock = mocks.StrictMock();
calculationWithoutOutputMock.Expect(c => c.HasOutput).Return(false);
mocks.ReplayAll();
var calculationGroup = new CalculationGroup
{
Children =
{
calculationWithoutOutputMock
}
};
// Call
var toolStripItem = factory.CreateClearAllCalculationOutputInGroupItem(calculationGroup);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Clear_all_output, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_ClearOutput_No_calculation_with_output_to_clear, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.ClearIcon, toolStripItem.Image);
Assert.IsFalse(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateClearAllCalculationOutputInGroupItem_PerformClickOnCreatedItemAndConfirmChange_CalculationOutputClearedAndObserversNotified()
{
var messageBoxText = "";
var messageBoxTitle = "";
var mocks = new MockRepository();
var calculationWithOutputMock1 = mocks.StrictMock();
var calculationWithOutputMock2 = mocks.StrictMock();
var calculationWithoutOutputMock = mocks.StrictMock();
calculationWithOutputMock1.Stub(c => c.HasOutput).Return(true);
calculationWithOutputMock2.Stub(c => c.HasOutput).Return(true);
calculationWithoutOutputMock.Stub(c => c.HasOutput).Return(false);
calculationWithOutputMock1.Expect(c => c.ClearOutput());
calculationWithOutputMock1.Expect(c => c.NotifyObservers());
calculationWithOutputMock2.Expect(c => c.ClearOutput());
calculationWithOutputMock2.Expect(c => c.NotifyObservers());
mocks.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
var messageBox = new MessageBoxTester(wnd);
messageBoxText = messageBox.Text;
messageBoxTitle = messageBox.Title;
messageBox.ClickOk();
};
var calculationGroup = new CalculationGroup
{
Children =
{
calculationWithOutputMock1,
new CalculationGroup
{
Children =
{
calculationWithOutputMock2,
calculationWithoutOutputMock
}
}
}
};
var toolStripItem = factory.CreateClearAllCalculationOutputInGroupItem(calculationGroup);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(BaseResources.Confirm, messageBoxTitle);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_ClearOutput_Are_you_sure_clear_all_output, messageBoxText);
mocks.VerifyAll();
}
[Test]
public void CreateClearAllCalculationOutputInGroupItem_PerformClickOnCreatedItemAndCancelChange_CalculationOutputNotCleared()
{
var mocks = new MockRepository();
var calculationWithOutputMock1 = mocks.StrictMock();
var calculationWithOutputMock2 = mocks.StrictMock();
var calculationWithoutOutputMock = mocks.StrictMock();
calculationWithOutputMock1.Stub(c => c.HasOutput).Return(true);
calculationWithOutputMock2.Stub(c => c.HasOutput).Return(true);
calculationWithoutOutputMock.Stub(c => c.HasOutput).Return(false);
mocks.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
var messageBox = new MessageBoxTester(wnd);
messageBox.ClickCancel();
};
var calculationGroup = new CalculationGroup
{
Children =
{
calculationWithOutputMock1,
new CalculationGroup
{
Children =
{
calculationWithOutputMock2,
calculationWithoutOutputMock
}
}
}
};
var toolStripItem = factory.CreateClearAllCalculationOutputInGroupItem(calculationGroup);
// Call
toolStripItem.PerformClick();
// Assert
mocks.VerifyAll();
}
[Test]
public void CreatePerformAllCalculationsInGroupItem_GroupWithCalculations_CreatesDecoratedAndEnabledItem()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var calculation = new TestCalculation();
var calculationGroup = new CalculationGroup
{
Children =
{
calculation
}
};
var calculationGroupContext = new TestCalculationGroupContext(calculationGroup, failureMechanismMock);
// Call
var toolStripItem = factory.CreatePerformAllCalculationsInGroupItem(calculationGroup, calculationGroupContext, null);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Calculate_all, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_CalculateAll_ToolTip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.CalculateAllIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreatePerformAllCalculationsInGroupItem_GroupWithoutCalculations_CreatesDecoratedAndDisabledItem()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var calculationGroup = new CalculationGroup();
var calculationGroupContext = new TestCalculationGroupContext(calculationGroup, failureMechanismMock);
// Call
var toolStripItem = factory.CreatePerformAllCalculationsInGroupItem(calculationGroup, calculationGroupContext, null);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Calculate_all, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.CalculationGroup_CalculateAll_No_calculations_to_run, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.CalculateAllIcon, toolStripItem.Image);
Assert.IsFalse(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreatePerformAllCalculationsInGroupItem_PerformClickOnCreatedItem_PerformAllCalculationMethodPerformed()
{
// Setup
var mocks = new MockRepository();
var calculationMock = mocks.StrictMock();
var failureMechanisMock = mocks.StrictMock();
mocks.ReplayAll();
var counter = 0;
var calculationGroup = new CalculationGroup
{
Children =
{
calculationMock
}
};
var calculationGroupContext = new TestCalculationGroupContext(calculationGroup, failureMechanisMock);
var toolStripItem = factory.CreatePerformAllCalculationsInGroupItem(calculationGroup, calculationGroupContext, (group, context) => counter++);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(1, counter);
mocks.VerifyAll();
}
[Test]
public void CreatePerformCalculationItem_Always_CreatesDecoratedItem()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var calculation = new TestCalculation();
var calculationContext = new TestCalculationContext(calculation, failureMechanismMock);
// Call
var toolStripItem = factory.CreatePerformCalculationItem(calculation, calculationContext, null);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Calculate, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.Calculate_ToolTip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.CalculateIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreatePerformCalculationItem_PerformClickOnCreatedItem_PerformCalculationMethod()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
mocks.ReplayAll();
var calculation = new TestCalculation();
var calculationContext = new TestCalculationContext(calculation, failureMechanismMock);
var counter = 0;
var toolStripItem = factory.CreatePerformCalculationItem(calculation, calculationContext, (calc, context) => counter++);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(1, counter);
mocks.VerifyAll();
}
[Test]
public void CreateClearCalculationOutputItem_CalculationWithOutput_CreatesDecoratedAndEnabledItem()
{
// Setup
var mocks = new MockRepository();
var calculationWithOutputMock = mocks.StrictMock();
calculationWithOutputMock.Expect(c => c.HasOutput).Return(true);
mocks.ReplayAll();
// Call
var toolStripItem = factory.CreateClearCalculationOutputItem(calculationWithOutputMock);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Clear_output, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.Clear_output_ToolTip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.ClearIcon, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateClearCalculationOutputItem_CalculationWithoutOutput_CreatesDecoratedAndDisabledItem()
{
// Setup
var mocks = new MockRepository();
var calculationWithOutputMock = mocks.StrictMock();
calculationWithOutputMock.Expect(c => c.HasOutput).Return(false);
mocks.ReplayAll();
// Call
var toolStripItem = factory.CreateClearCalculationOutputItem(calculationWithOutputMock);
// Assert
Assert.AreEqual(RingtoetsFormsResources.Clear_output, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.ClearOutput_No_output_to_clear, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.ClearIcon, toolStripItem.Image);
Assert.IsFalse(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateClearCalculationOutputItem_PerformClickOnCreatedItemAndConfirmChange_CalculationOutputClearedAndObserversNotified()
{
var messageBoxText = "";
var messageBoxTitle = "";
var mocks = new MockRepository();
var calculationWithOutputMock = mocks.StrictMock();
calculationWithOutputMock.Stub(c => c.HasOutput).Return(true);
calculationWithOutputMock.Expect(c => c.ClearOutput());
calculationWithOutputMock.Expect(c => c.NotifyObservers());
mocks.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
var messageBox = new MessageBoxTester(wnd);
messageBoxText = messageBox.Text;
messageBoxTitle = messageBox.Title;
messageBox.ClickOk();
};
var toolStripItem = factory.CreateClearCalculationOutputItem(calculationWithOutputMock);
// Call
toolStripItem.PerformClick();
// Assert
Assert.AreEqual(BaseResources.Confirm, messageBoxTitle);
Assert.AreEqual(RingtoetsFormsResources.Calculation_ContextMenuStrip_Are_you_sure_clear_output, messageBoxText);
mocks.VerifyAll();
}
[Test]
public void CreateClearCalculationOutputItem_PerformClickOnCreatedItemAndCancelChange_CalculationOutputNotCleared()
{
var mocks = new MockRepository();
var calculationWithOutputMock = mocks.StrictMock();
calculationWithOutputMock.Stub(c => c.HasOutput).Return(true);
mocks.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
var messageBox = new MessageBoxTester(wnd);
messageBox.ClickCancel();
};
var toolStripItem = factory.CreateClearCalculationOutputItem(calculationWithOutputMock);
// Call
toolStripItem.PerformClick();
mocks.VerifyAll();
}
[Test]
public void CreateDisabledChangeRelevancyItem_Always_CreatesDecoratedItem()
{
// Setup
var mocks = new MockRepository();
var failureMechanismContextMock = mocks.StrictMock>();
mocks.ReplayAll();
// Call
var toolStripItem = factory.CreateDisabledChangeRelevancyItem(failureMechanismContextMock);
// Assert
Assert.AreEqual(RingtoetsFormsResources.FailureMechanismContextMenuStrip_Is_relevant, toolStripItem.Text);
Assert.AreEqual(RingtoetsFormsResources.FailureMechanismContextMenuStrip_Is_relevant_Tooltip, toolStripItem.ToolTipText);
TestHelper.AssertImagesAreEqual(RingtoetsFormsResources.Checkbox_empty, toolStripItem.Image);
Assert.IsTrue(toolStripItem.Enabled);
mocks.VerifyAll();
}
[Test]
public void CreateDisabledChangeRelevancyItem_PerformClickOnCreatedItem_FailureMechanismIsRelevantSetToTrueAndObserversNotified()
{
// Setup
var mocks = new MockRepository();
var failureMechanismMock = mocks.StrictMock();
var failureMechanismContextMock = mocks.StrictMock>();
failureMechanismContextMock.Stub(c => c.WrappedData).Return(failureMechanismMock);
failureMechanismMock.Expect(c => c.IsRelevant).SetPropertyWithArgument(true);
failureMechanismMock.Expect(c => c.NotifyObservers());
mocks.ReplayAll();
var toolStripItem = factory.CreateDisabledChangeRelevancyItem(failureMechanismContextMock);
// Call
toolStripItem.PerformClick();
// Assert
mocks.VerifyAll();
}
# region Nested types
private class TestCalculationGroupContext : Observable, ICalculationContext
{
public TestCalculationGroupContext(CalculationGroup wrappedData, IFailureMechanism failureMechanism)
{
WrappedData = wrappedData;
FailureMechanism = failureMechanism;
}
public CalculationGroup WrappedData { get; private set; }
public IFailureMechanism FailureMechanism { get; private set; }
}
private class TestCalculationContext : Observable, ICalculationContext
{
public TestCalculationContext(TestCalculation wrappedData, IFailureMechanism failureMechanism)
{
WrappedData = wrappedData;
FailureMechanism = failureMechanism;
}
public TestCalculation WrappedData { get; private set; }
public IFailureMechanism FailureMechanism { get; private set; }
}
private class TestCalculation : Observable, ICalculation
{
public TestCalculation()
{
Name = "Nieuwe berekening";
}
public string Name { get; set; }
public string Comments { get; set; }
public bool HasOutput
{
get
{
return false;
}
}
public void ClearOutput() { }
public void ClearHydraulicBoundaryLocation() { }
public ICalculationInput GetObservableInput()
{
return null;
}
public ICalculationOutput GetObservableOutput()
{
return null;
}
}
# endregion
}
}