// 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 <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 Core.Common.Base.IO;
using Core.Common.IO.Readers;
using Core.Common.TestUtil;
using Core.Common.Utils.Builders;
using NUnit.Framework;
using Ringtoets.MacroStabilityInwards.Data.SoilProfile;
using Ringtoets.MacroStabilityInwards.IO.SoilProfile;

namespace Ringtoets.MacroStabilityInwards.IO.Test.SoilProfile
{
    [TestFixture]
    public class StochasticSoilModelReaderTest
    {
        private readonly string testDataPath = TestHelper.GetTestDataPath(TestDataPath.Ringtoets.MacroStabilityInwards.IO, "StochasticSoilModelDatabaseReader");

        [Test]
        public void Constructor_NonExistingPath_ThrowsCriticalFileReadException()
        {
            // Setup
            string testFile = Path.Combine(testDataPath, "none.soil");

            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(testFile)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);
            string expectedMessage = new FileReaderErrorMessageBuilder(testFile).Build("Het bestand bestaat niet.");
            Assert.AreEqual(expectedMessage, exception.Message);
        }

        [Test]
        [TestCase(null)]
        [TestCase("")]
        public void Constructor_FileNullOrEmpty_ThrowsCriticalFileReadException(string fileName)
        {
            // Setup
            string expectedMessage = $"Fout bij het lezen van bestand '{fileName}': bestandspad mag niet leeg of ongedefinieerd zijn.";
            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(fileName)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);
            Assert.AreEqual(expectedMessage, exception.Message);
        }

        [Test]
        [TestCase("text.txt")]
        [TestCase("empty.soil")]
        public void Constructor_IncorrectFormatFileOrInvalidSchema_ThrowsCriticalFileReadException(string dbName)
        {
            // Setup
            string dbFile = Path.Combine(testDataPath, dbName);
            string expectedMessage = new FileReaderErrorMessageBuilder(dbFile).Build("Kritieke fout opgetreden bij het uitlezen van waardes uit kolommen in de database.");

            // Precondition
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile), "Precondition: file can be opened for edits.");

            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(dbFile)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);
            Assert.AreEqual(expectedMessage, exception.Message);
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void Constructor_InvalidSchemaThatPassesVersionValidation_ThrowsCriticalFileReadException()
        {
            // Setup
            string dbFile = Path.Combine(testDataPath, "withoutSoilModelTables.soil");
            string expectedMessage = new FileReaderErrorMessageBuilder(dbFile).Build("Kan geen ondergrondmodellen lezen. Mogelijk bestaat de 'StochasticSoilModel' tabel niet.");

            // Precondition
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile), "Precondition: file can be opened for edits.");

            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(dbFile)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);
            Assert.AreEqual(expectedMessage, exception.Message);
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void Constructor_NonUniqueSoilModelNames_ThrowsCriticalFileReadException()
        {
            // Setup
            string path = Path.Combine(TestHelper.GetTestDataPath(TestDataPath.Ringtoets.MacroStabilityInwards.IO.Path, "SoilDatabaseConstraintsReader"));
            string dbFile = Path.Combine(path, "nonUniqueSoilModelNames.soil");
            string expectedMessage = new FileReaderErrorMessageBuilder(dbFile).Build("Namen van ondergrondmodellen zijn niet uniek.");

            // Precondition
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile), "Precondition: file can be opened for edits.");

            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(dbFile)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);
            Assert.AreEqual(expectedMessage, exception.Message);
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ParameteredConstructor_PathToExistingFile_ExpectedValues()
        {
            // Setup
            const string dbName = "emptyschema.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            // Call
            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                // Assert
                Assert.AreEqual(dbFile, stochasticSoilModelDatabaseReader.Path);
                Assert.IsInstanceOf<SqLiteDatabaseReaderBase>(stochasticSoilModelDatabaseReader);
            }
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void Constructor_IncorrectVersion_ThrowsCriticalFileReadException()
        {
            // Setup
            string dbFile = Path.Combine(testDataPath, "incorrectversion.soil");

            // Precondition
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile), "Precondition: file can be opened for edits.");

            // Call
            TestDelegate test = () =>
            {
                using (new StochasticSoilModelReader(dbFile)) {}
            };

            // Assert
            var exception = Assert.Throws<CriticalFileReadException>(test);

            const string version = "17.2.0.0";
            string expectedVersionMessage = $"De database heeft niet de vereiste versie informatie. Vereiste versie is '{version}'.";
            Assert.AreEqual(expectedVersionMessage, exception.Message);
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void HasNext_EmptyDatabase_ReturnsFalse()
        {
            // Setup
            const string dbName = "emptyschema.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                // Call
                bool isPrepared = stochasticSoilModelDatabaseReader.HasNext;

                // Assert
                Assert.IsFalse(isPrepared);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void HasNext_CompleteDatabase_ReturnsTrue()
        {
            // Setup
            const string dbName = "complete.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                // Call
                bool hasNext = stochasticSoilModelDatabaseReader.HasNext;

                // Assert
                Assert.IsTrue(hasNext);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_InvalidSegmentPoint_ThrowsStochasticSoilModelReadException()
        {
            // Setup
            const string dbName = "invalidSegmentPoint.soil";
            string dbFile = Path.Combine(testDataPath, dbName);
            string expectedMessage = new FileReaderErrorMessageBuilder(dbFile)
                .Build("De ondergrondschematisatie verwijst naar een ongeldige waarde.");

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                // Call
                TestDelegate test = () => stochasticSoilModelDatabaseReader.ReadStochasticSoilModel();

                // Assert
                var exception = Assert.Throws<CriticalFileReadException>(test);
                Assert.AreEqual(expectedMessage, exception.Message);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_EmptyDatabase_ReturnsNull()
        {
            // Setup
            const string dbName = "emptyschema.soil";
            string dbFile = Path.Combine(testDataPath, dbName);
            const int expectedNrOfModels = 0;

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                int nrOfModels = stochasticSoilModelDatabaseReader.MacroStabilityInwardsStochasticSoilModelCount;

                // Call
                MacroStabilityInwardsStochasticSoilModel stochasticSoilModel = stochasticSoilModelDatabaseReader.ReadStochasticSoilModel();

                // Assert
                Assert.IsNull(stochasticSoilModel);
                Assert.AreEqual(expectedNrOfModels, nrOfModels);
                Assert.IsFalse(stochasticSoilModelDatabaseReader.HasNext);
            }
            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_ModelWithoutProfile_ThreeModelsWithSecondWithoutProfiles()
        {
            // Setup
            const string dbName = "modelWithoutProfile.soil";
            string dbFile = Path.Combine(testDataPath, dbName);
            const int expectedNrOfModels = 3;

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                int nrOfModels = stochasticSoilModelDatabaseReader.MacroStabilityInwardsStochasticSoilModelCount;
                var readModels = new List<MacroStabilityInwardsStochasticSoilModel>();
                while (stochasticSoilModelDatabaseReader.HasNext)
                {
                    // Call
                    readModels.Add(stochasticSoilModelDatabaseReader.ReadStochasticSoilModel());
                }

                // Assert
                var expectedSegmentAndModelNames = new[]
                {
                    "36005_Piping",
                    "36006_Piping",
                    "36007_Piping"
                };
                var expectedSegmentPointCount = new[]
                {
                    1797,
                    144,
                    606
                };
                var expectedProfileCount = new[]
                {
                    10,
                    0,
                    8
                };
                Assert.AreEqual(expectedNrOfModels, nrOfModels);

                CollectionAssert.AreEqual(expectedSegmentAndModelNames, readModels.Select(m => m.Name));
                CollectionAssert.AreEqual(expectedSegmentPointCount, readModels.Select(m => m.Geometry.Count));
                CollectionAssert.AreEqual(expectedProfileCount, readModels.Select(m => m.StochasticSoilProfiles.Count));

                Assert.IsFalse(stochasticSoilModelDatabaseReader.HasNext);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_CompleteDatabase_ThreeModelsWithProfiles()
        {
            // Setup
            const string dbName = "complete.soil";
            string dbFile = Path.Combine(testDataPath, dbName);
            const int expectedNrOfModels = 3;

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                int nrOfModels = stochasticSoilModelDatabaseReader.MacroStabilityInwardsStochasticSoilModelCount;
                var readModels = new List<MacroStabilityInwardsStochasticSoilModel>();
                while (stochasticSoilModelDatabaseReader.HasNext)
                {
                    // Call
                    readModels.Add(stochasticSoilModelDatabaseReader.ReadStochasticSoilModel());
                }

                // Assert
                var expectedSegmentAndModelNames = new[]
                {
                    "36005_Piping",
                    "36006_Piping",
                    "36007_Piping"
                };
                var expectedSegmentPointCount = new[]
                {
                    1797,
                    144,
                    606
                };
                var expectedProfileCount = new[]
                {
                    10,
                    6,
                    8
                };
                Assert.AreEqual(expectedNrOfModels, nrOfModels);

                CollectionAssert.AreEqual(expectedSegmentAndModelNames, readModels.Select(m => m.Name));
                CollectionAssert.AreEqual(expectedSegmentPointCount, readModels.Select(m => m.Geometry.Count));
                CollectionAssert.AreEqual(expectedProfileCount, readModels.Select(m => m.StochasticSoilProfiles.Count));

                Assert.IsFalse(stochasticSoilModelDatabaseReader.HasNext);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void Count_ThreeModelsOneModelWithoutSegmentPoints_ReturnsTwo()
        {
            // Setup
            const string dbName = "modelWithoutSegmentPoints.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                int nrOfModels = stochasticSoilModelDatabaseReader.MacroStabilityInwardsStochasticSoilModelCount;

                Assert.AreEqual(2, nrOfModels);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_ThreeModelsOneModelWithoutSegmentPointsUsingCount_ReturnsTwoModels()
        {
            // Setup
            const string dbName = "modelWithoutSegmentPoints.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                var readModels = new List<MacroStabilityInwardsStochasticSoilModel>();
                for (var i = 0; i < stochasticSoilModelDatabaseReader.MacroStabilityInwardsStochasticSoilModelCount; i++)
                {
                    // Call
                    readModels.Add(stochasticSoilModelDatabaseReader.ReadStochasticSoilModel());
                }

                // Assert
                CheckModelWithoutSegmentPoints(readModels);
                Assert.IsFalse(stochasticSoilModelDatabaseReader.HasNext);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        [Test]
        public void ReadStochasticSoilModel_ThreeModelsOneModelWithoutSegmentPointsUsingHasNext_ReturnsTwoModels()
        {
            // Setup
            const string dbName = "modelWithoutSegmentPoints.soil";
            string dbFile = Path.Combine(testDataPath, dbName);

            using (var stochasticSoilModelDatabaseReader = new StochasticSoilModelReader(dbFile))
            {
                var readModels = new List<MacroStabilityInwardsStochasticSoilModel>();
                while (stochasticSoilModelDatabaseReader.HasNext)
                {
                    // Call
                    readModels.Add(stochasticSoilModelDatabaseReader.ReadStochasticSoilModel());
                }

                // Assert
                CheckModelWithoutSegmentPoints(readModels);
                Assert.IsFalse(stochasticSoilModelDatabaseReader.HasNext);
            }

            Assert.IsTrue(TestHelper.CanOpenFileForWrite(dbFile));
        }

        private static void CheckModelWithoutSegmentPoints(List<MacroStabilityInwardsStochasticSoilModel> readModels)
        {
            var expectedSegmentAndModelNames = new[]
            {
                "36005_Piping",
                "36007_Piping"
            };
            var expectedSegmentPointCount = new[]
            {
                1797,
                606
            };
            var expectedProfileCount = new[]
            {
                10,
                8
            };

            Assert.AreEqual(2, readModels.Count);
            CollectionAssert.AreEqual(expectedSegmentAndModelNames, readModels.Select(m => m.Name));
            CollectionAssert.AreEqual(expectedSegmentPointCount, readModels.Select(m => m.Geometry.Count));
            CollectionAssert.AreEqual(expectedProfileCount, readModels.Select(m => m.StochasticSoilProfiles.Count));
        }
    }
}