// 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.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Windows.Forms;
using Core.Common.Base;
using Core.Common.Base.Geometry;
using Core.Common.Controls.DataGrid;
using NUnit.Extensions.Forms;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Data.IllustrationPoints;
using Ringtoets.Common.Data.TestUtil;
using Ringtoets.Common.Data.TestUtil.IllustrationPoints;
using Ringtoets.Common.Forms.GuiServices;
using Ringtoets.Common.Forms.PresentationObjects;
using Ringtoets.Common.Forms.TestUtil;
using Ringtoets.Common.Forms.Views;
namespace Ringtoets.Common.Forms.Test.Views
{
[TestFixture]
public class DesignWaterLevelCalculationsViewTest
{
private const int calculateColumnIndex = 0;
private const int includeIllustrationPointsColumnIndex = 1;
private const int locationNameColumnIndex = 2;
private const int locationIdColumnIndex = 3;
private const int locationColumnIndex = 4;
private const int designWaterLevelColumnIndex = 5;
private Form testForm;
private MockRepository mockRepository;
[SetUp]
public void Setup()
{
testForm = new Form();
mockRepository = new MockRepository();
}
[TearDown]
public void TearDown()
{
testForm.Dispose();
mockRepository.VerifyAll();
}
[Test]
public void Constructor_GetNormFuncNull_ThrowsArgumentNullException()
{
// Setup
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mockRepository);
mockRepository.ReplayAll();
// Call
TestDelegate test = () => new DesignWaterLevelCalculationsView(new ObservableList(),
assessmentSection,
null,
"A");
// Assert
var exception = Assert.Throws(test);
Assert.AreEqual("getNormFunc", exception.ParamName);
}
[Test]
[TestCase(null)]
[TestCase("")]
public void Constructor_CategoryBoundaryNameInvalid_ThrowsArgumentException(string categoryBoundaryName)
{
// Setup
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mockRepository);
mockRepository.ReplayAll();
// Call
TestDelegate test = () => new DesignWaterLevelCalculationsView(new ObservableList(),
assessmentSection,
() => 0.01,
categoryBoundaryName);
// Assert
var exception = Assert.Throws(test);
Assert.AreEqual("'categoryBoundaryName' must have a value.", exception.Message);
}
[Test]
public void Constructor_ExpectedValues()
{
// Setup
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mockRepository);
mockRepository.ReplayAll();
// Call
using (var view = new DesignWaterLevelCalculationsView(new ObservableList(),
assessmentSection,
() => 0.01,
"A"))
{
// Assert
Assert.IsInstanceOf(view);
Assert.IsNull(view.Data);
}
}
[Test]
public void Constructor_DataGridViewCorrectlyInitialized()
{
// Setup
IAssessmentSection assessmentSection = AssessmentSectionHelper.CreateAssessmentSectionStub(mockRepository);
mockRepository.ReplayAll();
// Call
ShowDesignWaterLevelCalculationsView(new ObservableList(),
assessmentSection,
0.01,
"A",
testForm);
// Assert
DataGridView calculationsDataGridView = GetCalculationsDataGridView();
Assert.AreEqual(6, calculationsDataGridView.ColumnCount);
var calculateColumn = (DataGridViewCheckBoxColumn) calculationsDataGridView.Columns[calculateColumnIndex];
Assert.AreEqual("Berekenen", calculateColumn.HeaderText);
var includeIllustrationPointsColumn = (DataGridViewCheckBoxColumn) calculationsDataGridView.Columns[includeIllustrationPointsColumnIndex];
Assert.AreEqual("Illustratiepunten inlezen", includeIllustrationPointsColumn.HeaderText);
var locationNameColumn = (DataGridViewTextBoxColumn) calculationsDataGridView.Columns[locationNameColumnIndex];
Assert.AreEqual("Naam", locationNameColumn.HeaderText);
var locationIdColumn = (DataGridViewTextBoxColumn) calculationsDataGridView.Columns[locationIdColumnIndex];
Assert.AreEqual("ID", locationIdColumn.HeaderText);
var locationColumn = (DataGridViewTextBoxColumn) calculationsDataGridView.Columns[locationColumnIndex];
Assert.AreEqual("Coördinaten [m]", locationColumn.HeaderText);
var designWaterLevelColumn = (DataGridViewTextBoxColumn) calculationsDataGridView.Columns[designWaterLevelColumnIndex];
Assert.AreEqual("Waterstand [m+NAP]", designWaterLevelColumn.HeaderText);
var button = (Button) testForm.Controls.Find("CalculateForSelectedButton", true).First();
Assert.IsFalse(button.Enabled);
}
[Test]
public void Constructor_WithCalculations_DataGridViewCorrectlyInitialized()
{
// Call
ShowFullyConfiguredDesignWaterLevelCalculationsView(GetTestHydraulicBoundaryLocationCalculations(), testForm);
// Assert
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
DataGridViewRowCollection rows = calculationsDataGridViewControl.Rows;
Assert.AreEqual(4, rows.Count);
DataGridViewCellCollection cells = rows[0].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[calculateColumnIndex].FormattedValue);
Assert.AreEqual(false, cells[includeIllustrationPointsColumnIndex].FormattedValue);
Assert.AreEqual("1", cells[locationNameColumnIndex].FormattedValue);
Assert.AreEqual("1", cells[locationIdColumnIndex].FormattedValue);
Assert.AreEqual(new Point2D(1, 1).ToString(), cells[locationColumnIndex].FormattedValue);
Assert.AreEqual("-", cells[designWaterLevelColumnIndex].FormattedValue);
cells = rows[1].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[calculateColumnIndex].FormattedValue);
Assert.AreEqual(false, cells[includeIllustrationPointsColumnIndex].FormattedValue);
Assert.AreEqual("2", cells[locationNameColumnIndex].FormattedValue);
Assert.AreEqual("2", cells[locationIdColumnIndex].FormattedValue);
Assert.AreEqual(new Point2D(2, 2).ToString(), cells[locationColumnIndex].FormattedValue);
Assert.AreEqual(1.23.ToString(CultureInfo.CurrentCulture), cells[designWaterLevelColumnIndex].FormattedValue);
cells = rows[2].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[calculateColumnIndex].FormattedValue);
Assert.AreEqual(true, cells[includeIllustrationPointsColumnIndex].FormattedValue);
Assert.AreEqual("3", cells[locationNameColumnIndex].FormattedValue);
Assert.AreEqual("3", cells[locationIdColumnIndex].FormattedValue);
Assert.AreEqual(new Point2D(3, 3).ToString(), cells[locationColumnIndex].FormattedValue);
Assert.AreEqual("-", cells[designWaterLevelColumnIndex].FormattedValue);
cells = rows[3].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[calculateColumnIndex].FormattedValue);
Assert.AreEqual(true, cells[includeIllustrationPointsColumnIndex].FormattedValue);
Assert.AreEqual("4", cells[locationNameColumnIndex].FormattedValue);
Assert.AreEqual("4", cells[locationIdColumnIndex].FormattedValue);
Assert.AreEqual(new Point2D(4, 4).ToString(), cells[locationColumnIndex].FormattedValue);
Assert.AreEqual(1.01.ToString(CultureInfo.CurrentCulture), cells[designWaterLevelColumnIndex].FormattedValue);
}
[Test]
public void DesignWaterLevelCalculationsView_CalculationsUpdated_DataGridViewCorrectlyUpdated()
{
// Setup
ObservableList hydraulicBoundaryLocationCalculations = GetTestHydraulicBoundaryLocationCalculations();
ShowFullyConfiguredDesignWaterLevelCalculationsView(hydraulicBoundaryLocationCalculations, testForm);
const double designWaterLevel = 10.23;
var hydraulicBoundaryLocationCalculation = new HydraulicBoundaryLocationCalculation(new HydraulicBoundaryLocation(10, "10", 10.0, 10.0))
{
InputParameters =
{
ShouldIllustrationPointsBeCalculated = true
},
Output = new TestHydraulicBoundaryLocationCalculationOutput(designWaterLevel)
};
// Precondition
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
DataGridViewRowCollection rows = calculationsDataGridViewControl.Rows;
Assert.AreEqual(4, rows.Count);
hydraulicBoundaryLocationCalculations.Clear();
hydraulicBoundaryLocationCalculations.Add(hydraulicBoundaryLocationCalculation);
// Call
hydraulicBoundaryLocationCalculations.NotifyObservers();
// Assert
Assert.AreEqual(1, rows.Count);
DataGridViewCellCollection cells = rows[0].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[calculateColumnIndex].FormattedValue);
Assert.AreEqual(true, cells[includeIllustrationPointsColumnIndex].FormattedValue);
Assert.AreEqual("10", cells[locationNameColumnIndex].FormattedValue);
Assert.AreEqual("10", cells[locationIdColumnIndex].FormattedValue);
Assert.AreEqual(new Point2D(10, 10).ToString(), cells[locationColumnIndex].FormattedValue);
Assert.AreEqual(designWaterLevel, cells[designWaterLevelColumnIndex].Value);
}
[Test]
public void DesignWaterLevelCalculationsView_CalculationUpdated_DataGridViewCorrectlyUpdated()
{
// Setup
IObservableEnumerable hydraulicBoundaryLocationCalculations = GetTestHydraulicBoundaryLocationCalculations();
ShowFullyConfiguredDesignWaterLevelCalculationsView(hydraulicBoundaryLocationCalculations, testForm);
// Precondition
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
DataGridViewRowCollection rows = calculationsDataGridViewControl.Rows;
DataGridViewCellCollection cells = rows[0].Cells;
Assert.AreEqual(6, cells.Count);
Assert.AreEqual(false, cells[includeIllustrationPointsColumnIndex].FormattedValue);
HydraulicBoundaryLocationCalculation calculation = hydraulicBoundaryLocationCalculations.First();
// Call
calculation.InputParameters.ShouldIllustrationPointsBeCalculated = true;
calculation.NotifyObservers();
// Assert
Assert.AreEqual(true, cells[includeIllustrationPointsColumnIndex].FormattedValue);
}
[Test]
public void DesignWaterLevelCalculationsView_CalculationUpdated_IllustrationPointsControlCorrectlyUpdated()
{
// Setup
IObservableEnumerable hydraulicBoundaryLocationCalculations = GetTestHydraulicBoundaryLocationCalculations();
ShowFullyConfiguredDesignWaterLevelCalculationsView(hydraulicBoundaryLocationCalculations, testForm);
IllustrationPointsControl illustrationPointsControl = GetIllustrationPointsControl();
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
calculationsDataGridViewControl.SetCurrentCell(calculationsDataGridViewControl.GetCell(2, 0));
// Precondition
CollectionAssert.IsEmpty(illustrationPointsControl.Data);
var topLevelIllustrationPoints = new[]
{
new TopLevelSubMechanismIllustrationPoint(WindDirectionTestFactory.CreateTestWindDirection(),
"Regular",
new TestSubMechanismIllustrationPoint())
};
var generalResult = new TestGeneralResultSubMechanismIllustrationPoint(topLevelIllustrationPoints);
var output = new TestHydraulicBoundaryLocationCalculationOutput(generalResult);
// Call
HydraulicBoundaryLocationCalculation boundaryLocationCalculation = hydraulicBoundaryLocationCalculations.ElementAt(2);
boundaryLocationCalculation.Output = output;
boundaryLocationCalculation.NotifyObservers();
// Assert
IEnumerable expectedControlItems = CreateControlItems(generalResult);
CollectionAssert.AreEqual(expectedControlItems, illustrationPointsControl.Data, new IllustrationPointControlItemComparer());
}
[Test]
public void CalculateForSelectedButton_OneSelected_CallsCalculateDesignWaterLevels()
{
// Setup
IObservableEnumerable hydraulicBoundaryLocationCalculations = GetTestHydraulicBoundaryLocationCalculations();
DesignWaterLevelCalculationsView view = ShowFullyConfiguredDesignWaterLevelCalculationsView(hydraulicBoundaryLocationCalculations, testForm);
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
DataGridViewRowCollection rows = calculationsDataGridViewControl.Rows;
rows[0].Cells[calculateColumnIndex].Value = true;
var guiService = mockRepository.StrictMock();
HydraulicBoundaryLocationCalculation[] performedCalculations = null;
guiService.Expect(ch => ch.CalculateDesignWaterLevels(null, null, int.MinValue, null)).IgnoreArguments().WhenCalled(
invocation => { performedCalculations = ((IEnumerable) invocation.Arguments[1]).ToArray(); });
mockRepository.ReplayAll();
view.CalculationGuiService = guiService;
var buttonTester = new ButtonTester("CalculateForSelectedButton", testForm);
// Call
buttonTester.Click();
// Assert
Assert.AreEqual(1, performedCalculations.Length);
Assert.AreSame(hydraulicBoundaryLocationCalculations.First(), performedCalculations.First());
}
[Test]
public void CalculateForSelectedButton_OneSelectedButCalculationGuiServiceNotSet_DoesNotThrowException()
{
// Setup
ShowFullyConfiguredDesignWaterLevelCalculationsView(GetTestHydraulicBoundaryLocationCalculations(), testForm);
DataGridViewControl calculationsDataGridViewControl = GetCalculationsDataGridViewControl();
DataGridViewRowCollection rows = calculationsDataGridViewControl.Rows;
rows[0].Cells[calculateColumnIndex].Value = true;
var button = new ButtonTester("CalculateForSelectedButton", testForm);
// Call
TestDelegate test = () => button.Click();
// Assert
Assert.DoesNotThrow(test);
}
[Test]
public void CalculateForSelectedButton_Always_CalculateDesignWaterLevelsCalledAsExpected()
{
// Setup
const string databaseFilePath = "DatabaseFilePath";
const double norm = 0.01;
const string categoryBoundaryName = "A";
var assessmentSection = mockRepository.Stub();
var hydraulicBoundaryDatabase = new HydraulicBoundaryDatabase
{
FilePath = databaseFilePath
};
assessmentSection.Stub(a => a.HydraulicBoundaryDatabase).Return(hydraulicBoundaryDatabase);
assessmentSection.Stub(a => a.Id).Return(string.Empty);
assessmentSection.Stub(a => a.FailureMechanismContribution)
.Return(FailureMechanismContributionTestFactory.CreateFailureMechanismContribution());
assessmentSection.Stub(a => a.Attach(null)).IgnoreArguments();
assessmentSection.Stub(a => a.Detach(null)).IgnoreArguments();
var guiService = mockRepository.StrictMock();
IAssessmentSection assessmentSectionValue = null;
HydraulicBoundaryLocationCalculation[] performedCalculations = null;
double normValue = double.NaN;
string categoryBoundaryNameValue = null;
guiService.Expect(ch => ch.CalculateDesignWaterLevels(null, null, int.MinValue, null)).IgnoreArguments().WhenCalled(
invocation =>
{
assessmentSectionValue = (IAssessmentSection) invocation.Arguments[0];
performedCalculations = ((IEnumerable) invocation.Arguments[1]).ToArray();
normValue = (double) invocation.Arguments[2];
categoryBoundaryNameValue = (string) invocation.Arguments[3];
});
mockRepository.ReplayAll();
IObservableEnumerable hydraulicBoundaryLocationCalculations = GetTestHydraulicBoundaryLocationCalculations();
DesignWaterLevelCalculationsView view = ShowDesignWaterLevelCalculationsView(hydraulicBoundaryLocationCalculations,
assessmentSection,
norm,
categoryBoundaryName,
testForm);
DataGridView calculationsDataGridView = GetCalculationsDataGridView();
DataGridViewRowCollection rows = calculationsDataGridView.Rows;
rows[0].Cells[calculateColumnIndex].Value = true;
view.CalculationGuiService = guiService;
var button = new ButtonTester("CalculateForSelectedButton", testForm);
// Call
button.Click();
// Assert
Assert.AreEqual(categoryBoundaryName, categoryBoundaryNameValue);
Assert.AreSame(assessmentSection, assessmentSectionValue);
Assert.AreEqual(norm, normValue);
Assert.AreEqual(1, performedCalculations.Length);
Assert.AreSame(hydraulicBoundaryLocationCalculations.First(), performedCalculations.First());
}
private DataGridView GetCalculationsDataGridView()
{
return ControlTestHelper.GetDataGridView(testForm, "DataGridView");
}
private DataGridViewControl GetCalculationsDataGridViewControl()
{
return ControlTestHelper.GetDataGridViewControl(testForm, "DataGridViewControl");
}
private IllustrationPointsControl GetIllustrationPointsControl()
{
return ControlTestHelper.GetControls(testForm, "IllustrationPointsControl").Single();
}
private static IEnumerable CreateControlItems(
GeneralResult generalResult)
{
return generalResult.TopLevelIllustrationPoints
.Select(topLevelIllustrationPoint =>
{
SubMechanismIllustrationPoint illustrationPoint = topLevelIllustrationPoint.SubMechanismIllustrationPoint;
return new IllustrationPointControlItem(topLevelIllustrationPoint,
topLevelIllustrationPoint.WindDirection.Name,
topLevelIllustrationPoint.ClosingSituation,
illustrationPoint.Stochasts,
illustrationPoint.Beta);
});
}
private static DesignWaterLevelCalculationsView ShowDesignWaterLevelCalculationsView(IObservableEnumerable calculations,
IAssessmentSection assessmentSection,
double norm,
string categoryBoundaryName,
Form form)
{
var view = new DesignWaterLevelCalculationsView(calculations,
assessmentSection,
() => norm,
categoryBoundaryName);
form.Controls.Add(view);
form.Show();
return view;
}
private static DesignWaterLevelCalculationsView ShowFullyConfiguredDesignWaterLevelCalculationsView(IObservableEnumerable calculations,
Form form)
{
var assessmentSection = new AssessmentSectionStub();
return ShowDesignWaterLevelCalculationsView(calculations, assessmentSection, 0.01, "A", form);
}
private static ObservableList GetTestHydraulicBoundaryLocationCalculations()
{
var topLevelIllustrationPoints = new[]
{
new TopLevelSubMechanismIllustrationPoint(WindDirectionTestFactory.CreateTestWindDirection(),
"Regular",
new TestSubMechanismIllustrationPoint()),
new TopLevelSubMechanismIllustrationPoint(WindDirectionTestFactory.CreateTestWindDirection(),
"Test",
new TestSubMechanismIllustrationPoint())
};
var generalResult = new TestGeneralResultSubMechanismIllustrationPoint(topLevelIllustrationPoints);
return new ObservableList
{
new HydraulicBoundaryLocationCalculation(new HydraulicBoundaryLocation(1, "1", 1.0, 1.0)),
new HydraulicBoundaryLocationCalculation(new HydraulicBoundaryLocation(2, "2", 2.0, 2.0))
{
Output = new TestHydraulicBoundaryLocationCalculationOutput(1.23)
},
new HydraulicBoundaryLocationCalculation(new HydraulicBoundaryLocation(3, "3", 3.0, 3.0))
{
InputParameters =
{
ShouldIllustrationPointsBeCalculated = true
}
},
new HydraulicBoundaryLocationCalculation(new HydraulicBoundaryLocation(4, "4", 4.0, 4.0))
{
InputParameters =
{
ShouldIllustrationPointsBeCalculated = true
},
Output = new TestHydraulicBoundaryLocationCalculationOutput(1.01, generalResult)
}
};
}
[TestFixture]
private class ViewSynchronizationTest : CalculationsViewSynchronizationTester
{
private ObservableList calculations;
protected override int OutputColumnIndex
{
get
{
return designWaterLevelColumnIndex;
}
}
public override void Setup()
{
calculations = GetTestHydraulicBoundaryLocationCalculations();
base.Setup();
}
protected override object GetCalculationSelection(CalculationsView view, object selectedRowObject)
{
return new DesignWaterLevelCalculationContext(((HydraulicBoundaryLocationCalculationRow) selectedRowObject).CalculatableObject);
}
protected override CalculationsView ShowFullyConfiguredCalculationsView(Form form)
{
return ShowFullyConfiguredDesignWaterLevelCalculationsView(calculations, form);
}
protected override ObservableList GetCalculationsInView(CalculationsView view)
{
return calculations;
}
}
}
}