Cutlery/Kavita
1
0
Fork 0
mirror of https://github.com/Kareadita/Kavita.git synced 2025-06-01 12:44:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some bad test cases that really messed up my codebase.

Browse Source
This commit is contained in:
Joseph Milazzo 2021-03-22 16:02:07 -05:00
parent b66c6b5714
commit 585e965a85
11 changed files with 97 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
API.Tests/Services/ArchiveServiceTests.cs
View File

@ -63,7 +63,6 @@ namespace API.Tests.Services
[InlineData("not supported 1.zip", 1)] [InlineData("not supported 1.zip", 1)]
[InlineData("not supported 2.cbz", 0)] [InlineData("not supported 2.cbz", 0)]
[InlineData("not supported 3.cbz", 0)] [InlineData("not supported 3.cbz", 0)]
[InlineData("mangadex_131.zip", 577)]
public void GetNumberOfPagesFromArchiveTest(string archivePath, int expected) public void GetNumberOfPagesFromArchiveTest(string archivePath, int expected)
{ {
var testDirectory = Path.Join(Directory.GetCurrentDirectory(), "../../../Services/Test Data/ArchiveService/Archives"); var testDirectory = Path.Join(Directory.GetCurrentDirectory(), "../../../Services/Test Data/ArchiveService/Archives");
@ -119,7 +118,6 @@ namespace API.Tests.Services
[InlineData("not supported 1.zip", 1)] [InlineData("not supported 1.zip", 1)]
[InlineData("not supported 2.cbz", 169)] [InlineData("not supported 2.cbz", 169)]
[InlineData("not supported 3.cbz", 1)] [InlineData("not supported 3.cbz", 1)]
[InlineData("mangadex_131.zip", 577)]
public void CanExtractArchive(string archivePath, int expectedFileCount) public void CanExtractArchive(string archivePath, int expectedFileCount)
{ {
@ -128,17 +126,10 @@ namespace API.Tests.Services
DirectoryService.ClearAndDeleteDirectory(extractDirectory); DirectoryService.ClearAndDeleteDirectory(extractDirectory);
Stopwatch sw = Stopwatch.StartNew(); Stopwatch sw = Stopwatch.StartNew();
try _archiveService.ExtractArchive(Path.Join(testDirectory, archivePath), extractDirectory);
{ var di1 = new DirectoryInfo(extractDirectory);
_archiveService.ExtractArchive(Path.Join(testDirectory, archivePath), extractDirectory); Assert.Equal(expectedFileCount, di1.Exists ? di1.GetFiles().Length : 0);
var di1 = new DirectoryInfo(extractDirectory); _testOutputHelper.WriteLine($"Processed in {sw.ElapsedMilliseconds} ms");
Assert.Equal(expectedFileCount, di1.GetFiles().Length);
_testOutputHelper.WriteLine($"Processed Original in {sw.ElapsedMilliseconds} ms");
}
catch (Exception e)
{
_testOutputHelper.WriteLine("Could not process");
}
DirectoryService.ClearAndDeleteDirectory(extractDirectory); DirectoryService.ClearAndDeleteDirectory(extractDirectory);
} }
@ -159,6 +150,15 @@ namespace API.Tests.Services
_testOutputHelper.WriteLine($"Processed in {sw.ElapsedMilliseconds} ms"); _testOutputHelper.WriteLine($"Processed in {sw.ElapsedMilliseconds} ms");
} }
[Theory]
[InlineData("not supported 2.cbz")]
[InlineData("06_v01[DMM].zip")]
public void CanParseCoverImage(string inputFile)
{
var testDirectory = Path.Join(Directory.GetCurrentDirectory(), "../../../Services/Test Data/ArchiveService/Archives");
Assert.NotEmpty(_archiveService.GetCoverImage(Path.Join(testDirectory, inputFile)));
}
[Fact] [Fact]
public void ShouldHaveComicInfo() public void ShouldHaveComicInfo()
{ {

BIN
API.Tests/Services/Test Data/ArchiveService/Archives/06_v01[DMM].zip Normal file
View File

Binary file not shown.

BIN
API.Tests/Services/Test Data/ArchiveService/Thumbnails/001.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

2
API/Controllers/ServerController.cs
View File

@ -52,7 +52,7 @@ namespace API.Controllers
var dateString = DateTime.Now.ToShortDateString().Replace("/", "_"); var dateString = DateTime.Now.ToShortDateString().Replace("/", "_");
var tempLocation = Path.Join(tempDirectory, "logs_" + dateString); var tempLocation = Path.Join(tempDirectory, "logs_" + dateString);
_directoryService.ExistOrCreate(tempLocation); DirectoryService.ExistOrCreate(tempLocation);
if (!_directoryService.CopyFilesToDirectory(files, tempLocation)) if (!_directoryService.CopyFilesToDirectory(files, tempLocation))
{ {
return BadRequest("Unable to copy files to temp directory for log download."); return BadRequest("Unable to copy files to temp directory for log download.");

7
API/Interfaces/Services/IDirectoryService.cs
View File

@ -20,12 +20,7 @@ namespace API.Interfaces.Services
/// <param name="searchPatternExpression"></param> /// <param name="searchPatternExpression"></param>
/// <returns></returns> /// <returns></returns>
string[] GetFilesWithExtension(string path, string searchPatternExpression = ""); string[] GetFilesWithExtension(string path, string searchPatternExpression = "");
/// <summary> //bool ExistOrCreate(string directoryPath);
/// Returns true if the path exists and is a directory. If path does not exist, this will create it. Returns false in all fail cases.
/// </summary>
/// <param name="directoryPath"></param>
/// <returns></returns>
bool ExistOrCreate(string directoryPath);
Task<byte[]> ReadFileAsync(string path); Task<byte[]> ReadFileAsync(string path);

2
API/Parser/Parser.cs
View File

@ -9,7 +9,7 @@ namespace API.Parser
public static class Parser public static class Parser
{ {
public static readonly string MangaFileExtensions = @"\.cbz|\.zip|\.rar|\.cbr|.tar.gz|.7zip"; public static readonly string MangaFileExtensions = @"\.cbz|\.zip|\.rar|\.cbr|.tar.gz|.7zip";
public static readonly string ImageFileExtensions = @"\.png|\.jpeg|\.jpg|\.gif"; public static readonly string ImageFileExtensions = @"\.png|\.jpeg|\.jpg";
private static readonly string XmlRegexExtensions = @"\.xml"; private static readonly string XmlRegexExtensions = @"\.xml";
private static readonly Regex ImageRegex = new Regex(ImageFileExtensions, RegexOptions.IgnoreCase | RegexOptions.Compiled); private static readonly Regex ImageRegex = new Regex(ImageFileExtensions, RegexOptions.IgnoreCase | RegexOptions.Compiled);
private static readonly Regex MangaFileRegex = new Regex(MangaFileExtensions, RegexOptions.IgnoreCase | RegexOptions.Compiled); private static readonly Regex MangaFileRegex = new Regex(MangaFileExtensions, RegexOptions.IgnoreCase | RegexOptions.Compiled);

135
API/Services/ArchiveService.cs
View File

@ -87,39 +87,38 @@ namespace API.Services
{ {
if (!IsValidArchive(filepath)) return Array.Empty<byte>(); if (!IsValidArchive(filepath)) return Array.Empty<byte>();
if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(filepath)) // if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(filepath))
{ // {
using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(filepath); // using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory), createThumbnail); // return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} // }
//
if (GZipArchive.IsGZipFile(filepath)) // if (GZipArchive.IsGZipFile(filepath))
{ // {
using var archive = GZipArchive.Open(filepath); // using var archive = GZipArchive.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory), createThumbnail); // return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} // }
//
if (RarArchive.IsRarFile(filepath)) // if (RarArchive.IsRarFile(filepath))
{ // {
using var archive = RarArchive.Open(filepath); // using var archive = RarArchive.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory), createThumbnail); // return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} // }
//
if (SevenZipArchive.IsSevenZipFile(filepath)) // if (SevenZipArchive.IsSevenZipFile(filepath))
{ // {
using var archive = SevenZipArchive.Open(filepath); // using var archive = SevenZipArchive.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory), createThumbnail); // return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} // }
//
if (TarArchive.IsTarFile(filepath)) // if (TarArchive.IsTarFile(filepath))
{ // {
using var archive = TarArchive.Open(filepath); // using var archive = TarArchive.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory), createThumbnail); // return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} // }
_logger.LogError("Could not parse archive file");
return Array.Empty<byte>();
using var archive = ArchiveFactory.Open(filepath);
return FindCoverImage(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), createThumbnail);
} }
catch (Exception ex) catch (Exception ex)
{ {
@ -163,6 +162,7 @@ namespace API.Services
{ {
formatExtension = "." + formatExtension; formatExtension = "." + formatExtension;
} }
// TODO: Validate if jpeg is same as jpg
try try
{ {
using var thumbnail = Image.ThumbnailBuffer(entry, ThumbnailWidth); using var thumbnail = Image.ThumbnailBuffer(entry, ThumbnailWidth);
@ -230,27 +230,27 @@ namespace API.Services
if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(archivePath)) if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(archivePath))
{ {
using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(archivePath); using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(archivePath);
info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory)); info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsXml(entry.Key)));
} }
else if (GZipArchive.IsGZipFile(archivePath)) else if (GZipArchive.IsGZipFile(archivePath))
{ {
using var archive = GZipArchive.Open(archivePath); using var archive = GZipArchive.Open(archivePath);
info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory)); info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsXml(entry.Key)));
} }
else if (RarArchive.IsRarFile(archivePath)) else if (RarArchive.IsRarFile(archivePath))
{ {
using var archive = RarArchive.Open(archivePath); using var archive = RarArchive.Open(archivePath);
info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory)); info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsXml(entry.Key)));
} }
else if (SevenZipArchive.IsSevenZipFile(archivePath)) else if (SevenZipArchive.IsSevenZipFile(archivePath))
{ {
using var archive = SevenZipArchive.Open(archivePath); using var archive = SevenZipArchive.Open(archivePath);
info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory)); info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsXml(entry.Key)));
} }
else if (TarArchive.IsTarFile(archivePath)) else if (TarArchive.IsTarFile(archivePath))
{ {
using var archive = TarArchive.Open(archivePath); using var archive = TarArchive.Open(archivePath);
info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory)); info = FindComicInfoXml(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsXml(entry.Key)));
} }
if (info != null) if (info != null)
@ -270,6 +270,7 @@ namespace API.Services
private void ExtractArchiveEntities(IEnumerable<IArchiveEntry> entries, string extractPath) private void ExtractArchiveEntities(IEnumerable<IArchiveEntry> entries, string extractPath)
{ {
DirectoryService.ExistOrCreate(extractPath);
foreach (var entry in entries) foreach (var entry in entries)
{ {
entry.WriteToDirectory(extractPath, new ExtractionOptions() entry.WriteToDirectory(extractPath, new ExtractionOptions()
@ -293,34 +294,38 @@ namespace API.Services
if (!File.Exists(archivePath)) return; if (!File.Exists(archivePath)) return;
var sw = Stopwatch.StartNew(); var sw = Stopwatch.StartNew();
if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(archivePath)) // if (SharpCompress.Archives.Zip.ZipArchive.IsZipFile(archivePath))
{ // {
using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(archivePath); //
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory), extractPath); // //using var archive = SharpCompress.Archives.Zip.ZipArchive.Open(archivePath);
} // using var archive = ArchiveFactory.Open(archivePath);
else if (GZipArchive.IsGZipFile(archivePath)) // ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
{ // }
using var archive = GZipArchive.Open(archivePath); // else if (GZipArchive.IsGZipFile(archivePath))
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory), extractPath); // {
} else if (RarArchive.IsRarFile(archivePath)) // using var archive = GZipArchive.Open(archivePath);
{ // ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
using var archive = RarArchive.Open(archivePath); // } else if (RarArchive.IsRarFile(archivePath))
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory), extractPath); // {
} else if (SevenZipArchive.IsSevenZipFile(archivePath)) // using var archive = RarArchive.Open(archivePath);
{ // ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
using var archive = SevenZipArchive.Open(archivePath); // } else if (SevenZipArchive.IsSevenZipFile(archivePath))
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory), extractPath); // {
} // using var archive = SevenZipArchive.Open(archivePath);
else if (TarArchive.IsTarFile(archivePath)) // ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
{ // }
using var archive = TarArchive.Open(archivePath); // else if (TarArchive.IsTarFile(archivePath))
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory), extractPath); // {
} // using var archive = TarArchive.Open(archivePath);
else // ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
{ // }
_logger.LogError("Could not parse archive file"); // else
return; // {
} // _logger.LogError("Could not parse archive file");
// return;
// }
using var archive = ArchiveFactory.Open(archivePath);
ExtractArchiveEntities(archive.Entries.Where(entry => !entry.IsDirectory && Parser.Parser.IsImage(entry.Key)), extractPath);
_logger.LogDebug("[Fallback] Extracted archive to {ExtractPath} in {ElapsedMilliseconds} milliseconds", extractPath, sw.ElapsedMilliseconds); _logger.LogDebug("[Fallback] Extracted archive to {ExtractPath} in {ElapsedMilliseconds} milliseconds", extractPath, sw.ElapsedMilliseconds);
} }

