Add binding-integration-Tests (ongoing work).

atsushieno · atsushieno · commit f57fd6adb795 · 2018-07-26T02:32:25.000+09:00
context: dotnet#341 (comment) So far, it runs javac and jar to create input jars.
diff --git a/Java.Interop.sln b/Java.Interop.sln
@@ -17,7 +17,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{4C173212-3
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop", "src\Java.Interop\Java.Interop.csproj", "{94BD81F7-B06F-4295-9636-F8A3B6BDC762}"
 EndProject
-Project("{9344BDBB-3E7F-41FC-A0DD-8665D75EE146}") = "java-interop", "src\java-interop\java-interop.csproj", "{BB0AB9F7-0979-41A7-B7A9-877260655F94}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "java-interop", "src\java-interop\java-interop.csproj", "{BB0AB9F7-0979-41A7-B7A9-877260655F94}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop.Dynamic", "src\Java.Interop.Dynamic\Java.Interop.Dynamic.csproj", "{AD4468F8-8883-434B-9D4C-E1801BB3B52A}"
 EndProject
@@ -99,6 +99,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop.GenericMarshal
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop.BootstrapTasks", "src\Java.Interop.BootstrapTasks\Java.Interop.BootstrapTasks.csproj", "{3E8E5C8C-59A6-4A9A-B55D-46AB14431B2A}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "binding-integration-Tests", "tests\binding-integrated-Tests\binding-integration-Tests.csproj", "{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -349,6 +351,14 @@ Global
 		{3E8E5C8C-59A6-4A9A-B55D-46AB14431B2A}.XAIntegrationDebug|Any CPU.Build.0 = Debug|Any CPU
 		{3E8E5C8C-59A6-4A9A-B55D-46AB14431B2A}.XAIntegrationRelease|Any CPU.ActiveCfg = Release|Any CPU
 		{3E8E5C8C-59A6-4A9A-B55D-46AB14431B2A}.XAIntegrationRelease|Any CPU.Build.0 = Release|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.XAIntegrationDebug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.XAIntegrationDebug|Any CPU.Build.0 = Debug|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.XAIntegrationRelease|Any CPU.ActiveCfg = Release|Any CPU
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E}.XAIntegrationRelease|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{0C001D50-4176-45AE-BDC8-BA626508B0CC} = {C8F58966-94BF-407F-914A-8654F8B8AE3B}
@@ -392,5 +402,6 @@ Global
 		{C0487169-8F81-497F-919E-EB42B1D0243F} = {C8F58966-94BF-407F-914A-8654F8B8AE3B}
 		{D1243BAB-23CA-4566-A2A3-3ADA2C2DC3AF} = {4C173212-371D-45D8-BA83-9226194F48DC}
 		{3E8E5C8C-59A6-4A9A-B55D-46AB14431B2A} = {172B608B-E6F3-41CC-9949-203A76BA247C}
+		{D5CE4B09-C1D3-4647-B78B-6D2E89FE883E} = {271C9F30-F679-4793-942B-0D9527CB3E2F}
 	EndGlobalSection
 EndGlobal
