Merged PR 1106: Extend ReferenceData script task to prefill history w…

…ith all pre/post scripts when database is set up Related work items: #2141, #2142
4tecture · Mar 8, 2022 · 6ce7e16 · 6ce7e16
1 parent 78a1b1f
commit 6ce7e16
Show file tree

Hide file tree

Showing 19 changed files with 613 additions and 161 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,209 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+
+###############################
+# Core EditorConfig Options   #
+###############################
+# Remove the line below if you want to inherit .editorconfig settings from higher directories
+root = true
+
+# All files
+[*]
+indent_style = space
+
+# Code files
+[*.{cs,csx}]
+indent_size = 4
+charset = utf-8-bom
+
+# C# files
+[*.cs]
+
+#### Core EditorConfig Options ####
+
+# Indentation and spacing
+tab_width = 4
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = false
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = true
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false:silent
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_property = false:silent
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+
+# Expression-level preferences
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+csharp_style_throw_expression = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_compound_assignment = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+
+# Field preferences
+dotnet_style_readonly_field = true:suggestion
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = all:suggestion
+
+#### C# Coding Conventions ####
+
+# var preferences
+csharp_style_var_elsewhere = true:silent
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Modifier preferences
+csharp_prefer_static_local_function = true:suggestion
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
+
+# Code-block preferences
+csharp_prefer_braces = true:silent
+csharp_prefer_simple_using_statement = true:suggestion
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_prefer_index_operator = true:suggestion
+csharp_style_prefer_range_operator = true:suggestion
+csharp_style_unused_value_assignment_preference = discard_variable:suggestion
+csharp_style_unused_value_expression_statement_preference = discard_variable:silent
+
+# 'using' directive preferences
+csharp_using_directive_placement = outside_namespace:silent
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_labels = one_less_than_current
+csharp_indent_switch_labels = true
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+# Naming styles
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
diff --git a/CustomSSDTMigrationScripts/CustomSSDTMigrationScripts.csproj b/CustomSSDTMigrationScripts/CustomSSDTMigrationScripts.csproj
@@ -4,9 +4,6 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <PublishSingleFile>true</PublishSingleFile>
-    <AssemblyVersion>0.0.1.0</AssemblyVersion>
-    <FileVersion>0.0.1.0</FileVersion>
-    <Version>0.0.1.0</Version>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -33,7 +30,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Build.Tasks.Core" Version="17.0.0" />
-    <PackageReference Include="System.Text.Json" Version="6.0.0" />
+    <PackageReference Include="System.Text.Json" Version="6.0.2" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/CustomSSDTMigrationScripts/Tasks/PostScriptTask.cs b/CustomSSDTMigrationScripts/Tasks/PostScriptTask.cs
@@ -6,33 +6,32 @@ public class PostScriptTask : PrePostScriptTaskBase
     {
         public PostScriptTask()
         {
-
         }
 
         public override string ScriptTypeName => ScriptTypes.PostScript;
 
-        public override ScriptSettings DefaultScriptSettings => new ScriptSettings
+        protected override ScriptSettings DefaultScriptSettings => new ScriptSettings
         {
-            ScriptBaseDirectory = Path.Combine(base.ProjectRootDirectory, "Scripts", "PostScripts"),
+            ScriptBaseDirectory = Path.Combine(ProjectRootDirectory, "Scripts", "PostScripts"),
             ScriptNamePattern = @"^(\d{14})_(.*).sql",
             ScriptRecursiveSearch = true,
-            GeneratedScriptPath = Path.Combine(base.ProjectRootDirectory, "Scripts", "RunPostScriptsGenerated.sql"),
+            GeneratedScriptPath = Path.Combine(ProjectRootDirectory, "Scripts", "RunPostScriptsGenerated.sql"),
             ExecutionFilterMode = ScriptExecutionFilterMode.FILTER_BY_ALL,
             ExecutionFilterValue = null,
             TreatScriptNamePatternMismatchAsError = true,
             TreatHashMismatchAsError = true
         };
 
-        public override ScriptSettings CurrentScriptSettings => new ScriptSettings
+        public override ScriptSettings ScriptSettings => new ScriptSettings
         {
-            ScriptBaseDirectory = settings.PostScripts.ScriptBaseDirectory ?? DefaultScriptSettings.ScriptBaseDirectory,
-            ScriptNamePattern = settings.PostScripts.ScriptNamePattern ?? DefaultScriptSettings.ScriptNamePattern,
-            ScriptRecursiveSearch = settings.PostScripts.ScriptRecursiveSearch ?? DefaultScriptSettings.ScriptRecursiveSearch,
-            GeneratedScriptPath = settings.PostScripts.GeneratedScriptPath ?? DefaultScriptSettings.GeneratedScriptPath,
-            ExecutionFilterMode = settings.PostScripts.ExecutionFilterMode ?? DefaultScriptSettings.ExecutionFilterMode,
-            ExecutionFilterValue = settings.PostScripts.ExecutionFilterValue ?? DefaultScriptSettings.ExecutionFilterValue,
-            TreatScriptNamePatternMismatchAsError = settings.PostScripts.TreatScriptNamePatternMismatchAsError ?? DefaultScriptSettings.TreatScriptNamePatternMismatchAsError,
-            TreatHashMismatchAsError = settings.PostScripts.TreatHashMismatchAsError ?? DefaultScriptSettings.TreatHashMismatchAsError,
+            ScriptBaseDirectory = Settings.PostScripts.ScriptBaseDirectory ?? DefaultScriptSettings.ScriptBaseDirectory,
+            ScriptNamePattern = Settings.PostScripts.ScriptNamePattern ?? DefaultScriptSettings.ScriptNamePattern,
+            ScriptRecursiveSearch = Settings.PostScripts.ScriptRecursiveSearch ?? DefaultScriptSettings.ScriptRecursiveSearch,
+            GeneratedScriptPath = Settings.PostScripts.GeneratedScriptPath ?? DefaultScriptSettings.GeneratedScriptPath,
+            ExecutionFilterMode = Settings.PostScripts.ExecutionFilterMode ?? DefaultScriptSettings.ExecutionFilterMode,
+            ExecutionFilterValue = Settings.PostScripts.ExecutionFilterValue ?? DefaultScriptSettings.ExecutionFilterValue,
+            TreatScriptNamePatternMismatchAsError = Settings.PostScripts.TreatScriptNamePatternMismatchAsError ?? DefaultScriptSettings.TreatScriptNamePatternMismatchAsError,
+            TreatHashMismatchAsError = Settings.PostScripts.TreatHashMismatchAsError ?? DefaultScriptSettings.TreatHashMismatchAsError,
         };
     }
 }
