Skip to content
Merged
21 changes: 20 additions & 1 deletion src/Xamarin.Android.Build.Tasks/Tasks/BuildArchive.cs
Original file line number Diff line number Diff line change
Expand Up @@ -158,16 +158,35 @@ public override bool RunTask ()
// ItemSpec for these will be "<jarfile>#<entrypath>
// eg: "obj/myjar.jar#myfile.txt"
var jar_file_path = disk_path.Substring (0, disk_path.Length - (jar_entry_name.Length + 1));
var wasExistingOutputEntry = existingEntries.Remove (apk_path);
var hasApkEntry = apk.ContainsEntry (apk_path);

if (apk.ContainsEntry (apk_path)) {
if (hasApkEntry && !wasExistingOutputEntry) {
Log.LogDebugMessage ("Failed to add jar entry {0} from {1}: the same file already exists in the apk", jar_entry_name, Path.GetFileName (jar_file_path));
continue;
}

using (var stream = File.OpenRead (jar_file_path))
using (var jar = ZipArchive.Open (stream)) {
if (!jar.ContainsEntry (jar_entry_name)) {
Log.LogDebugMessage ("Failed to add jar entry {0} from {1}: entry not found in jar.", jar_entry_name, jar_file_path);
if (wasExistingOutputEntry)
existingEntries.Add (apk_path);
continue;
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
}

var jar_item = jar.ReadEntry (jar_entry_name);

if (hasApkEntry) {
// CRC is computed on uncompressed data — matching CRC means identical content regardless of compression settings.
if (apk.GetEntry (apk_path).CRC == jar_item.CRC) {
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
Log.LogDebugMessage ("Skipping {0} from {1} as it is up to date.", jar_entry_name, jar_file_path);
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
continue;
}

apk.DeleteEntry (apk_path);
}

byte [] data;
var d = MemoryStreamPool.Shared.Rent ();

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
#nullable enable
using System;
using System.Collections.Generic;
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.Android.Build.Tasks;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using NUnit.Framework;
using Xamarin.Android.Tasks;
using Xamarin.Tools.Zip;

namespace Xamarin.Android.Build.Tests;

[TestFixture]
public class BuildArchiveTests
{
string? tempDirectory;

string TempDirectory => tempDirectory ?? throw new InvalidOperationException ("Setup has not run.");

[SetUp]
public void Setup ()
{
tempDirectory = Path.Combine (Path.GetTempPath (), Path.GetRandomFileName ());
Directory.CreateDirectory (tempDirectory);
}

[TearDown]
public void TearDown ()
{
if (!tempDirectory.IsNullOrEmpty () && Directory.Exists (tempDirectory))
Directory.Delete (tempDirectory, recursive: true);
}

[Test]
public void ConsecutiveUnchangedBuildsKeepJavaArchiveEntries ()
{
var apk = Path.Combine (TempDirectory, "app.apk");
var jar = Path.Combine (TempDirectory, "classes.jar");

CreateArchive (apk, ("AndroidManifest.xml", "manifest"), ("commonMain/default/manifest", "existing"), ("stale.txt", "stale"));
CreateArchive (jar, ("commonMain/default/manifest", "current"));

var item = new TaskItem ($"{jar}#commonMain/default/manifest");
item.SetMetadata ("ArchivePath", "commonMain/default/manifest");
item.SetMetadata ("JavaArchiveEntry", "commonMain/default/manifest");
string? previousSnapshot = null;

for (var build = 1; build <= 3; build++) {
var task = new BuildArchive {
BuildEngine = new MockBuildEngine (TestContext.Out),
ApkOutputPath = apk,
FilesToAddToArchive = [item],
};

Assert.IsTrue (task.RunTask (), $"build {build} should have succeeded");

Comment thread
simonrozsival marked this conversation as resolved.
Resolved
var snapshot = GetArchiveSnapshot (apk);
if (previousSnapshot is not null)
Assert.AreEqual (previousSnapshot, snapshot, $"build {build} should match the previous unchanged build");
previousSnapshot = snapshot;

using (var archive = ZipArchive.Open (apk, FileMode.Open)) {
archive.AssertEntryContents (apk, "commonMain/default/manifest", "current");
archive.AssertDoesNotContainEntry (apk, "stale.txt");
}
}
}

Comment thread
simonrozsival marked this conversation as resolved.
Resolved
[Test]
public void ExistingJavaArchiveEntriesAreSkippedWhenUpToDate ()
{
var apk = Path.Combine (TempDirectory, "app.apk");
var jar = Path.Combine (TempDirectory, "classes.jar");

CreateArchive (apk, ("commonMain/default/manifest", "current"));
CreateArchive (jar, ("commonMain/default/manifest", "current"));

var item = new TaskItem ($"{jar}#commonMain/default/manifest");
item.SetMetadata ("ArchivePath", "commonMain/default/manifest");
item.SetMetadata ("JavaArchiveEntry", "commonMain/default/manifest");
var messages = new List<BuildMessageEventArgs> ();

var task = new BuildArchive {
BuildEngine = new MockBuildEngine (TestContext.Out, messages: messages),
ApkOutputPath = apk,
FilesToAddToArchive = [item],
};

Assert.IsTrue (task.RunTask (), "task should have succeeded");

Assert.That (messages, Has.Some.Property (nameof (BuildMessageEventArgs.Message)).EqualTo ($"Skipping commonMain/default/manifest from {jar} as it is up to date."));

using (var archive = ZipArchive.Open (apk, FileMode.Open)) {
archive.AssertEntryContents (apk, "commonMain/default/manifest", "current");
}
}

[Test]
public void DuplicateJavaArchiveEntriesKeepFirstCurrentBuildItem ()
{
var apk = Path.Combine (TempDirectory, "app.apk");
var firstJar = Path.Combine (TempDirectory, "first.jar");
var secondJar = Path.Combine (TempDirectory, "second.jar");

CreateArchive (apk, ("stale.txt", "stale"));
CreateArchive (firstJar, ("commonMain/default/manifest", "first"));
CreateArchive (secondJar, ("commonMain/default/manifest", "second"));

Comment thread
simonrozsival marked this conversation as resolved.
Resolved
var firstItem = new TaskItem ($"{firstJar}#commonMain/default/manifest");
firstItem.SetMetadata ("ArchivePath", "commonMain/default/manifest");
firstItem.SetMetadata ("JavaArchiveEntry", "commonMain/default/manifest");
var secondItem = new TaskItem ($"{secondJar}#commonMain/default/manifest");
secondItem.SetMetadata ("ArchivePath", "commonMain/default/manifest");
secondItem.SetMetadata ("JavaArchiveEntry", "commonMain/default/manifest");
var messages = new List<BuildMessageEventArgs> ();

var task = new BuildArchive {
BuildEngine = new MockBuildEngine (TestContext.Out, messages: messages),
ApkOutputPath = apk,
FilesToAddToArchive = [firstItem, secondItem],
};

Assert.IsTrue (task.RunTask (), "task should have succeeded");

Assert.That (messages, Has.Some.Property (nameof (BuildMessageEventArgs.Message)).EqualTo ("Failed to add jar entry commonMain/default/manifest from second.jar: the same file already exists in the apk"));

using (var archive = ZipArchive.Open (apk, FileMode.Open)) {
archive.AssertEntryContents (apk, "commonMain/default/manifest", "first");
archive.AssertDoesNotContainEntry (apk, "stale.txt");
}
}
Comment thread
simonrozsival marked this conversation as resolved.
Resolved

[Test]
public void MissingJarEntryIsSkippedAndExistingOutputEntryIsRemoved ()
{
var apk = Path.Combine (TempDirectory, "app.apk");
var jar = Path.Combine (TempDirectory, "classes.jar");

CreateArchive (apk, ("commonMain/default/manifest", "existing"));
CreateArchive (jar, ("other-entry.txt", "contents"));

var item = new TaskItem ($"{jar}#commonMain/default/manifest");
item.SetMetadata ("ArchivePath", "commonMain/default/manifest");
item.SetMetadata ("JavaArchiveEntry", "commonMain/default/manifest");
var messages = new List<BuildMessageEventArgs> ();

var task = new BuildArchive {
BuildEngine = new MockBuildEngine (TestContext.Out, messages: messages),
ApkOutputPath = apk,
FilesToAddToArchive = [item],
};

Assert.IsTrue (task.RunTask (), "task should have succeeded");

Assert.That (messages, Has.Some.Property (nameof (BuildMessageEventArgs.Message)).EqualTo ($"Failed to add jar entry commonMain/default/manifest from {jar}: entry not found in jar."));

// The entry should be removed. If the APK itself no longer exists, all entries were cleared (also satisfies the assertion).
if (File.Exists (apk)) {
using (var archive = ZipArchive.Open (apk, FileMode.Open)) {
archive.AssertDoesNotContainEntry (apk, "commonMain/default/manifest");
}
}
}

static void CreateArchive (string path, params (string name, string contents) [] entries)
{
using (var stream = File.Create (path))
using (var archive = ZipArchive.Create (stream)) {
foreach (var entry in entries) {
archive.AddEntry (entry.name, entry.contents, encoding: Encoding.UTF8);
}
}
}

static string GetArchiveSnapshot (string path)
{
using var archive = ZipArchive.Open (path, FileMode.Open);
return string.Join ("\n", archive
.OrderBy (entry => entry.FullName, StringComparer.Ordinal)
.Select (entry => {
using var stream = new MemoryStream ();
entry.Extract (stream);
return $"{entry.FullName}:{Convert.ToBase64String (stream.ToArray ())}";
}));
}
}