Merge pull request #1450 from sillsdev/improve-test-reliability

Made a few changes to improve reliability of unit tests

Author: tombogle

AddSortKey/AddSortKey.csproj

@@ -21,6 +21,7 @@
 
   <ItemGroup>
     <PackageReference Include="GitVersion.MsBuild" Version="5.11.1" PrivateAssets="all" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>

CHANGELOG.md

@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+- [SIL.TestUtilities] Added a Create method to TemporaryFolder that takes a TestContext
+
 ## [16.1.0] - 2025-07-18
 
 ### Added

ExtractCopyright.Tests/ExtractCopyright.Tests.csproj

@@ -12,6 +12,7 @@
     <PackageReference Include="GitVersion.MsBuild" Version="5.11.1" PrivateAssets="all" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.3.2" PrivateAssets="All" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>

ExtractCopyright/CopyrightFile.cs

@@ -1,9 +1,13 @@
 // Copyright (c) 2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
+
 using System;
-using System.IO;
 using System.Collections.Generic;
+using System.IO;
 using System.Text;
+using System.Text.RegularExpressions;
+using SIL.Acknowledgements;
+using static System.String;
 
 namespace SIL.ExtractCopyright
 {
@@ -18,22 +22,20 @@ public enum ExitValue {
 			NoDebianFolder,
 			NoAssemblyFolder,
 			NoPrefixFolder
-		};
+		}
 
 		public CopyrightFile()
 		{
 		}
 
-		public CopyrightFile(string filename)
-			: base(filename)
+		public CopyrightFile(string filename) : base(filename)
 		{
 		}
 
 		/// <summary>
 		/// Create or update the copyright file in the given debian folder.
 		/// </summary>
 		/// <param name="debianFolder">Debian folder.</param>
