// 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.IO;
using System.Linq;
using System.Windows.Forms;
using Core.Common.TestUtil;
using NUnit.Extensions.Forms;
using NUnit.Framework;
using Rhino.Mocks;
using Ringtoets.Common.Data.Hydraulics;
using Ringtoets.Common.Data.TestUtil;
using Ringtoets.Common.Forms.GuiServices;
using Ringtoets.Common.Service.MessageProviders;
using Ringtoets.Common.Service.TestUtil;
using Ringtoets.HydraRing.Calculation.Calculator.Factory;
using Ringtoets.HydraRing.Calculation.TestUtil.Calculator;
namespace Ringtoets.Common.Forms.Test.GuiServices
{
[TestFixture]
public class HydraulicBoundaryLocationCalculationGuiServiceTest : NUnitFormTest
{
private MockRepository mockRepository;
private readonly string testDataPath = TestHelper.GetTestDataPath(TestDataPath.Ringtoets.Integration.Service, "HydraRingCalculation");
[Test]
public void Constructor_NullMainWindow_ThrowsArgumentNullException()
{
// Setup & Call
TestDelegate test = () => new HydraulicBoundaryLocationCalculationGuiService(null);
// Assert
string paramName = Assert.Throws(test).ParamName;
const string expectedParamName = "viewParent";
Assert.AreEqual(expectedParamName, paramName);
}
[Test]
public void Constructor_DefaultValues()
{
// Setup
using (var viewParent = new Form())
{
// Call
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Assert
Assert.IsInstanceOf(guiService);
}
}
[Test]
public void CalculateDesignWaterLevels_NullCalculationServiceMessageProvider_ThrowsArgumentNullException()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
mockRepository.ReplayAll();
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
TestDelegate test = () => guiService.CalculateDesignWaterLevels(null, Enumerable.Empty(), 1, null);
// Assert
string paramName = Assert.Throws(test).ParamName;
const string expectedParamName = "messageProvider";
Assert.AreEqual(expectedParamName, paramName);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_NullLocations_ThrowsArgumentNullException()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
TestDelegate test = () => guiService.CalculateDesignWaterLevels(databasePath, null, 1, calculationMessageProviderMock);
// Assert
string paramName = Assert.Throws(test).ParamName;
const string expectedParamName = "locations";
Assert.AreEqual(expectedParamName, paramName);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_HydraulicDatabaseDoesNotExist_LogsError()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateDesignWaterLevels(databasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
string[] msgs = messages.ToArray();
Assert.AreEqual(1, msgs.Length);
StringAssert.StartsWith("Berekeningen konden niet worden gestart. ", msgs.First());
});
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_HydraulicDatabaseDoesNotExist_SuccessfulCalculationFalse()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateDesignWaterLevels(databasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
Assert.IsFalse(successfulCalculation);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_ValidPathEmptyList_NoLog()
{
// Setup
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateDesignWaterLevels(validDatabasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessagesCount(call, 0);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_ValidPathEmptyList_SuccessfulCalculationTrue()
{
// Setup
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateDesignWaterLevels(validDatabasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
Assert.IsTrue(successfulCalculation);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_ValidPathOneLocationInTheList_LogsMessages()
{
// Setup
const string hydraulicLocationName = "name";
const string calculationName = "calculationName";
const string calculatedNotConvergedMessage = "calculatedNotConvergedMessage";
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
calculatorFactory.Expect(cf => cf.CreateDesignWaterLevelCalculator(testDataPath)).Return(new TestDesignWaterLevelCalculator());
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityDescription(hydraulicLocationName)).Return(string.Empty);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(hydraulicLocationName)).Return(calculationName).Repeat.AtLeastOnce();
calculationMessageProviderMock.Expect(calc => calc.GetCalculatedNotConvergedMessage(hydraulicLocationName)).Return(calculatedNotConvergedMessage);
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateDesignWaterLevels(validDatabasePath,
new List
{
new TestHydraulicBoundaryLocation(hydraulicLocationName)
},
1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
string[] msgs = messages.ToArray();
Assert.AreEqual(7, msgs.Length);
CalculationServiceTestHelper.AssertValidationStartMessage(calculationName, msgs[0]);
CalculationServiceTestHelper.AssertValidationEndMessage(calculationName, msgs[1]);
CalculationServiceTestHelper.AssertCalculationStartMessage(calculationName, msgs[2]);
Assert.AreEqual(calculatedNotConvergedMessage, msgs[3]);
StringAssert.StartsWith("Toetspeil berekening is uitgevoerd op de tijdelijke locatie", msgs[4]);
CalculationServiceTestHelper.AssertCalculationEndMessage(calculationName, msgs[5]);
StringAssert.AreNotEqualIgnoringCase($"Uitvoeren van '{calculationName}' is gelukt.", msgs[6]);
});
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateDesignWaterLevels_ValidPathOneLocationInTheList_SuccessfulCalculationTrue()
{
// Setup
const string hydraulicLocationName = "name";
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
calculatorFactory.Expect(cf => cf.CreateDesignWaterLevelCalculator(testDataPath)).Return(new TestDesignWaterLevelCalculator());
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityDescription(hydraulicLocationName)).Return(string.Empty);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(hydraulicLocationName)).Return(string.Empty).Repeat.AtLeastOnce();
calculationMessageProviderMock.Expect(calc => calc.GetCalculatedNotConvergedMessage(hydraulicLocationName)).Return(string.Empty);
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateDesignWaterLevels(validDatabasePath,
new List
{
new TestHydraulicBoundaryLocation(hydraulicLocationName)
},
1, calculationMessageProviderMock);
// Assert
Assert.IsTrue(successfulCalculation);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_NullCalculationServiceMessageProvider_ThrowsArgumentNullException()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
mockRepository.ReplayAll();
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
TestDelegate test = () => guiService.CalculateWaveHeights(null, Enumerable.Empty(), 1, null);
// Assert
string paramName = Assert.Throws(test).ParamName;
const string expectedParamName = "messageProvider";
Assert.AreEqual(expectedParamName, paramName);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_NullLocations_ThrowsArgumentNullException()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
TestDelegate test = () => guiService.CalculateWaveHeights(databasePath, null, 1, calculationMessageProviderMock);
// Assert
string paramName = Assert.Throws(test).ParamName;
const string expectedParamName = "locations";
Assert.AreEqual(expectedParamName, paramName);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_HydraulicDatabaseDoesNotExist_LogsError()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateWaveHeights(databasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
string[] msgs = messages.ToArray();
Assert.AreEqual(1, msgs.Length);
StringAssert.StartsWith("Berekeningen konden niet worden gestart. ", msgs.First());
});
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_HydraulicDatabaseDoesNotExist_SuccessfulCalculationFalse()
{
// Setup
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
const string databasePath = "Does not exist";
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateWaveHeights(databasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
Assert.IsFalse(successfulCalculation);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_ValidPathEmptyList_NoLog()
{
// Setup
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateWaveHeights(validDatabasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessagesCount(call, 0);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_ValidPathEmptyList_SuccessfulCalculationTrue()
{
// Setup
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateWaveHeights(validDatabasePath, Enumerable.Empty(), 1, calculationMessageProviderMock);
// Assert
Assert.IsTrue(successfulCalculation);
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_ValidPathOneLocationInTheList_LogsMessages()
{
// Setup
const string hydraulicLocationName = "name";
const string calculationName = "calculationName";
const string calculatedNotConvergedMessage = "calculatedNotConvergedMessage";
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
calculatorFactory.Expect(cf => cf.CreateWaveHeightCalculator(testDataPath)).Return(new TestWaveHeightCalculator());
var calculationMessageProviderMock = mockRepository.StrictMock();
calculationMessageProviderMock.Expect(calc => calc.GetActivityDescription(hydraulicLocationName)).Return(string.Empty);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(hydraulicLocationName)).Return(calculationName).Repeat.AtLeastOnce();
calculationMessageProviderMock.Expect(calc => calc.GetCalculatedNotConvergedMessage(hydraulicLocationName)).Return(calculatedNotConvergedMessage);
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
Action call = () => guiService.CalculateWaveHeights(validDatabasePath,
new List
{
new TestHydraulicBoundaryLocation(hydraulicLocationName)
},
1, calculationMessageProviderMock);
// Assert
TestHelper.AssertLogMessages(call, messages =>
{
string[] msgs = messages.ToArray();
Assert.AreEqual(7, msgs.Length);
CalculationServiceTestHelper.AssertValidationStartMessage(calculationName, msgs[0]);
CalculationServiceTestHelper.AssertValidationEndMessage(calculationName, msgs[1]);
CalculationServiceTestHelper.AssertCalculationStartMessage(calculationName, msgs[2]);
Assert.AreEqual(calculatedNotConvergedMessage, msgs[3]);
StringAssert.StartsWith("Golfhoogte berekening is uitgevoerd op de tijdelijke locatie", msgs[4]);
CalculationServiceTestHelper.AssertCalculationEndMessage(calculationName, msgs[5]);
StringAssert.AreNotEqualIgnoringCase($"Uitvoeren van '{calculationName}' is gelukt.", msgs[6]);
});
}
mockRepository.VerifyAll();
}
[Test]
public void CalculateWaveHeights_ValidPathOneLocationInTheList_SuccessfulCalculationTrue()
{
// Setup
const string hydraulicLocationName = "name";
string validDatabasePath = Path.Combine(testDataPath, "HRD dutch coast south.sqlite");
var calculatorFactory = mockRepository.StrictMock();
var calculationMessageProviderMock = mockRepository.StrictMock();
calculatorFactory.Expect(cf => cf.CreateWaveHeightCalculator(testDataPath)).Return(new TestWaveHeightCalculator());
calculationMessageProviderMock.Expect(calc => calc.GetActivityDescription(hydraulicLocationName)).Return(string.Empty);
calculationMessageProviderMock.Expect(calc => calc.GetCalculationName(hydraulicLocationName)).Return(string.Empty).Repeat.AtLeastOnce();
calculationMessageProviderMock.Expect(calc => calc.GetCalculatedNotConvergedMessage(hydraulicLocationName)).Return(string.Empty);
mockRepository.ReplayAll();
DialogBoxHandler = (name, wnd) =>
{
// Expect an activity dialog which is automatically closed
};
using (var viewParent = new Form())
using (new HydraRingCalculatorFactoryConfig(calculatorFactory))
{
var guiService = new HydraulicBoundaryLocationCalculationGuiService(viewParent);
// Call
bool successfulCalculation = guiService.CalculateWaveHeights(validDatabasePath,
new List
{
new TestHydraulicBoundaryLocation(hydraulicLocationName)
},
1, calculationMessageProviderMock);
// Assert
Assert.IsTrue(successfulCalculation);
}
mockRepository.VerifyAll();
}
public override void Setup()
{
mockRepository = new MockRepository();
}
}
}