[Xamarin.Android.Build.Tasks] Fix up lint output resource paths.

Fixes #3360 The lint tool is run against our `$(IntermediateOutputPath)` directory, as a result we end up with paths which point to that directory. We should be fixing those paths up to point to the normal `Resources` directory in the project, just like we do with `aapt/aapt2`.
xamarin · Aug 22, 2019 · 69f413c · 69f413c
1 parent d762aa9
commit 69f413c
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 14 deletions.
diff --git a/src/Xamarin.Android.Build.Tasks/Tasks/Aapt.cs b/src/Xamarin.Android.Build.Tasks/Tasks/Aapt.cs
@@ -418,10 +418,9 @@ protected void LogEventsFromTextOutput (string singleLine, MessageImportance mes
 
 				// Try to map back to the original resource file, so when the user
 				// double clicks the error, it won't take them to the obj/Debug copy
-				if (file.StartsWith (resourceDirectory, StringComparison.InvariantCultureIgnoreCase)) {
-					file = file.Substring (resourceDirectory.Length).TrimStart (Path.DirectorySeparatorChar);
-					file = resource_name_case_map.ContainsKey (file) ? resource_name_case_map [file] : file;
-					file = Path.Combine ("Resources", file);
+				string newfile = MonoAndroidHelper.FixUpAndroidResourcePath (file, resourceDirectory, string.Empty, resource_name_case_map);
+				if (!string.IsNullOrEmpty (newfile)) {
+					file = newfile;
 				}
 
 				// Strip any "Error:" text from aapt's output

diff --git a/src/Xamarin.Android.Build.Tasks/Tasks/Aapt2.cs b/src/Xamarin.Android.Build.Tasks/Tasks/Aapt2.cs
@@ -164,16 +164,9 @@ protected bool LogAapt2EventsFromOutput (string singleLine, MessageImportance me
 					foreach (var dir in ResourceDirectories) {
 						var resourceDirectory = dir.ItemSpec;
 						var resourceDirectoryFullPath = ResourceDirectoryFullPath (resourceDirectory);
-						string newfile = null;
-						if (file.StartsWith (resourceDirectory, StringComparison.InvariantCultureIgnoreCase)) {
-							newfile = file.Substring (resourceDirectory.Length).TrimStart (Path.DirectorySeparatorChar);
-						}
-						if (file.StartsWith (resourceDirectoryFullPath, StringComparison.InvariantCultureIgnoreCase)) {
-							newfile = file.Substring (resourceDirectoryFullPath.Length).TrimStart (Path.DirectorySeparatorChar);
-						}
+
+						string newfile = MonoAndroidHelper.FixUpAndroidResourcePath (file, resourceDirectory, resourceDirectoryFullPath, resource_name_case_map);
 						if (!string.IsNullOrEmpty (newfile)) {
-							newfile = resource_name_case_map.ContainsKey (newfile) ? resource_name_case_map [newfile] : newfile;
-							newfile = Path.Combine ("Resources", newfile);
 							file = newfile;
 							break;
 						}

diff --git a/src/Xamarin.Android.Build.Tasks/Tasks/Lint.cs b/src/Xamarin.Android.Build.Tasks/Tasks/Lint.cs
@@ -38,6 +38,7 @@ public class Lint : ToolTask
 		const string NoFileWarningOrErrorRegExString = @"(?<type>Warning|Error):(?<text>.+)";
 		Regex codeErrorRegEx = new Regex (CodeErrorRegExString, RegexOptions.Compiled);
 		Regex noFileWarningOrErrorRegEx = new Regex(NoFileWarningOrErrorRegExString, RegexOptions.Compiled);
+		protected Dictionary<string, string> resource_name_case_map;
 		bool matched = false;
 		string file;
 		int line;
@@ -147,6 +148,8 @@ public class Lint : ToolTask
 			get { return OS.IsWindows ? "lint.bat" : "lint"; }
 		}
 
+		public string ResourceNameCaseMap { get; set; }
+
 		public Lint ()
 		{
 			ResourceDirectories = new ITaskItem[0];
@@ -208,6 +211,8 @@ public override bool Execute ()
 
 			EnvironmentVariables = new [] { "JAVA_HOME=" + JavaSdkPath };
 
+			resource_name_case_map = MonoAndroidHelper.LoadResourceCaseMap (ResourceNameCaseMap);
+
 			base.Execute ();
 
 			return !Log.HasLoggedErrors;
@@ -279,8 +284,21 @@ protected override void LogEventsFromTextOutput (string singleLine, MessageImpor
 				}
 				matched = true;
 				file = match.Groups ["file"].Value;
-				if (!string.IsNullOrEmpty (file))
+				if (!string.IsNullOrEmpty (file)) {
 					file = Path.Combine (TargetDirectory, file);
+					// Try to map back to the original resource file, so when the user
+					// double clicks the error, it won't take them to the obj/Debug copy
+					if (ResourceDirectories != null) {
+						foreach (var dir in ResourceDirectories) {
+							var resourceDirectory = Path.Combine (TargetDirectory, dir.ItemSpec);
+							string newfile = MonoAndroidHelper.FixUpAndroidResourcePath (file, resourceDirectory, string.Empty, resource_name_case_map);
+							if (!string.IsNullOrEmpty (newfile)) {
+								file = newfile;
+								break;
+							}
+						}
+					}
+				}
 				line = 0;
 				int.TryParse (match.Groups ["line"].Value, out line);
 				text = match.Groups ["text"].Value.Trim ();

diff --git a/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/BuildTest.cs b/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/BuildTest.cs
@@ -1560,6 +1560,48 @@ void FixLintOnWindows ()
 			}
 		}
 
+		[Test]
+		public void CheckLintResourceFileReferencesAreFixed ()
+		{
+			FixLintOnWindows ();
+
+			var proj = new XamarinAndroidApplicationProject () {
+				PackageReferences = {
+					KnownPackages.AndroidSupportV4_27_0_2_1,
+					KnownPackages.SupportConstraintLayout_1_0_2_2,
+				},
+			};
+			proj.SetProperty ("AndroidLintEnabled", true.ToString ());
+			proj.AndroidResources.Add (new AndroidItem.AndroidResource ("Resources\\layout\\test.axml") {
+				TextContent = () => {
+					return @"<?xml version=""1.0"" encoding=""utf-8""?>
+<ConstraintLayout xmlns:android=""http://schemas.android.com/apk/res/android""
+	xmlns:app=""http://schemas.android.com/apk/res-auto""
+	android:orientation=""vertical""
+	android:layout_width=""fill_parent""
+	android:layout_height=""fill_parent"">
+	<TextView android:id=""@+id/foo""
+		android:layout_width=""150dp""
+		android:layout_height=""wrap_content""
+		app:layout_constraintTop_toTopOf=""parent""
+	/>
+	<EditText
+		android:id=""@+id/phone""
+		android:layout_width=""fill_parent""
+		android:layout_height=""wrap_content""
+		android:hint=""Hint me up.""
+	/>
+ </ConstraintLayout>";
+				}
+			});
+			using (var b = CreateApkBuilder (Path.Combine ("temp", TestName))) {
+				Assert.IsTrue (b.Build (proj), "Project should have built.");
+				StringAssertEx.Contains ("XA0102", b.LastBuildOutput, "Output should contain XA0102 warnings");
+				var errorFilePath = Path.Combine (proj.IntermediateOutputPath, "android", proj.IntermediateOutputPath, "res", "layout", "test.xml");
+				StringAssertEx.DoesNotContain (errorFilePath, b.LastBuildOutput, $"Path {errorFilePath} should have been replaced.");
+			}
+		}
+
 		[Test]
 		public void CheckLintErrorsAndWarnings ()
 		{

diff --git a/src/Xamarin.Android.Build.Tasks/Utilities/MonoAndroidHelper.cs b/src/Xamarin.Android.Build.Tasks/Utilities/MonoAndroidHelper.cs
@@ -613,5 +613,22 @@ public static string TryGetAndroidJarPath (TaskLoggingHelper log, string platfor
 			}
 			return result;
 		}
+
+		public static string FixUpAndroidResourcePath (string file, string resourceDirectory, string resourceDirectoryFullPath, Dictionary<string, string> resource_name_case_map)
+		{
+			string newfile = null;
+			if (file.StartsWith (resourceDirectory, StringComparison.InvariantCultureIgnoreCase)) {
+				newfile = file.Substring (resourceDirectory.Length).TrimStart (Path.DirectorySeparatorChar);
+			}
+			if (!string.IsNullOrEmpty (resourceDirectoryFullPath) && file.StartsWith (resourceDirectoryFullPath, StringComparison.InvariantCultureIgnoreCase)) {
+				newfile = file.Substring (resourceDirectoryFullPath.Length).TrimStart (Path.DirectorySeparatorChar);
+			}
+			if (!string.IsNullOrEmpty (newfile)) {
+				newfile = resource_name_case_map.ContainsKey (newfile) ? resource_name_case_map [newfile] : newfile;
+				newfile = Path.Combine ("Resources", newfile);
+				return newfile;
+			}
+			return string.Empty;
+		}
 	}
 }
diff --git a/src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets b/src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets
@@ -1126,6 +1126,7 @@ because xbuild doesn't support framework reference assemblies.
 		ToolPath="$(LintToolPath)"
 		ToolExe="$(LintToolExe)"
 		JavaSdkPath="$(_JavaSdkDirectory)"
+		ResourceNameCaseMap="$(_AndroidResourceNameCaseMap)"
 	/>
 </Target>