using VersOne.Epub.Internal; using VersOne.Epub.Options; using VersOne.Epub.Schema; using VersOne.Epub.Test.Comparers; using VersOne.Epub.Test.Unit.Mocks; namespace VersOne.Epub.Test.Unit.Readers { public class Epub3NavDocumentReaderTests { private const string CONTENT_DIRECTORY_PATH = "Content"; private const string NAV_FILE_NAME = "toc.html"; private const string NAV_FILE_PATH = $"{CONTENT_DIRECTORY_PATH}/{NAV_FILE_NAME}"; private const string MINIMAL_NAV_FILE = """ """; private const string FULL_NAV_FILE = """ """; private const string MINIMAL_NAV_FILE_WITH_H1_HEADER = """ """; private const string MINIMAL_NAV_FILE_WITH_H2_HEADER = """ """; private const string MINIMAL_NAV_FILE_WITH_H3_HEADER = """ """; private const string MINIMAL_NAV_FILE_WITH_H4_HEADER = """ """; private const string MINIMAL_NAV_FILE_WITH_H5_HEADER = """ """; private const string MINIMAL_NAV_FILE_WITH_H6_HEADER = """ """; private const string NAV_FILE_WITHOUT_HTML_ELEMENT = """ """; private const string NAV_FILE_WITHOUT_BODY_ELEMENT = """ """; private const string NAV_FILE_WITHOUT_TOP_OL_ELEMENT = """

"""; private const string NAV_FILE_WITH_EMPTY_LI_ELEMENT = """ """; private const string NAV_FILE_WITH_ESCAPED_HREF_IN_A_ELEMENT = """ """; private const string NAV_FILE_WITH_WITH_NON_TOP_LEVEL_NAV_ELEMENT = """

"""; private const string NAV_FILE_WITHOUT_TYPE_IN_NAV_ELEMENT = """ """; private const string MINIMAL_NAV_FILE_WITHOUT_TYPE_IN_NAV_ELEMENT = """

"""; private static EpubPackage MinimalEpubPackageWithNav => new ( uniqueIdentifier: null, epubVersion: EpubVersion.EPUB_3, metadata: new EpubMetadata(), manifest: new EpubManifest ( items: new List() { new ( id: "nav", href: NAV_FILE_NAME, mediaType: "application/xhtml+xml", properties: new List() { EpubManifestProperty.NAV } ) } ), spine: new EpubSpine(), guide: null ); private static Epub3NavDocument MinimalEpub3NavDocument => new ( filePath: NAV_FILE_PATH ); private static Epub3NavDocument FullEpub3NavDocument => new ( filePath: NAV_FILE_PATH, navs: new List() { new ( type: Epub3StructuralSemanticsProperty.TOC, isHidden: false, head: "Table of Contents", ol: new Epub3NavOl ( isHidden: false, lis: new List() { new ( span: new Epub3NavSpan ( title: "Test span title", alt: "Test span alt", text: "Test span header" ), childOl: new Epub3NavOl ( isHidden: false, lis: new List() { new ( anchor: new Epub3NavAnchor ( href: "chapter1.html", title: "Test anchor title", alt: "Test anchor alt", text: "Chapter 1" ) ) } ) ), new ( anchor: new Epub3NavAnchor ( type: Epub3StructuralSemanticsProperty.LOI, href: "illustrations.html", text: "List of illustrations" ) ) } ) ), new ( type: Epub3StructuralSemanticsProperty.PAGE_LIST, isHidden: true, head: "Page list", ol: new Epub3NavOl ( isHidden: true, lis: new List() { new ( anchor: new Epub3NavAnchor ( href: "chapter1.html#page-1", text: "1" ) ) } ) ) } ); private static Epub3NavDocument MinimalEpub3NavDocumentWithHeader => new ( filePath: NAV_FILE_PATH, navs: new List() { new ( type: Epub3StructuralSemanticsProperty.TOC, isHidden: false, head: "Test header", ol: new Epub3NavOl() ) } ); public static IEnumerable ReadEpub3NavDocumentAsyncWithMinimalNavFileWithHeaderTestData { get { yield return new object[] { MINIMAL_NAV_FILE_WITH_H1_HEADER, MinimalEpub3NavDocumentWithHeader }; yield return new object[] { MINIMAL_NAV_FILE_WITH_H2_HEADER, MinimalEpub3NavDocumentWithHeader }; yield return new object[] { MINIMAL_NAV_FILE_WITH_H3_HEADER, MinimalEpub3NavDocumentWithHeader }; yield return new object[] { MINIMAL_NAV_FILE_WITH_H4_HEADER, MinimalEpub3NavDocumentWithHeader }; yield return new object[] { MINIMAL_NAV_FILE_WITH_H5_HEADER, MinimalEpub3NavDocumentWithHeader }; yield return new object[] { MINIMAL_NAV_FILE_WITH_H6_HEADER, MinimalEpub3NavDocumentWithHeader }; } } [Fact(DisplayName = "Constructing a Epub3NavDocumentReader instance with a non-null epubReaderOptions parameter should succeed")] public void ConstructorWithNonNullEpubReaderOptionsTest() { _ = new Epub3NavDocumentReader(new EpubReaderOptions()); } [Fact(DisplayName = "Constructing a Epub3NavDocumentReader instance with a null epubReaderOptions parameter should succeed")] public void ConstructorWithNullEpubReaderOptionsTest() { _ = new Epub3NavDocumentReader(null); } [Fact(DisplayName = "Reading a minimal NAV file should succeed")] public async Task ReadEpub3NavDocumentAsyncWithMinimalNavFileTest() { await TestSuccessfulReadOperation(MINIMAL_NAV_FILE, MinimalEpub3NavDocument); } [Fact(DisplayName = "Reading a full NAV file should succeed")] public async Task ReadEpub3NavDocumentAsyncWithFullNavFileTest() { await TestSuccessfulReadOperation(FULL_NAV_FILE, FullEpub3NavDocument); } [Theory(DisplayName = "Reading minimal NAV packages with h1-h6 headers should succeed")] [MemberData(nameof(ReadEpub3NavDocumentAsyncWithMinimalNavFileWithHeaderTestData))] public async Task ReadEpub3NavDocumentAsyncWithMinimalNavFileWithHeaderTest(string navFileContent, Epub3NavDocument expectedEpub3NavDocument) { await TestSuccessfulReadOperation(navFileContent, expectedEpub3NavDocument); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if EpubPackage is missing the NAV item and EpubVersion is not EPUB_2")] public async Task ReadEpub3NavDocumentAsyncForEpub3WithoutNavManifestItemTest() { TestZipFile testZipFile = new(); EpubPackage epubPackage = new ( uniqueIdentifier: null, epubVersion: EpubVersion.EPUB_3, metadata: new EpubMetadata(), manifest: new EpubManifest ( items: new List() { new ( id: "test", href: "test.html", mediaType: "application/xhtml+xml" ) } ), spine: new EpubSpine(), guide: null ); Epub3NavDocumentReader epub3NavDocumentReader = new(); await Assert.ThrowsAsync(() => epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, epubPackage)); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should return null if EpubPackage is missing the NAV item and EpubVersion is EPUB_2")] public async Task ReadEpub3NavDocumentAsyncForEpub2WithoutNavManifestItemTest() { TestZipFile testZipFile = new(); EpubPackage epubPackage = new ( uniqueIdentifier: null, epubVersion: EpubVersion.EPUB_2, metadata: new EpubMetadata(), manifest: new EpubManifest(), spine: new EpubSpine(), guide: null ); Epub3NavDocumentReader epub3NavDocumentReader = new(); Epub3NavDocument? epub3NavDocument = await epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, epubPackage); Assert.Null(epub3NavDocument); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if EPUB file is missing the NAV file specified in the EpubPackage")] public async Task ReadEpub3NavDocumentAsyncWithoutNavFileTest() { TestZipFile testZipFile = new(); Epub3NavDocumentReader epub3NavDocumentReader = new(); await Assert.ThrowsAsync(() => epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, MinimalEpubPackageWithNav)); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if the NCX file is larger than 2 GB")] public async Task ReadEpub3NavDocumentAsyncWithLargeNavFileTest() { TestZipFile testZipFile = new(); testZipFile.AddEntry(NAV_FILE_PATH, new Test4GbZipFileEntry()); Epub3NavDocumentReader epub3NavDocumentReader = new(); await Assert.ThrowsAsync(() => epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, MinimalEpubPackageWithNav)); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if the NAV file is missing the 'html' XML element")] public async Task ReadEpub3NavDocumentAsyncWithoutHtmlElement() { await TestFailingReadOperation(NAV_FILE_WITHOUT_HTML_ELEMENT); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if the NAV file is missing the 'body' XML element")] public async Task ReadEpub3NavDocumentAsyncWithoutBodyElement() { await TestFailingReadOperation(NAV_FILE_WITHOUT_BODY_ELEMENT); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if the NAV file is missing the top 'ol' XML element")] public async Task ReadEpub3NavDocumentAsyncWithoutTopOlElement() { await TestFailingReadOperation(NAV_FILE_WITHOUT_TOP_OL_ELEMENT); } [Fact(DisplayName = "ReadEpub3NavDocumentAsync should throw Epub3NavException if the NAV file has an empty 'li' XML element")] public async Task ReadEpub3NavDocumentAsyncWithEmptyLiElement() { await TestFailingReadOperation(NAV_FILE_WITH_EMPTY_LI_ELEMENT); } [Fact(DisplayName = "Reading a NAV file with a URI-escaped 'href' attribute in an 'a' XML element should succeed")] public async Task ReadEpub3NavDocumentAsyncWithEscapedAHrefTest() { Epub3NavDocument expectedEpub3NavDocument = new ( filePath: NAV_FILE_PATH, navs: new List() { new ( type: Epub3StructuralSemanticsProperty.TOC, ol: new Epub3NavOl ( lis: new List() { new ( anchor: new Epub3NavAnchor ( href: "chapter1.html", text: "Chapter 1" ) ) } ) ) } ); await TestSuccessfulReadOperation(NAV_FILE_WITH_ESCAPED_HREF_IN_A_ELEMENT, expectedEpub3NavDocument); } [Fact(DisplayName = "Reading a NAV file with non-top-level 'nav' element should succeed")] public async Task ReadEpub3NavDocumentAsyncWithNonTopLevelNavElementTest() { await TestSuccessfulReadOperation(NAV_FILE_WITH_WITH_NON_TOP_LEVEL_NAV_ELEMENT, MinimalEpub3NavDocumentWithHeader); } [Fact(DisplayName = "'nav' elements without 'type' attribute should be ignored")] public async Task ReadEpub3NavDocumentAsyncWithNavElementWithoutTypeTest() { await TestSuccessfulReadOperation(NAV_FILE_WITHOUT_TYPE_IN_NAV_ELEMENT, MinimalEpub3NavDocument); } [Fact(DisplayName = "'nav' elements without 'type' attribute that don't conform to EPUB standard should not throw an exception")] public async Task ReadEpub3NavDocumentAsyncWithNonEpubNavElementWithoutTypeTest() { await TestSuccessfulReadOperation(MINIMAL_NAV_FILE_WITHOUT_TYPE_IN_NAV_ELEMENT, MinimalEpub3NavDocument); } private static async Task TestSuccessfulReadOperation(string navFileContent, Epub3NavDocument expectedEpub3NavDocument, EpubReaderOptions? epubReaderOptions = null) { TestZipFile testZipFile = CreateTestZipFileWithNavFile(navFileContent); Epub3NavDocumentReader epub3NavDocumentReader = new(epubReaderOptions ?? new EpubReaderOptions()); Epub3NavDocument? actualEpub3NavDocument = await epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, MinimalEpubPackageWithNav); Epub3NavDocumentComparer.CompareEpub3NavDocuments(expectedEpub3NavDocument, actualEpub3NavDocument); } private static async Task TestFailingReadOperation(string navFileContent) { TestZipFile testZipFile = CreateTestZipFileWithNavFile(navFileContent); Epub3NavDocumentReader epub3NavDocumentReader = new(); await Assert.ThrowsAsync(() => epub3NavDocumentReader.ReadEpub3NavDocumentAsync(testZipFile, CONTENT_DIRECTORY_PATH, MinimalEpubPackageWithNav)); } private static TestZipFile CreateTestZipFileWithNavFile(string navFileContent) { TestZipFile testZipFile = new(); testZipFile.AddEntry(NAV_FILE_PATH, new TestZipFileEntry(navFileContent)); return testZipFile; } } }