test: added e2e test for bom issue

Author: Patrick Kinkeldei

tests/bom_issue/headerless_bom.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace Some.Fake.Namespace;
+
+public class SomeFakeClass
+{
+    public void SomeFakeMethod()
+    {
+        Console.WriteLine("Hello, World!");
+    }
+}

tests/bom_issue/headerless_bom.cs.expected

@@ -0,0 +1,15 @@
+// -------------------------------------------------------
+// Static Copyright
+// -------------------------------------------------------
+
+using System;
+
+namespace Some.Fake.Namespace;
+
+public class SomeFakeClass
+{
+    public void SomeFakeMethod()
+    {
+        Console.WriteLine("Hello, World!");
+    }
+}

tests/bom_issue/license.txt

@@ -0,0 +1 @@
+Static Copyright 

tests/bom_issue/licenserc.toml

@@ -0,0 +1,11 @@
+baseDir = "."
+headerPath = "license.txt"
+
+excludes = ["*.toml", "*.expected"]
+
+additionalHeaders = [
+    "style.toml"
+]
+
+[mapping.HASH_SOURCE_STYLE]
+extensions = ["cs"]

tests/bom_issue/style.toml

@@ -0,0 +1,9 @@
+[HASH_SOURCE_STYLE]
+firstLine = "// -------------------------------------------------------"
+endLine = "// -------------------------------------------------------\n"
+skipLinePattern = "^#!.*$"
+allowBlankLines = false
+multipleLines = false
+beforeEachLine = "// "
+firstLineDetectionPattern = "//\\s+\\-+"
+lastLineDetectionPattern = "//\\s+\\-+"

tests/it.py

@@ -38,3 +38,7 @@ def diff_files(file1, file2):
 
 subprocess.run([hawkeye, "format", "--fail-if-unknown", "--fail-if-updated=false", "--dry-run"], cwd=(basedir / "regression_blank_line"), check=True)
 diff_files(basedir / "regression_blank_line" / "main.rs.expected", basedir / "regression_blank_line" / "main.rs.formatted")
+
+# adds a copyright header to a utf-8 with bom encoded file. The header is inserted before the bom. Which moves the bom behing the added copyright header
+subprocess.run([hawkeye, "format", "--fail-if-unknown", "--fail-if-updated=false", "--dry-run"], cwd=(basedir / "bom_issue"), check=True)
+diff_files(basedir / "bom_issue" / "headerless_bom.cs.expected", basedir / "bom_issue" / "headerless_bom.cs")