Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow null connection string to be passed to UseProvider methods #28460

Merged
merged 1 commit into from
Jul 16, 2022
Merged

Allow null connection string to be passed to UseProvider methods #28460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/EFCore.SqlServer/Extensions/SqlServerDbContextOptionsBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,9 @@ public static DbContextOptionsBuilder UseSqlServer(
/// <returns>The options builder so that further configuration can be chained.</returns>
public static DbContextOptionsBuilder UseSqlServer(
this DbContextOptionsBuilder optionsBuilder,
string connectionString,
string? connectionString,
Action<SqlServerDbContextOptionsBuilder>? sqlServerOptionsAction = null)
{
Check.NotEmpty(connectionString, nameof(connectionString));

var extension = (SqlServerOptionsExtension)GetOrCreateExtension(optionsBuilder).WithConnectionString(connectionString);
((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(extension);

Expand Down Expand Up @@ -152,7 +150,7 @@ public static DbContextOptionsBuilder<TContext> UseSqlServer<TContext>(
/// <returns>The options builder so that further configuration can be chained.</returns>
public static DbContextOptionsBuilder<TContext> UseSqlServer<TContext>(
this DbContextOptionsBuilder<TContext> optionsBuilder,
string connectionString,
string? connectionString,
Action<SqlServerDbContextOptionsBuilder>? sqlServerOptionsAction = null)
where TContext : DbContext
=> (DbContextOptionsBuilder<TContext>)UseSqlServer(
Expand Down
8 changes: 2 additions & 6 deletions src/EFCore.SqlServer/Extensions/SqlServerServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,16 @@ public static class SqlServerServiceCollectionExtensions
/// <returns>The same service collection so that multiple calls can be chained.</returns>
public static IServiceCollection AddSqlServer<TContext>(
this IServiceCollection serviceCollection,
string connectionString,
string? connectionString,
Action<SqlServerDbContextOptionsBuilder>? sqlServerOptionsAction = null,
Action<DbContextOptionsBuilder>? optionsAction = null)
where TContext : DbContext
{
Check.NotEmpty(connectionString, nameof(connectionString));

return serviceCollection.AddDbContext<TContext>(
=> serviceCollection.AddDbContext<TContext>(
(_, options) =>
{
optionsAction?.Invoke(options);
options.UseSqlServer(connectionString, sqlServerOptionsAction);
});
}

/// <summary>
/// <para>
Expand Down
6 changes: 2 additions & 4 deletions src/EFCore.Sqlite.Core/Extensions/SqliteDbContextOptionsBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,9 @@ public static DbContextOptionsBuilder UseSqlite(
/// <returns>The options builder so that further configuration can be chained.</returns>
public static DbContextOptionsBuilder UseSqlite(
this DbContextOptionsBuilder optionsBuilder,
string connectionString,
string? connectionString,
Action<SqliteDbContextOptionsBuilder>? sqliteOptionsAction = null)
{
Check.NotEmpty(connectionString, nameof(connectionString));

var extension = (SqliteOptionsExtension)GetOrCreateExtension(optionsBuilder).WithConnectionString(connectionString);
((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(extension);

Expand Down Expand Up @@ -145,7 +143,7 @@ public static DbContextOptionsBuilder<TContext> UseSqlite<TContext>(
/// <returns>The options builder so that further configuration can be chained.</returns>
public static DbContextOptionsBuilder<TContext> UseSqlite<TContext>(
this DbContextOptionsBuilder<TContext> optionsBuilder,
string connectionString,
string? connectionString,
Action<SqliteDbContextOptionsBuilder>? sqliteOptionsAction = null)
where TContext : DbContext
=> (DbContextOptionsBuilder<TContext>)UseSqlite(
Expand Down
8 changes: 2 additions & 6 deletions src/EFCore.Sqlite.Core/Extensions/SqliteServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,16 @@ public static class SqliteServiceCollectionExtensions
/// <returns>The same service collection so that multiple calls can be chained.</returns>
public static IServiceCollection AddSqlite<TContext>(
this IServiceCollection serviceCollection,
string connectionString,
string? connectionString,
Action<SqliteDbContextOptionsBuilder>? sqliteOptionsAction = null,
Action<DbContextOptionsBuilder>? optionsAction = null)
where TContext : DbContext
{
Check.NotEmpty(connectionString, nameof(connectionString));

return serviceCollection.AddDbContext<TContext>(
=> serviceCollection.AddDbContext<TContext>(
(_, options) =>
{
optionsAction?.Invoke(options);
options.UseSqlite(connectionString, sqliteOptionsAction);
});
}

/// <summary>
/// <para>
Expand Down
10 changes: 6 additions & 4 deletions test/EFCore.Relational.Specification.Tests/TwoDatabasesTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,10 @@ public virtual void Can_query_from_one_connection_and_save_changes_to_another()
}

[ConditionalTheory]
[InlineData(false)]
[InlineData(true)]
public virtual void Can_set_connection_string_in_interceptor(bool withConnectionString)
[InlineData(true, false)]
[InlineData(true, false)]
[InlineData(true, true)]
public virtual void Can_set_connection_string_in_interceptor(bool withConnectionString, bool withNullConnectionString)
{
using var context1 = CreateBackingContext("TwoDatabasesIntercept");

Expand Down Expand Up @@ -132,7 +133,8 @@ public override void ConnectionClosed(DbConnection connection, ConnectionEndEven

protected abstract DbContextOptionsBuilder CreateTestOptions(
DbContextOptionsBuilder optionsBuilder,
bool withConnectionString = false);
bool withConnectionString = false,
bool withNullConnectionString = false);

protected abstract TwoDatabasesWithDataContext CreateBackingContext(string databaseName);

Expand Down
7 changes: 5 additions & 2 deletions test/EFCore.SqlServer.FunctionalTests/TwoDatabasesSqlServerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ public TwoDatabasesSqlServerTest(SqlServerFixture fixture)

protected override DbContextOptionsBuilder CreateTestOptions(
DbContextOptionsBuilder optionsBuilder,
bool withConnectionString = false)
bool withConnectionString = false,
bool withNullConnectionString = false)
=> withConnectionString
? optionsBuilder.UseSqlServer(DummyConnectionString)
? withNullConnectionString
? optionsBuilder.UseSqlServer((string)null)
: optionsBuilder.UseSqlServer(DummyConnectionString)
: optionsBuilder.UseSqlServer();

protected override TwoDatabasesWithDataContext CreateBackingContext(string databaseName)
Expand Down
20 changes: 12 additions & 8 deletions test/EFCore.SqlServer.Tests/SqlServerDbContextOptionsExtensionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,17 @@ public void Can_add_extension_with_connection_string()
Assert.Null(extension.Connection);
}

[ConditionalFact]
public void Can_add_extension_with_connection_string_using_generic_options()
[ConditionalTheory]
[InlineData(false)]
[InlineData(true)]
public void Can_add_extension_with_connection_string_using_generic_options(bool nullConnectionString)
{
var optionsBuilder = new DbContextOptionsBuilder<DbContext>();
optionsBuilder.UseSqlServer("Database=Whisper");
optionsBuilder.UseSqlServer(nullConnectionString ? null : "Database=Whisper");

var extension = optionsBuilder.Options.Extensions.OfType<SqlServerOptionsExtension>().Single();

Assert.Equal("Database=Whisper", extension.ConnectionString);
Assert.Equal(nullConnectionString ? null : "Database=Whisper", extension.ConnectionString);
Assert.Null(extension.Connection);
}

Expand Down Expand Up @@ -83,12 +85,14 @@ public void Can_add_extension_with_connection_using_generic_options()
Assert.Null(extension.ConnectionString);
}

[ConditionalFact]
public void Service_collection_extension_method_can_configure_sqlserver_options()
[ConditionalTheory]
[InlineData(false)]
[InlineData(true)]
public void Service_collection_extension_method_can_configure_sqlserver_options(bool nullConnectionString)
{
var serviceCollection = new ServiceCollection();
serviceCollection.AddSqlServer<ApplicationDbContext>(
"Database=Crunchie",
nullConnectionString ? null : "Database=Crunchie",
sqlServerOption =>
{
sqlServerOption.MaxBatchSize(123);
Expand All @@ -115,7 +119,7 @@ public void Service_collection_extension_method_can_configure_sqlserver_options(

Assert.Equal(123, sqlServerOptions.MaxBatchSize);
Assert.Equal(30, sqlServerOptions.CommandTimeout);
Assert.Equal("Database=Crunchie", sqlServerOptions.ConnectionString);
Assert.Equal(nullConnectionString ? null : "Database=Crunchie", sqlServerOptions.ConnectionString);
}
}

Expand Down
7 changes: 5 additions & 2 deletions test/EFCore.Sqlite.FunctionalTests/TwoDatabasesSqliteTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ public TwoDatabasesSqliteTest(TwoDatabasesFixture fixture)

protected override DbContextOptionsBuilder CreateTestOptions(
DbContextOptionsBuilder optionsBuilder,
bool withConnectionString = false)
bool withConnectionString = false,
bool withNullConnectionString = false)
=> withConnectionString
? optionsBuilder.UseSqlite(DummyConnectionString)
? withNullConnectionString
? optionsBuilder.UseSqlite((string)null)
: optionsBuilder.UseSqlite(DummyConnectionString)
: optionsBuilder.UseSqlite();

protected override TwoDatabasesWithDataContext CreateBackingContext(string databaseName)
Expand Down
20 changes: 12 additions & 8 deletions test/EFCore.Sqlite.Tests/SqliteDbContextOptionsBuilderExtensionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,17 @@ public void Can_add_extension_with_connection_string()
Assert.Null(extension.Connection);
}

[ConditionalFact]
public void Can_add_extension_with_connection_string_using_generic_options()
[ConditionalTheory]
[InlineData(false)]
[InlineData(true)]
public void Can_add_extension_with_connection_string_using_generic_options(bool nullConnectionString)
{
var optionsBuilder = new DbContextOptionsBuilder<DbContext>();
optionsBuilder.UseSqlite("Database=Whisper");
optionsBuilder.UseSqlite(nullConnectionString ? null : "Database=Whisper");

var extension = optionsBuilder.Options.Extensions.OfType<SqliteOptionsExtension>().Single();

Assert.Equal("Database=Whisper", extension.ConnectionString);
Assert.Equal(nullConnectionString ? null : "Database=Whisper", extension.ConnectionString);
Assert.Null(extension.Connection);
}

Expand Down Expand Up @@ -95,12 +97,14 @@ public void Can_add_extension_with_connection_using_generic_options()
Assert.Null(extension.ConnectionString);
}

[ConditionalFact]
public void Service_collection_extension_method_can_configure_sqlite_options()
[ConditionalTheory]
[InlineData(false)]
[InlineData(true)]
public void Service_collection_extension_method_can_configure_sqlite_options(bool nullConnectionString)
{
var serviceCollection = new ServiceCollection();
serviceCollection.AddSqlite<ApplicationDbContext>(
"Database=Crunchie",
nullConnectionString ? null : "Database=Crunchie",
sqliteOptions =>
{
sqliteOptions.MaxBatchSize(123);
Expand All @@ -127,7 +131,7 @@ public void Service_collection_extension_method_can_configure_sqlite_options()

Assert.Equal(123, sqliteOptions.MaxBatchSize);
Assert.Equal(30, sqliteOptions.CommandTimeout);
Assert.Equal("Database=Crunchie", sqliteOptions.ConnectionString);
Assert.Equal(nullConnectionString ? null : "Database=Crunchie", sqliteOptions.ConnectionString);
}
}

Expand Down