// 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;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Deltares.DamEngine.Data.Standard;
using Deltares.DamEngine.Io;
using Deltares.DamEngine.Io.XmlInput;
using Deltares.DamEngine.Io.XmlOutput;
using Deltares.DamEngine.TestHelpers;
using Deltares.MacroStability.Io;
using Deltares.MacroStability.Io.XmlInput;
using KellermanSoftware.CompareNetObjects;
using NUnit.Framework;
using Point2DType = Deltares.DamEngine.Io.XmlOutput.Point2DType;
using WaternetType = Deltares.MacroStability.Io.XmlInput.WaternetType;

namespace Deltares.DamEngine.IntegrationTests.IntegrationTests;

[TestFixture]
public class OperationalStabilityProfile1DTests
{
    // Constants for SensorType
    private const uint sourceTypeIgnore = 0;
    private const uint sourceTypeLocationData = 1;
    private const uint sourceTypeSensor = 2;

    public static IEnumerable<TestCaseData> AddTestCases
    {
        get
        {
            yield return new TestCaseData(
                // This is the case that all values are taken from the location data
                new SensorConfiguration
                {
                    SourceTypePl1OuterWaterLevel = sourceTypeLocationData,
                    Pl1OuterWaterLevel = -0.1,
                    SourceTypePl1PlLineOffsetBelowDikeTopAtRiver = sourceTypeLocationData,
                    Pl1PlLineOffsetBelowDikeTopAtRiver = 1.1,
                    SourceTypePl1PlLineOffsetBelowDikeTopAtPolder = sourceTypeLocationData,
                    Pl1PlLineOffsetBelowDikeTopAtPolder = 1.2,
                    SourceTypePl1PlLineOffsetBelowShoulderBaseInside = sourceTypeIgnore,
                    Pl1PlLineOffsetBelowShoulderBaseInside = 0.0,
                    SourceTypePl1PlLineOffsetBelowDikeToeAtPolder = sourceTypeLocationData,
                    Pl1PlLineOffsetBelowDikeToeAtPolder = 1.4,
                    SourceTypePl1PolderLevel = sourceTypeLocationData,
                    PlPolderLevel = -2.0,
                    SourceTypePl3 = sourceTypeLocationData,
                    HeadPl3 = -3.0,
                    SourceTypePl4 = sourceTypeIgnore,
                    HeadPl4 = 0.0
                },
                new PlLinePoints // PL-1
                {
                    Points =
                    [
                        new Point2DType
                        {
                            // Pl1Left
                            X = 0.0, // Expected X-value is leftmost point.X
                            Z = -0.1 // Expected Z-value is the value of location data WaterLevelOutside  of 'Purmer_PU0042+00_K': -0.1
                        },
                        new Point2DType
                        {
                            // Pl1AtDikeTopAtRiver
                            X = 18.731, // Expected X-value is location of DikeTopAtRiver = 18.731
                            Z = -1.2 // Expected Z-value is WaterLevelOutside - PlLineOffsetBelowDikeTopAtRiver = -0.1 - 1.1 = -1.2
                        },
                        new Point2DType
                        {
                            // Pl1AtDikeTopAtPolder
                            X = 22.562, // Expected X-value is location of DikeTopAtPolder = 22.562
                            Z = -1.3 // Expected Z-value is WaterLevelOutside - PlLineOffsetBelowDikeTopAtPolder = -0.1 - 1.2 = -1.3
                        },
                        new Point2DType
                        {
                            // DikeToeAtPolder
                            X = 29.374, // Expected X-value is location of DikeToeAtPolder = 29.374
                            Z = -2.937 // Expected Z-value is WaterLevelOutside - Pl1PlLineOffsetBelowDikeToeAtPolder = -1.357 - 1.4 = -2.937
                        },
                        new Point2DType
                        {
                            // Pl1Right
                            X = 57.896, // Expected X-value is rightmost point.X
                            Z = -2.0 // Expected Z-value is location data Polderlevel of 'Purmer_PU0042+00_K': -2.0
                        }
                    ]
                },
                new PlLinePoints // PL-3
                {
                    Points =
                    [
                        new Point2DType
                        {
                            // Pl3Left
                            X = 0.0, // Expected X-value is leftmost point.X
                            Z = -3.0 // Expected Z-value is the value of location data: -3.0
                        },
                        new Point2DType
                        {
                            // sensor 'PB01786_BuT'
                            X = 11.468, // Expected X-value is the location of the sensor X = 11.486
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the sensor: -2.87
                        },
                        new Point2DType
                        {
                            // sensor 'PB01786'
                            X = 36.185, // Expected X-value is the location of the sensor X = 36.185
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the sensor: -2.87
                        },
                        new Point2DType
                        {
                            // Pl3Right
                            X = 57.896, // Expected X-value is rightmost point.X: 57.896
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the last sensor: -2.87
                        }
                    ]
                },
                null).SetName("OnlyLocationData");
            yield return new TestCaseData(
                // This is the case that all values are taken from the sensor data
                new SensorConfiguration
                {
                    SourceTypePl1OuterWaterLevel = sourceTypeSensor,
                    Pl1OuterWaterLevel = -0.1,
                    SourceTypePl1PlLineOffsetBelowDikeTopAtRiver = sourceTypeIgnore,
                    Pl1PlLineOffsetBelowDikeTopAtRiver = 1.1,
                    SourceTypePl1PlLineOffsetBelowDikeTopAtPolder = sourceTypeIgnore,
                    Pl1PlLineOffsetBelowDikeTopAtPolder = 1.2,
                    SourceTypePl1PlLineOffsetBelowShoulderBaseInside = sourceTypeIgnore,
                    Pl1PlLineOffsetBelowShoulderBaseInside = 0.0,
                    SourceTypePl1PlLineOffsetBelowDikeToeAtPolder = sourceTypeIgnore,
                    Pl1PlLineOffsetBelowDikeToeAtPolder = 1.4,
                    SourceTypePl1PolderLevel = sourceTypeSensor,
                    PlPolderLevel = -2.0,
                    SourceTypePl3 = sourceTypeIgnore,
                    HeadPl3 = -3.0,
                    SourceTypePl4 = sourceTypeIgnore,
                    HeadPl4 = 0.0
                },
                new PlLinePoints
                {
                    Points =
                    [
                        new Point2DType
                        {
                            // Pl1Left amd Waterlevel sensor MPN-AS-27
                            X = 0.0, // Expected X-value is leftmost point.X
                            Z = -0.2 // Expected Z-value is the value of the first timestep of sensor: -0.2
                        },
                        new Point2DType
                        {
                            // Sensor RFT_R52_0110_45m_BuKr
                            X = 18.305, // Expected X-value is location sensor: 18.305
                            Z = 0.24 //  Expected Z-value is the value of the first timestep of sensor RFT_R52_0110_45m_BuKr: -0.2
                        },
                        new Point2DType
                        {
                            // Sensor RFT_R52_0110_45m_BiKr
                            X = 22.563, // Expected X-value is location of sensor = 22.563
                            Z = 0.29 // Expected Z-value is the value of the first timestep of sensor: -0.29
                        },
                        new Point2DType
                        {
                            // Sensor RFT_R52_0110_45m_InstBrm
                            X = 30.225, // Expected X-value is location of sensor: 30.225
                            Z = -2.35 // Expected Z-value is the value of the first timestep of sensor: -2.35
                        },
                        new Point2DType
                        {
                            // Sensor RFT_R52_0110_45m_BiT
                            X = 36.185, // Expected X-value is location of sensor: 36.185
                            Z = -3.23 // Expected Z-value is the value of the first timestep of sensor: -3.23
                        },
                        new Point2DType
                        {
                            // Pl1Right
                            X = 57.896, // Expected X-value is rightmost point.X
                            Z = -2.0 // Expected Z-value is location data Polderlevel of 'Purmer_PU0042+00_K': -2.0
                        }
                    ]
                },
                new PlLinePoints // PL-3
                {
                    Points =
                    [
                        new Point2DType
                        {
                            // Pl3Left
                            X = 0.0, // Expected X-value is leftmost point.X
                            Z = -0.2 // Expected Z-value is the value of the Waterlevel: -0.2
                        },
                        new Point2DType
                        {
                            // sensor 'PB01786_BuT'
                            X = 11.468, // Expected X-value is the location of the sensor X = 11.486
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the sensor: -2.87
                        },
                        new Point2DType
                        {
                            // sensor 'PB01786'
                            X = 36.185, // Expected X-value is the location of the sensor X = 36.185
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the sensor: -2.87
                        },
                        new Point2DType
                        {
                            // Pl3Right
                            X = 57.896, // Expected X-value is rightmost point.X: 57.896
                            Z = -2.87 // Expected Z-value is the value of  the first timestep of the last sensor: -2.87
                        }
                    ]
                },
                null).SetName("OnlySensorData");
        }
    }

