From 81e0f23c445007d70829e529fa9076f53845ea5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josef=20P=C3=B6tzl?= Date: Tue, 17 Nov 2026 15:05:02 +0100 Subject: [PATCH] Export test classes as UTF-8 with BOM and detect encoding on import VBComponent.Export and VBComponents.Import always use the ANSI code page. The core now rewrites exported .cls/.bas files as UTF-8 with BOM (new setting ImportExportEncoding: Utf8Bom (default) or Ansi) and imports an ANSI copy with CRLF of each source file. The import detects UTF-8 with or without BOM, otherwise ANSI, and rejects all files if one contains characters not available in the ANSI code page. --- source/AccUnit/AccessCodeLib.AccUnit.csproj | 1 + .../AccUnit/Configuration/TestClassManager.cs | 100 ++++++++++--- source/AccUnit/Configuration/UserSettings.cs | 14 +- .../Integration/TestSuiteUserSettings.cs | 9 +- source/AccUnit/Integration/UserSettings.cs | 9 +- .../Interfaces/ImportExportEncoding.cs | 16 +++ .../AccUnit/Properties/Settings.Designer.cs | 12 ++ source/AccUnit/Properties/Settings.settings | 3 + source/AccUnit/app.config | 3 + .../AccessCodeLib.Common.VBIDETools.csproj | 2 + .../Common.VBIDETools/CodeModuleContainer.cs | 36 ++++- .../UnsupportedSourceCharactersException.cs | 33 +++++ .../Common/Common.VBIDETools/VbaSourceFile.cs | 91 ++++++++++++ .../TestGeneratorTests/VbaSourceFileTests.cs | 136 ++++++++++++++++++ vbe-add-In/AccUnit.VbeAddIn/UserSettings.cs | 14 +- 15 files changed, 456 insertions(+), 23 deletions(-) create mode 100644 source/AccUnit/Interfaces/ImportExportEncoding.cs create mode 100644 source/Common/Common.VBIDETools/UnsupportedSourceCharactersException.cs create mode 100644 source/Common/Common.VBIDETools/VbaSourceFile.cs create mode 100644 source/Tests/TestGeneratorTests/VbaSourceFileTests.cs diff --git a/source/AccUnit/AccessCodeLib.AccUnit.csproj b/source/AccUnit/AccessCodeLib.AccUnit.csproj index 9dbe47b..5399e75 100644 --- a/source/AccUnit/AccessCodeLib.AccUnit.csproj +++ b/source/AccUnit/AccessCodeLib.AccUnit.csproj @@ -225,6 +225,7 @@ + diff --git a/source/AccUnit/Configuration/TestClassManager.cs b/source/AccUnit/Configuration/TestClassManager.cs index c02e4ac..941c01e 100644 --- a/source/AccUnit/Configuration/TestClassManager.cs +++ b/source/AccUnit/Configuration/TestClassManager.cs @@ -1,4 +1,5 @@ -using AccessCodeLib.Common.Tools.Logging; +using AccessCodeLib.AccUnit.Interfaces; +using AccessCodeLib.Common.Tools.Logging; using AccessCodeLib.Common.VBIDETools; using AccessCodeLib.Common.VBIDETools.Templates; using Microsoft.Vbe.Interop; @@ -6,6 +7,7 @@ using System.Collections.Generic; using System.IO; using System.Linq; +using System.Text; using System.Text.RegularExpressions; namespace AccessCodeLib.AccUnit.Configuration @@ -53,12 +55,23 @@ public string ExportTestClass(string name) private string ExportTestClass(string name, string exportdirectory) { - return CodeModuleManager.Export(name, exportdirectory); + return CodeModuleManager.Export(name, exportdirectory, ExportFileEncoding); } public string ExportTestClass(VBComponent component) { - return CodeModuleManager.Export(component, ExportDirectory); + return CodeModuleManager.Export(component, ExportDirectory, ExportFileEncoding); + } + + /// Encoding of exported .cls and .bas files (setting ImportExportEncoding); null keeps the ANSI file of the VBA editor. + private static Encoding ExportFileEncoding + { + get + { + return TestSuiteUserSettings.Current.ImportExportEncoding == ImportExportEncoding.Ansi + ? null + : VbaSourceFile.Utf8BomEncoding; + } } public void RemoveTestClass(string name, bool export = true) @@ -98,7 +111,7 @@ private void RemoveVbComponent(string name, bool export, string exportdirectory) { if (export) { - CodeModuleManager.ExportAndRemove(name, exportdirectory); + CodeModuleManager.ExportAndRemove(name, exportdirectory, ExportFileEncoding); } else { @@ -261,15 +274,76 @@ public void ImportTestComponents(string fileNameFilter = null, string importPath ImportTestComponents(importComponents, overwriteExistingComponent); } + /// + /// A .cls or .bas file contains characters that are not available in the ANSI code page of the VBA editor; nothing is imported. + /// public void ImportTestComponents(IEnumerable list, bool overwriteExistingComponent = false) { - foreach (var m in list) + var modules = list.ToList(); + ThrowIfSourceFilesCannotBeImported(modules); + + string ansiDirectory = null; + try { - if (overwriteExistingComponent) + foreach (var m in modules) { - RemoveComponentIfExists(m); + if (overwriteExistingComponent) + { + RemoveComponentIfExists(m); + } + + if (m.ComponentType == vbext_ComponentType.vbext_ct_Document) + { + ImportOfficeObject(new FileInfo(m.FileName)); + } + else + { + if (ansiDirectory is null) + { + ansiDirectory = CreateTempImportDirectory(); + } + // VBComponents.Import reads the ANSI code page: import an ANSI copy of the (UTF-8 or ANSI) source file + var ansiFile = VbaSourceFile.WriteAnsiCopy(m.FileName, ansiDirectory, VbaSourceFile.AnsiEncoding); + CodeModuleManager.Generator.Add(new FileInfo(ansiFile)); + } + } + } + finally + { + if (ansiDirectory != null) + { + DeleteTempImportDirectory(ansiDirectory); } - ImportTestComponent(new FileInfo(m.FileName), m.ComponentType); + } + } + + private static void ThrowIfSourceFilesCannotBeImported(IEnumerable modules) + { + var sourceFiles = modules.Where(m => m.ComponentType != vbext_ComponentType.vbext_ct_Document) + .Select(m => m.FileName); + var rejectedFiles = VbaSourceFile.GetFilesWithUnsupportedCharacters(sourceFiles, VbaSourceFile.AnsiEncoding).ToList(); + if (rejectedFiles.Count > 0) + { + throw new UnsupportedSourceCharactersException(rejectedFiles, VbaSourceFile.AnsiEncoding); + } + } + + private static string CreateTempImportDirectory() + { + var directory = Path.Combine(Path.GetTempPath(), "AccUnit", "Import-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(directory); + return directory; + } + + private static void DeleteTempImportDirectory(string directory) + { + try + { + Directory.Delete(directory, true); + } + catch (Exception ex) + { + Logger.Log(ex); } } @@ -293,16 +367,6 @@ private void RemoveComponentIfExists(CodeModuleInfo codeModuleInfo) } - private void ImportTestComponent(FileInfo importFile, vbext_ComponentType type) - { - if (type == vbext_ComponentType.vbext_ct_Document) - ImportOfficeObject(importFile); - else - { - CodeModuleManager.Generator.Add(importFile); - } - } - private void ImportOfficeObject(FileSystemInfo importFile) { if (!(ApplicationHelper is AccessApplicationHelper accessApplication)) diff --git a/source/AccUnit/Configuration/UserSettings.cs b/source/AccUnit/Configuration/UserSettings.cs index dd1ebcc..35e9714 100644 --- a/source/AccUnit/Configuration/UserSettings.cs +++ b/source/AccUnit/Configuration/UserSettings.cs @@ -1,4 +1,5 @@ -using AccessCodeLib.AccUnit.Properties; +using AccessCodeLib.AccUnit.Interfaces; +using AccessCodeLib.AccUnit.Properties; using AccessCodeLib.AccUnit.Tools.Templates; using AccessCodeLib.Common.Tools.Logging; using System; @@ -19,6 +20,8 @@ public interface IUserSettings string TestMethodTemplate { get; set; } void Save(); + + ImportExportEncoding ImportExportEncoding { get; set; } } public class UserSettings : IUserSettings @@ -126,6 +129,15 @@ public string ImportExportFolder set { _testSuiteUserSettings.ImportExportFolder = value.TrimEnd('\\', ' ').TrimStart(); } } + [Category("Import/Export")] + [DefaultValue(ImportExportEncoding.Utf8Bom)] + [Description("Encoding of exported test classes (.cls, .bas): Utf8Bom (UTF-8 with BOM) or Ansi (code page of the VBA editor).\nThe import detects the encoding.")] + public ImportExportEncoding ImportExportEncoding + { + get { return _testSuiteUserSettings.ImportExportEncoding; } + set { _testSuiteUserSettings.ImportExportEncoding = value; } + } + [Category("Templates")] [DefaultValue(@"%APPDATA%\AccessCodeLib\AccUnit\Templates")] [Description("Location of template files")] diff --git a/source/AccUnit/Integration/TestSuiteUserSettings.cs b/source/AccUnit/Integration/TestSuiteUserSettings.cs index 1938bab..8b00e0b 100644 --- a/source/AccUnit/Integration/TestSuiteUserSettings.cs +++ b/source/AccUnit/Integration/TestSuiteUserSettings.cs @@ -1,4 +1,5 @@ -using AccessCodeLib.AccUnit.Properties; +using AccessCodeLib.AccUnit.Interfaces; +using AccessCodeLib.AccUnit.Properties; using AccessCodeLib.Common.Tools.Logging; using System; using System.ComponentModel; @@ -47,6 +48,7 @@ public TestSuiteUserSettings Clone() var clone = new TestSuiteUserSettings { ImportExportFolder = ImportExportFolder, + ImportExportEncoding = ImportExportEncoding, SeparatorChar = SeparatorChar, SeparatorMaxLength = SeparatorMaxLength }; @@ -60,6 +62,7 @@ private void Load() using (new BlockLogger()) { ImportExportFolder = Settings.Default.ImportExportFolder; + ImportExportEncoding = Settings.Default.ImportExportEncoding; SeparatorMaxLength = Settings.Default.SeparatorMaxLength; SeparatorChar = Settings.Default.SeparatorChar; } @@ -68,6 +71,7 @@ private void Load() public void Save() { Settings.Default.ImportExportFolder = ImportExportFolder; + Settings.Default.ImportExportEncoding = ImportExportEncoding; Settings.Default.SeparatorMaxLength = SeparatorMaxLength; Settings.Default.SeparatorChar = SeparatorChar; Settings.Default.Save(); @@ -90,6 +94,9 @@ public string ImportExportFolder } } + /// Encoding of exported .cls and .bas files; the import detects the encoding. + public ImportExportEncoding ImportExportEncoding { get; set; } + [Category("Text output")] [DefaultValue(60)] [Description("")] diff --git a/source/AccUnit/Integration/UserSettings.cs b/source/AccUnit/Integration/UserSettings.cs index 865a4ca..2c94e18 100644 --- a/source/AccUnit/Integration/UserSettings.cs +++ b/source/AccUnit/Integration/UserSettings.cs @@ -1,4 +1,5 @@ -using AccessCodeLib.AccUnit.Properties; +using AccessCodeLib.AccUnit.Interfaces; +using AccessCodeLib.AccUnit.Properties; using AccessCodeLib.Common.Tools.Logging; using System; using System.ComponentModel; @@ -47,6 +48,7 @@ public UserSettings Clone() var clone = new UserSettings { ImportExportFolder = ImportExportFolder, + ImportExportEncoding = ImportExportEncoding, SeparatorChar = SeparatorChar, SeparatorMaxLength = SeparatorMaxLength }; @@ -60,6 +62,7 @@ private void Load() using (new BlockLogger()) { ImportExportFolder = Settings.Default.ImportExportFolder; + ImportExportEncoding = Settings.Default.ImportExportEncoding; SeparatorMaxLength = Settings.Default.SeparatorMaxLength; SeparatorChar = Settings.Default.SeparatorChar; } @@ -68,6 +71,7 @@ private void Load() public void Save() { Settings.Default.ImportExportFolder = ImportExportFolder; + Settings.Default.ImportExportEncoding = ImportExportEncoding; Settings.Default.SeparatorMaxLength = SeparatorMaxLength; Settings.Default.SeparatorChar = SeparatorChar; Settings.Default.Save(); @@ -90,6 +94,9 @@ public string ImportExportFolder } } + /// Encoding of exported .cls and .bas files; the import detects the encoding. + public ImportExportEncoding ImportExportEncoding { get; set; } + [Category("Text output")] [DefaultValue(60)] [Description("")] diff --git a/source/AccUnit/Interfaces/ImportExportEncoding.cs b/source/AccUnit/Interfaces/ImportExportEncoding.cs new file mode 100644 index 0000000..c8edd0f --- /dev/null +++ b/source/AccUnit/Interfaces/ImportExportEncoding.cs @@ -0,0 +1,16 @@ +using System.Runtime.InteropServices; + +namespace AccessCodeLib.AccUnit.Interfaces +{ + /// + /// Encoding of exported test class files (.cls, .bas). + /// The import always detects the encoding (UTF-8 with or without BOM, otherwise ANSI). + /// + [ComVisible(true)] + [Guid("FA0E0FD9-F0F3-40CB-9D8D-D7FD4502A8C0")] + public enum ImportExportEncoding + { + Utf8Bom = 0, + Ansi = 1 + } +} diff --git a/source/AccUnit/Properties/Settings.Designer.cs b/source/AccUnit/Properties/Settings.Designer.cs index 64eba54..08939c9 100644 --- a/source/AccUnit/Properties/Settings.Designer.cs +++ b/source/AccUnit/Properties/Settings.Designer.cs @@ -59,6 +59,18 @@ public string ImportExportFolder { } } + [global::System.Configuration.UserScopedSettingAttribute()] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Configuration.DefaultSettingValueAttribute("Utf8Bom")] + public global::AccessCodeLib.AccUnit.Interfaces.ImportExportEncoding ImportExportEncoding { + get { + return ((global::AccessCodeLib.AccUnit.Interfaces.ImportExportEncoding)(this["ImportExportEncoding"])); + } + set { + this["ImportExportEncoding"] = value; + } + } + [global::System.Configuration.UserScopedSettingAttribute()] [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] [global::System.Configuration.DefaultSettingValueAttribute("%APPDATA%\\AccessCodeLib\\AccUnit\\Templates")] diff --git a/source/AccUnit/Properties/Settings.settings b/source/AccUnit/Properties/Settings.settings index 09583fc..4fe2040 100644 --- a/source/AccUnit/Properties/Settings.settings +++ b/source/AccUnit/Properties/Settings.settings @@ -11,6 +11,9 @@ %APPFOLDER%\Tests\%APPNAME% + + Utf8Bom + %APPDATA%\AccessCodeLib\AccUnit\Templates diff --git a/source/AccUnit/app.config b/source/AccUnit/app.config index 1a9070e..a8c9b9c 100644 --- a/source/AccUnit/app.config +++ b/source/AccUnit/app.config @@ -16,6 +16,9 @@ %APPFOLDER%\Tests\%APPNAME% + + Utf8Bom + %APPDATA%\AccessCodeLib\AccUnit\Templates diff --git a/source/Common/Common.VBIDETools/AccessCodeLib.Common.VBIDETools.csproj b/source/Common/Common.VBIDETools/AccessCodeLib.Common.VBIDETools.csproj index b8ea725..0154877 100644 --- a/source/Common/Common.VBIDETools/AccessCodeLib.Common.VBIDETools.csproj +++ b/source/Common/Common.VBIDETools/AccessCodeLib.Common.VBIDETools.csproj @@ -136,6 +136,8 @@ + + diff --git a/source/Common/Common.VBIDETools/CodeModuleContainer.cs b/source/Common/Common.VBIDETools/CodeModuleContainer.cs index 61b6b18..fb47224 100644 --- a/source/Common/Common.VBIDETools/CodeModuleContainer.cs +++ b/source/Common/Common.VBIDETools/CodeModuleContainer.cs @@ -2,6 +2,7 @@ using Microsoft.Vbe.Interop; using System; using System.Linq; +using System.Text; namespace AccessCodeLib.Common.VBIDETools { @@ -68,13 +69,35 @@ public string Export(string name, string exportfolder) return Export(c, exportfolder); } + public string Export(string name, string exportfolder, Encoding fileEncoding) + { + var c = _vbProject.VBComponents.Item(name); + return Export(c, exportfolder, fileEncoding); + } + public string Export(VBComponent component, string exportfolder) + { + return Export(component, exportfolder, null); + } + + /// Encoding of .cls and .bas files; null keeps the ANSI file of the VBA editor. + public string Export(VBComponent component, string exportfolder, Encoding fileEncoding) { var fileName = $"{exportfolder.TrimEnd(' ', '\\')}\\{component.Name}{GetVbComponentTypeFileExtension(component.Type)}"; component.Export(fileName); + if (fileEncoding != null && IsConvertibleComponentType(component.Type)) + { + VbaSourceFile.ConvertExportedFile(fileName, fileEncoding, VbaSourceFile.AnsiEncoding); + } return fileName; } + private static bool IsConvertibleComponentType(vbext_ComponentType componenttype) + { + return componenttype == vbext_ComponentType.vbext_ct_ClassModule || + componenttype == vbext_ComponentType.vbext_ct_StdModule; + } + private static string GetVbComponentTypeFileExtension(vbext_ComponentType componenttype) { string fileExtension; @@ -107,7 +130,18 @@ public string ExportAndRemove(string name, string exportfolder) public string ExportAndRemove(VBComponent component, string exportfolder) { - var fileName = Export(component, exportfolder); + return ExportAndRemove(component, exportfolder, null); + } + + public string ExportAndRemove(string name, string exportfolder, Encoding fileEncoding) + { + var c = _vbProject.VBComponents.Item(name); + return ExportAndRemove(c, exportfolder, fileEncoding); + } + + public string ExportAndRemove(VBComponent component, string exportfolder, Encoding fileEncoding) + { + var fileName = Export(component, exportfolder, fileEncoding); Remove(component); return fileName; } diff --git a/source/Common/Common.VBIDETools/UnsupportedSourceCharactersException.cs b/source/Common/Common.VBIDETools/UnsupportedSourceCharactersException.cs new file mode 100644 index 0000000..9398741 --- /dev/null +++ b/source/Common/Common.VBIDETools/UnsupportedSourceCharactersException.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; + +namespace AccessCodeLib.Common.VBIDETools +{ + /// + /// Source files contain characters that are not available in the ANSI code page of the VBA editor. + /// + [Serializable] + public class UnsupportedSourceCharactersException : Exception + { + public UnsupportedSourceCharactersException(IEnumerable filePaths, Encoding ansiEncoding) + : this(filePaths.ToList(), ansiEncoding) + { + } + + private UnsupportedSourceCharactersException(IList filePaths, Encoding ansiEncoding) + : base(CreateMessage(filePaths, ansiEncoding)) + { + FilePaths = filePaths; + } + + public IList FilePaths { get; } + + private static string CreateMessage(IEnumerable filePaths, Encoding ansiEncoding) + { + return "The following files contain characters that are not available in the ANSI code page " + + ansiEncoding.WebName + " used by the VBA editor:\r\n" + string.Join("\r\n", filePaths); + } + } +} diff --git a/source/Common/Common.VBIDETools/VbaSourceFile.cs b/source/Common/Common.VBIDETools/VbaSourceFile.cs new file mode 100644 index 0000000..495f1ea --- /dev/null +++ b/source/Common/Common.VBIDETools/VbaSourceFile.cs @@ -0,0 +1,91 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text; + +namespace AccessCodeLib.Common.VBIDETools +{ + /// + /// Encoding of VBA source files (.cls, .bas). + /// VBComponent.Export and VBComponents.Import always use the ANSI code page of the system, + /// source files in a repository are usually UTF-8. + /// + public static class VbaSourceFile + { + private static readonly string[] LineSeparators = { "\r\n", "\n" }; + private static readonly byte[] Utf8Preamble = Encoding.UTF8.GetPreamble(); + + /// Code page used by VBComponent.Export and VBComponents.Import (Encoding.Default on .NET Framework). + public static Encoding AnsiEncoding + { + get { return Encoding.Default; } + } + + public static Encoding Utf8BomEncoding + { + get { return new UTF8Encoding(true); } + } + + /// UTF-8 with BOM, valid UTF-8 without BOM, otherwise the ANSI code page. + public static string Decode(byte[] bytes, Encoding ansiEncoding) + { + if (bytes.Take(Utf8Preamble.Length).SequenceEqual(Utf8Preamble)) + return Encoding.UTF8.GetString(bytes, Utf8Preamble.Length, bytes.Length - Utf8Preamble.Length); + + try + { + return new UTF8Encoding(false, true).GetString(bytes); + } + catch (DecoderFallbackException) + { + return ansiEncoding.GetString(bytes); + } + } + + public static string ReadAllText(string filePath, Encoding ansiEncoding) + { + return Decode(File.ReadAllBytes(filePath), ansiEncoding); + } + + public static bool CanBeEncoded(string sourceCode, Encoding ansiEncoding) + { + return ansiEncoding.GetString(ansiEncoding.GetBytes(sourceCode)) == sourceCode; + } + + public static string ToCrLf(string sourceCode) + { + return string.Join("\r\n", sourceCode.Split(LineSeparators, StringSplitOptions.None)); + } + + /// Rewrites a file exported by the VBA editor (ANSI) in the target encoding with CRLF line endings. + public static void ConvertExportedFile(string filePath, Encoding targetEncoding, Encoding ansiEncoding) + { + var sourceCode = ansiEncoding.GetString(File.ReadAllBytes(filePath)); + File.WriteAllText(filePath, ToCrLf(sourceCode), targetEncoding); + } + + /// + /// Writes the source file in the ANSI code page with CRLF line endings into the target directory, + /// as VBComponents.Import expects it. + /// + /// Path of the ANSI copy (same file name as the source file). + /// The file contains characters that are not available in the ANSI code page. + public static string WriteAnsiCopy(string sourceFilePath, string targetDirectory, Encoding ansiEncoding) + { + var sourceCode = ReadAllText(sourceFilePath, ansiEncoding); + if (!CanBeEncoded(sourceCode, ansiEncoding)) + throw new UnsupportedSourceCharactersException(new[] { sourceFilePath }, ansiEncoding); + + var targetFilePath = Path.Combine(targetDirectory, Path.GetFileName(sourceFilePath)); + File.WriteAllText(targetFilePath, ToCrLf(sourceCode), ansiEncoding); + return targetFilePath; + } + + /// Files that contain characters which are not available in the ANSI code page. + public static IEnumerable GetFilesWithUnsupportedCharacters(IEnumerable filePaths, Encoding ansiEncoding) + { + return filePaths.Where(filePath => !CanBeEncoded(ReadAllText(filePath, ansiEncoding), ansiEncoding)).ToList(); + } + } +} diff --git a/source/Tests/TestGeneratorTests/VbaSourceFileTests.cs b/source/Tests/TestGeneratorTests/VbaSourceFileTests.cs new file mode 100644 index 0000000..7375e23 --- /dev/null +++ b/source/Tests/TestGeneratorTests/VbaSourceFileTests.cs @@ -0,0 +1,136 @@ +using AccessCodeLib.Common.VBIDETools; +using NUnit.Framework; +using System; +using System.IO; +using System.Linq; +using System.Text; + +namespace TestGeneratorTests +{ + public class VbaSourceFileTests + { + private static readonly Encoding Ansi1252 = Encoding.GetEncoding(1252); + private const string GermanText = "' Größe ändern: äöüß €"; + private const string NonAnsiText = "' Pfeil → und 中"; + + private string _directory; + + [SetUp] + public void SetUp() + { + _directory = Path.Combine(Path.GetTempPath(), "AccUnitVbaSourceFileTests-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(_directory); + } + + [TearDown] + public void TearDown() + { + Directory.Delete(_directory, true); + } + + [Test] + public void Decode_Utf8WithBom_ReturnsTextWithoutBom() + { + var bytes = new UTF8Encoding(true).GetPreamble().Concat(Encoding.UTF8.GetBytes(GermanText)).ToArray(); + + Assert.That(VbaSourceFile.Decode(bytes, Ansi1252), Is.EqualTo(GermanText)); + } + + [Test] + public void Decode_Utf8WithoutBom_ReturnsText() + { + var bytes = Encoding.UTF8.GetBytes(GermanText); + + Assert.That(VbaSourceFile.Decode(bytes, Ansi1252), Is.EqualTo(GermanText)); + } + + [Test] + public void Decode_Ansi_ReturnsText() + { + var bytes = Ansi1252.GetBytes(GermanText); + + Assert.That(VbaSourceFile.Decode(bytes, Ansi1252), Is.EqualTo(GermanText)); + } + + [TestCase(GermanText, true)] + [TestCase(NonAnsiText, false)] + public void CanBeEncoded_ReturnsExpected(string text, bool expected) + { + Assert.That(VbaSourceFile.CanBeEncoded(text, Ansi1252), Is.EqualTo(expected)); + } + + [Test] + public void ToCrLf_MixedLineEndings_ReturnsCrLf() + { + Assert.That(VbaSourceFile.ToCrLf("a\nb\r\nc\n"), Is.EqualTo("a\r\nb\r\nc\r\n")); + } + + [Test] + public void WriteAnsiCopy_Utf8FileWithLf_WritesAnsiWithCrLf() + { + var sourceFile = Path.Combine(_directory, "Test1.cls"); + File.WriteAllText(sourceFile, "Option Explicit\n" + GermanText + "\n", new UTF8Encoding(true)); + var targetDirectory = Directory.CreateDirectory(Path.Combine(_directory, "ansi")).FullName; + + var ansiFile = VbaSourceFile.WriteAnsiCopy(sourceFile, targetDirectory, Ansi1252); + + Assert.That(ansiFile, Is.EqualTo(Path.Combine(targetDirectory, "Test1.cls"))); + Assert.That(File.ReadAllBytes(ansiFile), Is.EqualTo(Ansi1252.GetBytes("Option Explicit\r\n" + GermanText + "\r\n"))); + } + + [Test] + public void WriteAnsiCopy_AnsiFile_WritesSameText() + { + var sourceFile = Path.Combine(_directory, "Test2.bas"); + var ansiBytes = Ansi1252.GetBytes("Option Explicit\r\n" + GermanText + "\r\n"); + File.WriteAllBytes(sourceFile, ansiBytes); + var targetDirectory = Directory.CreateDirectory(Path.Combine(_directory, "ansi")).FullName; + + var ansiFile = VbaSourceFile.WriteAnsiCopy(sourceFile, targetDirectory, Ansi1252); + + Assert.That(File.ReadAllBytes(ansiFile), Is.EqualTo(ansiBytes)); + } + + [Test] + public void WriteAnsiCopy_NonAnsiCharacters_ThrowsAndWritesNothing() + { + var sourceFile = Path.Combine(_directory, "Test3.cls"); + File.WriteAllText(sourceFile, NonAnsiText, new UTF8Encoding(true)); + var targetDirectory = Directory.CreateDirectory(Path.Combine(_directory, "ansi")).FullName; + + var ex = Assert.Throws( + () => VbaSourceFile.WriteAnsiCopy(sourceFile, targetDirectory, Ansi1252)); + + Assert.That(ex.FilePaths, Is.EqualTo(new[] { sourceFile })); + Assert.That(Directory.GetFiles(targetDirectory), Is.Empty); + } + + [Test] + public void GetFilesWithUnsupportedCharacters_ReturnsOnlyRejectedFiles() + { + var ansiFile = Path.Combine(_directory, "Ansi.cls"); + File.WriteAllBytes(ansiFile, Ansi1252.GetBytes(GermanText)); + var utf8File = Path.Combine(_directory, "Utf8.cls"); + File.WriteAllText(utf8File, GermanText, new UTF8Encoding(false)); + var rejectedFile = Path.Combine(_directory, "Rejected.cls"); + File.WriteAllText(rejectedFile, NonAnsiText, new UTF8Encoding(true)); + + var result = VbaSourceFile.GetFilesWithUnsupportedCharacters(new[] { ansiFile, utf8File, rejectedFile }, Ansi1252); + + Assert.That(result, Is.EqualTo(new[] { rejectedFile })); + } + + [Test] + public void ConvertExportedFile_AnsiFile_WritesUtf8WithBomAndCrLf() + { + var file = Path.Combine(_directory, "Exported.cls"); + File.WriteAllBytes(file, Ansi1252.GetBytes("Option Explicit\r\n" + GermanText + "\n")); + + VbaSourceFile.ConvertExportedFile(file, VbaSourceFile.Utf8BomEncoding, Ansi1252); + + var expected = new UTF8Encoding(true).GetPreamble() + .Concat(Encoding.UTF8.GetBytes("Option Explicit\r\n" + GermanText + "\r\n")).ToArray(); + Assert.That(File.ReadAllBytes(file), Is.EqualTo(expected)); + } + } +} diff --git a/vbe-add-In/AccUnit.VbeAddIn/UserSettings.cs b/vbe-add-In/AccUnit.VbeAddIn/UserSettings.cs index d93c51f..69e6350 100644 --- a/vbe-add-In/AccUnit.VbeAddIn/UserSettings.cs +++ b/vbe-add-In/AccUnit.VbeAddIn/UserSettings.cs @@ -1,4 +1,5 @@ -using AccessCodeLib.AccUnit.Tools.Templates; +using AccessCodeLib.AccUnit.Interfaces; +using AccessCodeLib.AccUnit.Tools.Templates; using AccessCodeLib.Common.Tools.Logging; using System; using System.ComponentModel; @@ -84,6 +85,8 @@ public void Save() { AccUnit.UserSettings.Current = _testSuiteUserSettings; AccUnit.UserSettings.Current.Save(); + // TestClassManager reads TestSuiteUserSettings: reload it from the saved settings + TestSuiteUserSettings.UnloadCurrent(); Tools.UserSettings.Current = _toolsUserSettings; Tools.UserSettings.Current.Save(); /* @@ -121,6 +124,15 @@ public string ImportExportFolder set { _testSuiteUserSettings.ImportExportFolder = value.TrimEnd('\\', ' ').TrimStart(); } } + [Category("Import/Export")] + [DefaultValue(ImportExportEncoding.Utf8Bom)] + [Description("Encoding of exported test classes (.cls, .bas): Utf8Bom (UTF-8 with BOM) or Ansi (code page of the VBA editor).\nThe import detects the encoding.")] + public ImportExportEncoding ImportExportEncoding + { + get { return _testSuiteUserSettings.ImportExportEncoding; } + set { _testSuiteUserSettings.ImportExportEncoding = value; } + } + [Category("Templates")] [DefaultValue(@"%APPDATA%\AccessCodeLib\AccUnit\Templates")] [Description("Location of template files")]