[build] Enable globalization analyzer errors and fix issues (#6368)

Context: #6271
Context: dotnet/java-interop@7068f4b

Making culture-aware string comparisons when not intended can result
in very hard to diagnose bugs (See/#6271).

As we did in dotnet/java-interop@7068f4b2, update the appropriate
Roslyn code analyzers so that errors are generated around "unsafe"
string usage, and to ensure that we don't introduce any new issues
around string & globalization support in the future.

One complication with enabling these rules is that the .NET 6+ version
of these rules are stricter and require overloads that do not exist in
.NET Framework or .NET Standard to fix the violations.  Enabling these
rules in `.editorconfig` affects all `$(TargetFrameworkMoniker)`s;
we will instead use `Configuration.props` to only enable them for
non-.NET 6+ builds.

Additionally, tweak and reuses the existing Roslyn Analyzers logic to
exclude external code, as many libraries that are used for testing
(like `Mono.Debugg[ing|er].Soft)` have issues surfaced by these
analyzers.

Note that some non-test comparisons on filenames/paths were switched
from case-sensitive to case-insensitive compares.

Author: jpobst

Configuration.props

@@ -226,6 +226,20 @@
 
   <!-- Fix for IDEs -->
   <Target Name="CreateManifestResourceNames" />
+   
+  <!-- Don't analyze code from external repos -->
+  <PropertyGroup Condition=" !$(MSBuildProjectDirectory.Contains ('external')) and !$(MSBuildProjectDirectory.Contains ('NUnitLite')) ">
+    <XAShouldAnalyzeAssembly>True</XAShouldAnalyzeAssembly>
+  </PropertyGroup>
+   
+  <!-- The net6.0 versions of these analyzers are stricter and require overloads not available in .NET Framework, so start with just .NET Framework -->
+  <PropertyGroup Condition=" '$(TargetFramework)' != '' And (!$(TargetFramework.StartsWith('nets')) And !$(TargetFramework.StartsWith('net4')) And !$(TargetFramework.StartsWith('monoandroid'))) ">
+    <XABuildingForNetCoreApp>True</XABuildingForNetCoreApp>
+  </PropertyGroup>
+
+  <PropertyGroup Condition=" '$(XABuildingForNetCoreApp)' != 'True' And '$(XAShouldAnalyzeAssembly)' == 'True' ">
+    <WarningsAsErrors>$(WarningsAsErrors);CA1309;CA1310</WarningsAsErrors>
+  </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)build-tools\scripts\Ndk.targets" />
   <Import Project="$(MSBuildThisFileDirectory)build-tools\scripts\RoslynAnalyzers.projitems" Condition=" '$(EnableRoslynAnalyzers)' == 'true' " />

build-tools/Xamarin.Android.Tools.BootstrapTasks/Xamarin.Android.Tools.BootstrapTasks/CheckApiCompatibility.cs

@@ -78,7 +78,7 @@ public override bool Execute ()
 			}
 
 			TargetImplementationPath = implementationPath.FullName;
-			if (TargetImplementationPath.EndsWith ("\\") || TargetImplementationPath.EndsWith ("/")) {
+			if (TargetImplementationPath.EndsWith ("\\", StringComparison.Ordinal) || TargetImplementationPath.EndsWith ("/", StringComparison.Ordinal)) {
 				TargetImplementationPath = TargetImplementationPath.Substring (0, TargetImplementationPath.Length - 1);
 			}
 
@@ -189,7 +189,7 @@ void dataReceived (object sender, DataReceivedEventArgs args)
 						if (!string.IsNullOrWhiteSpace (args.Data)) {
 							lines.Add (args.Data.Trim ());
 
-							if (args.Data.IndexOf ("Native Crash Reporting") != -1) {
+							if (args.Data.IndexOf ("Native Crash Reporting", StringComparison.Ordinal) != -1) {
 								processHasCrashed = true;
 							}
 						}
@@ -245,13 +245,13 @@ void dataReceived (object sender, DataReceivedEventArgs args)
 						Log.LogMessage (MessageImportance.High, $"{Environment.NewLine}*** CodeGen missing items***{Environment.NewLine}");
 						var indent = 0;
 						foreach (var item in missingItems) {
-							if (item.StartsWith ("}")) {
+							if (item.StartsWith ("}", StringComparison.Ordinal)) {
 								indent--;
 							}
 
-							Log.LogMessage (MessageImportance.High, $"{(item.StartsWith ("namespace ") ? Environment.NewLine : string.Empty)}{new string (' ', indent * 2)}{item}");
+							Log.LogMessage (MessageImportance.High, $"{(item.StartsWith ("namespace ", StringComparison.Ordinal) ? Environment.NewLine : string.Empty)}{new string (' ', indent * 2)}{item}");
 
-							if (item.StartsWith ("{")) {
+							if (item.StartsWith ("{", StringComparison.Ordinal)) {
 								indent++;
 							}
 						}

build-tools/Xamarin.Android.Tools.BootstrapTasks/Xamarin.Android.Tools.BootstrapTasks/CodeGenDiff.cs

@@ -114,7 +114,7 @@ void dataReceived (object sender, DataReceivedEventArgs args)
 						return;
 					}
 
-					if (content.StartsWith ("namespace ") || content.IndexOf (" interface ") != -1 || content.IndexOf (" class ") != -1 || content.IndexOf (" partial struct ") != -1 || content.IndexOf (" enum ") != -1) {
+					if (content.StartsWith ("namespace ", StringComparison.Ordinal) || content.IndexOf (" interface ", StringComparison.Ordinal) != -1 || content.IndexOf (" class ", StringComparison.Ordinal) != -1 || content.IndexOf (" partial struct ", StringComparison.Ordinal) != -1 || content.IndexOf (" enum ", StringComparison.Ordinal) != -1) {
 						if (string.IsNullOrWhiteSpace (currentObject.Item)) {
 							currentObject.Item = content;
 						} else {

build-tools/Xamarin.Android.Tools.BootstrapTasks/Xamarin.Android.Tools.BootstrapTasks/GenerateWixFile.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.Linq;
 using System.Security.Cryptography;
@@ -121,13 +122,13 @@ static void RecurseDirectory (string top_dir, XmlWriter packWriter, XmlWriter co
 			packWriter.WriteAttributeString ("FileSource", directory);
 			foreach (var child in Directory.EnumerateDirectories (directory)) {
 				var directoryName = Path.GetFileName (child);
-				if (directoryName.StartsWith (".") || directoryName.StartsWith ("_"))
+				if (directoryName.StartsWith (".", StringComparison.Ordinal) || directoryName.StartsWith ("_", StringComparison.Ordinal))
 					continue;
 				RecurseDirectory (top_dir, packWriter, componentWriter, child);
 			}
 			foreach (var file in Directory.EnumerateFiles (directory)) {
 				var fileName = Path.GetFileName (file);
-				if (fileName.StartsWith (".") || fileName.StartsWith ("_"))
+				if (fileName.StartsWith (".", StringComparison.Ordinal) || fileName.StartsWith ("_", StringComparison.Ordinal))
 					continue;
 				AddFile (top_dir, packWriter, componentWriter, file);
 			}

build-tools/Xamarin.Android.Tools.BootstrapTasks/Xamarin.Android.Tools.BootstrapTasks/RenameTestCases.cs

@@ -166,7 +166,7 @@ static void CreateErrorResultsFile (string sourceFile, string destFile, string c
 		static void GetTestCaseInfo (string sourceFile, string destinationFolder, string config, string flavor, Action<string> logDebugMessage, out string testSuiteName, out string testCaseName, out string logcatPath)
 		{
 			var name        = Path.GetFileNameWithoutExtension (sourceFile);
-			if (name.StartsWith ("TestResult-"))
+			if (name.StartsWith ("TestResult-", StringComparison.Ordinal))
 				name    = name.Substring ("TestResult-".Length);
 			testSuiteName   = name;
 			testCaseName    = $"Possible Crash / {config}";

build-tools/api-merge/ApiDescription.cs

@@ -397,7 +397,7 @@ static string GetParameterType (string type, Dictionary<string, string> mappings
 				return "*";
 
 			// varargs should be normalized.
-			if (type.EndsWith ("..."))
+			if (type.EndsWith ("...", StringComparison.Ordinal))
 				return GetParameterType (type.Substring (0, type.Length - 3) + "[]", mappings);
 
 			int first = type.IndexOfAny (type_sep);

build-tools/api-merge/Mono.Options-PCL.cs

@@ -1353,11 +1353,11 @@ private static string GetArgumentName (int index, int maxIndex, string descripti
 			for (int i = 0; i < nameStart.Length; ++i) {
 				int start, j = 0;
 				do {
-					start = description.IndexOf (nameStart [i], j);
+					start = description.IndexOf (nameStart [i], j, StringComparison.Ordinal);
 				} while (start >= 0 && j != 0 ? description [j++ - 1] == '{' : false);
 				if (start == -1)
 					continue;
-				int end = description.IndexOf ("}", start);
+				int end = description.IndexOf ("}", start, StringComparison.Ordinal);
 				if (end == -1)
 					continue;
 				return description.Substring (start + nameStart [i].Length, end - start - nameStart [i].Length);

build-tools/check-boot-times/Program.cs

@@ -177,7 +177,7 @@ bool validation (string data, ManualResetEvent mre)
 
 				var activity = i % 2 == 0 ? "com.google.android.apps.photos/.home.HomeActivity" : "com.android.settings/.wifi.WifiStatusTest";
 				await RunProcess (adbPath, $"-e shell am start -n '{activity}'", 5000, (data, mre) => {
-					if (!string.IsNullOrWhiteSpace (data) && data.IndexOf ("com.android") != -1) {
+					if (!string.IsNullOrWhiteSpace (data) && data.IndexOf ("com.android", StringComparison.Ordinal) != -1) {
 						mre.Set ();
 					}
 					return true;
@@ -375,7 +375,7 @@ static async Task InstallSdk ()
 		{
 			bool validation (string data, ManualResetEvent mre)
 			{
-				if (!string.IsNullOrWhiteSpace (data) && data.IndexOf ("100%") != -1) {
+				if (!string.IsNullOrWhiteSpace (data) && data.IndexOf ("100%", StringComparison.Ordinal) != -1) {
 					mre.Set ();
 				}
 

build-tools/jnienv-gen/Generator.cs

@@ -209,7 +209,7 @@ static void GenerateJniEnv (TextWriter o)
 
 				switch (entry.ApiName) {
 				case "NewArray":
-					var copyArray = JNIEnvEntries.Single (e => e.Name.StartsWith ("Get") && e.Name.EndsWith ("ArrayRegion") &&
+					var copyArray = JNIEnvEntries.Single (e => e.Name.StartsWith ("Get", StringComparison.Ordinal) && e.Name.EndsWith ("ArrayRegion", StringComparison.Ordinal) &&
 							e.Parameters [0].Type.Type == entry.ReturnType.Type);
 					o.Write ("\t\t{2} static {0} {1} (", entry.ReturnType.ManagedType, entry.ApiName, entry.Visibility);
 					o.WriteLine ("{0} array)", copyArray.Parameters [3].Type.ManagedType);
@@ -233,7 +233,7 @@ static void GenerateJniEnv (TextWriter o)
 					break;
 				case "CopyArray":
 					o.Write ("\t\t{2} static unsafe {0} {1} (", entry.ReturnType.ManagedType, entry.ApiName, entry.Visibility);
-					if (entry.Name.StartsWith ("G")) {
+					if (entry.Name.StartsWith ("G", StringComparison.Ordinal)) {
 						o.WriteLine ("IntPtr src, {0} dest)", entry.Parameters [3].Type.ManagedType);
 						o.WriteLine ("\t\t{");
 						o.WriteLine ("\t\t\tif (src == IntPtr.Zero)");
@@ -319,15 +319,15 @@ entry.Parameters [entry.Parameters.Length-1].IsParamArray &&
 			o.Write ("Env.{0} (Handle", entry.Name);
 			for (int i = 0; i < entry.Parameters.Length; i++) {
 				o.Write (", ");
-				if (entry.Parameters [i].Type.ManagedType.StartsWith ("out "))
+				if (entry.Parameters [i].Type.ManagedType.StartsWith ("out ", StringComparison.Ordinal))
 					o.Write ("out ");
 				o.Write (Escape (entry.Parameters [i].Name));
 			}
 			o.WriteLine (");");
 			RaiseException (o, entry);
 			if (is_void) {
 			}
-			else if (entry.ReturnType.ManagedType == "IntPtr" && entry.ReturnType.Type.StartsWith ("j") && !entry.ReturnType.Type.EndsWith ("ID")) {
+			else if (entry.ReturnType.ManagedType == "IntPtr" && entry.ReturnType.Type.StartsWith ("j", StringComparison.Ordinal) && !entry.ReturnType.Type.EndsWith ("ID", StringComparison.Ordinal)) {
 				o.WriteLine ("\t\t\treturn LogCreateLocalRef (tmp);");
 			} else {
 				o.WriteLine ("\t\t\treturn tmp;");
@@ -381,13 +381,13 @@ static bool GenerateDefaultJavaInteropForwarder (TextWriter o, JniFunction entry
 			if (!is_void)
 				o.Write ("return ");
 			var n = entry.Name;
-			if (n.StartsWith ("Call"))
+			if (n.StartsWith ("Call", StringComparison.Ordinal))
 				n = n.TrimEnd (new[]{'A'});
 			o.Write ("JniEnvironment.{0}.{1} (", entry.DeclaringType, n);
 			for (int i = 0; i < entry.Parameters.Length; i++) {
 				if (i > 0)
 					o.Write (", ");
-				if (entry.Parameters [i].Type.ManagedType.StartsWith ("out "))
+				if (entry.Parameters [i].Type.ManagedType.StartsWith ("out ", StringComparison.Ordinal))
 					o.Write ("out ");
 				if (entry.Parameters [i].Type.ManagedType == "JValue*")
 					o.Write ("(JniArgumentValue*) " + Escape (entry.Parameters [i].Name));
@@ -445,7 +445,7 @@ static bool IsObjectReferenceType (TypeInfo type)
 				case "jweak":
 					return true;
 			}
-			if (type.Type.StartsWith ("j") && type.Type.EndsWith("Array"))
+			if (type.Type.StartsWith ("j", StringComparison.Ordinal) && type.Type.EndsWith("Array", StringComparison.Ordinal))
 				return true;
 			return false;
 		}
@@ -643,9 +643,9 @@ public string GetManagedType (string native_type)
 			case "jobjectRefType":
 				return "int";
 			default:
-				if (native_type.EndsWith ("Array"))
+				if (native_type.EndsWith ("Array", StringComparison.Ordinal))
 					return "IntPtr";
-				if (native_type.EndsWith ("*"))
+				if (native_type.EndsWith ("*", StringComparison.Ordinal))
 					return "IntPtr";
 				return native_type;
 			}

build-tools/jnienv-gen/Mono.Options-PCL.cs

@@ -1353,11 +1353,11 @@ private static string GetArgumentName (int index, int maxIndex, string descripti
 			for (int i = 0; i < nameStart.Length; ++i) {
 				int start, j = 0;
 				do {
-					start = description.IndexOf (nameStart [i], j);
+					start = description.IndexOf (nameStart [i], j, StringComparison.Ordinal);
 				} while (start >= 0 && j != 0 ? description [j++ - 1] == '{' : false);
 				if (start == -1)
 					continue;
-				int end = description.IndexOf ("}", start);
+				int end = description.IndexOf ("}", start, StringComparison.Ordinal);
 				if (end == -1)
 					continue;
 				return description.Substring (start + nameStart [i].Length, end - start - nameStart [i].Length);