// Copyright (C) Stichting Deltares 2018. All rights reserved.
//
// This file is part of the application DAM - UI.
//
// DAM - UI 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 <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.Dam.Data;
using Deltares.Dam.TestHelper;
using Deltares.Geotechnics.Soils;
using Deltares.Geotechnics.SurfaceLines;
using Deltares.Standard.TestUtils;

using KellermanSoftware.CompareNetObjects;
using NUnit.Framework;
using Segment = Deltares.Dam.Data.Segment;

namespace Deltares.Dam.Tests
{
    /// <summary>
    /// In this test the XML serialization is tested. 
    ///   - Can old projects be loaded; A test should be included for each release of the software
    ///   - Can the project be saved and loaded with the current version of the source
    /// </summary>
    [TestFixture]
    public class LoadCompatiblityTest
    {
        CompareLogic compare;

        /// <summary>
        /// Code that is run before each test
        /// </summary>
        [SetUp]
        public void Initialize()
        {
            compare = new CompareLogic();
            compare.Config.MaxDifferences = 100;
            compare.Config.CompareChildren = false;
            compare.Config.DoublePrecision = 0.000000001;
            compare.Config.MembersToIgnore = new List<string>
                                           {
                                               "SurfaceLineId",
                                               "LevelReductionInside", // Never used
                                               "LevelReductionOutside", // Never used
                                               "SheetPilePoint",
                                               "SheetPilePointX", 
                                               "SheetPilePointY", 
                                               "SheetPilePointZ", 
                                               "LocalXZSheetPilePoint", 
                                               "SoilbaseDB", 
                                               "SurfaceLine", 
                                               "LocalXZSurfaceLine",
                                               "SoilLayer1D",
                                               "SoildatabaseName",
                                               "SoilList",
                                               "MapForSoilGeometries2D"
                                           };
        }