    // 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
    [Test, Category(Categories.Slow)]
    [TestCaseSource(nameof(AddTestCases))]
    public void GivenStabilityInsideProfile1DProject_WhenCalculatingWithVariationsOnSpecifiedSensorLocationData_ThenExpectedResultIsGenerated(SensorConfiguration sensorConfiguration,
                                                                                                                                              PlLinePoints pl1Points,
                                                                                                                                              PlLinePoints pl3Points,
                                                                                                                                              PlLinePoints pl4Points)
    {
        var projectPath = "SensorProfile1DTests";
        string testCaseName = TestContext.CurrentContext.Test.Name;
        var calcDir = $"DAMLive.Calc.{testCaseName}";
        const string testFilesLocation = @".\TestFiles\Operational\SensorProfile1DTests\";
        string inputFilename = testFilesLocation + "CalculateStabilityInsideBishopGrid1InputFile.xml";
        string outputFilename = testFilesLocation + "CalculateStabilityInsideBishopGrid1OutputFile.xml";
        if (Directory.Exists(calcDir))
        {
            Directory.Delete(calcDir, true); // delete previous results
        }

        Input input = DamXmlSerialization.LoadInputFromXmlFile(inputFilename);
        input.CalculationMap = calcDir;
        input.ProjectPath = projectPath;
        Location location = input.Locations[0];
        FillSensorLocation(input.SensorData.SensorLocations[0], location, sensorConfiguration);
        string inputString = DamXmlSerialization.SaveInputAsXmlString(input);
        DamXmlSerialization.SaveInputAsXmlFile(inputFilename, input);
        Output output = GeneralHelper.RunAfterInputValidation(inputString, true, outputFilename);
        Assert.That(output, Is.Not.Null);
        // Read the kernel input data from the input file
        var kernelInputFilename = $"{projectPath}\\{calcDir}\\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 = MacroStabilityXmlSerialization.LoadInputFromXmlFile(kernelInputFilename);

        WaternetType waternet = expectedMacrostabilityInput.StabilityModel.ConstructionStages[0].Waternet;
        // Check the phreatic line
        List<MacroStability.Io.XmlInput.Point2DType> phreaticLine = waternet.PhreaticLine.WaternetLine.Points.ToList();
        var messages = new List<string>();
        messages.Add("Failing assertions");
        bool arePointsInLine = ArePointsInLine(pl1Points, phreaticLine, "PL-1", messages);
        // PL-3 
        List<MacroStability.Io.XmlInput.Point2DType> pl3 = waternet.HeadLines.Any() ? waternet.HeadLines[0]?.WaternetLine.Points.ToList() : null;
        arePointsInLine = arePointsInLine && ArePointsInLine(pl3Points, pl3, "PL-3", messages);
        // PL-4
        List<MacroStability.Io.XmlInput.Point2DType> pl4 = waternet.HeadLines?.Length > 1 ? waternet.HeadLines[1]?.WaternetLine.Points.ToList() : null;
        arePointsInLine = arePointsInLine && ArePointsInLine(pl4Points, pl4, "PL-4", messages);
        string assertMessage = string.Join(Environment.NewLine, messages);
        Assert.That(arePointsInLine, Is.True, assertMessage);
    }

