Add NormalizeLocales task

* Add task to help work with Crowdin locales
* Add MockBuildEngine to support testing
* Add task into the documentation

+semver:minor

Author: jasonleenaylor

CHANGELOG.md

@@ -16,6 +16,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [2.3.0] - 2020-04-15
+
+### Added
+
+- Add `NormalizeLocales` Task to help work with Crowdin Localized files
+
 ### Added
 
 - Create symbol nuget package

Documentation/SIL.BuildTasks.md

@@ -75,6 +75,12 @@ may be sent in clear.
 
 ### Example
 
+## NormalizeLocales task
+
+### Properties
+
+- `L10nsDirectory`: The directory whose subdirectories are locale names and contain localization files
+
 ## NUnit task
 
 Runs NUnit (v2) on a test assembly.

Readme.md

@@ -23,6 +23,7 @@ Several useful msbuild tasks.
 [FileUpdate](Documentation/SIL.BuildTasks.md#fileupdate-task) |
 [MakePot](Documentation/SIL.BuildTasks.md#makepot-task) |
 [MakeWixForDirTree](Documentation/SIL.BuildTasks.md#makewixfordirtree-task) |
+[NormalizeLocales](Documentation/SIL.BuildTasks.md#normalizelocales-task) | Drops country code from directories and filenames to help work with Crowdin
 [NUnit](Documentation/SIL.BuildTasks.md#nunit-task) | Run NUnit (v2) on a test assembly.
 [NUnit3](Documentation/SIL.BuildTasks.md#nunit3-task) | Run NUnit3 on a test assembly.
 [Split](Documentation/SIL.BuildTasks.md#split-task) |

SIL.BuildTasks.Tests/MockBuildEngine.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Collections;
+using Microsoft.Build.Framework;
+
+namespace SIL.BuildTasks.Tests
+{
+	class MockBuildEngine : IBuildEngine
+	{
+		public void LogErrorEvent(BuildErrorEventArgs e)
+		{
+		}
+
+		public void LogWarningEvent(BuildWarningEventArgs e)
+		{
+		}
+
+		public void LogMessageEvent(BuildMessageEventArgs e)
+		{
+		}
+
+		public void LogCustomEvent(CustomBuildEventArgs e)
+		{
+		}
+
+		public bool BuildProjectFile(string projectFileName, string[] targetNames, IDictionary globalProperties,
+			IDictionary targetOutputs)
+		{
+			throw new NotImplementedException();
+		}
+
+		public bool ContinueOnError => false;
+		public int LineNumberOfTaskNode => 0;
+		public int ColumnNumberOfTaskNode => 0;
+		public string ProjectFileOfTaskNode => throw new NotImplementedException();
+	}
+}

SIL.BuildTasks.Tests/NormalizeLocalesTests.cs

@@ -0,0 +1,131 @@
+// Copyright (c) 2020 SIL International
+// This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
+
+using System.Diagnostics;
+using System.IO;
+using System.Threading;
+using NUnit.Framework;
+
+namespace SIL.BuildTasks.Tests
+{
+	[TestFixture]
+	public class NormalizeLocalesTests
+	{
+		private NormalizeLocales _task;
+		private string _testDir;
+
+		[SetUp]
+		public void TestSetup()
+		{
+			_testDir = Path.Combine(Path.GetTempPath(), GetType().Name);
+			_task = new NormalizeLocales { BuildEngine = new MockBuildEngine(), L10nsDirectory = _testDir };
+
+			RecreateDirectory(_testDir);
+		}
+
+		[TearDown]
+		public void TestTeardown()
+		{
+			try
+			{
+				Directory.Delete(_testDir, true);
+			}
+			catch
+			{
+				Debug.WriteLine("Test could not clean up data directories.");
+			}
+		}
+
+		[Test]
+		public void DoesntCrashWhenNoNameChange()
+		{
+			FileSystemSetup(new[] { "de", "en-US" });
+
+			_task.Execute();
+
+			// Verify that the already-normalized locale is still normalized
+			VerifyLocale("de", "never-existed");
+			// Verify that the locale with a region has been normalized
+			VerifyLocale("en", "en-US");
+		}
+
+		[Test]
+		public void Works()
+		{
+			FileSystemSetup(new[] { "de-DE", "en-US", "zh-CN" });
+
+			_task.Execute();
+
+			// Verify that normal languages have no country codes
+			VerifyLocale("de", "de-DE");
+			VerifyLocale("en", "en-US");
+
+			// Verify that Chinese has the country code and that there is no regionless Chinese.
+			VerifyLocale("zh-CN", "zh");
+		}
+
+		private void FileSystemSetup(string[] locales)
+		{
+			foreach (var locale in locales)
+			{
+				var localeDir = Path.Combine(_testDir, locale);
+				Directory.CreateDirectory(localeDir);
+				File.WriteAllText(Path.Combine(localeDir, $"strings-{locale}.xml"), "some strings");
+				File.WriteAllText(Path.Combine(localeDir, $"Palaso.{locale}.xlf"), "pretend this is xliff");
+				var projectDir = Path.Combine(localeDir, "someProject");
+				Directory.CreateDirectory(projectDir);
+				File.WriteAllText(Path.Combine(projectDir, $"SomeFile.{locale}.resx"), "contents");
+			}
+		}
+
+		private void VerifyLocale(string expected, string not)
+		{
+			var localeDir = Path.Combine(_testDir, expected);
+			AssertDirExists(localeDir);
+			AssertDirDoesNotExist(Path.Combine(_testDir, not));
+
+			AssertFileExists(Path.Combine(localeDir, $"strings-{expected}.xml"));
+			AssertFileDoesNotExist(Path.Combine(localeDir, $"strings-{not}.xml"));
+			AssertFileExists(Path.Combine(localeDir, $"Palaso.{expected}.xlf"));
+			AssertFileDoesNotExist(Path.Combine(localeDir, $"Palaso.{not}.xlf"));
+			AssertFileExists(Path.Combine(localeDir, "someProject", $"SomeFile.{expected}.resx"));
+			AssertFileDoesNotExist(Path.Combine(localeDir, "someProject", $"SomeFile.{not}.resx"));
+		}
+
+		private static void AssertDirExists(string path)
+		{
+			Assert.That(Directory.Exists(path), $"Expected the directory {path} to exist, but it did not.");
+		}
+
+		private static void AssertDirDoesNotExist(string path)
+		{
+			Assert.That(!Directory.Exists(path), $"Expected the directory {path} not to exist, but it did.");
+		}
+
+		private static void AssertFileExists(string path)
+		{
+			Assert.That(File.Exists(path), $"Expected the file {path} to exist, but it did not.");
+		}
+
+		private static void AssertFileDoesNotExist(string path)
+		{
+			Assert.That(!File.Exists(path), $"Expected the file {path} not to exist, but it did.");
+		}
+		public static void RecreateDirectory(string path)
+		{
+			if (Directory.Exists(path))
+			{
+				try
+				{
+					Directory.Delete(path, true);
+					Thread.Sleep(1000); // wait for the filesystem to finish deleting
+				}
+				catch
+				{
+                    Assert.Fail("Couldn't delete old test data from aborted runs");
+				}
+			}
+			Directory.CreateDirectory(path);
+		}
+	}
+}

SIL.BuildTasks/NormalizeLocales.cs

@@ -0,0 +1,68 @@
+// Copyright (c) 2020 SIL International
+// This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
+
+using System.IO;
+using System.Linq;
+using Microsoft.Build.Framework;
+using Microsoft.Build.Utilities;
+
+namespace SIL.BuildTasks
+{
+	/// <summary>
+	/// Crowdin includes country codes either always or never. Country codes are required for Chinese, but mostly get in the way for other languages.
+	/// This task removes country codes from all locales except Chinese. It expects to work with paths in the form of /%locale%/filename.%locale.extension
+	/// </summary>
+	public class NormalizeLocales : Task
+	{
+		/// <summary>The directory whose subdirectories are locale names and contain localizations</summary>
+		[Required]
+		public string L10nsDirectory { get; set; }
+
+		public override bool Execute()
+		{
+			var locales = Directory.GetDirectories(L10nsDirectory).Select(Path.GetFileName);
+			foreach (var locale in locales)
+			{
+				RenameLocale(locale, Normalize(locale));
+			}
+			return true;
+		}
+
+		/// <summary>
+		/// Normalizes a locale in the form %language_code%-%region_code%, assuming the language is in the default region.
+		/// That is, strip the region codes from all languages except Chinese (which must always have a region code).
+		/// </summary>
+		public static string Normalize(string locale)
+		{
+			return locale.Equals("zh-CN") ? locale : locale.Split('-')[0];
+		}
+
+		private void RenameLocale(string source, string dest)
+		{
+			if (source == dest)
+			{
+				Log.LogMessage($"Not normalizing '{source}'.");
+				return;
+			}
+
+			var sourceDir = Path.Combine(L10nsDirectory, source);
+			var destDir = Path.Combine(L10nsDirectory, dest);
+			Directory.Move(sourceDir, destDir);
+
+			foreach (var file in Directory.EnumerateFiles(destDir, "*", SearchOption.AllDirectories))
+			{
+				var nameNoExt = Path.GetFileNameWithoutExtension(file);
+				// ReSharper disable once PossibleNullReferenceException - no files are null
+				if (nameNoExt.EndsWith(source))
+				{
+					var lengthToKeep = nameNoExt.Length - source.Length;
+					var dir = Path.GetDirectoryName(file);
+					var ext = Path.GetExtension(file);
+					// ReSharper disable once AssignNullToNotNullAttribute - no files are null
+					var newName = Path.Combine(dir, $"{nameNoExt.Substring(0, lengthToKeep)}{dest}{ext}");
+					File.Move(file, newName);
+				}
+			}
+		}
+	}
+}