/
TestHelpers.cs
361 lines (293 loc) · 14.8 KB
/
TestHelpers.cs
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
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
using Microsoft.EntityFrameworkCore.Diagnostics;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Internal;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Metadata.Conventions;
using Microsoft.EntityFrameworkCore.Metadata.Conventions.Infrastructure;
using Microsoft.EntityFrameworkCore.Storage;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Xunit;
namespace Microsoft.EntityFrameworkCore.TestUtilities
{
public abstract class TestHelpers
{
public DbContextOptions CreateOptions(IModel model, IServiceProvider serviceProvider = null)
{
var optionsBuilder = new DbContextOptionsBuilder()
.UseInternalServiceProvider(serviceProvider);
UseProviderOptions(optionsBuilder.UseModel(model));
return optionsBuilder.Options;
}
public DbContextOptions CreateOptions(IServiceProvider serviceProvider = null)
{
var optionsBuilder = new DbContextOptionsBuilder()
.UseInternalServiceProvider(serviceProvider);
UseProviderOptions(optionsBuilder);
return optionsBuilder.Options;
}
public IServiceProvider CreateServiceProvider(IServiceCollection customServices = null)
=> CreateServiceProvider(customServices, AddProviderServices);
private static IServiceProvider CreateServiceProvider(
IServiceCollection customServices,
Func<IServiceCollection, IServiceCollection> addProviderServices)
{
var services = new ServiceCollection();
addProviderServices(services);
if (customServices != null)
{
foreach (var service in customServices)
{
services.Add(service);
}
}
return services.BuildServiceProvider();
}
public abstract IServiceCollection AddProviderServices(IServiceCollection services);
public DbContextOptionsBuilder AddProviderOptions(DbContextOptionsBuilder optionsBuilder)
{
UseProviderOptions(optionsBuilder);
return optionsBuilder;
}
public abstract void UseProviderOptions(DbContextOptionsBuilder optionsBuilder);
public DbContext CreateContext(IServiceProvider serviceProvider, IModel model)
=> new DbContext(CreateOptions(model, serviceProvider));
public DbContext CreateContext(IServiceProvider serviceProvider, DbContextOptions options)
=> new DbContext(new DbContextOptionsBuilder(options).UseInternalServiceProvider(serviceProvider).Options);
public DbContext CreateContext(IServiceProvider serviceProvider)
=> new DbContext(CreateOptions(serviceProvider));
public DbContext CreateContext(IModel model)
=> new DbContext(CreateOptions(model, CreateServiceProvider()));
public DbContext CreateContext(DbContextOptions options)
=> new DbContext(new DbContextOptionsBuilder(options).UseInternalServiceProvider(CreateServiceProvider()).Options);
public DbContext CreateContext()
=> new DbContext(CreateOptions(CreateServiceProvider()));
public DbContext CreateContext(IServiceCollection customServices, IModel model)
=> new DbContext(CreateOptions(model, CreateServiceProvider(customServices)));
public DbContext CreateContext(IServiceCollection customServices, DbContextOptions options)
=> new DbContext(
new DbContextOptionsBuilder(options).UseInternalServiceProvider(CreateServiceProvider(customServices)).Options);
public DbContext CreateContext(IServiceCollection customServices)
=> new DbContext(CreateOptions(CreateServiceProvider(customServices)));
public IServiceProvider CreateContextServices(IServiceProvider serviceProvider, IModel model)
=> ((IInfrastructure<IServiceProvider>)CreateContext(serviceProvider, model)).Instance;
public IServiceProvider CreateContextServices(IServiceProvider serviceProvider, DbContextOptions options)
=> ((IInfrastructure<IServiceProvider>)CreateContext(serviceProvider, options)).Instance;
public IServiceProvider CreateContextServices(IServiceProvider serviceProvider)
=> ((IInfrastructure<IServiceProvider>)CreateContext(serviceProvider)).Instance;
public IServiceProvider CreateContextServices(IModel model)
=> ((IInfrastructure<IServiceProvider>)CreateContext(model)).Instance;
public IServiceProvider CreateContextServices(DbContextOptions options)
=> ((IInfrastructure<IServiceProvider>)CreateContext(options)).Instance;
public IServiceProvider CreateContextServices()
=> ((IInfrastructure<IServiceProvider>)CreateContext()).Instance;
public IServiceProvider CreateContextServices(IServiceCollection customServices, IModel model)
=> ((IInfrastructure<IServiceProvider>)CreateContext(customServices, model)).Instance;
public IServiceProvider CreateContextServices(IServiceCollection customServices, DbContextOptions options)
=> ((IInfrastructure<IServiceProvider>)CreateContext(customServices, options)).Instance;
public IServiceProvider CreateContextServices(IServiceCollection customServices)
=> ((IInfrastructure<IServiceProvider>)CreateContext(customServices)).Instance;
public IMutableModel BuildModelFor<TEntity>()
where TEntity : class
{
var builder = CreateConventionBuilder();
builder.Entity<TEntity>();
return builder.Model;
}
public ModelBuilder CreateConventionBuilder(
bool skipValidation = false,
IServiceCollection customServices = null)
{
customServices ??= new ServiceCollection();
var contextServices = CreateContextServices(customServices);
var conventionSet = contextServices.GetRequiredService<IConventionSetBuilder>().CreateConventionSet();
if (skipValidation)
{
// Use public API to remove convention, issue #214
ConventionSet.Remove(conventionSet.ModelFinalizedConventions, typeof(ValidatingConvention));
}
return new ModelBuilder(conventionSet);
}
public virtual IConventionSetBuilder CreateConventionSetBuilder()
=> CreateContextServices().GetRequiredService<IConventionSetBuilder>();
public ModelBuilder CreateConventionBuilder(
DiagnosticsLogger<DbLoggerCategory.Model> modelLogger,
DiagnosticsLogger<DbLoggerCategory.Model.Validation> validationLogger)
{
var contextServices = CreateContextServices(
new ServiceCollection()
.AddScoped<IDiagnosticsLogger<DbLoggerCategory.Model>>(_ => modelLogger)
.AddScoped<IDiagnosticsLogger<DbLoggerCategory.Model.Validation>>(_ => validationLogger));
return new ModelBuilder(
contextServices.GetRequiredService<IConventionSetBuilder>().CreateConventionSet(),
contextServices.GetRequiredService<ModelDependencies>().With(modelLogger));
}
public ConventionSet CreateConventionalConventionSet(
DiagnosticsLogger<DbLoggerCategory.Model> modelLogger,
DiagnosticsLogger<DbLoggerCategory.Model.Validation> validationLogger)
{
var contextServices = CreateContextServices(
new ServiceCollection()
.AddScoped<IDiagnosticsLogger<DbLoggerCategory.Model>>(_ => modelLogger)
.AddScoped<IDiagnosticsLogger<DbLoggerCategory.Model.Validation>>(_ => validationLogger));
return contextServices.GetRequiredService<IConventionSetBuilder>().CreateConventionSet();
}
public virtual LoggingDefinitions LoggingDefinitions { get; } = new TestLoggingDefinitions();
public InternalEntityEntry CreateInternalEntry<TEntity>(
IModel model,
EntityState entityState = EntityState.Detached,
TEntity entity = null)
where TEntity : class, new()
{
var entry = CreateContextServices(model)
.GetRequiredService<IStateManager>()
.GetOrCreateEntry(entity ?? new TEntity());
entry.SetEntityState(entityState);
return entry;
}
private static int AssertResults<T>(IList<T> expected, IList<T> actual)
{
Assert.Equal(expected.Count, actual.Count);
foreach (var expectedItem in expected)
{
Assert.True(
actual.Contains(expectedItem),
$"\r\nExpected item: [{expectedItem}] not found in results: [{string.Join(", ", actual.Take(10))}]...");
}
return actual.Count;
}
public static int AssertResults<T>(
IList<T> expected,
IList<T> actual,
Func<T, object> elementSorter,
Action<T, T> elementAsserter,
bool verifyOrdered)
{
Assert.Equal(expected.Count, actual.Count);
if (elementSorter == null
&& !verifyOrdered
&& expected.Count > 1 // If there is only 1 element then sorting is not necessary
&& expected.FirstOrDefault(e => e != null) is T nonNullElement
&& nonNullElement.GetType().GetInterface(nameof(IComparable)) == null)
{
if (elementAsserter != null)
{
throw new InvalidOperationException(
"Element asserter will not be used because results are not properly ordered - either remove asserter from the AssertQuery, add element sorter or set assertOrder to 'true'.");
}
return AssertResults(expected, actual);
}
elementSorter ??= (e => e);
elementAsserter ??= Assert.Equal;
if (!verifyOrdered)
{
expected = expected.OrderBy(elementSorter).ToList();
actual = actual.OrderBy(elementSorter).ToList();
}
for (var i = 0; i < expected.Count; i++)
{
elementAsserter(expected[i], actual[i]);
}
return actual.Count;
}
public static void ExecuteWithStrategyInTransaction<TContext>(
Func<TContext> createContext,
Action<DatabaseFacade, IDbContextTransaction> useTransaction,
Action<TContext> testOperation,
Action<TContext> nestedTestOperation1 = null,
Action<TContext> nestedTestOperation2 = null,
Action<TContext> nestedTestOperation3 = null)
where TContext : DbContext
{
using var c = createContext();
c.Database.CreateExecutionStrategy().Execute(
c, context =>
{
using var transaction = context.Database.BeginTransaction();
using (var innerContext = createContext())
{
useTransaction(innerContext.Database, transaction);
testOperation(innerContext);
}
if (nestedTestOperation1 == null)
{
return;
}
using (var innerContext1 = createContext())
{
useTransaction(innerContext1.Database, transaction);
nestedTestOperation1(innerContext1);
}
if (nestedTestOperation2 == null)
{
return;
}
using (var innerContext2 = createContext())
{
useTransaction(innerContext2.Database, transaction);
nestedTestOperation2(innerContext2);
}
if (nestedTestOperation3 == null)
{
return;
}
using var innerContext3 = createContext();
useTransaction(innerContext3.Database, transaction);
nestedTestOperation3(innerContext3);
});
}
public static async Task ExecuteWithStrategyInTransactionAsync<TContext>(
Func<TContext> createContext,
Action<DatabaseFacade, IDbContextTransaction> useTransaction,
Func<TContext, Task> testOperation,
Func<TContext, Task> nestedTestOperation1 = null,
Func<TContext, Task> nestedTestOperation2 = null,
Func<TContext, Task> nestedTestOperation3 = null)
where TContext : DbContext
{
using var c = createContext();
await c.Database.CreateExecutionStrategy().ExecuteAsync(
c, async context =>
{
using var transaction = await context.Database.BeginTransactionAsync();
using (var innerContext = createContext())
{
useTransaction(innerContext.Database, transaction);
await testOperation(innerContext);
}
if (nestedTestOperation1 == null)
{
return;
}
using (var innerContext1 = createContext())
{
useTransaction(innerContext1.Database, transaction);
await nestedTestOperation1(innerContext1);
}
if (nestedTestOperation2 == null)
{
return;
}
using (var innerContext2 = createContext())
{
useTransaction(innerContext2.Database, transaction);
await nestedTestOperation2(innerContext2);
}
if (nestedTestOperation3 == null)
{
return;
}
using var innerContext3 = createContext();
useTransaction(innerContext3.Database, transaction);
await nestedTestOperation3(innerContext3);
});
}
}
}