// Copyright (C) Stichting Deltares 2016. 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 Core.Common.Base.Geometry;
using Core.Common.IO.Exceptions;
using Core.Common.TestUtil;
using NUnit.Framework;
using Ringtoets.Common.Data.AssessmentSection;
namespace Ringtoets.Common.IO.Test
{
[TestFixture]
public class ReferenceLinesMetaReaderTest
{
private readonly string testDataPath = TestHelper.GetTestDataPath(TestDataPath.Ringtoets.Common.IO, "NBPW");
[Test]
[TestCase("")]
[TestCase(" ")]
[TestCase(null)]
public void ReadReferenceLinesMetas_NoFilePath_ThrowArgumentException(string invalidFilePath)
{
// Call
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert
var expectedMessage = string.Format("Fout bij het lezen van bestand '{0}': Bestandspad mag niet leeg of ongedefinieerd zijn.",
invalidFilePath);
TestHelper.AssertThrowsArgumentExceptionAndTestMessage(call, expectedMessage);
}
[Test]
public void ReadReferenceLinesMetas_FilePathHasInvalidPathCharacter_ThrowArgumentException()
{
// Setup
char[] invalidFileNameChars = Path.GetInvalidFileNameChars();
string validFilePath = Path.Combine(testDataPath, "NBPW.shp");
string invalidFilePath = validFilePath.Replace("P", invalidFileNameChars[1].ToString());
// Call
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert
var expectedMessage = string.Format("Fout bij het lezen van bestand '{0}': Bestandspad mag niet de volgende tekens bevatten: {1}",
invalidFilePath, String.Join(", ", invalidFileNameChars));
TestHelper.AssertThrowsArgumentExceptionAndTestMessage(call, expectedMessage);
}
[Test]
public void ReadReferenceLinesMetas_FilePathIsActuallyDirectoryPath_ThrowArgumentException()
{
// Setup
string invalidFilePath = Path.Combine(testDataPath, Path.DirectorySeparatorChar.ToString());
// Call
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert
var expectedMessage = string.Format("Fout bij het lezen van bestand '{0}': Bestandspad mag niet verwijzen naar een lege bestandsnaam.",
invalidFilePath);
TestHelper.AssertThrowsArgumentExceptionAndTestMessage(call, expectedMessage);
}
[Test]
public void ReadReferenceLinesMetas_ShapefileDoesntExist_ThrowCriticalFileReadException()
{
// Setup
string invalidFilePath = Path.Combine(testDataPath, "I_do_not_exist.shp");
// Call
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert
var expectedMessage = string.Format("Fout bij het lezen van bestand '{0}': Het bestand bestaat niet.",
invalidFilePath);
var message = Assert.Throws(call).Message;
Assert.AreEqual(expectedMessage, message);
}
[Test]
[TestCase("Multiple_Point_with_ID.shp")]
[TestCase("Multiple_Polygon_with_ID.shp")]
[TestCase("Single_Multi-Polygon_with_ID.shp")]
[TestCase("Single_Point_with_ID.shp")]
[TestCase("Single_Polygon_with_ID.shp")]
public void ReadReferenceLinesMetas_ShapefileDoesNotHaveSinglePolyline_ThrowCriticalFileReadException(string shapeFileName)
{
// Setup
string invalidFilePath = TestHelper.GetTestDataPath(TestDataPath.Core.Components.Gis.IO, shapeFileName);
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert .
var expectedMessage = string.Format("Fout bij het lezen van bestand '{0}': Bestand bevat geometrieën die geen lijn zijn.",
invalidFilePath);
var message = Assert.Throws(call).Message;
Assert.AreEqual(expectedMessage, message);
}
[Test]
[TestCase("NBPW_MultiPolyLines.shp")]
public void ReadReferenceLinesMeta_ShapefileHasMultiplePolylines_ThrowCriticalFileReadException(string shapeFileName)
{
// Setup
string invalidFilePath = Path.Combine(testDataPath, shapeFileName);
// Call
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(invalidFilePath);
// Assert
var expectedMessage = "Het bestand bevat een multi-polylijn. Multi-polylijnen worden niet ondersteund.";
var message = Assert.Throws(call).Message;
Assert.AreEqual(expectedMessage, message);
}
[Test]
[TestCase("NBPW_missingTrajectId.shp", "TRAJECT_ID")]
[TestCase("NBPW_missingNORM_SW.shp", "NORM_SW")]
[TestCase("NBPW_missingNORM_OG.shp", "NORM_OG")]
public void ReadReferenceLinesMetas_FileLacksAttribute_ThrowCriticalFileReadException(string shapeFileName, string missingAttribute)
{
// Setup
string validFilePath = Path.Combine(testDataPath, shapeFileName);
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(validFilePath);
// Assert
var message = Assert.Throws(call).Message;
var expectedMessage = String.Format("Het bestand heeft geen attribuut '{0}'. Dit attribuut is vereist.",
missingAttribute);
Assert.AreEqual(expectedMessage, message);
}
[Test]
[TestCase("NBPW_missingAllAttributes.shp", "TRAJECT_ID', 'NORM_SW', 'NORM_OG")]
[TestCase("NBPW_missingTrajectIdAndNORM_SW.shp", "TRAJECT_ID', 'NORM_SW")]
[TestCase("NBPW_missingTrajectIdAndNORM_OG.shp", "TRAJECT_ID', 'NORM_OG")]
[TestCase("NBPW_missingNORM_SWAndNORM_OG.shp", "NORM_SW', 'NORM_OG")]
public void ReadReferenceLinesMetas_FileLacksAttributes_ThrowCriticalFileReadException(string shapeFileName, string missingAttributes)
{
// Setup
string validFilePath = Path.Combine(testDataPath, shapeFileName);
TestDelegate call = () => ReferenceLinesMetaReader.ReadReferenceLinesMetas(validFilePath);
// Assert
var message = Assert.Throws(call).Message;
var expectedMessage = String.Format("Het bestand heeft de attributen '{0}' niet. Deze attributen zijn vereist.",
missingAttributes);
Assert.AreEqual(expectedMessage, message);
}
[Test]
public void ReadReferenceLinesMeta_ValidFilePath_ReturnsElement()
{
// Setup
var validFilePath = Path.Combine(testDataPath, "NBPW.shp");
// Call
List referenceLineMetas = ReferenceLinesMetaReader.ReadReferenceLinesMetas(validFilePath);
// Assert
Assert.AreEqual(3, referenceLineMetas.Count);
var expectedReferenceLineMeta1 = new ReferenceLineMeta
{
AssessmentSectionId = "1-1",
LowerLimitValue = 1000,
SignalingValue = 3000
};
expectedReferenceLineMeta1.ReferenceLine.SetGeometry(new[]
{
new Point2D(160679.9250, 475072.583),
new Point2D(160892.0751, 474315.4917)
});
AssertReferenceLineMetas(expectedReferenceLineMeta1, referenceLineMetas[0]);
var expectedReferenceLineMeta2 = new ReferenceLineMeta
{
AssessmentSectionId = "2-2",
LowerLimitValue = 100,
SignalingValue = 300
};
expectedReferenceLineMeta2.ReferenceLine.SetGeometry(new[]
{
new Point2D(155556.9191, 464341.1281),
new Point2D(155521.4761, 464360.7401)
});
AssertReferenceLineMetas(expectedReferenceLineMeta2, referenceLineMetas[1]);
var expectedReferenceLineMeta3 = new ReferenceLineMeta
{
AssessmentSectionId = "3-3",
LowerLimitValue = 100,
SignalingValue = 300
};
expectedReferenceLineMeta3.ReferenceLine.SetGeometry(new[]
{
new Point2D(147367.321899, 476902.915710),
new Point2D(147410.0515, 476938.9447)
});
AssertReferenceLineMetas(expectedReferenceLineMeta3, referenceLineMetas[2]);
}
[Test]
public void ReadReferenceLinesMeta_EmptyNormOgAndNormSw_ReturnsElement()
{
// Setup
var validFilePath = Path.Combine(testDataPath, "NBPW_EmptyNormOGAndNormSW.shp");
// Call
List referenceLineMetas = ReferenceLinesMetaReader.ReadReferenceLinesMetas(validFilePath);
// Assert
Assert.AreEqual(1, referenceLineMetas.Count);
var referenceLineMeta = referenceLineMetas.First();
Assert.AreEqual("46-1", referenceLineMeta.AssessmentSectionId);
Assert.IsNull(referenceLineMeta.SignalingValue);
Assert.IsNull(referenceLineMeta.LowerLimitValue);
}
[Test]
public void ReadReferenceLinesMeta_EmptyTrackId_ReturnsElement()
{
// Setup
string validFilePath = Path.Combine(testDataPath, "NBPW_EmptyTrackId.shp");
// Call
List referenceLineMetas = ReferenceLinesMetaReader.ReadReferenceLinesMetas(validFilePath);
// Assert
Assert.AreEqual(1, referenceLineMetas.Count);
var referenceLineMeta = referenceLineMetas.First();
Assert.AreEqual(string.Empty, referenceLineMeta.AssessmentSectionId);
}
private static void AssertReferenceLineMetas(ReferenceLineMeta expectedReferenceLineMeta, ReferenceLineMeta actualReferenceLineMeta)
{
Assert.AreEqual(expectedReferenceLineMeta.AssessmentSectionId, actualReferenceLineMeta.AssessmentSectionId);
Assert.AreEqual(expectedReferenceLineMeta.SignalingValue, actualReferenceLineMeta.SignalingValue);
Assert.AreEqual(expectedReferenceLineMeta.LowerLimitValue, actualReferenceLineMeta.LowerLimitValue);
var expectedPoints = expectedReferenceLineMeta.ReferenceLine.Points.ToArray();
var actualPoints = actualReferenceLineMeta.ReferenceLine.Points.ToArray();
var errorMessage = String.Format("Unexpected geometry found in ReferenceLineMeta with id '{0}'", actualReferenceLineMeta.AssessmentSectionId);
Assert.AreEqual(expectedPoints.Length, actualPoints.Length, errorMessage);
for (var i = 0; i < expectedPoints.Length; i++)
{
Assert.AreEqual(expectedPoints[i].X, actualPoints[i].X, 1e-6, errorMessage);
Assert.AreEqual(expectedPoints[i].Y, actualPoints[i].Y, 1e-6, errorMessage);
}
}
}
}