[binderator] Optionally include 'runtime' dependencies in dependency tree. (#1230)

Author: jpobst

Util/Xamarin.AndroidBinderator/Xamarin.AndroidBinderator/Config/BindingConfig.cs

@@ -56,6 +56,13 @@ public class BindingConfig
 		[JsonProperty("additionalProjects")]
 		public List<string> AdditionalProjects { get; set; } = new List<string>();
 
+		/// True to consider 'Runtime' dependencies from a POM file, False to ignore them.
+		[JsonProperty("strictRuntimeDependencies")]
+		public bool StrictRuntimeDependencies { get; set; }
+
+		[JsonProperty("excludedRuntimeDependencies")]
+		public string ExcludedRuntimeDependencies { get; set; }
+
 		[JsonProperty("metadata")]
 		public Dictionary<string, string> Metadata { get; set; } = new Dictionary<string, string>();
 	}

Util/Xamarin.AndroidBinderator/Xamarin.AndroidBinderator/Config/MavenArtifactConfig.cs

@@ -46,5 +46,10 @@ public string NugetVersion {
 
 		[JsonProperty("metadata")]
 		public Dictionary<string, string> Metadata { get; set; } = new Dictionary<string, string>();
+
+		[JsonProperty("excludedRuntimeDependencies")]
+		public string ExcludedRuntimeDependencies { get; set; }
+
+		public string GroupAndArtifactId => $"{GroupId}.{ArtifactId}";
 	}
 }

Util/Xamarin.AndroidBinderator/Xamarin.AndroidBinderator/Engine.cs

@@ -290,6 +290,7 @@ static async Task DownloadArtifacts(MavenRepository maven, BindingConfig config,
 		static List<BindingProjectModel> BuildProjectModels(BindingConfig config, TemplateConfig template, Dictionary<string, Project> mavenProjects)
 		{
 			var projectModels = new List<BindingProjectModel>();
+			var exceptions = new List<Exception>();
 
 			var baseMetadata = new Dictionary<string, string>();
 			MergeValues(baseMetadata, config.Metadata);
@@ -330,7 +331,6 @@ static List<BindingProjectModel> BuildProjectModels(BindingConfig config, Templa
 				var artifactExtractDir = Path.Combine(artifactDir, mavenArtifact.ArtifactId);
 
 				var proguardFile = Path.Combine(artifactExtractDir, "proguard.txt");
-				var exceptions = new List<Exception>();
 
 				projectModel.MavenArtifacts.Add(new MavenArtifactModel
 				{
@@ -348,8 +348,7 @@ static List<BindingProjectModel> BuildProjectModels(BindingConfig config, Templa
 				// Gather maven dependencies to try and map out nuget dependencies
 				foreach (var mavenDep in mavenProject.Dependencies)
 				{
-					// We only really care about 'compile' scoped dependencies (also null/blank means compile)
-					if (!string.IsNullOrEmpty(mavenDep.Scope) && !mavenDep.Scope.ToLowerInvariant().Equals("compile"))
+					if (!ShouldIncludeDependency(config, mavenArtifact, mavenDep, exceptions))
 						continue;
 
 					mavenDep.Version = FixVersion(mavenDep.Version);
@@ -360,6 +359,11 @@ static List<BindingProjectModel> BuildProjectModels(BindingConfig config, Templa
 						&& ma.ArtifactId == mavenDep.ArtifactId
 						&& mavenDep.Satisfies(ma.Version));
 
+					if (depMapping is null && mavenDep.IsRuntimeDependency()) {
+						exceptions.Add(new Exception($"Artifact '{mavenArtifact.GroupAndArtifactId}' has unknown 'Runtime' dependency '{mavenDep.GroupAndArtifactId()}'. Either fulfill or exclude this dependency."));
+						continue;
+					}
+
 					if (depMapping == null)
 					{
 						StringBuilder sb = new StringBuilder();
@@ -411,17 +415,41 @@ static List<BindingProjectModel> BuildProjectModels(BindingConfig config, Templa
 						}
 					});
 				}
-				if (exceptions.Any())
-                {
-					throw new AggregateException(exceptions.ToArray());
-                }
 
 			}
 
+			if (exceptions.Any())
+				throw new AggregateException(exceptions.ToArray());
+
 
 			return projectModels;
 		}
 
+		static bool ShouldIncludeDependency(BindingConfig config, MavenArtifactConfig artifact, Dependency dependency, List<Exception> exceptions)
+		{
+			// We always care about 'compile' scoped dependencies
+			if (dependency.IsCompileDependency())
+				return true;
+
+			// If we're not processing Runtime dependencies then ignore the rest
+			if (!config.StrictRuntimeDependencies)
+				return false;
+
+			// The only other thing we may care about is 'runtime', bail if this isn't 'runtime'
+			if (!dependency.IsRuntimeDependency())
+				return false;
+
+			// Check 'artifact' list
+			if (artifact.ExcludedRuntimeDependencies.OrEmpty().Split(',').Contains(dependency.GroupAndArtifactId(), StringComparer.OrdinalIgnoreCase))
+				return false;
+
+			// Check 'global' list
+			if (config.ExcludedRuntimeDependencies.OrEmpty ().Split (',').Contains (dependency.GroupAndArtifactId (), StringComparer.OrdinalIgnoreCase))
+				return false;
+
+			return true;
+		}
+
 		static string GetRelativePath(string filespec, string folder)
 		{
 			Uri pathUri = new Uri(filespec);

Util/Xamarin.AndroidBinderator/Xamarin.AndroidBinderator/Extensions.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using MavenNet.Models;
+
+namespace AndroidBinderator
+{
+	public static class Extensions
+	{
+		public static string OrEmpty (this string value) => value ?? string.Empty;
+
+		public static string GroupAndArtifactId (this Dependency dependency) => $"{dependency.GroupId}.{dependency.ArtifactId}";
+
+		public static bool IsCompileDependency (this Dependency dependency) => string.IsNullOrWhiteSpace (dependency.Scope) || dependency.Scope.ToLowerInvariant ().Equals ("compile");
+
+		public static bool IsRuntimeDependency (this Dependency dependency) => dependency != null && dependency.Scope.ToLowerInvariant ().Equals ("runtime");
+	}
+}