// 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 System;
using System.IO;
using System.Linq;
using Core.Common.Base.Data;
using Core.Common.Base.Service;
using Core.Common.TestUtil;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Service.MessageProviders;
using Ringtoets.Common.Service.TestUtil;
using Ringtoets.HydraRing.Data;
namespace Ringtoets.Common.Service.Test
{
[TestFixture]
public class WaveHeightCalculationActivityTest
{
private const string validFile = "HRD dutch coast south.sqlite";
private MockRepository mockRepository;
private readonly string testDataPath = TestHelper.GetTestDataPath(TestDataPath.Ringtoets.Integration.Service, "HydraRingCalculation");
[SetUp]
public void SetUp()
{
mockRepository = new MockRepository();
}
[Test]
public void ParameteredConstructor_ExpectedValues()
{
// Setup
const string locationName = "locationName";
const string activityName = "GetActivityName";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName);
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return(activityName);
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
// Call
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock, hydraulicBoundaryLocationMock, validFilePath, "", 1);
// Assert
Assert.IsInstanceOf(activity);
Assert.AreSame(activityName, activity.Name);
Assert.IsNull(activity.ProgressText);
Assert.AreEqual(ActivityState.None, activity.State);
}
[Test]
public void ParameteredConstructor_NullCalculationServiceMessageProvider_ThrowsArgumentNullException()
{
// Setup
var hydraulicBoundaryLocationMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
// Call
TestDelegate call = () => new WaveHeightCalculationActivity(null, hydraulicBoundaryLocationMock, validFilePath, "", 1);
// Assert
var exception = Assert.Throws(call);
Assert.AreEqual("messageProvider", exception.ParamName);
mockRepository.VerifyAll();
}
[Test]
public void ParameteredConstructor_HydraulicBoundaryLocationNull_ThrowsArgumentNullException()
{
// Setup
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
// Call
TestDelegate call = () => new WaveHeightCalculationActivity(calculationMessageProviderMock, null, validFilePath, "", 1);
// Assert
var exception = Assert.Throws(call);
Assert.AreEqual("hydraulicBoundaryLocation", exception.ParamName);
mockRepository.VerifyAll();
}
[Test]
public void Run_InvalidHydraulicBoundaryDatabase_PerformValidationAndLogStartAndEndAndError()
{
// Setup
string inValidFilePath = Path.Combine(testDataPath, "notexisting.sqlite");
const string locationName = "testLocation";
const string activityName = "GetActivityName";
const string calculationName = "locationName";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Id).Return(1);
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, double.NaN);
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return(activityName);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(locationName)).Return(calculationName).Repeat.AtLeastOnce();
mockRepository.ReplayAll();
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock,
hydraulicBoundaryLocationMock, inValidFilePath, "", 1);
// Call
Action call = () => activity.Run();
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
var msgs = messages.ToArray();
Assert.AreEqual(3, msgs.Length);
StringAssert.StartsWith(string.Format("Validatie van '{0}' gestart om: ", calculationName), msgs[0]);
StringAssert.StartsWith("Herstellen van de verbinding met de hydraulische randvoorwaardendatabase is mislukt. Fout bij het lezen van bestand", msgs[1]);
StringAssert.StartsWith(string.Format("Validatie van '{0}' beëindigd om: ", calculationName), msgs[2]);
});
Assert.AreEqual(ActivityState.Failed, activity.State);
}
[Test]
public void Run_ValidHydraulicBoundaryLocation_PerformValidationAndCalculationAndLogStartAndEnd()
{
// Setup
string validFilePath = Path.Combine(testDataPath, validFile);
const string locationName = "locationName";
const string activityName = "GetActivityName";
const string calculationName = "locationName";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, double.NaN);
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return(activityName);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(locationName)).Return(calculationName).Repeat.AtLeastOnce();
mockRepository.ReplayAll();
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock,
hydraulicBoundaryLocationMock,
validFilePath, "", 30);
using (new WaveHeightCalculationServiceConfig())
{
var testService = (TestHydraulicBoundaryLocationCalculationService) WaveHeightCalculationService.Instance;
// Call
activity.Run();
// Assert
Assert.AreSame(calculationMessageProviderMock, testService.MessageProvider);
}
Assert.AreEqual(ActivityState.Executed, activity.State);
mockRepository.VerifyAll();
}
[Test]
public void Run_CalculationAlreadyRan_ValidationAndCalculationNotPerformedAndStateSkipped()
{
// Setup
string validFilePath = Path.Combine(testDataPath, validFile);
const string locationName = "locationName";
const string activityName = "GetActivityName";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, 3.0);
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return(activityName);
mockRepository.ReplayAll();
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock,
hydraulicBoundaryLocationMock, validFilePath, "", 30);
// Call
Action call = () => activity.Run();
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
var msgs = messages.ToArray();
Assert.AreEqual(0, msgs.Length);
});
Assert.AreEqual(ActivityState.Skipped, activity.State);
mockRepository.VerifyAll();
}
[Test]
public void Finish_ValidCalculationAndRun_SetsProperties()
{
// Setup
const string locationName = "locationName";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, double.NaN);
hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence = CalculationConvergence.CalculatedNotConverged;
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return("");
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(locationName)).Return("").Repeat.AtLeastOnce();
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock, hydraulicBoundaryLocationMock,
validFilePath, "", 30);
using (new WaveHeightCalculationServiceConfig())
{
activity.Run();
}
// Call
activity.Finish();
// Assert
Assert.IsFalse(double.IsNaN(hydraulicBoundaryLocationMock.WaveHeight));
Assert.AreEqual(CalculationConvergence.CalculatedConverged, hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence);
mockRepository.VerifyAll();
}
[Test]
public void Finish_InvalidCalculationAndRun_DoesNotSetProperties()
{
// Setup
var calculationMessageProviderMock = mockRepository.StrictMock();
const string locationName = "locationName";
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return("");
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(locationName)).Return("").Repeat.AtLeastOnce();
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, double.NaN);
hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence = CalculationConvergence.CalculatedConverged;
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock, hydraulicBoundaryLocationMock,
validFilePath, "", 30);
using (new WaveHeightCalculationServiceConfig())
{
var testService = (TestHydraulicBoundaryLocationCalculationService) WaveHeightCalculationService.Instance;
testService.CalculationConvergenceOutput = CalculationConvergence.NotCalculated;
activity.Run();
}
// Call
activity.Finish();
// Assert
Assert.IsNaN(hydraulicBoundaryLocationMock.WaveHeight);
Assert.AreEqual(CalculationConvergence.CalculatedConverged, hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence);
mockRepository.VerifyAll();
}
[Test]
public void Finish_ValidCalculationAndRun_LogWarningNoConvergence()
{
// Setup
const string locationName = "locationName";
const string activityName = "getActivityName";
const string calculationNotConvergedMessage = "GetCalculatedNotConvergedMessage";
var hydraulicBoundaryLocationMock = mockRepository.Stub();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.WaveHeight = new RoundedDouble(2, double.NaN);
hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence = CalculationConvergence.CalculatedConverged;
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return(activityName);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(locationName)).Return("GetCalculationName").Repeat.AtLeastOnce();
calculationMessageProviderMock.Expect(calc => calc.GetCalculatedNotConvergedMessage(locationName)).Return(calculationNotConvergedMessage);
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
const int norm = 300;
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock,
hydraulicBoundaryLocationMock,
validFilePath,
"",
norm);
using (new WaveHeightCalculationServiceConfig())
{
var testService = (TestHydraulicBoundaryLocationCalculationService) WaveHeightCalculationService.Instance;
testService.CalculationConvergenceOutput = CalculationConvergence.CalculatedNotConverged;
activity.Run();
}
// Call
Action call = () => activity.Finish();
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
var msgs = messages.ToArray();
Assert.AreEqual(2, msgs.Length);
StringAssert.StartsWith(calculationNotConvergedMessage, msgs[0]);
StringAssert.StartsWith(string.Format("Uitvoeren van '{0}' is gelukt.", activityName), msgs[1]);
});
Assert.AreEqual(CalculationConvergence.CalculatedNotConverged, hydraulicBoundaryLocationMock.WaveHeightCalculationConvergence);
mockRepository.VerifyAll();
}
[Test]
public void Finish_CalculationAlreadyRan_FinishNotPerformed()
{
// Setup
RoundedDouble waveHeight = (RoundedDouble) 3.0;
const string locationName = "Name";
var hydraulicBoundaryLocationMock = mockRepository.StrictMock();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.Name).Return(locationName).Repeat.AtLeastOnce();
hydraulicBoundaryLocationMock.Expect(hbl => hbl.WaveHeight).Return(waveHeight).Repeat.AtLeastOnce();
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityName(locationName)).Return("");
mockRepository.ReplayAll();
string validFilePath = Path.Combine(testDataPath, validFile);
var activity = new WaveHeightCalculationActivity(calculationMessageProviderMock, hydraulicBoundaryLocationMock, validFilePath, "", 30);
activity.Run();
// Call
activity.Finish();
// Assert
mockRepository.VerifyAll();
}
}
}