Skip to content

Commit

Permalink
[Xamarin.Android.Build.Tasks] Better support for netstandard librarie…
Browse files Browse the repository at this point in the history 
…s. (#1356)

Fixes: #1154
Fixes: #1162

NetStandard packages sometimes ship with both reference and
implementation assemblies. The NuGet build task
`<ResolveNuGetPackageAssets/>` only resolves the `ref` version of the
assemblies. There does not seem to be away way to *force* NuGet to
resolve the lib one.

This commit reworks the `<ResolveAssemblies/>` task to attempt to map
the `ref` to a `lib` if we find a Referenece Assembly. Historically
we just issue a warning (which will probably be ignored), but
now we will use the `project.assets.json` file to find the
implementation version of the `ref` assembly, by using the
`NuGet.ProjectModel` package to find the library which is associated
with a reference assembly.

We thus "ignore" reference assemblies, using the "referenced"/"real"
assemblies instead, to ensure that our existing build process
continues to generate usable packages.

*Note*: An alternative approach would be to "embrace" reference
assemblies, allowing them to be used in the build. This doesn't
currently work with our build system, as we assume assemblies will
contain native libraries, Android resources, and other artifacts
which must be extracted at build time, and reference assemblies will
not contain these artifacts.

We would like to explore the "embrace" strategy, but this will
require far more effort to support.
  • Loading branch information
@dellis1972 @jonpryor
dellis1972 authored and jonpryor committed Mar 21, 2018
1 parent 52850d6 commit c7b9a50
Show file tree
Hide file tree
Showing 7 changed files with 216 additions and 23 deletions.
101 changes: 82 additions & 19 deletions src/Xamarin.Android.Build.Tasks/Tasks/ResolveAssemblies.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@
using MonoDroid.Tuner;
using System.IO;
using Xamarin.Android.Tools;
using NuGet.Common;
using NuGet.Frameworks;
using NuGet.ProjectModel;

using Java.Interop.Tools.Cecil;

namespace Xamarin.Android.Tasks
{
public class ResolveAssemblies : Task
public class ResolveAssemblies : AsyncTask
{
// The user's assemblies to package
[Required]
Expand All @@ -24,6 +27,12 @@ public class ResolveAssemblies : Task
[Required]
public string ReferenceAssembliesDirectory { get; set; }

public string ProjectAssetFile { get; set; }

public string TargetMoniker { get; set; }

public string NuGetPackageRoot { get; set; }

public string I18nAssemblies { get; set; }
public string LinkMode { get; set; }

Expand All @@ -45,25 +54,45 @@ public class ResolveAssemblies : Task

public override bool Execute ()
{
using (var resolver = new DirectoryAssemblyResolver (this.CreateTaskLogger (), loadDebugSymbols: false)) {
return Execute (resolver);
}
System.Threading.Tasks.Task.Run (() => {
using (var resolver = new DirectoryAssemblyResolver (this.CreateTaskLogger (), loadDebugSymbols: false)) {
return Execute (resolver);
}
}, Token).ContinueWith ((t) => {
if (t.Exception != null) {
var ex = t.Exception.GetBaseException ();
LogError (ex.Message + Environment.NewLine + ex.StackTrace);
}
Complete ();
});
return base.Execute ();
}

bool Execute (DirectoryAssemblyResolver resolver)
{
Log.LogDebugMessage ("ResolveAssemblies Task");
Log.LogDebugMessage (" ReferenceAssembliesDirectory: {0}", ReferenceAssembliesDirectory);
Log.LogDebugMessage (" I18nAssemblies: {0}", I18nAssemblies);
Log.LogDebugMessage (" LinkMode: {0}", LinkMode);
Log.LogDebugTaskItems (" Assemblies:", Assemblies);
LogDebugMessage ("ResolveAssemblies Task");
LogDebugMessage (" ReferenceAssembliesDirectory: {0}", ReferenceAssembliesDirectory);
LogDebugMessage (" I18nAssemblies: {0}", I18nAssemblies);
LogDebugMessage (" LinkMode: {0}", LinkMode);
LogDebugTaskItems (" Assemblies:", Assemblies);
LogDebugMessage (" ProjectAssetFile: {0}", ProjectAssetFile);
LogDebugMessage (" NuGetPackageRoot: {0}", NuGetPackageRoot);
LogDebugMessage (" TargetMoniker: {0}", TargetMoniker);

foreach (var dir in ReferenceAssembliesDirectory.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries))
resolver.SearchDirectories.Add (dir);

var assemblies = new HashSet<string> ();

var topAssemblyReferences = new List<AssemblyDefinition> ();
var logger = new NuGetLogger((s) => {
LogDebugMessage ("{0}", s);
});

LockFile lockFile = null;
if (!string.IsNullOrEmpty (ProjectAssetFile) && File.Exists (ProjectAssetFile)) {
lockFile = LockFileUtilities.GetLockFile (ProjectAssetFile, logger);
}

try {
foreach (var assembly in Assemblies) {
Expand All @@ -77,21 +106,26 @@ bool Execute (DirectoryAssemblyResolver resolver)
if (assemblyDef == null)
throw new InvalidOperationException ("Failed to load assembly " + assembly.ItemSpec);
if (MonoAndroidHelper.IsReferenceAssembly (assemblyDef)) {
Log.LogWarning ($"Ignoring {assembly_path} as it is a Reference Assembly");
continue;
// Resolve "runtime" library
if (lockFile != null)
assemblyDef = ResolveRuntimeAssemblyForReferenceAssembly (lockFile, resolver, assemblyDef.Name);
if (lockFile == null || assemblyDef == null) {
LogWarning ($"Ignoring {assembly_path} as it is a Reference Assembly");
continue;
}
}
topAssemblyReferences.Add (assemblyDef);
assemblies.Add (Path.GetFullPath (assemblyDef.MainModule.FullyQualifiedName));
}
} catch (Exception ex) {
Log.LogError ("Exception while loading assemblies: {0}", ex);
LogError ("Exception while loading assemblies: {0}", ex);
return false;
}
try {
foreach (var assembly in topAssemblyReferences)
AddAssemblyReferences (resolver, assemblies, assembly, true);
} catch (Exception ex) {
Log.LogError ("Exception while loading assemblies: {0}", ex);
LogError ("Exception while loading assemblies: {0}", ex);
return false;
}

Expand All @@ -109,17 +143,46 @@ bool Execute (DirectoryAssemblyResolver resolver)
ResolvedUserAssemblies = ResolvedAssemblies.Where (p => !MonoAndroidHelper.IsFrameworkAssembly (p.ItemSpec, true)).ToArray ();
ResolvedDoNotPackageAttributes = do_not_package_atts.ToArray ();

Log.LogDebugTaskItems (" [Output] ResolvedAssemblies:", ResolvedAssemblies);
Log.LogDebugTaskItems (" [Output] ResolvedUserAssemblies:", ResolvedUserAssemblies);
Log.LogDebugTaskItems (" [Output] ResolvedFrameworkAssemblies:", ResolvedFrameworkAssemblies);
Log.LogDebugTaskItems (" [Output] ResolvedDoNotPackageAttributes:", ResolvedDoNotPackageAttributes);
LogDebugTaskItems (" [Output] ResolvedAssemblies:", ResolvedAssemblies);
LogDebugTaskItems (" [Output] ResolvedUserAssemblies:", ResolvedUserAssemblies);
LogDebugTaskItems (" [Output] ResolvedFrameworkAssemblies:", ResolvedFrameworkAssemblies);
LogDebugTaskItems (" [Output] ResolvedDoNotPackageAttributes:", ResolvedDoNotPackageAttributes);

return !Log.HasLoggedErrors;
}

readonly List<string> do_not_package_atts = new List<string> ();
int indent = 2;

AssemblyDefinition ResolveRuntimeAssemblyForReferenceAssembly (LockFile lockFile, DirectoryAssemblyResolver resolver, AssemblyNameDefinition assemblyNameDefinition)
{
if (string.IsNullOrEmpty(TargetMoniker) || string.IsNullOrEmpty (NuGetPackageRoot) || !Directory.Exists (NuGetPackageRoot))
return null;

var framework = NuGetFramework.Parse (TargetMoniker);
if (framework == null) {
LogWarning ($"Could not parse '{TargetMoniker}'");
return null;
}
var target = lockFile.GetTarget (framework, string.Empty);
if (target == null) {
LogWarning ($"Could not resolve target for '{TargetMoniker}'");
return null;
}
var libraryPath = lockFile.Libraries.FirstOrDefault (x => x.Name == assemblyNameDefinition.Name);
if (libraryPath == null)
return null;
var library = target.Libraries.FirstOrDefault (x => x.Name == assemblyNameDefinition.Name);
if (library == null)
return null;
var runtime = library.RuntimeAssemblies.FirstOrDefault ();
if (runtime == null)
return null;
var path = Path.Combine (NuGetPackageRoot, libraryPath.Path, runtime.Path);
LogDebugMessage ($"Attempting to load {path}");
return resolver.Load (path, forceLoad: true);
}

void AddAssemblyReferences (DirectoryAssemblyResolver resolver, ICollection<string> assemblies, AssemblyDefinition assembly, bool topLevel)
{
var fqname = assembly.MainModule.FullyQualifiedName;
Expand All @@ -132,11 +195,11 @@ void AddAssemblyReferences (DirectoryAssemblyResolver resolver, ICollection<stri
foreach (var att in assembly.CustomAttributes.Where (a => a.AttributeType.FullName == "Java.Interop.DoNotPackageAttribute")) {
string file = (string) att.ConstructorArguments.First ().Value;
if (string.IsNullOrWhiteSpace (file))
Log.LogError ("In referenced assembly {0}, Java.Interop.DoNotPackageAttribute requires non-null file name.", assembly.FullName);
LogError ("In referenced assembly {0}, Java.Interop.DoNotPackageAttribute requires non-null file name.", assembly.FullName);
do_not_package_atts.Add (Path.GetFileName (file));
}

Log.LogMessage (MessageImportance.Low, "{0}Adding assembly reference for {1}, recursively...", new string (' ', indent), assembly.Name);
LogMessage ("{0}Adding assembly reference for {1}, recursively...", new string (' ', indent), assembly.Name);
indent += 2;
// Add this assembly
if (!topLevel && assemblies.All (a => new AssemblyNameDefinition (a, null).Name != assembly.Name.Name))
Expand Down
33 changes: 31 additions & 2 deletions src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/PackagingTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,14 @@ public partial class App : Application
public App()
{
JsonConvert.DeserializeObject<string>(""test"");
package = Package.Open ("""");
try {
JsonConvert.DeserializeObject<string>(""test"");
package = Package.Open ("""");
} catch {
}
InitializeComponent();
MainPage = new ContentPage ();
}
protected override void OnStart()
Expand Down Expand Up @@ -337,6 +342,29 @@ protected override void OnResume()
KnownPackages.XamarinForms_2_3_4_231,
}
};
app.MainActivity = @"using System;
using Android.App;
using Android.Content;
using Android.Runtime;
using Android.Views;
using Android.Widget;
using Android.OS;
using XamFormsSample;
namespace App1
{
[Activity (Label = ""App1"", MainLauncher = true, Icon = ""@drawable/icon"")]
public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity {
protected override void OnCreate (Bundle bundle)
{
base.OnCreate (bundle);
global::Xamarin.Forms.Forms.Init (this, bundle);
LoadApplication (new App ());
}
}
}";
app.SetProperty (KnownProperties.AndroidSupportedAbis, "x86;armeabi-v7a");
var expectedFiles = new string [] {
"Java.Interop.dll",
Expand All @@ -346,6 +374,7 @@ protected override void OnResume()
"System.dll",
"System.Runtime.Serialization.dll",
"System.IO.Packaging.dll",
"System.IO.Compression.dll",
"Mono.Android.Export.dll",
"App1.dll",
"FormsViewGroup.dll",
Expand Down
2 changes: 1 addition & 1 deletion ....Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Xamarin.Android.Build.Tests.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<OutputType>Library</OutputType>
<RootNamespace>Xamarin.Android.Build.Tests</RootNamespace>
<AssemblyName>Xamarin.Android.Build.Tests</AssemblyName>
<TargetFrameworkVersion>v4.5.1</TargetFrameworkVersion>
<TargetFrameworkVersion>v4.6.2</TargetFrameworkVersion>
</PropertyGroup>
<Import Project="Xamarin.Android.Build.Tests.Shared.projitems" Label="Shared" Condition="Exists('Xamarin.Android.Build.Tests.Shared.projitems')" />
<Import Project="..\..\..\..\Configuration.props" />
Expand Down
34 changes: 34 additions & 0 deletions src/Xamarin.Android.Build.Tasks/Utilities/NuGetLogger.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
using System;
using NuGet.Common;
using Microsoft.Build.Utilities;
using TPL = System.Threading.Tasks;

namespace Xamarin.Android.Tasks {

class NuGetLogger : LoggerBase {
Action<string> log;

public NuGetLogger (Action<string> log)
{
this.log = log;
}

public override void Log (ILogMessage message) {
log (message.Message);
}

public override void Log (LogLevel level, string data) {
log (data);
}

public override TPL.Task LogAsync (ILogMessage message) {
Log (message);
return TPL.Task.FromResult(0);
}

public override TPL.Task LogAsync (LogLevel level, string data) {
Log (level, data);
return TPL.Task.FromResult(0);
}
}
}
53 changes: 52 additions & 1 deletion src/Xamarin.Android.Build.Tasks/Xamarin.Android.Build.Tasks.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<RootNamespace>Xamarin.Android.Tasks</RootNamespace>
<AssemblyName>Xamarin.Android.Build.Tasks</AssemblyName>
<FileAlignment>512</FileAlignment>
<TargetFrameworkVersion>v4.5.1</TargetFrameworkVersion>
<TargetFrameworkVersion>v4.6.2</TargetFrameworkVersion>
<SchemaVersion>2.0</SchemaVersion>
</PropertyGroup>
<Import Project="..\..\Configuration.props" />
Expand Down Expand Up @@ -48,6 +48,56 @@
<Reference Include="FSharp.Compiler.CodeDom">
<HintPath>..\..\packages\FSharp.Compiler.CodeDom.1.0.0.1\lib\net40\FSharp.Compiler.CodeDom.dll</HintPath>
</Reference>
<Reference Include="FSharp.Core">
<HintPath>..\..\packages\FSharp.Core.3.1.2.5\lib\net40\FSharp.Core.dll</HintPath>
</Reference>
<Reference Include="Newtonsoft.Json">
<HintPath>..\..\packages\Newtonsoft.Json.11.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
</Reference>
<Reference Include="NuGet.Frameworks">
<HintPath>..\..\packages\NuGet.Frameworks.4.6.0\lib\net46\NuGet.Frameworks.dll</HintPath>
</Reference>
<Reference Include="NuGet.Common">
<HintPath>..\..\packages\NuGet.Common.4.6.0\lib\net46\NuGet.Common.dll</HintPath>
</Reference>
<Reference Include="System.IO.Compression" />
<Reference Include="NuGet.Configuration">
<HintPath>..\..\packages\NuGet.Configuration.4.6.0\lib\net46\NuGet.Configuration.dll</HintPath>
</Reference>
<Reference Include="System.Security" />
<Reference Include="NuGet.Versioning">
<HintPath>..\..\packages\NuGet.Versioning.4.6.0\lib\net46\NuGet.Versioning.dll</HintPath>
</Reference>
<Reference Include="NuGet.LibraryModel">
<HintPath>..\..\packages\NuGet.LibraryModel.4.6.0\lib\net46\NuGet.LibraryModel.dll</HintPath>
</Reference>
<Reference Include="NuGet.Packaging.Core">
<HintPath>..\..\packages\NuGet.Packaging.Core.4.6.0\lib\net46\NuGet.Packaging.Core.dll</HintPath>
</Reference>
<Reference Include="NuGet.Packaging">
<HintPath>..\..\packages\NuGet.Packaging.4.6.0\lib\net46\NuGet.Packaging.dll</HintPath>
</Reference>
<Reference Include="System.Runtime">
<HintPath>..\..\packages\System.Runtime.4.3.0\lib\net462\System.Runtime.dll</HintPath>
</Reference>
<Reference Include="mscorlib" />
<Reference Include="System.ComponentModel.Composition" />
<Reference Include="System.Runtime.InteropServices">
<HintPath>..\..\packages\System.Runtime.InteropServices.4.3.0\lib\net462\System.Runtime.InteropServices.dll</HintPath>
</Reference>
<Reference Include="NuGet.Protocol">
<HintPath>..\..\packages\NuGet.Protocol.4.6.0\lib\net46\NuGet.Protocol.dll</HintPath>
</Reference>
<Reference Include="System.IdentityModel" />
<Reference Include="System.Net.Http" />
<Reference Include="System.Net.Http.WebRequest" />
<Reference Include="System.ServiceModel" />
<Reference Include="NuGet.DependencyResolver.Core">
<HintPath>..\..\packages\NuGet.DependencyResolver.Core.4.6.0\lib\net46\NuGet.DependencyResolver.Core.dll</HintPath>
</Reference>
<Reference Include="NuGet.ProjectModel">
<HintPath>..\..\packages\NuGet.ProjectModel.4.6.0\lib\net46\NuGet.ProjectModel.dll</HintPath>
</Reference>
</ItemGroup>
<ItemGroup>
<Compile Include="$(IntermediateOutputPath)Profile.g.cs" />
Expand Down Expand Up @@ -500,6 +550,7 @@
<Compile Include="Utilities\SatelliteAssembly.cs" />
<Compile Include="Tasks\AndroidApkSigner.cs" />
<Compile Include="Tasks\Desugar.cs" />
<Compile Include="Utilities\NuGetLogger.cs" />
<None Include="Resources\desugar_deploy.jar">
<Link>desugar_deploy.jar</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
Expand Down
3 changes: 3 additions & 0 deletions src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1588,6 +1588,9 @@ because xbuild doesn't support framework reference assemblies.
Assemblies="@(FilteredAssemblies)"
I18nAssemblies="$(MandroidI18n)"
LinkMode="$(AndroidLinkMode)"
ProjectAssetFile="$(ProjectLockFile)"
NuGetPackageRoot="$(NuGetPackageRoot)"
TargetMoniker="$(NuGetTargetMoniker)"
ReferenceAssembliesDirectory="$(TargetFrameworkDirectory)">
<Output TaskParameter="ResolvedAssemblies" ItemName="ResolvedAssemblies" />
<Output TaskParameter="ResolvedUserAssemblies" ItemName="ResolvedUserAssemblies" />
Expand Down
13 changes: 13 additions & 0 deletions src/Xamarin.Android.Build.Tasks/packages.config
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,17 @@
<packages>
<package id="FSharp.Compiler.CodeDom" version="1.0.0.1" targetFramework="net45" />
<package id="Irony" version="0.9.1" targetFramework="net45" />
<package id="Newtonsoft.Json" version="11.0.1" targetFramework="net451" />
<package id="NuGet.Common" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Configuration" version="4.6.0" targetFramework="net462" />
<package id="NuGet.DependencyResolver.Core" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Frameworks" version="4.6.0" targetFramework="net462" />
<package id="NuGet.LibraryModel" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Packaging" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Packaging.Core" version="4.6.0" targetFramework="net462" />
<package id="NuGet.ProjectModel" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Protocol" version="4.6.0" targetFramework="net462" />
<package id="NuGet.Versioning" version="4.6.0" targetFramework="net462" />
<package id="System.Runtime" version="4.3.0" targetFramework="net462" />
<package id="System.Runtime.InteropServices" version="4.3.0" targetFramework="net462" />
</packages>

0 comments on commit c7b9a50

Please sign in to comment.