Skip to content

[Xamarin.Android.Build.Tasks] skip proguard.txt files in class libraries #8025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2023
+22 −4
Merged

[Xamarin.Android.Build.Tasks] skip proguard.txt files in class libraries #8025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b3c512
[Xamarin.Android.Build.Tasks] skip `proguard.txt` files in class libr…
jonathanpeppers May 9, 2023
0fcf0f4
Improve test case
jonathanpeppers May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Xamarin.Android.Build.Tasks/Tasks/ResolveLibraryProjectImports.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ public class ResolveLibraryProjectImports : AndroidTask
[Required]
public bool DesignTimeBuild { get; set; }

public bool AndroidApplication { get; set; }

[Output]
public ITaskItem [] Jars { get; set; }

Expand Down Expand Up @@ -442,7 +444,7 @@ void Extract (
resolvedAssetDirectories.Add (new TaskItem (Path.GetFullPath (assetsDir), new Dictionary<string, string> {
{ OriginalFile, aarFullPath },
}));
if (File.Exists (proguardFile)) {
if (AndroidApplication && File.Exists (proguardFile)) {
proguardConfigFiles.Add (new TaskItem (Path.GetFullPath (proguardFile), new Dictionary<string, string> {
{ OriginalFile, aarFullPath },
}));
Expand Down
13 changes: 13 additions & 0 deletions ...in.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Utilities/AssertionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,19 @@ public static void AssertTargetIsPartiallyBuilt (this BuildOutput output, string
Assert.IsTrue (output.IsTargetPartiallyBuilt (target), $"The target {target} should have been partially built.");
}

[DebuggerHidden]
Copy link
Contributor

@jonpryor jonpryor May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would a unit test method need [DebuggerHidden]?

Copy link
Contributor

@jonpryor jonpryor May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though i see some of the other Assert* methods have [DebuggerHidden]…

Copy link
Member Author

@jonathanpeppers jonathanpeppers May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The on assertion-style methods in this file, it allows the debugger to break on the line in your test instead of inside here.

It's really optional, and maybe only useful inside IDEs?

public static void AssertEntryEquals (this ZipArchive zip, string zipPath, string archivePath, string expected)
{
zip.AssertContainsEntry (zipPath, archivePath);

var entry = zip.ReadEntry (archivePath);
using var stream = new MemoryStream ();
entry.Extract (stream);
stream.Position = 0;
using var reader = new StreamReader (stream);
Assert.AreEqual (expected, reader.ReadToEnd ().Trim ());
}

[DebuggerHidden]
public static void AssertContainsEntry (this ZipArchive zip, string zipPath, string archivePath)
{
Expand Down
8 changes: 5 additions & 3 deletions src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/XASdkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public void DotNetBuildLibrary (bool isRelease, bool duplicateAar, bool useDesig
BinaryContent = () => XamarinAndroidApplicationProject.icon_binary_mdpi,
},
new AndroidItem.ProguardConfiguration ("proguard.txt") {
TextContent = () => @"-ignorewarnings",
TextContent = () => "# LibraryC",
},
}
};
Expand All @@ -97,7 +97,7 @@ public void DotNetBuildLibrary (bool isRelease, bool duplicateAar, bool useDesig
FileAssert.Exists (aarPath);
using (var aar = ZipHelper.OpenZip (aarPath)) {
aar.AssertContainsEntry (aarPath, "assets/bar/bar.txt");
aar.AssertContainsEntry (aarPath, "proguard.txt");
aar.AssertEntryEquals (aarPath, "proguard.txt", "# LibraryC");
}

var libB = new XASdkProject (outputType: "Library") {
Expand Down Expand Up @@ -139,7 +139,7 @@ public Foo ()
TextContent = () => ResourceData.JavaSourceTestExtension,
},
new AndroidItem.ProguardConfiguration ("proguard.txt") {
TextContent = () => @"-ignorewarnings",
TextContent = () => "# LibraryB",
},
}
};
Expand Down Expand Up @@ -185,6 +185,8 @@ public Foo ()
aar.AssertContainsEntry (aarPath, $"libs/{projectJarHash}.jar");
aar.AssertContainsEntry (aarPath, "jni/arm64-v8a/libfoo.so");
aar.AssertContainsEntry (aarPath, "jni/x86/libfoo.so");
// proguard.txt from Library C should not flow to Library B and "double"
aar.AssertEntryEquals (aarPath, "proguard.txt", "# LibraryB");
Comment on lines +188 to +189
Copy link
Member Author

@jonathanpeppers jonathanpeppers May 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok with the updated test, this was previously failing with:

Expected string length 10 but was 22. Strings differ at index 10.
  Expected: "# LibraryB"
  But was:  "# LibraryB\r\n# LibraryC"

So this is better than using an .aar from maven.

}

// Check EmbeddedResource files do not exist
Expand Down
1 change: 1 addition & 0 deletions src/Xamarin.Android.Build.Tasks/Xamarin.Android.EmbeddedResource.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This file is used by all project types, including binding projects.
Outputs="$(_AndroidStampDirectory)_ResolveLibraryProjectImports.stamp">
<ResolveLibraryProjectImports
ContinueOnError="$(DesignTimeBuild)"
AndroidApplication="$(AndroidApplication)"
CacheFile="$(_AndroidLibraryProjectImportsCache)"
DesignTimeBuild="$(DesignTimeBuild)"
Assemblies="@(_MonoAndroidReferencePath);@(_MonoAndroidReferenceDependencyPaths)"
Expand Down