// 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.Linq;
using System.Windows.Forms;
using Core.Common.Base.Geometry;
using Core.Components.Gis.Data;
using Core.Components.Gis.Forms;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Data.TestUtil;
using Ringtoets.Common.Forms.TestUtil;
using Ringtoets.Common.Forms.Views;
namespace Ringtoets.Common.Forms.Test.Views
{
[TestFixture]
public class FailureMechanismViewTest
{
private const int referenceLineIndex = 0;
private const int sectionsIndex = 1;
private const int sectionsStartPointIndex = 2;
private const int sectionsEndPointIndex = 3;
private const int hydraulicBoundaryLocationsIndex = 4;
private static IEnumerable GetCalculationFuncs
{
get
{
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaterLevelCalculationsForFactorizedSignalingNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaterLevelCalculationsForSignalingNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaterLevelCalculationsForLowerLimitNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaterLevelCalculationsForFactorizedLowerLimitNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaveHeightCalculationsForFactorizedSignalingNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaveHeightCalculationsForSignalingNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaveHeightCalculationsForLowerLimitNorm.First()));
yield return new TestCaseData(new Func(
assessmentSection => assessmentSection.WaveHeightCalculationsForFactorizedLowerLimitNorm.First()));
}
}
[Test]
public void Constructor_ExpectedValues()
{
// Setup
var failureMechanism = new TestFailureMechanism();
var assessmentSection = new ObservableTestAssessmentSectionStub();
// Call
using (var view = new FailureMechanismView(failureMechanism, assessmentSection))
{
// Assert
Assert.IsInstanceOf(view);
Assert.IsInstanceOf(view);
Assert.IsNull(view.Data);
Assert.AreSame(failureMechanism, view.FailureMechanism);
Assert.AreSame(assessmentSection, view.AssessmentSection);
Assert.AreEqual(1, view.Controls.Count);
Assert.IsInstanceOf(view.Controls[0]);
Assert.AreSame(view.Map, ((RingtoetsMapControl) view.Controls[0]).MapControl);
Assert.AreEqual(DockStyle.Fill, ((Control) view.Map).Dock);
AssertEmptyMapData(view.Map.Data);
}
}
[Test]
public void Constructor_failureMechanismNull_ThrowsArgumentNullException()
{
// Setup
var mocks = new MockRepository();
var assessmentSection = mocks.Stub();
mocks.ReplayAll();
// Call
TestDelegate call = () => new FailureMechanismView(null, assessmentSection);
// Assert
var exception = Assert.Throws(call);
Assert.AreEqual("failureMechanism", exception.ParamName);
mocks.VerifyAll();
}
[Test]
public void Constructor_AssessmentSectionNull_ThrowsArgumentNullException()
{
// Setup
var mocks = new MockRepository();
var failureMechanism = mocks.Stub();
mocks.ReplayAll();
// Call
TestDelegate call = () => new FailureMechanismView(failureMechanism, null);
// Assert
var exception = Assert.Throws(call);
Assert.AreEqual("assessmentSection", exception.ParamName);
mocks.VerifyAll();
}
[Test]
public void Constructor_AssessmentSectionWithBackgroundData_BackgroundDataSet()
{
// Setup
IAssessmentSection assessmentSection = new ObservableTestAssessmentSectionStub();
// Call
using (var view = new FailureMechanismView(new TestFailureMechanism(), assessmentSection))
{
// Assert
MapDataTestHelper.AssertImageBasedMapData(assessmentSection.BackgroundData, view.Map.BackgroundMapData);
}
}
[Test]
public void Data_FailureMechanismContext_DataUpdatedToCollectionOfFilledMapData()
{
// Setup
var geometryPoints = new[]
{
new Point2D(0.0, 0.0),
new Point2D(2.0, 0.0),
new Point2D(4.0, 4.0),
new Point2D(6.0, 4.0)
};
var referenceLine = new ReferenceLine();
referenceLine.SetGeometry(new[]
{
new Point2D(1.0, 2.0),
new Point2D(2.0, 1.0)
});
var assessmentSection = new ObservableTestAssessmentSectionStub
{
ReferenceLine = referenceLine
};
assessmentSection.AddHydraulicBoundaryLocation(new HydraulicBoundaryLocation(1, "test", 1.0, 2.0));
var failureMechanism = new TestFailureMechanism();
failureMechanism.AddSection(new FailureMechanismSection("A", geometryPoints.Take(2)));
failureMechanism.AddSection(new FailureMechanismSection("B", geometryPoints.Skip(1).Take(2)));
failureMechanism.AddSection(new FailureMechanismSection("C", geometryPoints.Skip(2).Take(2)));
// Call
using (var view = new FailureMechanismView(failureMechanism, assessmentSection))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
// Assert
MapDataCollection mapData = map.Data;
Assert.IsInstanceOf(mapData);
List mapDataList = mapData.Collection.ToList();
Assert.AreEqual(5, mapDataList.Count);
MapDataTestHelper.AssertReferenceLineMapData(assessmentSection.ReferenceLine, mapDataList[referenceLineIndex]);
MapDataTestHelper.AssertFailureMechanismSectionsMapData(failureMechanism.Sections, mapDataList[sectionsIndex]);
MapDataTestHelper.AssertFailureMechanismSectionsStartPointMapData(failureMechanism.Sections, mapDataList[sectionsStartPointIndex]);
MapDataTestHelper.AssertFailureMechanismSectionsEndPointMapData(failureMechanism.Sections, mapDataList[sectionsEndPointIndex]);
MapDataTestHelper.AssertHydraulicBoundaryLocationsMapData(assessmentSection.HydraulicBoundaryDatabase.Locations, mapDataList[hydraulicBoundaryLocationsIndex]);
}
}
[Test]
[TestCaseSource(nameof(GetCalculationFuncs))]
public void GivenViewWithHydraulicBoundaryLocationsData_WhenHydraulicBoundaryLocationCalculationUpdatedAndNotified_ThenMapDataUpdated(
Func getCalculationFunc)
{
// Given
var hydraulicBoundaryLocation = new HydraulicBoundaryLocation(1, "test1", 1.0, 2.0);
var assessmentSection = new ObservableTestAssessmentSectionStub();
assessmentSection.AddHydraulicBoundaryLocation(hydraulicBoundaryLocation);
using (var view = new FailureMechanismView(new TestFailureMechanism(), assessmentSection))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
MapData hydraulicBoundaryLocationsMapData = map.Data.Collection.ElementAt(hydraulicBoundaryLocationsIndex);
// Precondition
MapDataTestHelper.AssertHydraulicBoundaryLocationOutputsMapData(assessmentSection, hydraulicBoundaryLocationsMapData);
// When
HydraulicBoundaryLocationCalculation calculation = getCalculationFunc(assessmentSection);
calculation.Output = new TestHydraulicBoundaryLocationOutput(new Random(21).NextDouble());
calculation.NotifyObservers();
// Then
MapDataTestHelper.AssertHydraulicBoundaryLocationOutputsMapData(assessmentSection, hydraulicBoundaryLocationsMapData);
}
}
[Test]
public void UpdateObserver_HydraulicBoundaryLocationsDataUpdated_MapDataUpdated()
{
// Setup
var assessmentSection = new ObservableTestAssessmentSectionStub();
assessmentSection.AddHydraulicBoundaryLocation(new HydraulicBoundaryLocation(1, "test1", 1.0, 2.0));
using (var view = new FailureMechanismView(new TestFailureMechanism(), assessmentSection))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
MapData hydraulicBoundaryLocationsMapData = map.Data.Collection.ElementAt(hydraulicBoundaryLocationsIndex);
// Precondition
MapDataTestHelper.AssertHydraulicBoundaryLocationsMapData(assessmentSection.HydraulicBoundaryDatabase.Locations, hydraulicBoundaryLocationsMapData);
// Call
assessmentSection.AddHydraulicBoundaryLocation(new HydraulicBoundaryLocation(2, "test2", 3.0, 4.0));
assessmentSection.HydraulicBoundaryDatabase.Locations.NotifyObservers();
// Assert
MapDataTestHelper.AssertHydraulicBoundaryLocationsMapData(assessmentSection.HydraulicBoundaryDatabase.Locations, hydraulicBoundaryLocationsMapData);
}
}
[Test]
public void UpdateObserver_ReferenceLineUpdated_MapDataUpdated()
{
// Setup
var referenceLine = new ReferenceLine();
referenceLine.SetGeometry(new List
{
new Point2D(1.0, 2.0),
new Point2D(2.0, 1.0)
});
var assessmentSection = new ObservableTestAssessmentSectionStub
{
ReferenceLine = referenceLine
};
using (var view = new FailureMechanismView(new TestFailureMechanism(), assessmentSection))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
MapData referenceLineMapData = map.Data.Collection.ElementAt(referenceLineIndex);
// Precondition
MapDataTestHelper.AssertReferenceLineMapData(assessmentSection.ReferenceLine, referenceLineMapData);
// Call
assessmentSection.ReferenceLine.SetGeometry(new List
{
new Point2D(2.0, 5.0),
new Point2D(4.0, 3.0)
});
assessmentSection.NotifyObservers();
// Assert
MapDataTestHelper.AssertReferenceLineMapData(assessmentSection.ReferenceLine, referenceLineMapData);
}
}
[Test]
public void UpdateObserver_FailureMechanismSectionsUpdated_MapDataUpdated()
{
// Setup
var failureMechanism = new TestFailureMechanism();
using (var view = new FailureMechanismView(failureMechanism, new ObservableTestAssessmentSectionStub()))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
var sectionMapData = (MapLineData) map.Data.Collection.ElementAt(sectionsIndex);
var sectionStartsMapData = (MapPointData) map.Data.Collection.ElementAt(sectionsStartPointIndex);
var sectionsEndsMapData = (MapPointData) map.Data.Collection.ElementAt(sectionsEndPointIndex);
// Call
failureMechanism.AddSection(new FailureMechanismSection(string.Empty, new[]
{
new Point2D(1, 2),
new Point2D(1, 2)
}));
failureMechanism.NotifyObservers();
// Assert
MapDataTestHelper.AssertFailureMechanismSectionsMapData(failureMechanism.Sections, sectionMapData);
MapDataTestHelper.AssertFailureMechanismSectionsStartPointMapData(failureMechanism.Sections, sectionStartsMapData);
MapDataTestHelper.AssertFailureMechanismSectionsEndPointMapData(failureMechanism.Sections, sectionsEndsMapData);
}
}
[Test]
public void UpdateObserver_DataUpdated_MapLayersSameOrder()
{
// Setup
const int updatedRefenceLineLayerIndex = referenceLineIndex + 4;
const int updatedSectionsLayerIndex = sectionsIndex - 1;
const int updateSectionStartLayerIndex = sectionsStartPointIndex - 1;
const int updatedSectionEndLayerIndex = sectionsEndPointIndex - 1;
const int updatedHydraulicLocationsLayerIndex = hydraulicBoundaryLocationsIndex - 1;
var assessmentSection = new ObservableTestAssessmentSectionStub();
var failureMechanism = new TestFailureMechanism();
using (var view = new FailureMechanismView(failureMechanism, assessmentSection))
{
IMapControl map = ((RingtoetsMapControl) view.Controls[0]).MapControl;
MapDataCollection mapData = map.Data;
var dataToMove = (MapLineData) map.Data.Collection.ElementAt(referenceLineIndex);
mapData.Remove(dataToMove);
mapData.Add(dataToMove);
List mapDataList = mapData.Collection.ToList();
// Precondition
var referenceLineData = (MapLineData) mapDataList[updatedRefenceLineLayerIndex];
Assert.AreEqual("Referentielijn", referenceLineData.Name);
var sectionsData = (MapLineData) mapDataList[updatedSectionsLayerIndex];
Assert.AreEqual("Vakindeling", sectionsData.Name);
var sectionStartsData = (MapPointData) mapDataList[updateSectionStartLayerIndex];
Assert.AreEqual("Vakindeling (startpunten)", sectionStartsData.Name);
var sectionEndsData = (MapPointData) mapDataList[updatedSectionEndLayerIndex];
Assert.AreEqual("Vakindeling (eindpunten)", sectionEndsData.Name);
var hydraulicLocationsData = (MapPointData) mapDataList[updatedHydraulicLocationsLayerIndex];
Assert.AreEqual("Hydraulische randvoorwaarden", hydraulicLocationsData.Name);
var points = new List
{
new Point2D(2.0, 5.0),
new Point2D(4.0, 3.0)
};
var referenceLine = new ReferenceLine();
referenceLine.SetGeometry(points);
assessmentSection.ReferenceLine = referenceLine;
// Call
assessmentSection.NotifyObservers();
// Assert
var actualReferenceLineData = (MapLineData) mapDataList[updatedRefenceLineLayerIndex];
Assert.AreEqual("Referentielijn", actualReferenceLineData.Name);
var actualSectionsData = (MapLineData) mapDataList[updatedSectionsLayerIndex];
Assert.AreEqual("Vakindeling", actualSectionsData.Name);
var actualSectionStartsData = (MapPointData) mapDataList[updateSectionStartLayerIndex];
Assert.AreEqual("Vakindeling (startpunten)", actualSectionStartsData.Name);
var actualSectionEndsData = (MapPointData) mapDataList[updatedSectionEndLayerIndex];
Assert.AreEqual("Vakindeling (eindpunten)", actualSectionEndsData.Name);
var actualHydraulicLocationsData = (MapPointData) mapDataList[updatedHydraulicLocationsLayerIndex];
Assert.AreEqual("Hydraulische randvoorwaarden", actualHydraulicLocationsData.Name);
}
}
private static void AssertEmptyMapData(MapDataCollection mapDataCollection)
{
Assert.AreEqual("Test failure mechanism", mapDataCollection.Name);
List mapDataList = mapDataCollection.Collection.ToList();
Assert.AreEqual(5, mapDataList.Count);
var referenceLineMapData = (MapLineData) mapDataList[referenceLineIndex];
var sectionsMapData = (MapLineData) mapDataList[sectionsIndex];
var sectionsStartPointMapData = (MapPointData) mapDataList[sectionsStartPointIndex];
var sectionsEndPointMapData = (MapPointData) mapDataList[sectionsEndPointIndex];
var hydraulicBoundaryLocationsMapData = (MapPointData) mapDataList[hydraulicBoundaryLocationsIndex];
CollectionAssert.IsEmpty(referenceLineMapData.Features);
CollectionAssert.IsEmpty(sectionsMapData.Features);
CollectionAssert.IsEmpty(sectionsStartPointMapData.Features);
CollectionAssert.IsEmpty(sectionsEndPointMapData.Features);
CollectionAssert.IsEmpty(hydraulicBoundaryLocationsMapData.Features);
Assert.AreEqual("Referentielijn", referenceLineMapData.Name);
Assert.AreEqual("Vakindeling", sectionsMapData.Name);
Assert.AreEqual("Vakindeling (startpunten)", sectionsStartPointMapData.Name);
Assert.AreEqual("Vakindeling (eindpunten)", sectionsEndPointMapData.Name);
Assert.AreEqual("Hydraulische randvoorwaarden", hydraulicBoundaryLocationsMapData.Name);
}
}
}