File size: 11,808 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 |
using VersOne.Epub.Options;
using VersOne.Epub.Test.Integration.CustomSerialization;
using VersOne.Epub.Test.Integration.Types;
namespace VersOne.Epub.Test.Integration.Runner
{
internal class TestCaseWriter
{
private delegate List<TestCase> TestCaseGenerator(string testEpubFilePath);
private readonly TestCaseSerializer testCaseSerializer;
private readonly string rootTestCasesDirectory;
private readonly string testCasesFileName;
private readonly string testEpubFileName;
private readonly Dictionary<string, TestCaseGenerator> testCaseGenerators;
public TestCaseWriter(TestCaseSerializer testCaseSerializer, string rootTestCasesDirectory, string testCasesFileName, string testEpubFileName)
{
this.testCaseSerializer = testCaseSerializer;
this.rootTestCasesDirectory = rootTestCasesDirectory;
this.testCasesFileName = testCasesFileName;
this.testEpubFileName = testEpubFileName;
testCaseGenerators = new()
{
{ @"Typical\EPUB2", GenerateTypicalEpub2BookTestCases },
{ @"Typical\EPUB3", GenerateTypicalEpub3BookTestCases },
{ @"Bugfixes\53", GenerateIssue53TestCases },
{ @"Bugfixes\55", GenerateIssue55TestCases },
{ @"Bugfixes\57", GenerateIssue57TestCases },
{ @"Features\RemoteContent", GenerateRemoteContentTestCases },
{ @"Malformed\InvalidManifestItems\EPUB2", GenerateInvalidManifestItemsEpub2TestCases },
{ @"Malformed\InvalidManifestItems\EPUB3", GenerateInvalidManifestItemsEpub3TestCases },
{ @"Malformed\MissingContentForNavigationPoint", GenerateMissingContentForNavigationPointTestCases },
{ @"Malformed\MissingToc", GenerateMissingTocTestCases },
{ @"Workarounds\Xml11", GenerateXml11TestCases }
};
}
public void WriteAllTestCases()
{
foreach (KeyValuePair<string, TestCaseGenerator> testCaseGenerator in testCaseGenerators)
{
string testCaseDirectoryPath = testCaseGenerator.Key;
string testCaseDirectoryAbsolutePath = Path.Combine(rootTestCasesDirectory, testCaseDirectoryPath);
string testCaseFilePath = Path.Combine(testCaseDirectoryAbsolutePath, testCasesFileName);
string testEpubFilePath = Path.Combine(testCaseDirectoryAbsolutePath, testEpubFileName);
List<TestCase> testCases = testCaseGenerator.Value(testEpubFilePath);
WriteTestCases(testCaseFilePath, testEpubFilePath, testCases);
}
}
private List<TestCase> GenerateTypicalEpub2BookTestCases(string testEpubFilePath)
{
return new()
{
new TestCase
(
name: "Typical EPUB 2 book",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
)
};
}
private List<TestCase> GenerateTypicalEpub3BookTestCases(string testEpubFilePath)
{
return new()
{
new TestCase
(
name: "Typical EPUB 3 book",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
)
};
}
private List<TestCase> GenerateIssue53TestCases(string testEpubFilePath)
{
return new()
{
new TestCase
(
name: "Issue #53: EPUB schema metadata/date/event and metadata/identifier/scheme attributes are not being parsed",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
)
};
}
private List<TestCase> GenerateIssue55TestCases(string testEpubFilePath)
{
return new()
{
new TestCase
(
name: "Issue #55: EPUB 2 NCX navigation list parsing issues",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
)
};
}
private List<TestCase> GenerateIssue57TestCases(string testEpubFilePath)
{
return new()
{
new TestCase
(
name: "Issue #57: Cover extracting issue for EPUB 2 books without a cover and a guide",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
)
};
}
private List<TestCase> GenerateRemoteContentTestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithDownloadingRemoteContentEnabled = new()
{
ContentDownloaderOptions = new ContentDownloaderOptions()
{
DownloadContent = true,
DownloaderUserAgent = "EpubReader Integration Test Runner (https://github.com/vers-one/EpubReader)"
}
};
return new()
{
new TestCase
(
name: "EPUB 3 book with remote content files - without options",
expectedResult: EpubReader.ReadBook(testEpubFilePath)
),
new TestCase
(
name: "EPUB 3 book with remote content files - with options",
options: optionsWithDownloadingRemoteContentEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithDownloadingRemoteContentEnabled)
)
};
}
private List<TestCase> GenerateInvalidManifestItemsEpub2TestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithSkippingInvalidManifestItemsEnabled = new()
{
PackageReaderOptions = new PackageReaderOptions()
{
SkipInvalidManifestItems = true
}
};
return new()
{
new TestCase
(
name: "EPUB 2 book with invalid manifest items - without options",
expectedException: new TestCaseException
(
type: "EpubPackageException",
message: "Incorrect EPUB manifest: item ID is missing."
)
),
new TestCase
(
name: "EPUB 2 book with invalid manifest items - with options",
options: optionsWithSkippingInvalidManifestItemsEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithSkippingInvalidManifestItemsEnabled)
)
};
}
private List<TestCase> GenerateInvalidManifestItemsEpub3TestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithSkippingInvalidManifestItemsEnabled = new()
{
PackageReaderOptions = new PackageReaderOptions()
{
SkipInvalidManifestItems = true
}
};
return new()
{
new TestCase
(
name: "EPUB 3 book with invalid manifest items - without options",
expectedException: new TestCaseException
(
type: "EpubPackageException",
message: "Incorrect EPUB manifest: item ID is missing."
)
),
new TestCase
(
name: "EPUB 3 book with invalid manifest items - with options",
options: optionsWithSkippingInvalidManifestItemsEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithSkippingInvalidManifestItemsEnabled)
)
};
}
private List<TestCase> GenerateMissingContentForNavigationPointTestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithIgnoringMissingContentForNavigationPointsEnabled = new()
{
Epub2NcxReaderOptions = new Epub2NcxReaderOptions()
{
IgnoreMissingContentForNavigationPoints = true
}
};
return new()
{
new TestCase
(
name: "EPUB 2 book with missing 'content' attribute for EPUB 2 NCX navigation point - without options",
expectedException: new TestCaseException
(
type: "Epub2NcxException",
message: "EPUB parsing error: navigation point \"navpoint-2\" should contain content."
)
),
new TestCase
(
name: "EPUB 2 book with missing 'content' attribute for EPUB 2 NCX navigation point - with options",
options: optionsWithIgnoringMissingContentForNavigationPointsEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithIgnoringMissingContentForNavigationPointsEnabled)
)
};
}
private List<TestCase> GenerateMissingTocTestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithIgnoringMissingTocEnabled = new()
{
PackageReaderOptions = new PackageReaderOptions()
{
IgnoreMissingToc = true
}
};
return new()
{
new TestCase
(
name: "EPUB 2 book with missing TOC attribute - without options",
expectedException: new TestCaseException
(
type: "EpubPackageException",
message: "Incorrect EPUB spine: TOC is missing."
)
),
new TestCase
(
name: "EPUB 2 book with missing TOC attribute - with options",
options: optionsWithIgnoringMissingTocEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithIgnoringMissingTocEnabled)
)
};
}
private List<TestCase> GenerateXml11TestCases(string testEpubFilePath)
{
EpubReaderOptions optionsWithSkippingXmlHeadersEnabled = new()
{
XmlReaderOptions = new XmlReaderOptions()
{
SkipXmlHeaders = true
}
};
return new()
{
new TestCase
(
name: "EPUB 2 book with XML 1.1 files - without options",
expectedException: new TestCaseException
(
type: "XmlException"
)
),
new TestCase
(
name: "EPUB 2 book with XML 1.1 files - with options",
options: optionsWithSkippingXmlHeadersEnabled,
expectedResult: EpubReader.ReadBook(testEpubFilePath, optionsWithSkippingXmlHeadersEnabled)
)
};
}
private void WriteTestCases(string testCaseFilePath, string testEpubFilePath, List<TestCase> testCases)
{
testCaseSerializer.Serialize(testCaseFilePath, testEpubFilePath, testCases);
}
}
}
|