diff --git a/CustomSSDTMigrationScripts/Tasks/PrePostScriptTaskBase.cs b/CustomSSDTMigrationScripts/Tasks/PrePostScriptTaskBase.cs
@@ -10,7 +10,7 @@ public PrePostScriptTaskBase()
         {
         }
 
-        public override void ExecuteScriptTask()
+        protected override void ExecuteScriptTask()
         {
             var sqlScript = $@"
 {SqlSnippets.ManufacturerHeader}
@@ -84,7 +84,7 @@ IF NOT EXISTS(SELECT *
                             FROM dbo.[_MigrationScriptsHistory]
                             WHERE [ScriptHash] = '{hashBase64}')
             BEGIN
-                IF {Convert.ToInt32(CurrentScriptSettings.TreatHashMismatchAsError)}!=0
+                IF {Convert.ToInt32(ScriptSettings.TreatHashMismatchAsError)}!=0
                     RAISERROR ('ERROR: The hash value for the {ScriptTypeName} migration script {script.Name} does not match with the origin registered and executed script.', 18, 1);
                 ELSE
                     -- SEVERITY 0-9 is treated as warning
@@ -108,7 +108,7 @@ BEGIN CATCH
            @ErrorSeverity = ERROR_SEVERITY(),
            @ErrorState = ERROR_STATE();
 
-	-- Rollback all transactions if any of the {ScriptTypeName} scripts failed.
+    -- Rollback all transactions if any of the {ScriptTypeName} scripts failed.
     IF @@TRANCOUNT > 0  
         ROLLBACK TRANSACTION;
 
@@ -121,8 +121,8 @@ IF @@TRANCOUNT > 0
     COMMIT TRANSACTION;  
 GO";
 
-            File.WriteAllText(CurrentScriptSettings.GeneratedScriptPath, sqlScript, Encoding.UTF8);
-            Logger.LogMessage($@"Script execution file '{CurrentScriptSettings.GeneratedScriptPath}' has been generated.");
+            File.WriteAllText(ScriptSettings.GeneratedScriptPath, sqlScript, Encoding.UTF8);
+            Logger.LogMessage($@"Script execution file '{ScriptSettings.GeneratedScriptPath}' has been generated.");
         }
     }
 }
