nhyatt/bitwarden
1
0
Fork 0
mirror of https://github.com/bitwarden/server.git synced 2025-04-05 21:18:13 -05:00
Code

[DEVOPS-1218] Add dryrun mode to MsSqlMigratorUtility (#3795)

Browse Source 
* Add dryrun mode to MsSqlMigratorUtility

* Fix

* Update util/MsSqlMigratorUtility/Program.cs

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

* Update util/MsSqlMigratorUtility/Program.cs

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

* Update util/MsSqlMigratorUtility/Program.cs

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

* Fixes

* Fix using

* Format

* Update util/MsSqlMigratorUtility/Program.cs

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

* Fixes

* Fix after merge

* Fix

* Fix

* Remove unnecessary param name

---------

Co-authored-by: Matt Bishop <mbishop@bitwarden.com>
This commit is contained in:
Michał Chęciński 2024-03-25 15:22:02 +01:00 committed by GitHub
parent 03fe077ec8
commit fd71ed8584
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
util/Migrator/DbMigrator.cs
View File

@ -1,5 +1,6 @@
using System.Data; using System.Data;
using System.Reflection; using System.Reflection;
using System.Text;
using Bit.Core; using Bit.Core;
using DbUp; using DbUp;
using DbUp.Helpers; using DbUp.Helpers;
@ -22,6 +23,7 @@ public class DbMigrator
public bool MigrateMsSqlDatabaseWithRetries(bool enableLogging = true, public bool MigrateMsSqlDatabaseWithRetries(bool enableLogging = true,
bool repeatable = false, bool repeatable = false,
string folderName = MigratorConstants.DefaultMigrationsFolderName, string folderName = MigratorConstants.DefaultMigrationsFolderName,
bool dryRun = false,
CancellationToken cancellationToken = default) CancellationToken cancellationToken = default)
{ {
var attempt = 1; var attempt = 1;
@ -31,7 +33,7 @@ public class DbMigrator
{ {
PrepareDatabase(cancellationToken); PrepareDatabase(cancellationToken);
var success = MigrateDatabase(enableLogging, repeatable, folderName, cancellationToken); var success = MigrateDatabase(enableLogging, repeatable, folderName, dryRun, cancellationToken);
return success; return success;
} }
catch (SqlException ex) catch (SqlException ex)
@ -99,6 +101,7 @@ public class DbMigrator
private bool MigrateDatabase(bool enableLogging = true, private bool MigrateDatabase(bool enableLogging = true,
bool repeatable = false, bool repeatable = false,
string folderName = MigratorConstants.DefaultMigrationsFolderName, string folderName = MigratorConstants.DefaultMigrationsFolderName,
bool dryRun = false,
CancellationToken cancellationToken = default) CancellationToken cancellationToken = default)
{ {
if (enableLogging) if (enableLogging)
@ -130,6 +133,19 @@ public class DbMigrator
} }
var upgrader = builder.Build(); var upgrader = builder.Build();
if (dryRun)
{
var scriptsToExec = upgrader.GetScriptsToExecute();
var stringBuilder = new StringBuilder("Scripts that will be applied:");
foreach (var script in scriptsToExec)
{
stringBuilder.AppendLine(script.Name);
}
_logger.LogInformation(Constants.BypassFiltersEventId, stringBuilder.ToString());
return true;
}
var result = upgrader.PerformUpgrade(); var result = upgrader.PerformUpgrade();
if (enableLogging) if (enableLogging)

12
util/MsSqlMigratorUtility/Program.cs
View File

@ -15,21 +15,23 @@ internal class Program
[Option('r', "repeatable", Description = "Mark scripts as repeatable")] [Option('r', "repeatable", Description = "Mark scripts as repeatable")]
bool repeatable = false, bool repeatable = false,
[Option('f', "folder", Description = "Folder name of database scripts")] [Option('f', "folder", Description = "Folder name of database scripts")]
string folderName = MigratorConstants.DefaultMigrationsFolderName) string folderName = MigratorConstants.DefaultMigrationsFolderName,
=> MigrateDatabase(databaseConnectionString, repeatable, folderName); [Option('d', "dry-run", Description = "Print the scripts that will be applied without actually executing them")]
bool dryRun = false
) => MigrateDatabase(databaseConnectionString, repeatable, folderName, dryRun);
private static bool MigrateDatabase(string databaseConnectionString, private static bool MigrateDatabase(string databaseConnectionString,
bool repeatable = false, string folderName = "") bool repeatable = false, string folderName = "", bool dryRun = false)
{ {
var migrator = new DbMigrator(databaseConnectionString); var migrator = new DbMigrator(databaseConnectionString);
bool success; bool success;
if (!string.IsNullOrWhiteSpace(folderName)) if (!string.IsNullOrWhiteSpace(folderName))
{ {
success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, folderName); success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, folderName, dryRun);
} }
else else
{ {
success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable); success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, dryRun: dryRun);
} }
return success; return success;