Validate generated Docx files with C#'s OpenXmlValidator

Author: ad-si

Diff for: TestWordFiles/.gitignore

@@ -0,0 +1,2 @@
+bin
+obj

Diff for: TestWordFiles/Program.cs

@@ -0,0 +1,42 @@
+using System;
+using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Packaging;
+using DocumentFormat.OpenXml.Validation;
+using Newtonsoft.Json;
+
+class Program {
+  static void ValidateWordDocument(string filePath) {
+    try {
+      var wordDoc = WordprocessingDocument.Open(filePath, true);
+      var validator = new OpenXmlValidator();
+      var count = 0;
+      foreach (var error in validator.Validate(wordDoc)) {
+        if (error.Description.StartsWith("The element has unexpectedx child")) {
+          continue;
+        }
+        count++;
+        Console.WriteLine("Error " + count);
+        Console.WriteLine("Description: " + error.Description);
+        Console.WriteLine("ErrorType: " + error.ErrorType);
+        Console.WriteLine("Node: " + error.Node);
+        Console.WriteLine("Path: " + error.Path.XPath);
+        Console.WriteLine("Part: " + error.Part.Uri);
+        Console.WriteLine("-------------------------------------------");
+      }
+
+      Console.WriteLine("count={0}", count);
+    }
+    catch (Exception ex) {
+      Console.WriteLine(ex.Message);
+    }
+  }
+
+  static void Main()  {
+    string[] files = System.IO.Directory.GetFiles("../tests", "_tmp_*.docx");
+    foreach (string file in files) {
+      Console.WriteLine("🆕 ===========================================");
+      Console.WriteLine("Validating file: " + file);
+      ValidateWordDocument(file);
+    }
+  }
+}

Diff for: TestWordFiles/TestWordFiles.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="DocumentFormat.OpenXml" Version="3.0.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+  </ItemGroup>
+
+</Project>

Diff for: TestWordFiles/TestWordFiles.sln

@@ -0,0 +1,24 @@
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.2.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestWordFiles", "TestWordFiles.csproj", "{D73FB080-814B-606D-27F6-12CDD99E6878}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{D73FB080-814B-606D-27F6-12CDD99E6878}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D73FB080-814B-606D-27F6-12CDD99E6878}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D73FB080-814B-606D-27F6-12CDD99E6878}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D73FB080-814B-606D-27F6-12CDD99E6878}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {32E5F859-BF84-4B82-BFA3-F80F3FCDF4AF}
+	EndGlobalSection
+EndGlobal

Diff for: justfile

@@ -35,6 +35,11 @@ test-unit: node_modules
   node --test --disable-warning=ExperimentalWarning
 
 
+# Run C#'s OpenXmlValidator on the test Docx files
+test-docx-files:
+  cd TestWordFiles && dotnet run
+
+
 # Run all the tests
 test: fmt lint test-unit