// Copyright 2009-2022 Josh Close // This file is a part of CsvHelper and is dual licensed under MS-PL and Apache 2.0. // See LICENSE.txt for details or visit http://www.opensource.org/licenses/ms-pl.html for MS-PL and http://opensource.org/licenses/Apache-2.0 for Apache 2.0. // https://github.com/JoshClose/CsvHelper using CsvHelper.Configuration; using Xunit; using System.Globalization; using System.IO; using System.Linq; using System.Text; namespace CsvHelper.Tests { public class HeaderValidationTests { [Fact] public void ValidateHeader_ValidHeaders_NoException() { using (var csv = new CsvReader(new StringReader("Id,Name"), CultureInfo.InvariantCulture)) { csv.Read(); csv.ReadHeader(); csv.ValidateHeader(); } } [Fact] public void ValidateHeader_PropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { csv.Read(); csv.ReadHeader(); try { csv.ValidateHeader(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void ValidateHeader_ReferencePropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { csv.Read(); csv.ReadHeader(); try { csv.ValidateHeader(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void ValidateHeader_ConstructorParametersDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { csv.Read(); csv.ReadHeader(); try { csv.ValidateHeader(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void GetRecord_PropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { csv.Read(); try { csv.GetRecord(typeof(Test)); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void GetRecordGeneric_PropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { csv.Read(); try { csv.GetRecord(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void GetRecords_PropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { try { csv.GetRecords(typeof(Test)).ToList(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void GetRecordsGeneric_PropertiesDontMatch_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("bad data"), CultureInfo.InvariantCulture)) { try { csv.GetRecords().ToList(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Equal(2, ex.InvalidHeaders.Length); } } } [Fact] public void GetRecordsGeneric_PrivateSetter_NoException() { var data = new StringBuilder(); data.AppendLine("Number"); data.AppendLine("1"); using (var csv = new CsvReader(new StringReader(data.ToString()), CultureInfo.InvariantCulture)) { var records = csv.GetRecords().ToList(); var record = records[0]; Assert.Equal(1, record.Number); Assert.Equal(2, record.Double); } } [Fact] public void GetRecordsGeneric_IgnoreProperty_NoException() { var data = new StringBuilder(); data.AppendLine("Id"); data.AppendLine("1"); using (var csv = new CsvReader(new StringReader(data.ToString()), CultureInfo.InvariantCulture)) { csv.Context.RegisterClassMap(); var records = csv.GetRecords().ToList(); var record = records[0]; Assert.Equal(1, record.Id); Assert.Null(record.Name); } } [Fact] public void ValidateHeader_NoNamesMapped_NoException() { using (var csv = new CsvReader(new StringReader("Id"), CultureInfo.InvariantCulture)) { csv.Context.RegisterClassMap(); csv.Read(); csv.ReadHeader(); csv.ValidateHeader(); } } [Fact] public void ValidateHeader_HasIndexAndName_ThrowsHeaderValidationException() { using (var csv = new CsvReader(new StringReader("Id"), CultureInfo.InvariantCulture)) { csv.Context.RegisterClassMap(); csv.Read(); csv.ReadHeader(); try { csv.ValidateHeader(); throw new XUnitException(); } catch (HeaderValidationException ex) { Assert.Single(ex.InvalidHeaders); Assert.Equal("Name", ex.InvalidHeaders[0].Names[0]); } } } private class Test { public int Id { get; set; } public string Name { get; set; } } private class HasReference { public Test Reference { get; set; } } private class HasConstructor { public int Id { get; private set; } public string Name { get; private set; } public HasConstructor(int Id, string Name) { this.Id = Id; this.Name = Name; } } private class HasPrivateSetter { public int Number { get; set; } public int Double => Number * 2; } private sealed class HasIgnoredPropertyMap : ClassMap { public HasIgnoredPropertyMap() { AutoMap(CultureInfo.InvariantCulture); Map(m => m.Name).Ignore(); } } private sealed class HasIndexNoNameMap : ClassMap { public HasIndexNoNameMap() { Map(m => m.Id).Index(0); Map(m => m.Name).Index(1); } } private sealed class HasIndexAndNameMap : ClassMap { public HasIndexAndNameMap() { Map(m => m.Id).Index(0).Name("Id"); Map(m => m.Name).Index(1).Name("Name"); } } } }