/// <summary>
/// Initializes a new instance of the <see cref="TemporarySqlLocalDbInstance"/> class.
/// </summary>
/// <param name="instanceName">The name of the temporary SQL LocalDB instance.</param>
/// <param name="provider">The <see cref="ISqlLocalDbProvider"/> to use to create the temporary instance.</param>
/// <param name="deleteFiles">Whether to delete the file(s) associated with the SQL LocalDB instance when deleted.</param>
/// <exception cref="ArgumentNullException">
/// <paramref name="instanceName"/> or <paramref name="provider"/> is <see langword="null"/>.
/// </exception>
public TemporarySqlLocalDbInstance(string instanceName, ISqlLocalDbProvider provider, bool deleteFiles)
{
if (instanceName == null)
{
throw new ArgumentNullException(nameof(instanceName));
}
if (provider == null)
{
throw new ArgumentNullException(nameof(provider));
}
_instance = provider.CreateInstance(instanceName);
_deleteFiles = deleteFiles;
try
{
_instance.Start();
}
catch (Exception)
{
SqlLocalDbInstance.Delete(_instance, throwIfNotFound: true, deleteFiles: _deleteFiles);
throw;
}
}
/// <summary>
/// Gets an SQL Local DB instance with the specified name if it exists, otherwise a new instance with the specified name is created.
/// </summary>
/// <param name="value">The <see cref="ISqlLocalDbProvider"/> to use to get or create the instance.</param>
/// <param name="instanceName">The name of the SQL Server LocalDB instance to get or create.</param>
/// <returns>
/// An SQL Local DB instance with the name specified by <paramref name="instanceName"/>.
/// </returns>
/// <exception cref="ArgumentNullException">
/// <paramref name="value"/> or <paramref name="instanceName"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="InvalidOperationException">
/// <paramref name="value"/> returns <see langword="null"/> when queried for instances.
/// </exception>
public static ISqlLocalDbInstance GetOrCreateInstance(this ISqlLocalDbProvider value, string instanceName)
{
if (value == null)
{
throw new ArgumentNullException(nameof(value));
}
if (instanceName == null)
{
throw new ArgumentNullException(nameof(instanceName));
}
bool instanceExists = false;
if (SqlLocalDbApi.IsDefaultInstanceName(instanceName))
{
// The default instance is always listed, even if it does not exist,
// so need to query that separately to verify whether to get or create.
instanceExists = SqlLocalDbApi.GetInstanceInfo(instanceName).Exists;
}
else
{
// This approach is used otherwise for testability
IList <ISqlLocalDbInstanceInfo> instances = value.GetInstances();
if (instances != null)
{
// Instance names in SQL Local DB are case-insensitive
instanceExists = instances
.Where((p) => p != null)
.Where((p) => string.Equals(p.Name, instanceName, StringComparison.OrdinalIgnoreCase))
.Any();
}
}
if (instanceExists)
{
return(value.GetInstance(instanceName));
}
else
{
return(value.CreateInstance(instanceName));
}
}
/// <summary>
/// Tests the lifecycle of SQL LocalDB instances.
/// </summary>
/// <param name="localDB">The <see cref="ISqlLocalDbApi"/> to use.</param>
/// <param name="provider">The <see cref="ISqlLocalDbProvider"/> to use.</param>
private static void TestInstanceLifecycle(ISqlLocalDbApi localDB, ISqlLocalDbProvider provider)
{
string instanceName = Guid.NewGuid().ToString();
string sharedInstanceName = string.Empty;
ISqlLocalDbInstance instance = provider.CreateInstance(instanceName);
instance.Start();
try
{
bool currentUserIsAdmin = Helpers.IsCurrentUserAdmin();
if (currentUserIsAdmin)
{
sharedInstanceName = Guid.NewGuid().ToString();
instance.Share(sharedInstanceName);
// Restart the instance so it listens on the new shared name's pipe
instance.Restart();
}
try
{
ISqlLocalDbInstanceInfo info = provider.GetInstances()
.Where((p) => string.Equals(p.Name, instanceName, StringComparison.Ordinal))
.FirstOrDefault();
Assert.IsNotNull(info, "GetInstances() did not return the created instance.");
Assert.AreEqual(sharedInstanceName, info.SharedName, "ISqlLocalDbInstanceInfo.SharedName is incorrect.");
using (SqlConnection connection = instance.CreateConnection())
{
Assert.IsNotNull(connection, "CreateConnection() returned null.");
TestConnection(connection);
}
if (currentUserIsAdmin)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder();
builder.DataSource = string.Format(CultureInfo.InvariantCulture, "(localdb)\\.\\{0}", sharedInstanceName);
builder.IntegratedSecurity = true;
using (SqlConnection connection = new SqlConnection(builder.ConnectionString))
{
TestConnection(connection);
}
}
}
finally
{
if (currentUserIsAdmin)
{
instance.Unshare();
}
}
}
finally
{
instance.Stop();
localDB.DeleteInstance(instance.Name);
}
}
/// <summary>
/// Tests the lifecycle of SQL LocalDB instances.
/// </summary>
/// <param name="localDB">The <see cref="ISqlLocalDbApi"/> to use.</param>
/// <param name="provider">The <see cref="ISqlLocalDbProvider"/> to use.</param>
private static void TestInstanceLifecycle(ISqlLocalDbApi localDB, ISqlLocalDbProvider provider)
{
string instanceName = Guid.NewGuid().ToString();
string sharedInstanceName = string.Empty;
ISqlLocalDbInstance instance = provider.CreateInstance(instanceName);
instance.Start();
try
{
bool currentUserIsAdmin = Helpers.IsCurrentUserAdmin();
if (currentUserIsAdmin)
{
sharedInstanceName = Guid.NewGuid().ToString();
instance.Share(sharedInstanceName);
// Restart the instance so it listens on the new shared name's pipe
instance.Restart();
}
try
{
ISqlLocalDbInstanceInfo info = provider.GetInstances()
.Where((p) => string.Equals(p.Name, instanceName, StringComparison.Ordinal))
.FirstOrDefault();
Assert.IsNotNull(info, "GetInstances() did not return the created instance.");
Assert.AreEqual(sharedInstanceName, info.SharedName, "ISqlLocalDbInstanceInfo.SharedName is incorrect.");
using (SqlConnection connection = instance.CreateConnection())
{
Assert.IsNotNull(connection, "CreateConnection() returned null.");
TestConnection(connection);
}
if (currentUserIsAdmin)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder()
{
DataSource = $@"(localdb)\.\{sharedInstanceName}",
IntegratedSecurity = true
};
using (SqlConnection connection = new SqlConnection(builder.ConnectionString))
{
TestConnection(connection);
}
}
}
finally
{
if (currentUserIsAdmin)
{
instance.Unshare();
}
}
}
finally
{
instance.Stop();
localDB.DeleteInstance(instance.Name);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="TemporarySqlLocalDbInstance"/> class.
/// </summary>
/// <param name="instanceName">The name of the temporary SQL LocalDB instance.</param>
/// <param name="provider">The <see cref="ISqlLocalDbProvider"/> to use to create the temporary instance.</param>
/// <param name="deleteFiles">Whether to delete the file(s) associated with the SQL LocalDB instance when deleted.</param>
/// <exception cref="ArgumentNullException">
/// <paramref name="instanceName"/> or <paramref name="provider"/> is <see langword="null"/>.
/// </exception>
public TemporarySqlLocalDbInstance(string instanceName, ISqlLocalDbProvider provider, bool deleteFiles)
{
if (instanceName == null)
{
throw new ArgumentNullException(nameof(instanceName));
}
if (provider == null)
{
throw new ArgumentNullException(nameof(provider));
}
_instance = provider.CreateInstance(instanceName);
_deleteFiles = deleteFiles;
try
{
_instance.Start();
}
catch (Exception)
{
SqlLocalDbInstance.Delete(_instance, throwIfNotFound: true, deleteFiles: _deleteFiles);
throw;
}
}