2
API/Services/CacheService.cs
View File

@ -32,7 +32,7 @@ namespace API.Services
public void EnsureCacheDirectory() public void EnsureCacheDirectory()
{ {
_logger.LogDebug("Checking if valid Cache directory: {CacheDirectory}", CacheDirectory); _logger.LogDebug("Checking if valid Cache directory: {CacheDirectory}", CacheDirectory);
if (!_directoryService.ExistOrCreate(CacheDirectory)) if (!DirectoryService.ExistOrCreate(CacheDirectory))
{ {
_logger.LogError("Cache directory {CacheDirectory} is not accessible or does not exist. Creating...", CacheDirectory); _logger.LogError("Cache directory {CacheDirectory} is not accessible or does not exist. Creating...", CacheDirectory);
} }

8
API/Services/DirectoryService.cs
View File

@ -71,7 +71,12 @@ namespace API.Services
return !Directory.Exists(path) ? Array.Empty<string>() : Directory.GetFiles(path); return !Directory.Exists(path) ? Array.Empty<string>() : Directory.GetFiles(path);
} }
public bool ExistOrCreate(string directoryPath) /// <summary>
/// Returns true if the path exists and is a directory. If path does not exist, this will create it. Returns false in all fail cases.
/// </summary>
/// <param name="directoryPath"></param>
/// <returns></returns>
public static bool ExistOrCreate(string directoryPath)
{ {
var di = new DirectoryInfo(directoryPath); var di = new DirectoryInfo(directoryPath);
if (di.Exists) return true; if (di.Exists) return true;
@ -81,7 +86,6 @@ namespace API.Services
} }
catch (Exception ex) catch (Exception ex)
{ {
_logger.LogError(ex, "There was an issue creating directory: {Directory}", directoryPath);
return false; return false;
} }
return true; return true;

