// Copyright (C) Stichting Deltares 2024. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
// 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.Collections.Generic;
using System.IO;
using System.Linq;
using Deltares.DamEngine.Data.Standard;
using Deltares.DamEngine.Io;
using Deltares.DamEngine.Io.XmlOutput;
using Deltares.DamEngine.TestHelpers;
using Deltares.MacroStability.Io.XmlInput;
using KellermanSoftware.CompareNetObjects;
using NUnit.Framework;
using Point2DType = Deltares.DamEngine.Io.XmlOutput.Point2DType;

namespace Deltares.DamEngine.IntegrationTests.IntegrationTests;

[TestFixture]
public class OperationalStabilityProfile1DTests
{
    [Test, Category(Categories.Slow)]
    // Following testcase based on the DamLive test Deltares.DamLive.Tests.StabilityInsideBishopGridTest
    // "Deltares.DamLive.Tests\TestData\IntegrationTests\StabilityInsideBishopGrid\DAMLive.damx"
    // with DamLive rev.4860
    [TestCase("CalculateStabilityInsideBishopGrid1")]
    // Following testcase based on the DamLive test Deltares.DamLive.Tests.StabilityInsideBishopGridTest
    // "Deltares.DamLive.Tests\TestData\IntegrationTests\StabilityInsideBishopGrid\DAMLive.damx"
    // with DamLive rev.4860
    // This tests if the sensor location data is used in the calculation by changing the source type of Pl1 offset below diketop to
    // use the specified location data (which will be set to 1.1).
    // Expected X-value is location of DikeTopAtPolder = 22.562
    // Expected Z-value is WaterLevelOutside - PlLineOffsetBelowDikeTopAtPolder = -0.2 - 1.1 = -1.3
    [TestCase("CalculateStabilityInsideBishopGrid1", true, 22.562, -1.3)]
    // Following testcase based on the DamLive test Deltares.DamLive.Tests.StabilityInsideUpliftVanBeeSwarmTest
    // "Deltares.DamLive.Tests\TestData\IntegrationTests\StabilityInsideUpliftVanBeeSwarm\DAMLive.damx"
    // with DamLive rev.4860
    [TestCase("CalculateStabilityInsideUpliftVanBeeSwarm1")]
    // Following testcase based on the DamLive test Deltares.DamLive.Tests.StabilityInsideUpliftVanGridTest
    // "Deltares.DamLive.Tests\TestData\IntegrationTests\StabilityInsideUpliftVanGrid\DAMLive.damx"
    // with DamLive rev.4860
    [TestCase("CalculateStabilityInsideUpliftVanGrid1")]
    public void GivenStabilityInsideProfile1DProject_WhenCalculatingWithSpecifiedModel_ThenExpectedResultIsGenerated(
        string baseName, bool isUseSensorLocationData = false, double expectedPlLineXValue = 0.0, double expectedPlLineZValue = 0.0)
    {
        const string calcDir = "DAMLive.Calc";
        const string testFilesLocation = @".\TestFiles\Operational\Profile1DTests\";
        string baseOutputName = baseName;
        if (isUseSensorLocationData)
        {
            baseOutputName += "_UseLocationData";
        }
        string projectPath = baseOutputName;
        string inputFilename = baseName + "InputFile.xml";
        string outputFilename = baseOutputName + "OutputFile.xml";
        if (Directory.Exists(calcDir))
        {
            Directory.Delete(calcDir, true); // delete previous results
        }

        // Load expected output
        // Note 1: The expected output files (e.g. "CalculateStabilityInsideBishopGrid1OutputFile.xml") is also saved to the
        //         working folder
        // Note 2: The expected output files should be generated with the Release build of the solution.
        //         Unfortunately, the Debug build of the solution generates different output files.
        string expectedOutputFileName = testFilesLocation + outputFilename;
        Output expectedOutput = DamXmlSerialization.LoadOutputFromXmlFile(expectedOutputFileName);

        // Given
        // Load input
        string inputString = File.ReadAllText(testFilesLocation + inputFilename);
        inputString = XmlAdapter.ChangeValueInXml(inputString, "ProjectPath", projectPath); // Current directory will be used
        inputString = XmlAdapter.ChangeValueInXml(inputString, "CalculationMap", calcDir); // Current directory will be used
        if (isUseSensorLocationData)
        {
            // Change the source type of Pl1 offset below diketop location data (=1) 
            inputString = XmlAdapter.ChangeValueInXml(inputString, "SourceTypePl1PlLineOffsetBelowDikeTopAtPolder", "1"); 
            inputString = XmlAdapter.ChangeValueInXml(inputString, "PlLineOffsetBelowDikeTopAtPolder", "1.1"); 
        } 
        // When
        // Run calculation
        Output actualOutput = GeneralHelper.RunAfterInputValidation(inputString, true, outputFilename);
        if (isUseSensorLocationData)
        {
            // Read the kernel input data from the input file
            string kernelInputFilename = $"{baseName}_UseLocationData\\DAMLive.Calc\\Stability\\Bishop\\Dik(dike)_Loc(Purmer_PU0042+00_K)_Stp(0)_Mdl(Bishop)_2016-03-02T03_10_00_Pro(Purmer_PU0042+00K).skx";
            FullInputModelType expectedMacrostabilityInput = MacroStability.Io.MacroStabilityXmlSerialization.LoadInputFromXmlFile(kernelInputFilename);
            List<MacroStability.Io.XmlInput.Point2DType> phreaticLine = expectedMacrostabilityInput.StabilityModel.ConstructionStages[0].Waternet.PhreaticLine.WaternetLine.Points.ToList();
            var expectedPoint = new Point2DType()
            {
                X = expectedPlLineXValue,
                Z = expectedPlLineZValue
            };
            const double tolerance = 0.0005;
            bool pointExists = phreaticLine.Any(p => p.X.IsNearEqual(expectedPoint.X, tolerance) && p.Z.IsNearEqual(expectedPoint.Z, tolerance));
            Assert.That(pointExists, Is.True, "The expected point was not found in the phreatic line.");
        } 
        // Then
        // Compare output
        Assert.Multiple(() =>
            {
                Assert.That(actualOutput, Is.Not.Null);
                Assert.That(expectedOutput, Is.Not.Null);
            }
        );
        CompareOutput(expectedOutput, actualOutput);
    }

    private static void CompareOutput(Output expected, Output actual)
    {
        var compare = new CompareLogic
        {
            Config =
            {
                MaxDifferences = 100
            }
        };
        ComparisonResult result = compare.Compare(expected, actual);
        Assert.That(result.Differences, Is.Empty, "Differences found read/write Output object");
    }
}