-		/// <param name="assemblyFolder">Assembly folder.</param>
 		/// <param name="prefixFolder">Prefix folder.</param>
 		public static int CreateOrUpdateCopyrightFile(string debianFolder, string prefixFolder)
 		{
@@ -47,17 +49,17 @@ public static int CreateOrUpdateCopyrightFile(string debianFolder, string prefix
 				var controlFile = new DebianControl(Path.Combine(debianFolder, "control"));
 				ParseControlContentForValues(controlFile, ref programName, ref contactEmail, ref sourceUrl);
 				// If necessary, try to read some primary information from the changelog file.
-				if (String.IsNullOrEmpty(programName) || String.IsNullOrEmpty(contactEmail))
+				if (IsNullOrEmpty(programName) || IsNullOrEmpty(contactEmail))
 				{
 					var lines = File.ReadAllLines(Path.Combine(debianFolder, "changelog"), Encoding.UTF8);
 					ParseChangelogContentForValues(lines, ref programName, ref contactEmail);
 				}
 				// If we can't derive any information, flag it as unknown.
-				if (String.IsNullOrEmpty(programName))
+				if (IsNullOrEmpty(programName))
 					programName = "UNKNOWN";
-				if (String.IsNullOrEmpty(contactEmail))
+				if (IsNullOrEmpty(contactEmail))
 					contactEmail = "UNKNOWN";
-				if (String.IsNullOrEmpty(sourceUrl))
+				if (IsNullOrEmpty(sourceUrl))
 					sourceUrl = "UNKNOWN";
 				copyrights = CreateNewCopyrightFile(programName, contactEmail, sourceUrl);
 				copyrights._filepath = Path.Combine(debianFolder, "copyright");
@@ -70,7 +72,7 @@ public static int CreateOrUpdateCopyrightFile(string debianFolder, string prefix
 				Console.WriteLine("ExtractCopyright: updating existing file at \"{0}\"", copyrights._filepath);
 			}
 
-			var ackDict = SIL.Acknowledgements.AcknowledgementsProvider.CollectAcknowledgements();
+			var ackDict = AcknowledgementsProvider.CollectAcknowledgements();
 			foreach (var key in ackDict.Keys)
 				copyrights.AddOrUpdateParagraphFromAcknowledgement(ackDict[key], prefixFolder);
 
@@ -101,11 +103,9 @@ internal static void ParseControlContentForValues(DebianControl controlFile, ref
 				// 1) Vcs-Browser (url to see source code repository in the browser), or if that isn't provided
 				// 2) HomePage (url to see some sort of project home page in the browser), or if that isn't provided
 				// 3) Vcs-Git (url to clone git repository on local machine)
-				var urlField = sourcePara.FindField("Vcs-Browser");
-				if (urlField == null)
-					urlField = sourcePara.FindField("HomePage");
-				if (urlField == null)
-					urlField = sourcePara.FindField("Vcs-Git");
+				var urlField = sourcePara.FindField("Vcs-Browser") ??
+					sourcePara.FindField("HomePage") ??
+					sourcePara.FindField("Vcs-Git");
 				if (urlField != null)
 					sourceUrl = urlField.Value;
 			}
@@ -118,22 +118,22 @@ internal static void ParseChangelogContentForValues(string[] lines, ref string p
 			{
 				// The first line of an entry in the changelog looks like this:
 				// "bloom-desktop-alpha (3.9.0) stable; urgency=medium"
-				if (String.IsNullOrEmpty(programName) && lines[i].Contains(" urgency=") && lines[i].Contains(";"))
+				if (IsNullOrEmpty(programName) && lines[i].Contains(" urgency=") && lines[i].Contains(";"))
 				{
-					var headerPieces = lines[i].Trim().Split(new char[]{' '});
+					var headerPieces = lines[i].Trim().Split(' ');
 					programName = headerPieces[i];
 				}
 				// The closing line of an entry in the changelog looks like this:
 				// " -- Stephen McConnel <stephen_mcconnel@sil.org>  Wed, 18 Jan 2017 11:38:31 -0600"
 				// the two spaces following the <email@address> are significant
-				else if (String.IsNullOrEmpty(contactEmail) && lines[i].StartsWith(" -- ") && lines[i].Contains("@"))
+				else if (IsNullOrEmpty(contactEmail) && lines[i].StartsWith(" -- ") && lines[i].Contains("@"))
 				{
 					var line = lines[i].Substring(4).Trim();
-					var idx = line.IndexOf("  ");
+					var idx = line.IndexOf("  ", StringComparison.Ordinal);
 					if (idx > 0)
 						contactEmail = line.Substring(0, idx);
 				}
-				if (!String.IsNullOrEmpty(programName) && !String.IsNullOrEmpty(contactEmail))
+				if (!IsNullOrEmpty(programName) && !IsNullOrEmpty(contactEmail))
 					return;
 			}
 		}
@@ -156,7 +156,7 @@ public static CopyrightFile CreateNewCopyrightFile(string programName, string co
 			para.Fields.Add(new DebianField("Source", sourceUrl));
 
 			// REVIEW: can we assume these values?
-			var programCopyright = String.Format("{0} SIL Global", DateTime.Now.Year);
+			var programCopyright = Format("{0} SIL Global", DateTime.Now.Year);
 			var programLicense = "MIT";
 
 			para = new DebianParagraph();
@@ -170,10 +170,10 @@ public static CopyrightFile CreateNewCopyrightFile(string programName, string co
 			return copyrights;
 		}
 
-		internal void AddOrUpdateParagraphFromAcknowledgement(Acknowledgements.AcknowledgementAttribute ack, string prefix)
+		internal void AddOrUpdateParagraphFromAcknowledgement(AcknowledgementAttribute ack, string prefix)
 		{
-			string fileSpec = null;
-			if (!string.IsNullOrEmpty(ack.Location))
+			string fileSpec;
+			if (!IsNullOrEmpty(ack.Location))
 			{
 				fileSpec = ack.Location;
 				if (!fileSpec.StartsWith("/"))
@@ -183,7 +183,7 @@ internal void AddOrUpdateParagraphFromAcknowledgement(Acknowledgements.Acknowled
 			{
 				fileSpec = ack.Key;
 			}
-			if (!String.IsNullOrEmpty(prefix))
+			if (!IsNullOrEmpty(prefix))
 				fileSpec = Path.Combine(prefix, fileSpec);
 
 			if (IsWindowsSpecific(Path.GetFileName(fileSpec)))
@@ -207,18 +207,14 @@ internal void AddOrUpdateParagraphFromAcknowledgement(Acknowledgements.Acknowled
 			Paragraphs.Add(para);
 			para.Fields.Add(new DebianField("Files", fileSpec));
 
-			string person;
-			string year;
-			ExtractCopyrightInformation(ack.Copyright, out person, out year);
+			ExtractCopyrightInformation(ack.Copyright, out var person, out var year);
 			var copyright = year + " " + person;
 			para.Fields.Add(new DebianField("Copyright", copyright));
 
-			string shortLicense;
-			List<string> longLicense;
-			ExtractLicenseInformation(ack.LicenseUrl, out shortLicense, out longLicense);
+			ExtractLicenseInformation(ack.LicenseUrl, out var shortLicense, out var longLicense);
 			para.Fields.Add(new DebianField("License", shortLicense));
 
-			if (!string.IsNullOrEmpty(ack.Url))
+			if (!IsNullOrEmpty(ack.Url))
 				para.Fields.Add(new DebianField("Comment", "URL = " + ack.Url));
 
 			if (shortLicense != "????" && longLicense.Count > 0)
@@ -227,7 +223,7 @@ internal void AddOrUpdateParagraphFromAcknowledgement(Acknowledgements.Acknowled
 			}
 		}
 
-		private bool IsWindowsSpecific(string name)
+		private static bool IsWindowsSpecific(string name)
 		{
 			switch (name)
 			{
@@ -261,19 +257,15 @@ internal void AddLicenseParagraphIfNeeded(string license, IEnumerable<string> de
 		}
 
 		private void UpdateParagraphFromAcknowledgement(DebianParagraph para,
-			Acknowledgements.AcknowledgementAttribute ack)
+			AcknowledgementAttribute ack)
 		{
-			string person;
-			string year;
-			ExtractCopyrightInformation(ack.Copyright, out person, out year);
+			ExtractCopyrightInformation(ack.Copyright, out var person, out var year);
 			if (year == "????")
 				return;			// we don't know if this information is newer or not
 			var copyrightField = para.FindField("Copyright");
 			if (copyrightField != null)
 			{
-				string prevYear;
-				string prevPerson;
-				ExtractCopyrightInformation(copyrightField.Value, out prevYear, out prevPerson);
+				ExtractCopyrightInformation(copyrightField.Value, out var prevYear, out _);
 				if (prevYear == "????" || prevYear.CompareTo(year) < 0)
 				{
 					copyrightField.Value = year + " " + person;
@@ -284,9 +276,7 @@ private void UpdateParagraphFromAcknowledgement(DebianParagraph para,
 				}
 			}
 
-			string shortLicense;
-			List<string> longLicense;
-			ExtractLicenseInformation(ack.LicenseUrl, out shortLicense, out longLicense);
+			ExtractLicenseInformation(ack.LicenseUrl, out var shortLicense, out var longLicense);
 			if (shortLicense != "????")
 			{
 				var licenseField = para.FindField("License");
@@ -296,7 +286,7 @@ private void UpdateParagraphFromAcknowledgement(DebianParagraph para,
 					AddLicenseParagraphIfNeeded(shortLicense, longLicense);
 			}
 
-			if (!string.IsNullOrEmpty(ack.Url))
+			if (!IsNullOrEmpty(ack.Url))
 			{
 				var commentField = para.FindField("Comment");
 				if (commentField == null)
@@ -318,7 +308,7 @@ private void ExtractCopyrightInformation(string original, out string person, out
 			copyright = copyright.Replace("(c)", "");
 			copyright = copyright.Replace("©", "");
 			// extract year and person if present
-			var match = System.Text.RegularExpressions.Regex.Match(copyright, "([0-9][0-9][0-9][0-9][-0-9]*)");
+			var match = Regex.Match(copyright, "([0-9][0-9][0-9][0-9][-0-9]*)");
 			if (match.Success)
 			{
 				year = copyright.Substring(match.Index, match.Length);
@@ -329,15 +319,15 @@ private void ExtractCopyrightInformation(string original, out string person, out
 				person = copyright;
 			}
 			person = person.Trim();
-			if (string.IsNullOrEmpty(person))
+			if (IsNullOrEmpty(person))
 				person = "????";
 		}
 
 		private void ExtractLicenseInformation(string original, out string shortLicense, out List<string> longLicense)
 		{
 			shortLicense = "????";
 			longLicense = new List<string>();
-			if (!string.IsNullOrEmpty(original))
+			if (!IsNullOrEmpty(original))
 			{
 				shortLicense = original;
 				var idx = shortLicense.LastIndexOf('/');
@@ -362,7 +352,7 @@ private void ExtractLicenseInformation(string original, out string shortLicense,
 		/// <summary>
 		/// The standard MIT license used for SIL software.
 		/// </summary>
-		public static string[] StandardMITLicense = new string[] {
+		public static string[] StandardMITLicense = {
 			"Permission is hereby granted, free of charge, to any person obtaining a",
 			"copy of this software and associated documentation files (the \"Software\"),",
 			"to deal in the Software without restriction, including without limitation",

ExtractCopyright/ExtractCopyright.csproj

@@ -13,6 +13,7 @@
 
   <ItemGroup>
     <PackageReference Include="GitVersion.MsBuild" Version="5.11.1" PrivateAssets="all" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>

SIL.Archiving.Tests/SIL.Archiving.Tests.csproj

@@ -18,6 +18,7 @@
     <PackageReference Include="NUnit3TestAdapter" Version="4.3.2" PrivateAssets="All" />
     <PackageReference Include="System.IO.Compression" Version="4.3.0" />
     <PackageReference Include="System.IO.Compression.ZipFile" Version="4.3.0" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>

SIL.Archiving/SIL.Archiving.csproj

@@ -28,8 +28,8 @@
     <PackageReference Include="SIL.ReleaseTasks" Version="3.1.1" PrivateAssets="All" />
     <PackageReference Include="System.IO.Compression" Version="4.3.0" />
     <PackageReference Include="System.IO.Compression.ZipFile" Version="4.3.0" />
-    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
     <PackageReference Include="System.Memory" Version="4.5.5" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\SIL.Core.Desktop\SIL.Core.Desktop.csproj" />

SIL.Core.Desktop.Tests/SIL.Core.Desktop.Tests.csproj

@@ -15,6 +15,7 @@
     <PackageReference Include="NDesk.DBus" Version="0.15.0" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.3.2" PrivateAssets="All" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>

SIL.Core.Desktop/SIL.Core.Desktop.csproj

@@ -20,6 +20,7 @@
     <PackageReference Include="System.Configuration.ConfigurationManager" Version="6.0.0" />
     <PackageReference Include="System.Drawing.Common" Version="6.0.0" />
     <PackageReference Include="System.IO.FileSystem.AccessControl" Version="5.0.0" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\SIL.Core\SIL.Core.csproj" />

SIL.Core.Tests/SIL.Core.Tests.csproj

@@ -16,6 +16,7 @@
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.3.2" PrivateAssets="All" />
     <PackageReference Include="SIL.ReleaseTasks" Version="3.1.1" PrivateAssets="All" />
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.2" />
   </ItemGroup>
 
   <ItemGroup>