Merge pull request #292 from atc-net/feature/CodeCompliance-for-Local…

…ization-Translations Extend code compliance for localization translations
atc-net · Oct 19, 2023 · 6e66f97 · 6e66f97
2 parents 97559e4 + 3c6bfe8
commit 6e66f97
Show file tree

Hide file tree

Showing 10 changed files with 637 additions and 11 deletions.
diff --git a/docs/CodeDoc/Atc.XUnit/Atc.XUnit.md b/docs/CodeDoc/Atc.XUnit/Atc.XUnit.md
@@ -72,6 +72,35 @@ CodeComplianceNamingHelper.
 ><b>Parameters:</b><br>
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`type`&nbsp;&nbsp;-&nbsp;&nbsp;The type.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`useFullName`&nbsp;&nbsp;-&nbsp;&nbsp;if set to true [use full name].<br />
+#### AssertLocalizationResources
+>```csharp
+>void AssertLocalizationResources(Assembly assembly, IList<string> cultureNames, IList<string> allowSuffixTermsForKeySuffixWithPlaceholders = null)
+>```
+><b>Summary:</b> Asserts the localization resources with missing translations or invalid keys with placeholders in value.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`assembly`&nbsp;&nbsp;-&nbsp;&nbsp;The assembly.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cultureNames`&nbsp;&nbsp;-&nbsp;&nbsp;The culture names.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`allowSuffixTermsForKeySuffixWithPlaceholders`&nbsp;&nbsp;-&nbsp;&nbsp;The allow suffix terms for key suffix with placeholders.<br />
+#### AssertLocalizationResourcesForInvalidKeysSuffixWithPlaceholders
+>```csharp
+>void AssertLocalizationResourcesForInvalidKeysSuffixWithPlaceholders(Assembly assembly, IList<string> cultureNames, IList<string> allowSuffixTermsForKeySuffixWithPlaceholders = null)
+>```
+><b>Summary:</b> Asserts the localization resources with invalid keys with placeholders in value.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`assembly`&nbsp;&nbsp;-&nbsp;&nbsp;The assembly.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cultureNames`&nbsp;&nbsp;-&nbsp;&nbsp;The culture names.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`allowSuffixTermsForKeySuffixWithPlaceholders`&nbsp;&nbsp;-&nbsp;&nbsp;The allow suffix terms for key suffix with placeholders.<br />
+#### AssertLocalizationResourcesForMissingTranslations
+>```csharp
+>void AssertLocalizationResourcesForMissingTranslations(Assembly assembly, IList<string> cultureNames)
+>```
+><b>Summary:</b> Asserts the localization resources with missing translations.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`assembly`&nbsp;&nbsp;-&nbsp;&nbsp;The assembly.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cultureNames`&nbsp;&nbsp;-&nbsp;&nbsp;The culture names.<br />
 
 <br />
 
@@ -451,14 +480,18 @@ TestResultHelper.
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`useFullName`&nbsp;&nbsp;-&nbsp;&nbsp;if set to true [use full name].<br />
 #### AssertOnTestResultsFromMethodsWithWrongDefinitions
 >```csharp
->void AssertOnTestResultsFromMethodsWithWrongDefinitions(string assemblyName, Dictionary<MethodInfo, string> methodsWithWrongNaming, bool useFullName = False)
+>void AssertOnTestResultsFromMethodsWithWrongDefinitions(string assemblyName, IDictionary<MethodInfo, string> methodsWithWrongNaming, bool useFullName = False)
 >```
 ><b>Summary:</b> Asserts the on test results from methods with wrong definitions.
 >
 ><b>Parameters:</b><br>
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`assemblyName`&nbsp;&nbsp;-&nbsp;&nbsp;Name of the assembly.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`methodsWithWrongNaming`&nbsp;&nbsp;-&nbsp;&nbsp;The methods with wrong naming.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`useFullName`&nbsp;&nbsp;-&nbsp;&nbsp;if set to true [use full name].<br />
+#### AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders
+>```csharp
+>void AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders(string assemblyName, IDictionary<string, Dictionary<string, List<string>>> missingTranslations, IDictionary<string, Dictionary<string, List<string>>> invalidKeysSuffixWithPlaceholders)
+>```
 #### ToExcelTestResultsFromMethodsWithMissingTests
 >```csharp
 >void ToExcelTestResultsFromMethodsWithMissingTests(DirectoryInfo reportDirectory, string assemblyName, MethodInfo[] methodsWithMissingTests)

diff --git a/docs/CodeDoc/Atc.XUnit/IndexExtended.md b/docs/CodeDoc/Atc.XUnit/IndexExtended.md
@@ -15,6 +15,9 @@
   -  Static Methods
      - AssertExportedTypesWithWrongDefinitions(Assembly assembly, List&lt;Type&gt; excludeTypes = null, bool useFullName = False)
      - AssertExportedTypesWithWrongDefinitions(Type type, bool useFullName = False)
