// 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.ComponentModel;
using Core.Common.Base.Data;
using Core.Common.TestUtil;
using NUnit.Framework;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.FailureMechanism;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Data.TestUtil;
using Ringtoets.Common.Service;
using Ringtoets.GrassCoverErosionOutwards.Data.TestUtil;
namespace Ringtoets.GrassCoverErosionOutwards.Data.Test
{
[TestFixture]
public class GrassCoverErosionOutwardsFailureMechanismExtensionsTest
{
[Test]
public void GetAssessmentLevel_FailureMechanismNull_ThrowsArgumentNullException()
{
// Call
TestDelegate test = () => GrassCoverErosionOutwardsFailureMechanismExtensions.GetAssessmentLevel(null,
new AssessmentSectionStub(),
new TestHydraulicBoundaryLocation(),
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("failureMechanism", paramName);
}
[Test]
public void GetAssessmentLevel_AssessmentSectionNull_ThrowsArgumentNullException()
{
// Setup
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetAssessmentLevel(null,
new TestHydraulicBoundaryLocation(),
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("assessmentSection", paramName);
}
[Test]
public void GetAssessmentLevel_InvalidFailureMechanismCategoryType_ThrowsInvalidEnumArgumentException()
{
// Setup
const int invalidValue = 9999;
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetAssessmentLevel(assessmentSection,
new TestHydraulicBoundaryLocation(),
(FailureMechanismCategoryType) invalidValue);
// Assert
string expectedMessage = $"The value of argument 'categoryType' ({invalidValue}) is invalid for Enum type '{nameof(FailureMechanismCategoryType)}'.";
string parameterName = TestHelper.AssertThrowsArgumentExceptionAndTestMessage(test, expectedMessage).ParamName;
Assert.AreEqual("categoryType", parameterName);
}
[Test]
public void GetAssessmentLevel_HydraulicBoundaryLocationNull_ReturnsNaN()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
RoundedDouble assessmentLevel = failureMechanism.GetAssessmentLevel(assessmentSection,
null,
new Random(32).NextEnumValue());
// Assert
Assert.IsNaN(assessmentLevel);
}
[Test]
public void GetAssessmentLevel_NoCorrespondingCalculation_ReturnsNaN()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
RoundedDouble assessmentLevel = failureMechanism.GetAssessmentLevel(assessmentSection,
new TestHydraulicBoundaryLocation(),
new Random(32).NextEnumValue());
// Assert
Assert.IsNaN(assessmentLevel);
}
[Test]
public void GetAssessmentLevel_NoCorrespondingAssessmentLevelOutput_ReturnsNaN()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var hydraulicBoundaryLocation = new TestHydraulicBoundaryLocation();
assessmentSection.SetHydraulicBoundaryLocationCalculations(new[]
{
hydraulicBoundaryLocation
});
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
RoundedDouble assessmentLevel = failureMechanism.GetAssessmentLevel(assessmentSection,
hydraulicBoundaryLocation,
new Random(32).NextEnumValue());
// Assert
Assert.IsNaN(assessmentLevel);
}
[Test]
[TestCaseSource(
typeof(GrassCoverErosionOutwardsAssessmentSectionTestHelper),
nameof(GrassCoverErosionOutwardsAssessmentSectionTestHelper.GetHydraulicBoundaryLocationCalculationConfigurationPerFailureMechanismCategoryType))]
public void GetAssessmentLevel_HydraulicBoundaryLocationWithOutput_ReturnsCorrespondingAssessmentLevel(
IAssessmentSection assessmentSection,
GrassCoverErosionOutwardsFailureMechanism failureMechanism,
HydraulicBoundaryLocation hydraulicBoundaryLocation,
FailureMechanismCategoryType categoryType,
HydraulicBoundaryLocationCalculation expectedHydraulicBoundaryLocationCalculation)
{
// Call
RoundedDouble assessmentLevel = failureMechanism.GetAssessmentLevel(assessmentSection,
hydraulicBoundaryLocation,
categoryType);
// Assert
Assert.AreEqual(expectedHydraulicBoundaryLocationCalculation.Output.Result, assessmentLevel);
}
[Test]
public void GetHydraulicBoundaryLocationCalculation_FailureMechanismNull_ThrowsArgumentNullException()
{
// Call
TestDelegate test = () => GrassCoverErosionOutwardsFailureMechanismExtensions.GetHydraulicBoundaryLocationCalculation(
null,
new AssessmentSectionStub(),
new TestHydraulicBoundaryLocation(),
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("failureMechanism", paramName);
}
[Test]
public void GetHydraulicBoundaryLocationCalculation_AssessmentSectionNull_ThrowsArgumentNullException()
{
// Setup
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetHydraulicBoundaryLocationCalculation(
null,
new TestHydraulicBoundaryLocation(),
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("assessmentSection", paramName);
}
[Test]
public void GetHydraulicBoundaryLocationCalculation_InvalidFailureMechanismCategoryType_ThrowsInvalidEnumArgumentException()
{
// Setup
const int invalidValue = 9999;
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetHydraulicBoundaryLocationCalculation(assessmentSection,
new TestHydraulicBoundaryLocation(),
(FailureMechanismCategoryType) invalidValue);
// Assert
string expectedMessage = $"The value of argument 'categoryType' ({invalidValue}) is invalid for Enum type '{nameof(FailureMechanismCategoryType)}'.";
string parameterName = TestHelper.AssertThrowsArgumentExceptionAndTestMessage(test, expectedMessage).ParamName;
Assert.AreEqual("categoryType", parameterName);
}
[Test]
public void GetHydraulicBoundaryLocationCalculation_HydraulicBoundaryLocationNull_ReturnsNull()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
HydraulicBoundaryLocationCalculation hydraulicBoundaryLocationCalculation = failureMechanism.GetHydraulicBoundaryLocationCalculation(
assessmentSection,
null,
new Random(32).NextEnumValue());
// Assert
Assert.IsNull(hydraulicBoundaryLocationCalculation);
}
[Test]
public void GetHydraulicBoundaryLocationCalculation_NoCorrespondingCalculation_ReturnsNull()
{
// Setup
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
HydraulicBoundaryLocationCalculation hydraulicBoundaryLocationCalculation = failureMechanism.GetHydraulicBoundaryLocationCalculation(
assessmentSection,
new TestHydraulicBoundaryLocation(),
new Random(32).NextEnumValue());
// Assert
Assert.IsNull(hydraulicBoundaryLocationCalculation);
}
[Test]
[TestCaseSource(
typeof(GrassCoverErosionOutwardsAssessmentSectionTestHelper),
nameof(GrassCoverErosionOutwardsAssessmentSectionTestHelper.GetHydraulicBoundaryLocationCalculationConfigurationPerFailureMechanismCategoryType))]
public void GetHydraulicBoundaryLocationCalculation_HydraulicBoundaryLocationWithOutput_ReturnsCorrespondingHydraulicBoundaryLocationCalculation(
IAssessmentSection assessmentSection,
GrassCoverErosionOutwardsFailureMechanism failureMechanism,
HydraulicBoundaryLocation hydraulicBoundaryLocation,
FailureMechanismCategoryType categoryType,
HydraulicBoundaryLocationCalculation expectedHydraulicBoundaryLocationCalculation)
{
// Call
HydraulicBoundaryLocationCalculation hydraulicBoundaryLocationCalculation = failureMechanism.GetHydraulicBoundaryLocationCalculation(
assessmentSection,
hydraulicBoundaryLocation,
categoryType);
// Assert
Assert.AreSame(expectedHydraulicBoundaryLocationCalculation, hydraulicBoundaryLocationCalculation);
}
[Test]
public void GetNorm_FailureMechanismNull_ThrowsArgumentNullException()
{
// Call
TestDelegate test = () => GrassCoverErosionOutwardsFailureMechanismExtensions.GetNorm(null,
new AssessmentSectionStub(),
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("failureMechanism", paramName);
}
[Test]
public void GetNorm_AssessmentSectionNull_ThrowsArgumentNullException()
{
// Setup
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetNorm(null,
FailureMechanismCategoryType.FactorizedLowerLimitNorm);
// Assert
string paramName = Assert.Throws(test).ParamName;
Assert.AreEqual("assessmentSection", paramName);
}
[Test]
public void GetNorm_InvalidFailureMechanismCategoryType_ThrowsInvalidEnumArgumentException()
{
// Setup
const int invalidValue = 9999;
var assessmentSection = new AssessmentSectionStub();
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism();
// Call
TestDelegate test = () => failureMechanism.GetNorm(assessmentSection,
(FailureMechanismCategoryType) invalidValue);
// Assert
string expectedMessage = $"The value of argument 'categoryType' ({invalidValue}) is invalid for Enum type '{nameof(FailureMechanismCategoryType)}'.";
string parameterName = TestHelper.AssertThrowsArgumentExceptionAndTestMessage(test, expectedMessage).ParamName;
Assert.AreEqual("categoryType", parameterName);
}
[Test]
[TestCaseSource(nameof(GetNormConfigurationPerFailureMechanismCategoryType))]
public void GetNorm_AssessmentSectionWithNormConfiguration_ReturnsCorrespondingNorm(
GrassCoverErosionOutwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection,
FailureMechanismCategoryType categoryType,
double expectedNorm)
{
// Call
double norm = failureMechanism.GetNorm(assessmentSection, categoryType);
// Assert
Assert.AreEqual(expectedNorm, norm);
}
private static IEnumerable GetNormConfigurationPerFailureMechanismCategoryType()
{
const double signalingNorm = 0.002;
const double lowerLimitNorm = 0.005;
var assessmentSection = new AssessmentSectionStub
{
FailureMechanismContribution =
{
LowerLimitNorm = lowerLimitNorm,
SignalingNorm = signalingNorm
}
};
var failureMechanism = new GrassCoverErosionOutwardsFailureMechanism
{
Contribution = 25
};
yield return new TestCaseData(
failureMechanism,
assessmentSection,
FailureMechanismCategoryType.MechanismSpecificFactorizedSignalingNorm,
GetMechanismSpecificNorm(failureMechanism, signalingNorm / 30)
).SetName("MechanismSpecificFactorizedSignalingNorm");
yield return new TestCaseData(
failureMechanism,
assessmentSection,
FailureMechanismCategoryType.MechanismSpecificSignalingNorm,
GetMechanismSpecificNorm(failureMechanism, signalingNorm)
).SetName("MechanismSpecificSignalingNorm");
yield return new TestCaseData(
failureMechanism,
assessmentSection,
FailureMechanismCategoryType.MechanismSpecificLowerLimitNorm,
GetMechanismSpecificNorm(failureMechanism, lowerLimitNorm)
).SetName("MechanismSpecificLowerLimitNorm");
yield return new TestCaseData(
failureMechanism,
assessmentSection,
FailureMechanismCategoryType.LowerLimitNorm,
lowerLimitNorm
).SetName("LowerLimitNorm");
yield return new TestCaseData(
failureMechanism,
assessmentSection,
FailureMechanismCategoryType.FactorizedLowerLimitNorm,
lowerLimitNorm * 30
).SetName("FactorizedLowerLimitNorm");
}
private static double GetMechanismSpecificNorm(GrassCoverErosionOutwardsFailureMechanism failureMechanism,
double norm)
{
return RingtoetsCommonDataCalculationService.ProfileSpecificRequiredProbability(
norm,
failureMechanism.Contribution,
failureMechanism.GeneralInput.N);
}
}
}