    [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
            var 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 = 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 bool ArePointsInLine(PlLinePoints pointsToFind, List<MacroStability.Io.XmlInput.Point2DType> line, string lineName, List<string> messages)
    {
        const double tolerance = 0.0005;
        if (pointsToFind == null)
        {
            return true;
        }

        var arePointsInLine = true;
        var missingPoints = new List<string>();
        foreach (Point2DType point in pointsToFind.Points)
        {
            bool isPointExists = (line != null) && line.Any(p => p.X.IsNearEqual(point.X, tolerance) && p.Z.IsNearEqual(point.Z, tolerance));
            if (!isPointExists)
            {
                missingPoints.Add($"X: {point.X}, Z: {point.Z}");
                arePointsInLine = false;
            }
        }

        if (!arePointsInLine)
        {
            messages.Add($"The following points were not found in {lineName}");
            messages.AddRange(missingPoints);
        }

        return arePointsInLine;
    }

    public class SensorConfiguration
    {
        public uint SourceTypePl1OuterWaterLevel { get; set; } = sourceTypeSensor;
        public double Pl1OuterWaterLevel { get; set; }
        public uint SourceTypePl1PlLineOffsetBelowDikeTopAtRiver { get; set; } = sourceTypeIgnore;
        public double Pl1PlLineOffsetBelowDikeTopAtRiver { get; set; }
        public uint SourceTypePl1PlLineOffsetBelowDikeTopAtPolder { get; set; } = sourceTypeIgnore;
        public double Pl1PlLineOffsetBelowDikeTopAtPolder { get; set; }
        public uint SourceTypePl1PlLineOffsetBelowShoulderBaseInside { get; set; } = sourceTypeIgnore;
        public double Pl1PlLineOffsetBelowShoulderBaseInside { get; set; }
        public uint SourceTypePl1PlLineOffsetBelowDikeToeAtPolder { get; set; } = sourceTypeIgnore;
        public double Pl1PlLineOffsetBelowDikeToeAtPolder { get; set; }
        public uint SourceTypePl1PolderLevel { get; set; } = sourceTypeSensor;
        public double PlPolderLevel { get; set; }
        public uint SourceTypePl3 { get; set; } = sourceTypeLocationData;
        public double HeadPl3 { get; set; }
        public uint SourceTypePl4 { get; set; } = sourceTypeLocationData;
        public double HeadPl4 { get; set; }
    }

    public class PlLinePoints
    {
        public List<Point2DType> Points { get; set; }
    }

    private static void FillSensorLocation(SensorLocation sensorDataSensorLocation, Location location, SensorConfiguration sensorConfiguration)
    {
        sensorDataSensorLocation.SourceTypePl1WaterLevelAtRiver = sensorConfiguration.SourceTypePl1OuterWaterLevel;
        location.DesignScenarios[0].RiverLevel = sensorConfiguration.Pl1OuterWaterLevel;
        sensorDataSensorLocation.SourceTypePl1PlLineOffsetBelowDikeTopAtRiver = sensorConfiguration.SourceTypePl1PlLineOffsetBelowDikeTopAtRiver;
        location.DesignScenarios[0].PlLineOffsetBelowDikeTopAtRiver = sensorConfiguration.Pl1PlLineOffsetBelowDikeTopAtRiver;
        sensorDataSensorLocation.SourceTypePl1PlLineOffsetBelowDikeTopAtPolder = sensorConfiguration.SourceTypePl1PlLineOffsetBelowDikeTopAtPolder;
        location.DesignScenarios[0].PlLineOffsetBelowDikeTopAtPolder = sensorConfiguration.Pl1PlLineOffsetBelowDikeTopAtPolder;
        sensorDataSensorLocation.SourceTypePl1PlLineOffsetBelowShoulderBaseInside = sensorConfiguration.SourceTypePl1PlLineOffsetBelowShoulderBaseInside;
        location.DesignScenarios[0].PlLineOffsetBelowShoulderBaseInside = sensorConfiguration.Pl1PlLineOffsetBelowShoulderBaseInside;
        sensorDataSensorLocation.SourceTypePl1PlLineOffsetBelowDikeToeAtPolder = sensorConfiguration.SourceTypePl1PlLineOffsetBelowDikeToeAtPolder;
        location.DesignScenarios[0].PlLineOffsetBelowDikeToeAtPolder = sensorConfiguration.Pl1PlLineOffsetBelowDikeToeAtPolder;
        sensorDataSensorLocation.SourceTypePl1WaterLevelAtPolder = sensorConfiguration.SourceTypePl1PolderLevel;
        location.DesignScenarios[0].PolderLevel = sensorConfiguration.PlPolderLevel;
        sensorDataSensorLocation.SourceTypePl3 = sensorConfiguration.SourceTypePl3;
        location.DesignScenarios[0].HeadPl3 = sensorConfiguration.HeadPl3;
        location.DesignScenarios[0].HeadPl3Specified = true;
        sensorDataSensorLocation.SourceTypePl4 = sensorConfiguration.SourceTypePl4;
        location.DesignScenarios[0].HeadPl4Specified = true;
        location.DesignScenarios[0].HeadPl4 = sensorConfiguration.HeadPl4;
    }

    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");
    }
}