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
|
using System;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Jellyfin.Database.Implementations;
using Jellyfin.Database.Implementations.Entities;
using Jellyfin.Database.Implementations.Locking;
using Jellyfin.Database.Providers.Sqlite;
using Jellyfin.Server.Implementations.FullSystemBackup;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.SystemBackupService;
using Microsoft.Data.Sqlite;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging.Abstractions;
using Moq;
using Xunit;
using BaseItemKind = Jellyfin.Data.Enums.BaseItemKind;
namespace Jellyfin.Server.Implementations.Tests.FullSystemBackup;
/// <summary>
/// Tests for <see cref="BackupService"/>, in particular that a single row of corrupt
/// <see cref="KeyframeData"/> (e.g. malformed <c>KeyframeTicks</c> JSON) does not abort
/// an otherwise healthy backup. See https://github.com/jellyfin/jellyfin/issues/17216.
/// </summary>
public sealed class BackupServiceTests : IDisposable
{
private readonly SqliteConnection _connection;
private readonly DbContextOptions<JellyfinDbContext> _dbOptions;
private readonly string _testRoot;
private readonly string _backupPath;
private readonly string _configurationDirectoryPath;
public BackupServiceTests()
{
_connection = new SqliteConnection("Data Source=:memory:");
_connection.Open();
_dbOptions = new DbContextOptionsBuilder<JellyfinDbContext>()
.UseSqlite(_connection)
.Options;
using (var ctx = CreateDbContext())
{
ctx.Database.EnsureCreated();
}
// Use the test assembly's own output directory instead of Path.GetTempPath(). On GitHub-hosted
// windows-latest runners, the system temp directory lives on the constrained C: drive, which can have
// less than the 5GiB BackupService requires free, causing spurious failures. AppContext.BaseDirectory
// is under the repo checkout (the much larger D: drive on Windows runners) on all platforms.
_testRoot = Path.Combine(AppContext.BaseDirectory, "jellyfin-backup-service-tests-" + Guid.NewGuid().ToString("N"));
_backupPath = Path.Combine(_testRoot, "Backup");
_configurationDirectoryPath = Path.Combine(_testRoot, "Config");
Directory.CreateDirectory(_backupPath);
Directory.CreateDirectory(_configurationDirectoryPath);
}
public void Dispose()
{
_connection.Dispose();
if (Directory.Exists(_testRoot))
{
Directory.Delete(_testRoot, true);
}
}
[Fact]
public async Task CreateBackupAsync_WithCorruptKeyframeDataRow_SkipsRowAndCompletesBackup()
{
var cancellationToken = TestContext.Current.CancellationToken;
var validItemId = Guid.Parse("11111111-1111-1111-1111-111111111111");
var corruptItemId = Guid.Parse("22222222-2222-2222-2222-222222222222");
await using (var ctx = CreateDbContext())
{
// A healthy item + keyframe row, written the normal way.
ctx.BaseItems.Add(CreateMovieEntity(validItemId, "Good Movie"));
ctx.BaseItems.Add(CreateMovieEntity(corruptItemId, "Corrupt Movie"));
await ctx.SaveChangesAsync(cancellationToken).ConfigureAwait(true);
ctx.KeyframeData.Add(new KeyframeData
{
ItemId = validItemId,
TotalDuration = 60_000,
KeyframeTicks = [0, 1000, 2000]
});
await ctx.SaveChangesAsync(cancellationToken).ConfigureAwait(true);
// Simulate a corrupted database row: truncated JSON array for KeyframeTicks,
// written directly via SQL to bypass EF's normal (well-formed) write path.
await ctx.Database.ExecuteSqlInterpolatedAsync(
$"INSERT INTO KeyframeData (ItemId, TotalDuration, KeyframeTicks) VALUES ({corruptItemId.ToString()}, {5000L}, {"[1,2,3"})",
cancellationToken).ConfigureAwait(true);
}
var backupService = CreateBackupService();
var manifest = await backupService.CreateBackupAsync(new BackupOptionsDto()).ConfigureAwait(true);
Assert.True(File.Exists(manifest.Path));
using var archive = await ZipFile.OpenReadAsync(manifest.Path, cancellationToken).ConfigureAwait(true);
var keyframeEntry = archive.GetEntry("Database/KeyframeData.json");
Assert.NotNull(keyframeEntry);
await using var entryStream = await keyframeEntry!.OpenAsync(cancellationToken).ConfigureAwait(true);
using var document = await JsonDocument.ParseAsync(entryStream, cancellationToken: cancellationToken).ConfigureAwait(true);
var rows = document.RootElement.EnumerateArray().ToList();
// The corrupt row must be skipped, but the valid row must still make it into the backup.
var singleRow = Assert.Single(rows);
Assert.Equal(validItemId, singleRow.GetProperty("ItemId").GetGuid());
}
private BackupService CreateBackupService()
{
var factory = new Mock<IDbContextFactory<JellyfinDbContext>>();
factory.Setup(f => f.CreateDbContext()).Returns(CreateDbContext);
factory.Setup(f => f.CreateDbContextAsync(It.IsAny<CancellationToken>())).ReturnsAsync(CreateDbContext);
var applicationHost = new Mock<IServerApplicationHost>();
applicationHost.Setup(a => a.ApplicationVersion).Returns(new Version(10, 11, 0));
var applicationPaths = new Mock<IServerApplicationPaths>();
applicationPaths.Setup(a => a.BackupPath).Returns(_backupPath);
applicationPaths.Setup(a => a.ConfigurationDirectoryPath).Returns(_configurationDirectoryPath);
applicationPaths.Setup(a => a.DataPath).Returns(Path.Combine(_testRoot, "Data"));
applicationPaths.Setup(a => a.RootFolderPath).Returns(Path.Combine(_testRoot, "Root"));
applicationPaths.Setup(a => a.InternalMetadataPath).Returns(Path.Combine(_testRoot, "Metadata"));
applicationPaths.Setup(a => a.DefaultInternalMetadataPath).Returns(Path.Combine(_testRoot, "MetadataDefault"));
var jellyfinDatabaseProvider = new Mock<IJellyfinDatabaseProvider>();
jellyfinDatabaseProvider.Setup(p => p.RunScheduledOptimisation(It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);
jellyfinDatabaseProvider.Setup(p => p.PurgeDatabase(It.IsAny<JellyfinDbContext>(), It.IsAny<System.Collections.Generic.IEnumerable<string>>())).Returns(Task.CompletedTask);
var applicationLifetime = new Mock<IHostApplicationLifetime>();
var libraryManager = new Mock<ILibraryManager>();
libraryManager.Setup(l => l.IsScanRunning).Returns(false);
return new BackupService(
NullLogger<BackupService>.Instance,
factory.Object,
applicationHost.Object,
applicationPaths.Object,
jellyfinDatabaseProvider.Object,
applicationLifetime.Object,
libraryManager.Object);
}
private static BaseItemEntity CreateMovieEntity(Guid id, string name)
{
return new BaseItemEntity
{
Id = id,
Type = "Movie",
Name = name,
PresentationUniqueKey = id.ToString("N"),
MediaType = "Video",
IsMovie = true,
IsFolder = false,
IsVirtualItem = false
};
}
private JellyfinDbContext CreateDbContext()
{
return new JellyfinDbContext(
_dbOptions,
NullLogger<JellyfinDbContext>.Instance,
new SqliteDatabaseProvider(null!, NullLogger<SqliteDatabaseProvider>.Instance),
new NoLockBehavior(NullLogger<NoLockBehavior>.Instance));
}
}
|
