Skip to content

[Xamarin.Android.Tools.AndroidSdk] Prefer JAVA_HOME #86

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
Jun 4, 2020
Merged

[Xamarin.Android.Tools.AndroidSdk] Prefer JAVA_HOME #86

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
55ea8df
[Xamarin.Android.Tools.AndroidSdk] Prefer JAVA_HOME
jonpryor Jun 3, 2020
12f7298
[Xamarin.Android.Tools.AndroidSdk] Prefer JI_JAVA_HOME
jonpryor Jun 3, 2020
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
11 changes: 6 additions & 5 deletions src/Xamarin.Android.Tools.AndroidSdk/JdkInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,10 +281,11 @@ public static IEnumerable<JdkInfo> GetKnownSystemJdkInfos (Action<TraceLevel, st
{
logger = logger ?? AndroidSdkInfo.DefaultConsoleLogger;

return GetWindowsJdks (logger)
return GetEnvironmentVariableJdks ("JI_JAVA_HOME", logger)
.Concat (GetWindowsJdks (logger))
.Concat (GetConfiguredJdks (logger))
.Concat (GetMacOSMicrosoftJdks (logger))
.Concat (GetJavaHomeEnvironmentJdks (logger))
.Concat (GetEnvironmentVariableJdks ("JAVA_HOME", logger))
.Concat (GetPathEnvironmentJdks (logger))
.Concat (GetLibexecJdks (logger))
.Concat (GetJavaAlternativesJdks (logger))
Expand Down Expand Up @@ -352,12 +353,12 @@ static IEnumerable<JdkInfo> GetWindowsJdks (Action<TraceLevel, string> logger)
return AndroidSdkWindows.GetJdkInfos (logger);
}

static IEnumerable<JdkInfo> GetJavaHomeEnvironmentJdks (Action<TraceLevel, string> logger)
static IEnumerable<JdkInfo> GetEnvironmentVariableJdks (string envVar, Action<TraceLevel, string> logger)
{
var java_home = Environment.GetEnvironmentVariable ("JAVA_HOME");
var java_home = Environment.GetEnvironmentVariable (envVar);
if (string.IsNullOrEmpty (java_home))
yield break;
var jdk = TryGetJdkInfo (java_home, logger, "$JAVA_HOME");
var jdk = TryGetJdkInfo (java_home, logger, $"${envVar}");
if (jdk != null)
yield return jdk;
}
Expand Down
15 changes: 2 additions & 13 deletions src/Xamarin.Android.Tools.AndroidSdk/Sdks/AndroidSdkWindows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ protected override IEnumerable<string> GetAllAvailableAndroidSdks ()

protected override string? GetJavaSdkPath ()
{
var jdk = GetJdkInfos (Logger).FirstOrDefault ();
var jdk = JdkInfo.GetKnownSystemJdkInfos (Logger).FirstOrDefault ();
return jdk?.HomePath;
}

Expand Down Expand Up @@ -139,18 +139,7 @@ IEnumerable<JdkInfo> ToJdkInfos (IEnumerable<string> paths, string locator)
.Concat (ToJdkInfos (GetOpenJdkPaths (), "OpenJDK"))
.Concat (ToJdkInfos (GetKnownOpenJdkPaths (), "Well-known OpenJDK paths"))
.Concat (ToJdkInfos (GetOracleJdkPaths (), "Oracle JDK"))
.Concat (ToJdkInfos (GetEnvironmentJdkPaths (), "Environment Variables"));
}

private static IEnumerable<string> GetEnvironmentJdkPaths ()
{
var environment = new [] { "JAVA_HOME" };
foreach (var key in environment) {
var value = Environment.GetEnvironmentVariable (key);
if (!string.IsNullOrEmpty (value)) {
yield return value;
}
}
;
}

private static IEnumerable<string> GetPreferredJdkPaths ()
Expand Down
15 changes: 9 additions & 6 deletions tests/Xamarin.Android.Tools.AndroidSdk-Tests/AndroidSdkInfoTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,13 @@ public void Constructor_SetValuesFromPath ()
}

[Test]
[Ignore ("This test will only work locally if you rename/remove your Open JDK directory.")]
public void JdkDirectory_JavaHome ()
public void JdkDirectory_JavaHome ([Values ("JI_JAVA_HOME", "JAVA_HOME")] string envVar)
{
if (envVar.Equals ("JAVA_HOME", StringComparison.OrdinalIgnoreCase)) {
Assert.Ignore ("This test will only work locally if you rename/remove your Open JDK directory.");
return;
}

CreateSdks (out string root, out string jdk, out string ndk, out string sdk);
JdkInfoTests.CreateFauxJdk (jdk, releaseVersion: "1.8.999", releaseBuildNumber: "9", javaVersion: "1.8.999-9");

Expand All @@ -150,16 +154,15 @@ public void JdkDirectory_JavaHome ()
string java_home = null;
try {
// We only set via JAVA_HOME
java_home = Environment.GetEnvironmentVariable ("JAVA_HOME", EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable ("JAVA_HOME", jdk);
java_home = Environment.GetEnvironmentVariable (envVar, EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable (envVar, jdk, EnvironmentVariableTarget.Process);
var info = new AndroidSdkInfo (logger, androidSdkPath: sdk, androidNdkPath: ndk, javaSdkPath: "");

Assert.AreEqual (ndk, info.AndroidNdkPath, "AndroidNdkPath not preserved!");
Assert.AreEqual (sdk, info.AndroidSdkPath, "AndroidSdkPath not preserved!");
Assert.AreEqual (jdk, info.JavaSdkPath, "JavaSdkPath not preserved!");
} finally {
if (java_home != null)
Environment.SetEnvironmentVariable ("JAVA_HOME", java_home, EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable (envVar, java_home, EnvironmentVariableTarget.Process);
Directory.Delete (root, recursive: true);
}
}
Expand Down
17 changes: 17 additions & 0 deletions tests/Xamarin.Android.Tools.AndroidSdk-Tests/JdkInfoTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ namespace Xamarin.Android.Tools.Tests
[TestFixture]
public class JdkInfoTests
{
[Test]
public void GetKnownSystemJdkInfos_PrefersJiJavaHome ()
{
var previous = Environment.GetEnvironmentVariable ("JI_JAVA_HOME", EnvironmentVariableTarget.Process);
try {
Environment.SetEnvironmentVariable ("JI_JAVA_HOME", FauxJdkDir, EnvironmentVariableTarget.Process);

var defaultJdkDir = JdkInfo.GetKnownSystemJdkInfos ()
.FirstOrDefault ();
Assert.IsNotNull (defaultJdkDir);
Assert.AreEqual (FauxJdkDir, defaultJdkDir.HomePath);
}
finally {
Environment.SetEnvironmentVariable ("JI_JAVA_HOME", previous, EnvironmentVariableTarget.Process);
}
}

[Test]
public void Constructor_NullPath ()
{
Expand Down