+     - AssertLocalizationResources(Assembly assembly, IList&lt;string&gt; cultureNames, IList&lt;string&gt; allowSuffixTermsForKeySuffixWithPlaceholders = null)
+     - AssertLocalizationResourcesForInvalidKeysSuffixWithPlaceholders(Assembly assembly, IList&lt;string&gt; cultureNames, IList&lt;string&gt; allowSuffixTermsForKeySuffixWithPlaceholders = null)
+     - AssertLocalizationResourcesForMissingTranslations(Assembly assembly, IList&lt;string&gt; cultureNames)
 - [CodeComplianceTestHelper](Atc.XUnit.md#codecompliancetesthelper)
   -  Static Methods
      - AssertExportedMethodsWithMissingTests(DecompilerType decompilerType, Assembly sourceAssembly, Assembly testAssembly, List&lt;Type&gt; excludeSourceTypes = null, bool useFullName = False)
@@ -51,7 +54,8 @@
   -  Static Methods
      - AssertOnTestResults(IReadOnlyCollection&lt;TestResult&gt; testResults)
      - AssertOnTestResultsFromMethodsWithMissingTests(string assemblyName, MethodInfo[] methodsWithMissingTests, bool useFullName = False)
-     - AssertOnTestResultsFromMethodsWithWrongDefinitions(string assemblyName, Dictionary&lt;MethodInfo, string&gt; methodsWithWrongNaming, bool useFullName = False)
+     - AssertOnTestResultsFromMethodsWithWrongDefinitions(string assemblyName, IDictionary&lt;MethodInfo, string&gt; methodsWithWrongNaming, bool useFullName = False)
+     - AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders(string assemblyName, IDictionary&lt;string, Dictionary&lt;string, List&lt;string&gt;&gt;&gt; missingTranslations, IDictionary&lt;string, Dictionary&lt;string, List&lt;string&gt;&gt;&gt; invalidKeysSuffixWithPlaceholders)
      - ToExcelTestResultsFromMethodsWithMissingTests(DirectoryInfo reportDirectory, string assemblyName, MethodInfo[] methodsWithMissingTests)
 - [Traits](Atc.XUnit.md#traits)
   -  Static Fields

diff --git a/src/Atc.XUnit/Atc.XUnit.csproj b/src/Atc.XUnit/Atc.XUnit.csproj
@@ -25,4 +25,8 @@
     <ProjectReference Include="..\Atc\Atc.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="Atc.XUnit.Tests" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/Atc.XUnit/CodeComplianceHelper.cs b/src/Atc.XUnit/CodeComplianceHelper.cs
@@ -42,4 +42,86 @@ public static void AssertExportedTypesWithWrongDefinitions(
             methodsWithWrongNaming,
             useFullName);
     }
+
+    /// <summary>
+    /// Asserts the localization resources with missing translations or invalid keys with placeholders in value.
+    /// </summary>
+    /// <param name="assembly">The assembly.</param>
+    /// <param name="cultureNames">The culture names.</param>
+    /// <param name="allowSuffixTermsForKeySuffixWithPlaceholders">The allow suffix terms for key suffix with placeholders.</param>
+    public static void AssertLocalizationResources(
+        Assembly assembly,
+        IList<string> cultureNames,
+        IList<string>? allowSuffixTermsForKeySuffixWithPlaceholders = null)
+    {
+        if (assembly is null)
+        {
+            throw new ArgumentNullException(nameof(assembly));
+        }
+
+        var missingTranslations = AssemblyLocalizationResourcesHelper.CollectMissingTranslations(
+            assembly,
+            cultureNames);
+
+        var invalidKeysSuffixWithPlaceholders = AssemblyLocalizationResourcesHelper.CollectInvalidKeySuffixWithPlaceholders(
+            assembly,
+            cultureNames,
+            allowSuffixTermsForKeySuffixWithPlaceholders);
+
+        TestResultHelper.AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders(
+            assembly.GetName().Name,
+            missingTranslations,
+            invalidKeysSuffixWithPlaceholders);
+    }
+
+    /// <summary>
+    /// Asserts the localization resources with missing translations.
+    /// </summary>
+    /// <param name="assembly">The assembly.</param>
+    /// <param name="cultureNames">The culture names.</param>
+    public static void AssertLocalizationResourcesForMissingTranslations(
+        Assembly assembly,
+        IList<string> cultureNames)
+    {
+        if (assembly is null)
+        {
+            throw new ArgumentNullException(nameof(assembly));
+        }
+
+        var missingTranslations = AssemblyLocalizationResourcesHelper.CollectMissingTranslations(
+            assembly,
+            cultureNames);
+
+        TestResultHelper.AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders(
+            assembly.GetName().Name,
+            missingTranslations,
+            invalidKeysSuffixWithPlaceholders: null);
+    }
+
+    /// <summary>
+    /// Asserts the localization resources with invalid keys with placeholders in value.
+    /// </summary>
+    /// <param name="assembly">The assembly.</param>
+    /// <param name="cultureNames">The culture names.</param>
+    /// <param name="allowSuffixTermsForKeySuffixWithPlaceholders">The allow suffix terms for key suffix with placeholders.</param>
+    public static void AssertLocalizationResourcesForInvalidKeysSuffixWithPlaceholders(
+        Assembly assembly,
+        IList<string> cultureNames,
+        IList<string>? allowSuffixTermsForKeySuffixWithPlaceholders = null)
+    {
+        if (assembly is null)
+        {
+            throw new ArgumentNullException(nameof(assembly));
+        }
+
+        var invalidKeysSuffixWithPlaceholders = AssemblyLocalizationResourcesHelper.CollectInvalidKeySuffixWithPlaceholders(
+            assembly,
+            cultureNames,
+            allowSuffixTermsForKeySuffixWithPlaceholders);
+
+        TestResultHelper.AssertOnTestResultsFromMissingTranslationsAndInvalidKeysSuffixWithPlaceholders(
+            assembly.GetName().Name,
+            missingTranslations: null,
+            invalidKeysSuffixWithPlaceholders);
+    }
 }
diff --git a/src/Atc.XUnit/GlobalUsings.cs b/src/Atc.XUnit/GlobalUsings.cs
@@ -1,6 +1,9 @@
+global using System.Collections;
 global using System.Diagnostics;
 global using System.Diagnostics.CodeAnalysis;
+global using System.Globalization;
 global using System.Reflection;
+global using System.Resources;
 global using System.Runtime.CompilerServices;
 global using System.Runtime.InteropServices;
 global using System.Text;