diff --git a/tests/binding-integrated-Tests/BindingBuilder.cs b/tests/binding-integrated-Tests/BindingBuilder.cs
@@ -0,0 +1,170 @@
+using NUnit.Framework;
+using System;
+using System.Diagnostics;
+using Java.Interop;
+using System.IO;
+using System.Linq;
+
+namespace BindingIntegrationTests
+{
+	public class BindingBuilder
+	{
+		[Flags]
+		public enum Steps
+		{
+			Javac,
+			Jar,
+			ClassParse,
+			ApiXmlAdjuster,
+			Generator,
+			Csc,
+			All = Javac | Jar | ClassParse | ApiXmlAdjuster | Generator | Csc
+		}
+
+		public const string JavaSourcesSubDir = "java-sources";
+		public const string ClassesSubDir = "classes";
+
+		public Steps ProcessSteps { get; set; } = Steps.All;
+
+		// entire work (intermediate output) directory
+		public string IntermediateOutputPathRelative { get; set; } = "intermediate-output";
+
+		// Used to resolve javac and rt.jar
+		public string JdkPath { get; set; }
+
+		static string ProbeJavaHome ()
+		{
+			var env = Environment.GetEnvironmentVariable ("JAVA_HOME");
+			if (!string.IsNullOrEmpty (env))
+				return env;
+			return "/usr/lib/jvm/java-8-openjdk-amd64/";
+		}
+
+		public static BindingBuilder CreateBestBetDefault (BindingProject project)
+		{
+			return new BindingBuilder (project) { JdkPath = ProbeJavaHome () };
+		}
+
+		public BindingBuilder (BindingProject project)
+		{
+			this.project = project;
+		}
+
+		readonly BindingProject project;
+
+		public string IntermediateOutputPathAbsolute => Path.Combine (Path.GetDirectoryName (new Uri (GetType ().Assembly.CodeBase).LocalPath), IntermediateOutputPathRelative, project.Id);
+
+		public void Clean ()
+		{
+			if (Directory.Exists (IntermediateOutputPathAbsolute))
+				Directory.Delete (IntermediateOutputPathAbsolute, true);
+		}
+
+		public void Build ()
+		{
+			Javac ();
+			Jar ();
+			ClassParse ();
+			AdjustApiXml ();
+			GenerateBindingSources ();
+			CompileBindings ();
+		}
+
+		Action<string> ensureDirectory = dir => { if (!Directory.Exists (dir)) Directory.CreateDirectory (dir); };
+
+		void Javac ()
+		{
+			if ((ProcessSteps & Steps.Javac) != Steps.Javac)
+				return;
+
+			if (JdkPath == null)
+				throw new InvalidOperationException ("JdkPath is not set.");
+
+			var objDir = IntermediateOutputPathAbsolute;
+			ensureDirectory (objDir);
+
+			string sourcesSaved = Path.Combine (objDir, JavaSourcesSubDir);
+			ensureDirectory (sourcesSaved);
+			foreach (var item in project.JavaSourceStrings)
+				File.WriteAllText (Path.Combine (sourcesSaved, item.FileName), item.Content);
+			var sourceFiles = project.JavaSourceFiles.Concat (project.JavaSourceStrings.Select (i => Path.Combine (sourcesSaved, i.FileName)));
+
+			if (project.CompiledClassesDirectory == null)
+				project.CompiledClassesDirectory = Path.Combine (objDir, ClassesSubDir);
+			ensureDirectory (project.CompiledClassesDirectory);
+
+			var psi = new ProcessStartInfo () {
+				UseShellExecute = false,
+				FileName = JdkPath != null ? Path.Combine (JdkPath, "bin", "javac") : "javac",
+				Arguments = $"{project.JavacOptions} -d \"{project.CompiledClassesDirectory}\" {string.Join (" ", sourceFiles.Select (s => '"' + s + '"'))}",
+				RedirectStandardOutput = true,
+				RedirectStandardError = true,
+			};
+			if (project.CustomRuntimeJar != null)
+				psi.Arguments += $" -bootclasspath {project.CustomRuntimeJar} -classpath {project.CustomRuntimeJar}";
+
+			project.JavacExecutionOutput = $"Execute javac as: {psi.FileName} {psi.Arguments}\n";
+
+			var proc = new Process () { StartInfo = psi };
+			proc.OutputDataReceived += (sender, e) => project.JavacExecutionOutput += e.Data;
+			proc.ErrorDataReceived += (sender, e) => project.JavacExecutionOutput += e.Data;
+			proc.Start ();
+			proc.BeginOutputReadLine ();
+			proc.BeginErrorReadLine ();
+			proc.WaitForExit ();
+			if (proc.ExitCode != 0)
+				throw new Exception ("Javac failed: " + project.JavacExecutionOutput);
+		}
+
+		void Jar ()
+		{
+			if ((ProcessSteps & Steps.Jar) != Steps.Jar)
+				return;
+
+			if (JdkPath == null)
+				throw new InvalidOperationException ("JdkPath is not set.");
+
+			var objDir = IntermediateOutputPathAbsolute;
+			if (project.CompiledClassesDirectory == null)
+				project.CompiledClassesDirectory = Path.Combine (objDir, ClassesSubDir);
+			project.CompiledJarFile = Path.Combine (project.CompiledClassesDirectory, project.Id + ".jar");
+
+			var psi = new ProcessStartInfo () {
+				UseShellExecute = false,
+				FileName = JdkPath != null ? Path.Combine (JdkPath, "bin", "jar") : "jar",
+				Arguments = $"cvf \"{project.CompiledJarFile}\" -C \"{project.CompiledClassesDirectory}\" .",
+				RedirectStandardOutput = true,
+				RedirectStandardError = true,
+			};
+
+			project.JarExecutionOutput = $"Execute jar as: {psi.FileName} {psi.Arguments}\n";
+
+			var proc = new Process () { StartInfo = psi };
+			proc.OutputDataReceived += (sender, e) => project.JarExecutionOutput += e.Data;
+			proc.ErrorDataReceived += (sender, e) => project.JarExecutionOutput += e.Data;
+			proc.Start ();
+			proc.BeginOutputReadLine ();
+			proc.BeginErrorReadLine ();
+			proc.WaitForExit ();
+			if (proc.ExitCode != 0)
+				throw new Exception ("Jar failed: " + project.JarExecutionOutput);
+		}
+
+		void ClassParse ()
+		{
+		}
+
+		void AdjustApiXml ()
+		{
+		}
+
+		void GenerateBindingSources ()
+		{
+		}
+
+		void CompileBindings ()
+		{
+		}
+	}
+}
+
diff --git a/tests/binding-integrated-Tests/BindingProject.cs b/tests/binding-integrated-Tests/BindingProject.cs
@@ -0,0 +1,50 @@
+﻿using System.Collections.Generic;
+
+namespace BindingIntegrationTests
+{
+	public class JavaSource
+	{
+		public string FileName { get; set; }
+		public string Content { get; set; }
+	}
+
+	public class BindingProject
+	{
+		public string Id { get; set; }
+
+		// initial inputs
+		public IList<string> JavaSourceFiles { get; set; } = new List<string> ();
+		public IList<JavaSource> JavaSourceStrings { get; set; } = new List<JavaSource> ();
+		public string JavacOptions { get; set; } = "-g";
+		// rt.jar, android.jar etc.
+		// If it is specified, then javac will run with -bootclasspath and -cp
+		public string CustomRuntimeJar { get; set; }
+
+		public IList<string> ApiXmlFiles { get; set; } = new List<string> ();
+		public IList<string> MetadataXmlFiles { get; set; } = new List<string> ();
+		//public IList<string> MetadataXmlStrings { get; set; }
+		public IList<string> InputJarFiles { get; set; } = new List<string> ();
+		public IList<string> ReferenceJarFiles { get; set; } = new List<string> ();
+		public IList<string> CSharpSourceFiles { get; set; } = new List<string> ();
+		//public IList<string> CSharpSourceStrings { get; set; } = new List<string> ();
+		public IList<string> ReferenceDlls { get; set; } = new List<string> ();
+
+		public string JavacExecutionOutput { get; internal set; }
+		// Java classes directory generated by javac (Javac() method)
+		public string CompiledClassesDirectory { get; set; }
+
+		public string JarExecutionOutput { get; internal set; }
+		// Java libraries archived by jar
+		public string CompiledJarFile { get; internal set; }
+
+		// API XML description generated by class-parse
+		public string GeneratedClassParseXmlFile { get; internal set; }
+		// API XML description generated by api-xml-adjuster
+		public string GeneratedApiXmlFile { get; internal set; }
+
+		// C# sources generated by generator
+		public IList<string> GeneratedCSharpSourceFiles { get; internal set; }
+		// DLL built by C# compiler
+		public string GeneratedDllFile { get; internal set; }
+	}
+}
diff --git a/tests/binding-integrated-Tests/README.md b/tests/binding-integrated-Tests/README.md
@@ -0,0 +1,26 @@
+This directory contains a set of integration tests for binding infrastructure.
+
+The test fixtures make it possible to build binding Java library, export
+API, generate binding sources, compile them and even execute it on JVM.
+
+### Input items
+
+- Java sources
+- Metadata fixup
+- input Java libraries
+- reference Java libraries
+- reference managed libraries
+
+### Tools
+
+- class-parse
+- api-xml-adjuster
+- generator
+- csc
+
+### Build artifacts to test
+
+- jars
+- dlls
+- generated C# sources
+
diff --git a/tests/binding-integrated-Tests/SampleTest.cs b/tests/binding-integrated-Tests/SampleTest.cs
@@ -0,0 +1,77 @@
+﻿using System;
+using System.IO;
+using NUnit.Framework;
+
+namespace BindingIntegrationTests
+{
+	// Whenever we write complicated test foundation, we should ensure that it actually works.
+	public class SampleTest
+	{
+		[Test]
+		public void YouNeedJdkPath ()
+		{
+			Assert.Throws<InvalidOperationException> (() => {
+				new BindingBuilder (new BindingProject ()).Build ();
+			});
+		}
+
+		[Test]
+		public void VerifyJavac ()
+		{
+			// You don't even have to create a set of project files. They can be created on the fly.
+			var project = new BindingProject { Id = nameof (VerifyJavac) };
+			string fooJavaFileName = "Foo.java";
+			string fooJavaContent = "public class Foo {}";
+			project.JavaSourceStrings.Add (new JavaSource { FileName = fooJavaFileName, Content = fooJavaContent });
+
+			// Set up builder. Hopefully you don't have to provide JDK path, it will be probed.
+			var builder = BindingBuilder.CreateBestBetDefault (project);
+			builder.ProcessSteps = BindingBuilder.Steps.Javac;
+			builder.Clean ();
+			builder.Build ();
+
+			var savedFooJavaFile = Path.Combine (builder.IntermediateOutputPathAbsolute, BindingBuilder.JavaSourcesSubDir, fooJavaFileName);
+			Assert.IsTrue (File.Exists (savedFooJavaFile), "Java source not saved");
+			Assert.AreEqual (fooJavaContent, File.ReadAllText (savedFooJavaFile), "Saved java content mismatch.");
+			var classesDir = Path.Combine (builder.IntermediateOutputPathAbsolute, BindingBuilder.ClassesSubDir);
+			Assert.AreEqual (classesDir, project.CompiledClassesDirectory, "classes directory mismatch.");
+			var fooClassFile = Path.Combine (classesDir, "Foo.class");
+			Assert.IsTrue (File.Exists (fooClassFile), "Compiled Foo.class not found");
+		}
+
+		[Test]
+		public void VerifyJavacWithRtJar ()
+		{
+			var project = new BindingProject { Id = nameof (VerifyJavacWithRtJar) };
+			string fooJavaFileName = "Foo.java";
+			string fooJavaContent = "public class Foo {}";
+			project.JavaSourceStrings.Add (new JavaSource { FileName = fooJavaFileName, Content = fooJavaContent });
+
+			var builder = BindingBuilder.CreateBestBetDefault (project);
+			project.CustomRuntimeJar = Path.Combine (builder.JdkPath, "jre", "lib", "rt.jar");
+			Assert.IsTrue (File.Exists (project.CustomRuntimeJar), "rt.jar exists");
+			builder.ProcessSteps = BindingBuilder.Steps.Javac;
+			builder.Clean ();
+			builder.Build ();
+		}
+
+		[Test]
+		public void VerifyJar ()
+		{
+			// You don't even have to create a set of project files. They can be created on the fly.
+			var project = new BindingProject { Id = nameof (VerifyJar) };
+			project.JavaSourceStrings.Add (new JavaSource { FileName = "Foo.java", Content = "public class Foo {}" });
+			project.JavaSourceStrings.Add (new JavaSource { FileName = "Bar.java", Content = "public class Bar {}" });
+
+			// Set up builder. Hopefully you don't have to provide JDK path, it will be probed.
+			var builder = BindingBuilder.CreateBestBetDefault (project);
+			builder.ProcessSteps = BindingBuilder.Steps.Javac | BindingBuilder.Steps.Jar;
+			builder.Clean ();
+			builder.Build ();
+
+			var jar = Path.Combine (builder.IntermediateOutputPathAbsolute, BindingBuilder.ClassesSubDir, project.Id + ".jar");
+			Assert.AreEqual (jar, project.CompiledJarFile, "jar file path mismatch.");
+			Assert.IsTrue (File.Exists (project.CompiledJarFile), "Compiled jar not found");
+		}
+	}
+}
diff --git a/tests/binding-integrated-Tests/binding-integration-Tests.csproj b/tests/binding-integrated-Tests/binding-integration-Tests.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup> 
+    <TargetFramework>net461</TargetFramework>
+    <RootNamespace>BindingIntegrationTests</RootNamespace>
+  </PropertyGroup> 
+  <ItemGroup>
+    <PackageReference Include="NUnit" Version="3.10.1" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Java.Interop\Java.Interop.csproj" />
+    <ProjectReference Include="..\TestJVM\TestJVM.csproj" />
+    <ProjectReference Include="..\..\src\Xamarin.Android.Tools.Bytecode\Xamarin.Android.Tools.Bytecode.csproj" />
+    <ProjectReference Include="..\..\src\Xamarin.Android.Tools.ApiXmlAdjuster\Xamarin.Android.Tools.ApiXmlAdjuster.csproj" />
+  </ItemGroup>
+</Project>
