From fd71ed85847a4da73e65d516610054426283438f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Ch=C4=99ci=C5=84ski?=
 <mchecinski@bitwarden.com>
Date: Mon, 25 Mar 2024 15:22:02 +0100
Subject: [PATCH] [DEVOPS-1218] Add dryrun mode to MsSqlMigratorUtility (#3795)

* 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>
---
 util/Migrator/DbMigrator.cs          | 18 +++++++++++++++++-
 util/MsSqlMigratorUtility/Program.cs | 12 +++++++-----
 2 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/util/Migrator/DbMigrator.cs b/util/Migrator/DbMigrator.cs
index 49aec7f404..a6ca53abdb 100644
--- a/util/Migrator/DbMigrator.cs
+++ b/util/Migrator/DbMigrator.cs
@@ -1,5 +1,6 @@
 using System.Data;
 using System.Reflection;
+using System.Text;
 using Bit.Core;
 using DbUp;
 using DbUp.Helpers;
@@ -22,6 +23,7 @@ public class DbMigrator
     public bool MigrateMsSqlDatabaseWithRetries(bool enableLogging = true,
         bool repeatable = false,
         string folderName = MigratorConstants.DefaultMigrationsFolderName,
+        bool dryRun = false,
         CancellationToken cancellationToken = default)
     {
         var attempt = 1;
@@ -31,7 +33,7 @@ public class DbMigrator
             {
                 PrepareDatabase(cancellationToken);
 
-                var success = MigrateDatabase(enableLogging, repeatable, folderName, cancellationToken);
+                var success = MigrateDatabase(enableLogging, repeatable, folderName, dryRun, cancellationToken);
                 return success;
             }
             catch (SqlException ex)
@@ -99,6 +101,7 @@ public class DbMigrator
     private bool MigrateDatabase(bool enableLogging = true,
         bool repeatable = false,
         string folderName = MigratorConstants.DefaultMigrationsFolderName,
+        bool dryRun = false,
         CancellationToken cancellationToken = default)
     {
         if (enableLogging)
@@ -130,6 +133,19 @@ public class DbMigrator
         }
 
         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();
 
         if (enableLogging)
diff --git a/util/MsSqlMigratorUtility/Program.cs b/util/MsSqlMigratorUtility/Program.cs
index 5f215d1552..47deab256e 100644
--- a/util/MsSqlMigratorUtility/Program.cs
+++ b/util/MsSqlMigratorUtility/Program.cs
@@ -15,21 +15,23 @@ internal class Program
         [Option('r', "repeatable", Description = "Mark scripts as repeatable")]
         bool repeatable = false,
         [Option('f', "folder", Description = "Folder name of database scripts")]
-        string folderName = MigratorConstants.DefaultMigrationsFolderName)
-        => MigrateDatabase(databaseConnectionString, repeatable, folderName);
+        string folderName = MigratorConstants.DefaultMigrationsFolderName,
+        [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,
-        bool repeatable = false, string folderName = "")
+        bool repeatable = false, string folderName = "", bool dryRun = false)
     {
         var migrator = new DbMigrator(databaseConnectionString);
         bool success;
         if (!string.IsNullOrWhiteSpace(folderName))
         {
-            success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, folderName);
+            success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, folderName, dryRun);
         }
         else
         {
-            success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable);
+            success = migrator.MigrateMsSqlDatabaseWithRetries(true, repeatable, dryRun: dryRun);
         }
 
         return success;