        /// <summary>
        /// Create expected location for "TPL_Hempolder_0100"
        /// </summary>
        /// <returns></returns>
        private Location CreateHhnkTplHempolder100()
        {
            Location location = new Location
                       {
                           AreLocalXZObjectsCreated = true,
                           Name = "TPL_Hempolder_0100",
                           DikeRingId = "TPL_Hempolder",
                           Description = "",
                           XRd = 111232.178664511,
                           YRd = 507197.06382921,
                           SegmentId = "234",
                           PolderLevel = -1.29999995232,
                           HeadPL2 = -1.3,
                           XSoilGeometry2DOrigin = 0.0, // actual value
                           DikeEmbankmentMaterial = "HHNK1_Bfg",
                           ShoulderEmbankmentMaterial = "HHNK1_Bfl",
                           DampingFactorPL3 = 0.0, // actual value
                           DampingFactorPL4 = 0.0, // actual value
                           PenetrationLength = 0.0, // actual value
                           TrafficLoad = 5.0,
                           PLLineCreationMethod = PLLineCreationMethod.ExpertKnowledgeRRD,
                           StabilityShoulderGrowSlope = 0.333333333333333,
                           StabilityShoulderGrowDeltaX = 2.0,
                           StabilitySlopeAdaptionDeltaX = 2.0,
                           MinimalCircleDepth = 1.5,
                           DistanceToEntryPoint = 0.0, // actual value
                           StabilityZoneType = MStabZonesType.NoZones,
                           Segment = new Segment
                                         {
                                             Name = "234" , 
                                         },

                       };
            var soilProfile = new SoilProfile1D {Name = "Segment_234_1D1", BottomLevel = -29};
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_kade" }, 30) {IsAquifer = false} );
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfo" }, -1) { IsAquifer = false } );
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Ppp" }, -1.5) { IsAquifer = false } );
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfg" }, -4) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcs" }, -5.5) { IsAquifer = true } );
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Bss" }, -24) { IsAquifer = true });
            location.Segment.AddSoilProfileProbability(soilProfile, 0.0, FailureMechanismSystemType.StabilityInside);
            location.Segment.SoilProfileProbabilities[0].Probability = 69.3;
            soilProfile = new SoilProfile1D { Name = "Segment_234_1D2", BottomLevel = -29 };
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_kade" }, 30) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfo" }, -1) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Ppp" }, -1.5) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfg" }, -4) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcc" }, -5.5) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcs" }, -12.5) { IsAquifer = true });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Bss" }, -24) { IsAquifer = true });
            location.Segment.AddSoilProfileProbability(soilProfile, 0.0, FailureMechanismSystemType.StabilityInside);
            location.Segment.SoilProfileProbabilities[1].Probability = 0.7;
            soilProfile = new SoilProfile1D { Name = "Segment_234_1D3", BottomLevel = -29 };
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_kade" }, 30) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfo" }, -1) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Ppp" }, -1.5) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfg" }, -4) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcs" }, -7) { IsAquifer = true });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Bss" }, -24) { IsAquifer = true });
            location.Segment.AddSoilProfileProbability(soilProfile, 0.0, FailureMechanismSystemType.StabilityInside);
            location.Segment.SoilProfileProbabilities[2].Probability = 29.7;
            soilProfile = new SoilProfile1D { Name = "Segment_234_1D4", BottomLevel = -29 };
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_kade" }, 30) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfo" }, -1) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Ppp" }, -1.5) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tfg" }, -4) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcc" }, -7) { IsAquifer = false });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Tcs" }, -14) { IsAquifer = true });
            soilProfile.Layers.Add(new SoilLayer1D(new Soil { Name = "HHNK1_Bss" }, -24) { IsAquifer = true });
            location.Segment.AddSoilProfileProbability(soilProfile, 0.0, FailureMechanismSystemType.StabilityInside);
            location.Segment.SoilProfileProbabilities[3].Probability = 0.3;
            return location;
        }

        /// <summary>
        /// Compares the soil profiles.
        /// </summary>
        /// <param name="expectedSoilProfile1D">The expected soilprofile1D.</param>
        /// <param name="actualSoilProfile1D">The actual soilprofile1D.</param>
        void CompareSoilProfiles(SoilProfile1D expectedSoilProfile1D, SoilProfile1D actualSoilProfile1D)
        {
            int expectedLayerCount = expectedSoilProfile1D.Layers.Count;
            int actualLayerCount = expectedSoilProfile1D.Layers.Count;
            Assert.AreEqual(expectedLayerCount, actualLayerCount);

            for (int layerIndex = 0; layerIndex < expectedLayerCount; layerIndex++)
            {
                Assert.AreEqual(expectedSoilProfile1D.Layers[layerIndex].Soil.Name, actualSoilProfile1D.Layers[layerIndex].Soil.Name, String.Format("Non-matching name in layer {0}", layerIndex));
                Assert.AreEqual(expectedSoilProfile1D.Layers[layerIndex].IsAquifer, actualSoilProfile1D.Layers[layerIndex].IsAquifer, String.Format("Non-matching isAquifer in layer {0}", layerIndex));
            }
        }

        [Test]
        [Category("Integration")]
        public void CanLoadVersion_1_3_3_1()
        {
            const string projectFilenameHhnk = @"..\..\..\data\Dam\Versions\V 1.3.3.1\HHNK\TPL_Hempolder.damx";
            using (var projectData = ProjectLoader.LoadProjectData(projectFilenameHhnk))
            {
                Assert.AreEqual(DamProjectType.AssessOld, projectData.DamProjectType);
                Assert.AreEqual(0, projectData.Locations.Count);
            }                        
        }


        private static void CheckHempolderSurfaceline(Location actualLocation)
        {
            const double accuracy = 0.01;
            // quick check for surfaceline2 conversion
            Assert.NotNull(actualLocation.SurfaceLine2);
            Assert.AreEqual("TPL_Hempolder_0100", actualLocation.SurfaceLine2.Name);
            Assert.AreEqual(true, actualLocation.SurfaceLine2.CharacteristicPoints.GeometryMustContainPoint);
            Assert.AreEqual(true, actualLocation.SurfaceLine2.HasDike());
            var dikeToeAtRiver = actualLocation.SurfaceLine2.CharacteristicPoints.FirstOrDefault(p => p.CharacteristicPointType == CharacteristicPointType.DikeToeAtRiver);
            Assert.NotNull(dikeToeAtRiver);
            Assert.AreEqual(111222.28, dikeToeAtRiver.X, accuracy);
            Assert.AreEqual(507206.24, dikeToeAtRiver.Y, accuracy);
        }

        /// <summary>
        /// Compares the segments.
        /// </summary>
        /// <param name="expectedLocation">The expected location.</param>
        /// <param name="actualLocation">The actual location.</param>
        private void CompareSegments(Location expectedLocation, Location actualLocation)
        {
            for (int soilProfile1DIndex = 0;
                soilProfile1DIndex < expectedLocation.Segment.SoilProfileProbabilities.Count;
                soilProfile1DIndex++)
            {
                CompareSoilProfiles(expectedLocation.Segment.SoilProfileProbabilities[soilProfile1DIndex].SoilProfile,
                    actualLocation.Segment.SoilProfileProbabilities[soilProfile1DIndex].SoilProfile);
            }
        }

        /// <summary>
        /// Determines whether version_1_5_1_7 can be loaded. 
        /// </summary>
        [Test]
        [Category("Integration")]
        public void CanLoadVersion_1_5_1_7_ScenariosPLLineParameters()
        {
            const string projectFilenameTutorialDesign = @"..\..\..\data\Dam\Versions\V 1.5.1.7\Tutorial Design\DAM Tutorial Design (Old 1.5.1.7).damx";
            using (var projectData = ProjectLoader.LoadProjectData(projectFilenameTutorialDesign))
            {
                foreach (Location location in projectData.Locations)
                {
                    // surfaceline2 present with characteristic points ?
                    Assert.NotNull(location.SurfaceLine2);
                    Assert.AreEqual(location.Name, location.SurfaceLine2.Name);
                    Assert.AreEqual(true, location.SurfaceLine2.CharacteristicPoints.GeometryMustContainPoint);
                    Assert.AreEqual(true, location.SurfaceLine2.HasDike());
                }
            }
        }

        [Test]
        [Category("Integration")]
        public void CanLoadVersion_1_5_2_1()
        {
            const string fullProjectFilename = @"..\..\..\data\Dam\Versions\V 1.5.2.1\HHNK\TPL_Hempolder.damx";
            using (var projectData = ProjectLoader.LoadProjectData(fullProjectFilename))
            {
                Assert.AreEqual(DamProjectType.AssessOld, projectData.DamProjectType);
                Assert.AreEqual(0, projectData.Locations.Count);
            }
        }

        [Test]
        [Category("Integration")]
        [TestCase(@"HHNK\TPL_Hempolder.damx", @"HHNK\TPL_Hempolder0.soilmaterials.mdb", "TPL_Hempolder_0100")]
        public void CanLoadVersion_14_1_1_14(string projectFilename, string expectedSoilbaseName, string locationName)
        {
            const string dataFolder = @"..\..\..\data\Dam\Versions\V 14.1.1.14\";
            string fullProjectFilename = Path.Combine(dataFolder, projectFilename);

            using (var projectData = ProjectLoader.LoadProjectData(fullProjectFilename))
            {
                if (projectData.DamProjectType == DamProjectType.AssessOld)
                {
                    Assert.AreEqual(0, projectData.Locations.Count);
                }
                else
                {
                    // Check data
                    using (Location expectedLocation = CreateHhnkTplHempolder100())
                    {
                        expectedLocation.SoildatabaseName = Path.Combine(dataFolder, expectedSoilbaseName);
                        Location actualLocation = projectData.Locations.Single(s => s.Name == locationName);
                        CompareSegments(expectedLocation, actualLocation);
                        var result = compare.Compare(expectedLocation, actualLocation);
                        Assert.AreEqual(0, result.Differences.Count, result.DifferencesString);

                        CheckHempolderSurfaceline(actualLocation);

                    }
                }
            }
        }

        [Test]
        [Category("Integration")]
        [TestCase(@"HHNK\TPL_Hempolder.damx", @"HHNK\TPL_Hempolder0.soilmaterials.mdb", "TPL_Hempolder_0100")]
        [TestCase(@"HHNKRegionalDesign\HHNK HemPolder Regional Design.damx", @"HHNKRegionalDesign\HHNK HemPolder Regional Design0.soilmaterials.mdb", "TPL_Hempolder_0100")]
        public void CanLoadVersion_15_1_1_3(string projectFilename, string expectedSoilbaseName, string locationName)
        {
            const string dataFolder = @"..\..\..\data\Dam\Versions\V 15.1.1.3\";
            string fullProjectFilename = Path.Combine(dataFolder, projectFilename);

            using (var projectData = ProjectLoader.LoadProjectData(fullProjectFilename))
            {
                if (projectData.DamProjectType == DamProjectType.AssessOld)
                {
                    Assert.AreEqual(0, projectData.Locations.Count);
                }
                else
                {
                    // Check data
                    using (Location expectedLocation = CreateHhnkTplHempolder100())
                    {
                        expectedLocation.SoildatabaseName = Path.Combine(dataFolder, expectedSoilbaseName);
                        Location actualLocation = projectData.Locations.Single(s => s.Name == locationName);
                        CompareSegments(expectedLocation, actualLocation);
                        var result = compare.Compare(expectedLocation, actualLocation);
                        Assert.AreEqual(0, result.Differences.Count, result.DifferencesString);

                        CheckHempolderSurfaceline(actualLocation);

                    }
                }
            }
        }

        [Test]
        [Category("Integration")]
        [TestCase(@"HHNK\TPL_Hempolder.damx", @"HHNK\TPL_Hempolder0.soilmaterials.mdb", "TPL_Hempolder_0100")]
        [TestCase(@"HHNKRegionalDesign\HHNK HemPolder Regional Design.damx", @"HHNKRegionalDesign\HHNK HemPolder Regional Design0.soilmaterials.mdb", "TPL_Hempolder_0100")]
        public void CanLoadVersion_18_1_3(string projectFilename, string expectedSoilbaseName, string locationName)
        {
            const string dataFolder = @"..\..\..\data\Dam\Versions\V 18.1.3\";
            string fullProjectFilename = Path.Combine(dataFolder, projectFilename);

            using (var projectData = ProjectLoader.LoadProjectData(fullProjectFilename))
            {
                if (projectData.DamProjectType == DamProjectType.AssessOld)
                {
                    Assert.AreEqual(0, projectData.Locations.Count);
                }
                else
                {
                    using (Location expectedLocation = CreateHhnkTplHempolder100())
                    {
                        expectedLocation.SoildatabaseName = Path.Combine(dataFolder, expectedSoilbaseName);
                        Location actualLocation = projectData.Locations.Single(s => s.Name == locationName);
                        CompareSegments(expectedLocation, actualLocation);
                        var result = compare.Compare(expectedLocation, actualLocation);
                        Assert.AreEqual(0, result.Differences.Count, result.DifferencesString);

                        CheckHempolderSurfaceline(actualLocation);

                    }
                }
                // Check data
                
            }
        }

        [Category("Integration")]
        [TestCase(@"..\..\..\data\Dam\Versions\V 15.1.1.3\HHNKRegionalDesign\", @"HHNK HemPolder Regional Design - Calculated.damx")]
        [TestCase(@"..\..\..\data\Dam\Versions\V 18.1.3\HHNKRegionalDesign\", @"HHNK HemPolder Regional Design - Calculated.damx")]
        [TestCase(@"..\..\..\data\Dam\Versions\V 15.1.1.3\TutorialDesign\", @"DAM Tutorial Design - Calculated.damx")]
        [TestCase(@"..\..\..\data\Dam\Versions\V 18.1.3\TutorialDesign\", @"DAM Tutorial Design - Calculated.damx")]
        // Work in progress; it should be implemented that results are not loaded (MWDAM-1463)
        public void GivenOldProjectFileWithCalculationResultsWhenLoadingThisFileThenResultsAreNotLoaded(
            string dataFolder, string projectFilename)
        {
            string fullProjectFilename = Path.Combine(dataFolder, projectFilename);
            using (var projectData = ProjectLoader.LoadProjectData(fullProjectFilename))
            {
                Assert.AreEqual(0, projectData.DesignCalculations.Count); 
            }
        }

        /// <summary>
        /// Test if the project can be saved and loaded with the current version of the source
        ///   - Load old project
        ///   - save this project
        ///   - load this project
        ///   - compare for a specific location if the data is correct
        /// This test is based on the same data as in CanLoadVersion_15_1_1_3()
        /// </summary>
        [Test]
        [Category(Categories.Slow)]
        public void CanSaveAndLoadCurrentVersion()
        {
            const string projectFilenameHhnk = @"..\..\..\data\Dam\Versions\V 15.1.1.3\HHNKRegionalDesign\HHNK HemPolder Regional Design.damx";
            const string projectFilenameCurrentVersion = @".\TPL_HempolderCurrent.damx";

            // HHNK (Hollands Noorderkwartier)
            using (var projectData = ProjectLoader.LoadProjectData(projectFilenameHhnk))
            {
                // Save in current XML format
                DamProject.SaveData(projectFilenameCurrentVersion, projectData);

                // Load from current XML format
                using (var currentProjectData = ProjectLoader.LoadProjectData(projectFilenameCurrentVersion)) 
                using (Location expectedLocation = CreateHhnkTplHempolder100())// Check data
                {
                    expectedLocation.SoildatabaseName = @".\TPL_HempolderCurrent0.soilmaterials.mdb";
                    Location actualLocation = currentProjectData.Locations.Single(s => s.Name == "TPL_Hempolder_0100");
                    var result = compare.Compare(expectedLocation, actualLocation);
                    Assert.AreEqual(0, result.Differences.Count, result.DifferencesString);
                }
            }
        }
    }
}