4
API/Services/Tasks/BackupService.cs
View File

@ -66,7 +66,7 @@ namespace API.Services.Tasks
var backupDirectory = Task.Run(() => _unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.BackupDirectory)).Result.Value; var backupDirectory = Task.Run(() => _unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.BackupDirectory)).Result.Value;
_logger.LogDebug("Backing up to {BackupDirectory}", backupDirectory); _logger.LogDebug("Backing up to {BackupDirectory}", backupDirectory);
if (!_directoryService.ExistOrCreate(backupDirectory)) if (!DirectoryService.ExistOrCreate(backupDirectory))
{ {
_logger.LogError("Could not write to {BackupDirectory}; aborting backup", backupDirectory); _logger.LogError("Could not write to {BackupDirectory}; aborting backup", backupDirectory);
return; return;
@ -82,7 +82,7 @@ namespace API.Services.Tasks
} }
var tempDirectory = Path.Join(_tempDirectory, dateString); var tempDirectory = Path.Join(_tempDirectory, dateString);
_directoryService.ExistOrCreate(tempDirectory); DirectoryService.ExistOrCreate(tempDirectory);
_directoryService.ClearDirectory(tempDirectory); _directoryService.ClearDirectory(tempDirectory);
_directoryService.CopyFilesToDirectory( _directoryService.CopyFilesToDirectory(

4
API/Services/Tasks/ScannerService.cs
View File

@ -33,7 +33,7 @@ namespace API.Services.Tasks
_metadataService = metadataService; _metadataService = metadataService;
} }
//[DisableConcurrentExecution(timeoutInSeconds: 5)] [DisableConcurrentExecution(timeoutInSeconds: 5)]
[AutomaticRetry(Attempts = 0, LogEvents = false, OnAttemptsExceeded = AttemptsExceededAction.Delete)] [AutomaticRetry(Attempts = 0, LogEvents = false, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
public void ScanLibraries() public void ScanLibraries()
{ {
@ -64,7 +64,7 @@ namespace API.Services.Tasks
_scannedSeries = null; _scannedSeries = null;
} }
//[DisableConcurrentExecution(5)] [DisableConcurrentExecution(5)]
[AutomaticRetry(Attempts = 0, LogEvents = false, OnAttemptsExceeded = AttemptsExceededAction.Delete)] [AutomaticRetry(Attempts = 0, LogEvents = false, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
public void ScanLibrary(int libraryId, bool forceUpdate) public void ScanLibrary(int libraryId, bool forceUpdate)
{ {