From 236db20eae0d99812868be5e2a8e7af5bf84ba54 Mon Sep 17 00:00:00 2001
From: duph97 <dung.a.pham@capgemini.com>
Date: Thu, 5 Sep 2024 10:26:20 +0200
Subject: [PATCH] Improvement/velocity writer utf 8 encoding (#286)

---
 .../tools/solicitor/writer/velocity/VelocityWriter.java    | 7 +++++--
 documentation/master-solicitor.asciidoc                    | 1 +
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/core/src/main/java/com/devonfw/tools/solicitor/writer/velocity/VelocityWriter.java b/core/src/main/java/com/devonfw/tools/solicitor/writer/velocity/VelocityWriter.java
index 29323185..3de027ea 100644
--- a/core/src/main/java/com/devonfw/tools/solicitor/writer/velocity/VelocityWriter.java
+++ b/core/src/main/java/com/devonfw/tools/solicitor/writer/velocity/VelocityWriter.java
@@ -6,9 +6,11 @@
 
 import java.io.BufferedWriter;
 import java.io.File;
-import java.io.FileWriter;
+import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStreamWriter;
+import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.Map.Entry;
 
@@ -91,7 +93,8 @@ public void writeReport(String templateSource, String target, Map<String, DataTa
     // write output
     File file = new File(target);
     IOHelper.checkAndCreateLocation(file);
-    try (BufferedWriter writer = new BufferedWriter(new FileWriter(file))) {
+    try (BufferedWriter writer = new BufferedWriter(
+        new OutputStreamWriter(new FileOutputStream(file), StandardCharsets.UTF_8))) {
       Velocity.evaluate(context, writer, "solicitor report velocity", templateString);
       writer.flush();
     } catch (IOException e) {
diff --git a/documentation/master-solicitor.asciidoc b/documentation/master-solicitor.asciidoc
index efd4df24..17a257be 100644
--- a/documentation/master-solicitor.asciidoc
+++ b/documentation/master-solicitor.asciidoc
@@ -1955,6 +1955,7 @@ Spring beans implementing this interface will be called at certain points in the
 == Release Notes
 Changes in 1.27.0::
 * https://github.com/devonfw/solicitor/issues/283: New Reader for data generated by the Gradle License Report Plugin. See <<Gradle License Report Plugin>>. Reader `gradle2` deprecated (stage 2). Reader `gradle` removed.
+* https://github.com/devonfw/solicitor/issues/285: VelocityWriter now enforces UTF-8 encoding when writing results.
 
 Changes in 1.26.0::
 * https://github.com/devonfw/solicitor/issues/281: Solicitor now assumes ScanCode v32 to be used within the ScanCode integration. ScanCode JSON result files of v30 and v31 can still be processed but the scripting for doing the scans assumes v32 to be installed.