diff --git a/CustomSSDTMigrationScripts/Tasks/PreScriptTask.cs b/CustomSSDTMigrationScripts/Tasks/PreScriptTask.cs
@@ -6,33 +6,32 @@ public class PreScriptTask : PrePostScriptTaskBase
     {
         public PreScriptTask()
         {
-
         }
 
         public override string ScriptTypeName => ScriptTypes.PreScript;
 
-        public override ScriptSettings DefaultScriptSettings => new ScriptSettings
+        protected override ScriptSettings DefaultScriptSettings => new ScriptSettings
         {
-            ScriptBaseDirectory = Path.Combine(base.ProjectRootDirectory, "Scripts", "PreScripts"),
+            ScriptBaseDirectory = Path.Combine(ProjectRootDirectory, "Scripts", "PreScripts"),
             ScriptNamePattern = @"^(\d{14})_(.*).sql",
             ScriptRecursiveSearch = true,
-            GeneratedScriptPath = Path.Combine(base.ProjectRootDirectory, "Scripts", "RunPreScriptsGenerated.sql"),
+            GeneratedScriptPath = Path.Combine(ProjectRootDirectory, "Scripts", "RunPreScriptsGenerated.sql"),
             ExecutionFilterMode = ScriptExecutionFilterMode.FILTER_BY_ALL,
             ExecutionFilterValue = null,
             TreatScriptNamePatternMismatchAsError = true,
             TreatHashMismatchAsError = true
         };
 
-        public override ScriptSettings CurrentScriptSettings => new ScriptSettings
+        public override ScriptSettings ScriptSettings => new ScriptSettings
         {
-            ScriptBaseDirectory = settings.PreScripts.ScriptBaseDirectory ?? DefaultScriptSettings.ScriptBaseDirectory,
-            ScriptNamePattern = settings.PreScripts.ScriptNamePattern ?? DefaultScriptSettings.ScriptNamePattern,
-            ScriptRecursiveSearch = settings.PreScripts.ScriptRecursiveSearch ?? DefaultScriptSettings.ScriptRecursiveSearch,
-            GeneratedScriptPath = settings.PreScripts.GeneratedScriptPath ?? DefaultScriptSettings.GeneratedScriptPath,
-            ExecutionFilterMode = settings.PreScripts.ExecutionFilterMode ?? DefaultScriptSettings.ExecutionFilterMode,
-            ExecutionFilterValue = settings.PreScripts.ExecutionFilterValue ?? DefaultScriptSettings.ExecutionFilterValue,
-            TreatScriptNamePatternMismatchAsError = settings.PreScripts.TreatScriptNamePatternMismatchAsError ?? DefaultScriptSettings.TreatScriptNamePatternMismatchAsError,
-            TreatHashMismatchAsError = settings.PreScripts.TreatHashMismatchAsError ?? DefaultScriptSettings.TreatHashMismatchAsError,
+            ScriptBaseDirectory = Settings.PreScripts.ScriptBaseDirectory ?? DefaultScriptSettings.ScriptBaseDirectory,
+            ScriptNamePattern = Settings.PreScripts.ScriptNamePattern ?? DefaultScriptSettings.ScriptNamePattern,
+            ScriptRecursiveSearch = Settings.PreScripts.ScriptRecursiveSearch ?? DefaultScriptSettings.ScriptRecursiveSearch,
+            GeneratedScriptPath = Settings.PreScripts.GeneratedScriptPath ?? DefaultScriptSettings.GeneratedScriptPath,
+            ExecutionFilterMode = Settings.PreScripts.ExecutionFilterMode ?? DefaultScriptSettings.ExecutionFilterMode,
+            ExecutionFilterValue = Settings.PreScripts.ExecutionFilterValue ?? DefaultScriptSettings.ExecutionFilterValue,
+            TreatScriptNamePatternMismatchAsError = Settings.PreScripts.TreatScriptNamePatternMismatchAsError ?? DefaultScriptSettings.TreatScriptNamePatternMismatchAsError,
+            TreatHashMismatchAsError = Settings.PreScripts.TreatHashMismatchAsError ?? DefaultScriptSettings.TreatHashMismatchAsError,
         };
     }
 }