File size: 17,708 Bytes
fab29d7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
using VersOne.Epub.Internal;
using VersOne.Epub.Options;
using VersOne.Epub.Schema;
using VersOne.Epub.Test.Unit.Mocks;
namespace VersOne.Epub.Test.Unit.Readers
{
public class BookCoverReaderTests
{
private const string LOCAL_COVER_FILE_NAME = "cover.jpg";
private const string REMOTE_COVER_FILE_HREF = "https://example.com/books/123/cover.jpg";
private const EpubContentType COVER_FILE_CONTENT_TYPE = EpubContentType.IMAGE_JPEG;
private const string COVER_FILE_CONTENT_MIME_TYPE = "image/jpeg";
[Fact(DisplayName = "ReadBookCover should return null for a EPUB 2 book without a cover")]
public void ReadBookCoverForEpub2WithoutCoverTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "ReadBookCover should return null for a EPUB 3 book without a cover")]
public void ReadBookCoverForEpub3WithoutCoverTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_3);
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "Extracting cover from EPUB 2 book with a cover defined in the metadata should succeed")]
public void ReadBookCoverForEpub2WithCoverInMetadataTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: "cover-image"
));
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: LOCAL_COVER_FILE_NAME,
mediaType: COVER_FILE_CONTENT_MIME_TYPE
));
EpubLocalByteContentFileRef expectedCoverImageFileRef = CreateLocalTestImageFileRef();
TestSuccessfulReadOperation(epubSchema, expectedCoverImageFileRef);
}
[Fact(DisplayName = "Extracting cover from EPUB 2 book with a cover defined in the guide should succeed")]
public void ReadBookCoverForEpub2WithCoverInGuideTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema
(
epubVersion: EpubVersion.EPUB_2,
guide: new EpubGuide
(
items:
[
new
(
type: "cover",
title: null,
href: LOCAL_COVER_FILE_NAME
)
]
)
);
EpubLocalByteContentFileRef expectedCoverImageFileRef = CreateLocalTestImageFileRef();
TestSuccessfulReadOperation(epubSchema, expectedCoverImageFileRef);
}
[Fact(DisplayName = "ReadBookCover should return null if the cover defined in the guide doesn't exist among the content image files")]
public void ReadBookCoverForEpub2WithCoverInGuideReferencingNonExistingImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema
(
epubVersion: EpubVersion.EPUB_2,
guide: new EpubGuide
(
items:
[
new
(
type: "cover",
title: null,
href: LOCAL_COVER_FILE_NAME
)
]
)
);
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "Extracting cover from EPUB 3 book with a cover defined in the manifest should succeed")]
public void ReadBookCoverForEpub3WithCoverInManifestTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_3);
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: LOCAL_COVER_FILE_NAME,
mediaType: COVER_FILE_CONTENT_MIME_TYPE,
properties: new List<EpubManifestProperty>()
{
EpubManifestProperty.COVER_IMAGE
}
));
EpubLocalByteContentFileRef expectedCoverImageFileRef = CreateLocalTestImageFileRef();
TestSuccessfulReadOperation(epubSchema, expectedCoverImageFileRef);
}
[Fact(DisplayName = "ReadBookCover should not fail if Metadata.MetaItems has no cover item in a EPUB 2 book")]
public void ReadBookCoverForEpub2WithNoCoverMetaItemTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "other-item",
content: "some content"
));
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the Content property in the cover meta item is empty")]
public void ReadBookCoverForEpub2WithEmptyCoverMetaItemContentTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: String.Empty
));
TestFailingReadOperation(epubSchema);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the manifest item with the ID specified in the cover meta item is missing and BookCoverReaderOptions.Epub2MetadataIgnoreMissingManifestItem is false")]
public void ReadBookCoverForEpub2WithMissingManifestItemWithoutIgnoringErrorOptionTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: "cover-image"
));
TestFailingReadOperation(epubSchema);
}
[Fact(DisplayName = "ReadBookCover should return null if the manifest item with the ID specified in the cover meta item is missing and BookCoverReaderOptions.Epub2MetadataIgnoreMissingManifestItem is false")]
public void ReadBookCoverForEpub2WithMissingManifestItemWithIgnoringErrorOptionTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: "cover-image"
));
BookCoverReaderOptions bookCoverReaderOptions = new()
{
Epub2MetadataIgnoreMissingManifestItem = true
};
TestSuccessfulReadOperation(epubSchema, null, bookCoverReaderOptions);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the image referenced by the cover manifest item is missing in the EPUB 2 file")]
public void ReadBookCoverForEpub2WithMissingManifestItemImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: "cover-image"
));
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: LOCAL_COVER_FILE_NAME,
mediaType: COVER_FILE_CONTENT_MIME_TYPE
));
TestFailingReadOperation(epubSchema);
}
[Fact(DisplayName = "ReadBookCover should return null if a EPUB 2 book has no cover in the metadata and no cover references in the guide")]
public void ReadBookCoverForEpub2WithNoCoverInMetadataAndGuideTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema
(
epubVersion: EpubVersion.EPUB_2,
guide: new EpubGuide
(
items:
[
new
(
type: "test-type",
title: null,
href: "test.jpg"
)
]
)
);
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "ReadBookCover should return null if a EPUB 3 book has no cover in the manifest")]
public void ReadBookCoverForEpub3WithNoCoverInManifestTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema
(
epubVersion: EpubVersion.EPUB_3,
manifest: new EpubManifest
(
items:
[
new
(
id: "test-image",
href: "test.jpg",
mediaType: COVER_FILE_CONTENT_MIME_TYPE
),
new
(
id: "test-item-with-property",
href: "toc.html",
mediaType: "application/xhtml+xml",
properties: new List<EpubManifestProperty>()
{
EpubManifestProperty.NAV
}
)
]
)
);
TestSuccessfulReadOperation(epubSchema, null);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the image referenced by the cover manifest item is missing in the EPUB 3 file")]
public void ReadBookCoverForEpub3WithMissingManifestItemImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_3);
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: LOCAL_COVER_FILE_NAME,
mediaType: COVER_FILE_CONTENT_MIME_TYPE,
properties:
[
EpubManifestProperty.COVER_IMAGE
]
));
TestFailingReadOperation(epubSchema);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the image referenced by the cover manifest item in the EPUB 2 file is a remote resource")]
public void ReadBookCoverForEpub2WithRemoteManifestItemImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_2);
epubSchema.Package.Metadata.MetaItems.Add(new EpubMetadataMeta
(
name: "cover",
content: "cover-image"
));
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: REMOTE_COVER_FILE_HREF,
mediaType: COVER_FILE_CONTENT_MIME_TYPE
));
EpubRemoteByteContentFileRef remoteTestImageFileRef = CreateRemoteTestImageFileRef();
EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> imageContentRefs = CreateImageContentRefs(remoteImageFileRef: remoteTestImageFileRef);
TestFailingReadOperation(epubSchema, imageContentRefs);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the image referenced by the cover guide item in the EPUB 2 file is a remote resource")]
public void ReadBookCoverForEpub2WithRemoteGuideItemImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema
(
epubVersion: EpubVersion.EPUB_2,
guide: new EpubGuide
(
items:
[
new (
type: "cover",
title: null,
href: REMOTE_COVER_FILE_HREF
)
]
)
);
EpubRemoteByteContentFileRef remoteTestImageFileRef = CreateRemoteTestImageFileRef();
EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> imageContentRefs = CreateImageContentRefs(remoteImageFileRef: remoteTestImageFileRef);
TestFailingReadOperation(epubSchema, imageContentRefs);
}
[Fact(DisplayName = "ReadBookCover should throw EpubPackageException if the image referenced by the cover manifest item in the EPUB 3 file is a remote resource")]
public void ReadBookCoverForEpub3WithRemoteManifestItemImageTest()
{
EpubSchema epubSchema = CreateEmptyEpubSchema(EpubVersion.EPUB_3);
epubSchema.Package.Manifest.Items.Add(new EpubManifestItem
(
id: "cover-image",
href: REMOTE_COVER_FILE_HREF,
mediaType: COVER_FILE_CONTENT_MIME_TYPE,
properties:
[
EpubManifestProperty.COVER_IMAGE
]
));
EpubRemoteByteContentFileRef remoteTestImageFileRef = CreateRemoteTestImageFileRef();
EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> imageContentRefs = CreateImageContentRefs(remoteImageFileRef: remoteTestImageFileRef);
TestFailingReadOperation(epubSchema, imageContentRefs);
}
private static void TestSuccessfulReadOperation(EpubSchema epubSchema, EpubLocalByteContentFileRef? expectedLocalCoverImageFileRef,
BookCoverReaderOptions? bookCoverReaderOptions = null)
{
EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> imageContentRefs =
expectedLocalCoverImageFileRef != null
? CreateImageContentRefs(localImageFileRef: expectedLocalCoverImageFileRef)
: new EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef>();
EpubLocalByteContentFileRef? actualCoverImageFileRef =
BookCoverReader.ReadBookCover(epubSchema, imageContentRefs, bookCoverReaderOptions ?? new BookCoverReaderOptions());
Assert.Equal(expectedLocalCoverImageFileRef, actualCoverImageFileRef);
}
private static void TestFailingReadOperation(
EpubSchema epubSchema, EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef>? imageContentRefs = null,
BookCoverReaderOptions? bookCoverReaderOptions = null)
{
imageContentRefs ??= new EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef>();
Assert.Throws<EpubPackageException>(() =>
BookCoverReader.ReadBookCover(epubSchema, imageContentRefs, bookCoverReaderOptions ?? new BookCoverReaderOptions()));
}
private static EpubSchema CreateEmptyEpubSchema(EpubVersion epubVersion, EpubManifest? manifest = null, EpubGuide? guide = null)
{
return new EpubSchema
(
package: new EpubPackage
(
uniqueIdentifier: null,
epubVersion: epubVersion,
metadata: new EpubMetadata(),
manifest: manifest ?? new EpubManifest(),
spine: new EpubSpine(),
guide: guide
),
epub2Ncx: null,
epub3NavDocument: null,
mediaOverlays: null,
contentDirectoryPath: String.Empty
);
}
private static EpubLocalByteContentFileRef CreateLocalTestImageFileRef()
{
EpubContentFileRefMetadata localImageFileRefMetadata = new(LOCAL_COVER_FILE_NAME, COVER_FILE_CONTENT_TYPE, COVER_FILE_CONTENT_MIME_TYPE);
return new(localImageFileRefMetadata, LOCAL_COVER_FILE_NAME, new TestEpubContentLoader());
}
private static EpubRemoteByteContentFileRef CreateRemoteTestImageFileRef()
{
EpubContentFileRefMetadata remoteImageFileRefMetadata = new(REMOTE_COVER_FILE_HREF, COVER_FILE_CONTENT_TYPE, COVER_FILE_CONTENT_MIME_TYPE);
return new(remoteImageFileRefMetadata, new TestEpubContentLoader());
}
private static EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> CreateImageContentRefs(
EpubLocalByteContentFileRef? localImageFileRef = null, EpubRemoteByteContentFileRef? remoteImageFileRef = null)
{
List<EpubLocalByteContentFileRef> local = new();
List<EpubRemoteByteContentFileRef> remote = new();
if (localImageFileRef != null)
{
local.Add(localImageFileRef);
}
if (remoteImageFileRef != null)
{
remote.Add(remoteImageFileRef);
}
EpubContentCollectionRef<EpubLocalByteContentFileRef, EpubRemoteByteContentFileRef> result = new(local.AsReadOnly(), remote.AsReadOnly());
return result;
}
}
}
|