org.gradle.internal.jvm.JvmTest.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.internal.jvm
import org.gradle.api.JavaVersion
import org.gradle.internal.os.OperatingSystem
import org.gradle.test.fixtures.file.TestFile
import org.gradle.test.fixtures.file.TestNameTestDirectoryProvider
import org.gradle.util.Matchers
import org.gradle.util.SetSystemProperties
import org.junit.Rule
import spock.lang.Specification
class JvmTest extends Specification {
@Rule
TestNameTestDirectoryProvider tmpDir = new TestNameTestDirectoryProvider(getClass())
@Rule
SetSystemProperties sysProp = new SetSystemProperties()
OperatingSystem os = Mock() {
getExecutableName(_) >> { String name ->
return "${name}.exe"
}
}
OperatingSystem theOs = OperatingSystem.current()
Jvm getJvm() {
new Jvm(os)
}
def setup() {
JavaVersion.resetCurrent()
}
def cleanup() {
JavaVersion.resetCurrent()
}
def assertJreHomeIfNotJava9(Jvm jvm, TestFile softwareRoot, String jreHome) {
assertJreHomeIfNotJava9(jvm, softwareRoot, jreHome, false /* alsoStandaloneJreHome */)
}
def assertJreHomeIfNotJava9(Jvm jvm, TestFile softwareRoot, String jreHome, boolean alsoStandaloneJreHome) {
if (jvm.javaVersion.isJava9Compatible()) {
assert jvm.jre == null
if (alsoStandaloneJreHome) {
assert jvm.standaloneJre == null
}
} else {
assert jvm.jre.homeDir == softwareRoot.file(jreHome)
if (alsoStandaloneJreHome) {
assert jvm.standaloneJre.homeDir == softwareRoot.file(jreHome)
}
}
return true
}
def "uses system property to determine if Java 5/6/7"() {
System.properties['java.version'] = "1.$version" as String
expect:
jvm.javaVersion."java$version"
!jvm.javaVersion."java$other1"
!jvm.javaVersion."java$other2"
where:
version | other1 | other2
5 | 6 | 7
6 | 7 | 5
7 | 5 | 6
}
def "locates JDK and JRE installs for a typical JRE installation embedded in a Java 8 JDK installation"() {
given:
TestFile software = tmpDir.createDir('software')
software.create {
jdk {
lib {
file 'tools.jar'
}
bin {
file 'java.exe'
file 'javac.exe'
file 'javadoc.exe'
}
jre {
lib { file 'rt.jar' }
bin { file 'java.exe' }
}
}
}
when:
def jvm = new Jvm(os, software.file('jdk/jre'), "1.8.0.221", JavaVersion.VERSION_1_8)
then:
jvm.javaHome == software.file('jdk')
jvm.jdk
jvm.toolsJar == software.file('jdk/lib/tools.jar')
jvm.javaExecutable == software.file('jdk/bin/java.exe')
jvm.javacExecutable == software.file('jdk/bin/javac.exe')
jvm.javadocExecutable == software.file('jdk/bin/javadoc.exe')
jvm.embeddedJre.homeDir == software.file('jdk/jre')
jvm.standaloneJre == null
jvm.jre.homeDir == jvm.embeddedJre.homeDir
}
def "locates JDK and JRE installs for a typical Java 8 JDK installation"() {
given:
def java8ImplementationVersion = "1.8.0.221"
def software = tmpDir.createDir('software')
software.create {
jdk {
lib {
file 'tools.jar'
}
bin {
file 'java.exe'
file 'javac.exe'
file 'javadoc.exe'
}
jre {
lib { file 'rt.jar' }
bin { file 'java.exe' }
}
}
}
when:
def jvm = new Jvm(os, software.file('jdk'), java8ImplementationVersion, JavaVersion.VERSION_1_8)
then:
jvm.javaHome == software.file('jdk')
jvm.jdk
jvm.toolsJar == software.file('jdk/lib/tools.jar')
jvm.javaExecutable == software.file('jdk/bin/java.exe')
jvm.javacExecutable == software.file('jdk/bin/javac.exe')
jvm.javadocExecutable == software.file('jdk/bin/javadoc.exe')
jvm.jre.homeDir == software.file('jdk/jre')
jvm.embeddedJre.homeDir == software.file("jdk/jre")
jvm.standaloneJre == null
jvm.jre.homeDir == jvm.embeddedJre.homeDir
}
def "locates JDK install for a typical Java 9 JDK installation"() {
given:
def java9ImplementationVersion = "9.0.3"
def software = tmpDir.createDir('software')
software.create {
jdk {
lib {
file 'tools.jar'
}
bin {
file 'java.exe'
file 'javac.exe'
file 'javadoc.exe'
}
}
}
when:
def jvm = new Jvm(os, software.file('jdk'), java9ImplementationVersion, JavaVersion.VERSION_1_9)
then:
jvm.javaHome == software.file('jdk')
jvm.jdk
jvm.toolsJar == software.file('jdk/lib/tools.jar')
jvm.javaExecutable == software.file('jdk/bin/java.exe')
jvm.javacExecutable == software.file('jdk/bin/javac.exe')
jvm.javadocExecutable == software.file('jdk/bin/javadoc.exe')
jvm.embeddedJre == null
jvm.standaloneJre == null
jvm.jre == null
}
def "locates JRE install for a typical standalone Java 8 JRE installation"() {
given:
TestFile software = tmpDir.createDir('software')
software.create {
jre {
bin { file 'java.exe' }
lib { file 'rt.jar' }
}
}
when:
def jvm = new Jvm(os, software.file('jre'), "1.8.0.221", JavaVersion.VERSION_1_8)
then:
jvm.javaHome == software.file('jre')
!jvm.jdk
jvm.toolsJar == null
jvm.javaExecutable == software.file('jre/bin/java.exe')
jvm.embeddedJre == null
jvm.standaloneJre == null
jvm.jre == null
}
def "locates JDK and JRE installs for a typical JRE installation alongside Java 8 JDK installation on Windows"() {
given:
TestFile software = tmpDir.createDir('software')
software.create {
"${jreDirName}" {
bin { file 'java.exe' }
lib { file 'rt.jar' }
}
"${jdkDirName}" {
bin {
file 'java.exe'
file 'javac.exe'
file 'javadoc.exe'
}
lib { file 'tools.jar' }
}
}
def jreDir = software.file(jreDirName)
def jdkDir = software.file(jdkDirName)
and:
_ * os.windows >> true
when:
def jvm = new Jvm(os, jreDir, version, JavaVersion.toVersion(version))
then:
jvm.javaHome == jdkDir
jvm.jdk
jvm.toolsJar == jdkDir.file("lib/tools.jar")
jvm.javaExecutable == jdkDir.file('bin/java.exe')
jvm.javacExecutable == jdkDir.file('bin/javac.exe')
jvm.javadocExecutable == jdkDir.file('bin/javadoc.exe')
jvm.embeddedJre == null
jvm.standaloneJre.homeDir == jreDir
jvm.jre.homeDir == jvm.standaloneJre.homeDir
where:
version | jreDirName | jdkDirName
'1.6.0' | 'jre6' | 'jdk1.6.0'
'1.5.0_22' | 'jre1.5.0_22' | 'jdk1.5.0_22'
}
def "locates JDK and JRE installs for a typical Java 8 JDK installation on Windows"() {
given:
TestFile software = tmpDir.createDir('software')
software.create {
"${jreDirName}" {
bin { file 'java.exe' }
lib {
file 'rt.jar'
}
}
"${jdkDirName}" {
bin {
file 'java.exe'
file 'javac.exe'
file 'javadoc.exe'
}
jre {
lib {
file 'rt.jar'
}
}
lib {
file 'tools.jar'
}
}
}
def jreDir = software.file(jreDirName)
def jdkDir = software.file(jdkDirName)
and:
_ * os.windows >> true
when:
def jvm = new Jvm(os, jdkDir, version, JavaVersion.toVersion(version))
then:
jvm.javaHome == jdkDir
jvm.jdk
jvm.toolsJar == jdkDir.file("lib/tools.jar")
jvm.javaExecutable == jdkDir.file('bin/java.exe')
jvm.javacExecutable == jdkDir.file('bin/javac.exe')
jvm.javadocExecutable == jdkDir.file('bin/javadoc.exe')
jvm.embeddedJre.homeDir == jdkDir.file('jre')
jvm.standaloneJre.homeDir == jreDir
jvm.jre.homeDir == jreDir
where:
version | jreDirName | jdkDirName
'1.6.0' | 'jre6' | 'jdk1.6.0'
'1.5.0_22' | 'jre1.5.0_22' | 'jdk1.5.0_22'
}
def "JVM are equal when their Java home dirs are the same"() {
given:
TestFile installDir = tmpDir.createDir('software')
installDir.create {
lib {
file 'tools.jar'
}
bin {
file 'java'
}
}
expect:
def jvm = new Jvm(os, installDir, "1.8.0", JavaVersion.VERSION_1_8)
def jvm2 = new Jvm(os, installDir, "1.8.0", JavaVersion.VERSION_1_8)
Matchers.strictlyEquals(jvm, jvm2)
}
def "Returns current JVM when located using Java home dir"() {
expect:
def current = Jvm.current()
def jvm = Jvm.forHome(current.javaHome)
jvm.is(current)
}
def "Returns current JVM when located using java.home dir"() {
expect:
def current = Jvm.current()
def jvm = Jvm.forHome(new File(System.getProperty("java.home")))
jvm.is(current)
}
def "uses system property to determine if Sun/Oracle JVM"() {
when:
System.properties['java.vm.vendor'] = 'Sun'
def jvm = Jvm.createCurrent()
then:
jvm.getClass() == Jvm.JvmImplementation
}
def "uses system property to determine if Apple JVM"() {
when:
System.properties['java.vm.vendor'] = 'Apple Inc.'
def jvm = Jvm.createCurrent()
then:
jvm.getClass() == Jvm.AppleJvm
when:
System.properties['java.vm.vendor'] = 'Sun'
jvm = Jvm.createCurrent()
then:
jvm.getClass() == Jvm.JvmImplementation
}
def "uses system property to determine if IBM JVM"() {
when:
System.properties['java.vm.vendor'] = 'IBM Corporation'
def jvm = Jvm.createCurrent()
then:
jvm.getClass() == Jvm.IbmJvm
}
def "finds executable for java home supplied"() {
System.properties['java.vm.vendor'] = 'Sun'
when:
def home = tmpDir.createDir("home")
home.create {
jre {
bin {
file theOs.getExecutableName('java')
file theOs.getExecutableName('javadoc')
}
}
}
then:
home.file(theOs.getExecutableName("jre/bin/javadoc")).absolutePath ==
Jvm.forHome(home.file("jre")).getExecutable("javadoc").absolutePath
}
def "finds tools.jar if java home supplied"() {
System.properties['java.vm.vendor'] = 'Sun'
when:
def home = tmpDir.createDir("home")
home.create {
jdk {
bin { file theOs.getExecutableName('java') }
lib { file 'tools.jar' }
}
}
then:
home.file("jdk/lib/tools.jar").absolutePath ==
Jvm.forHome(home.file("jdk")).toolsJar.absolutePath
}
def "provides decent feedback if executable not found"() {
given:
def home = tmpDir.createDir("home")
home.create {
bin { file theOs.getExecutableName('java') }
}
when:
Jvm.forHome(home).getExecutable("foobar")
then:
def ex = thrown(JavaHomeException)
ex.message.contains('foobar')
}
def "falls back to PATH if executable cannot be found when using default java"() {
given:
def home = tmpDir.createDir("home")
System.properties['java.home'] = home.absolutePath
_ * os.findInPath("foobar") >> new File('/path/foobar.exe')
when:
def exec = jvm.getExecutable("foobar")
then:
exec == new File('/path/foobar.exe')
}
def "falls back to current dir if executable cannot be found anywhere"() {
given:
def home = tmpDir.createDir("home")
System.properties['java.home'] = home.absolutePath
os.getExecutableName(_ as String) >> "foobar.exe"
1 * os.findInPath("foobar") >> null
when:
def exec = jvm.getExecutable("foobar")
then:
exec == new File('foobar.exe')
}
def "provides decent feedback for invalid java home"() {
given:
def someHome = tmpDir.createDir("someHome")
when:
Jvm.forHome(someHome)
then:
def ex = thrown(JavaHomeException)
ex.message.contains('someHome')
}
def "provides basic validation for java home"() {
when:
Jvm.forHome(new File('i dont exist'))
then:
thrown(IllegalArgumentException)
}
def "describes accurately when created for supplied java home"() {
def jdkDir = tmpDir.createDir('dummyFolder')
jdkDir.create {
bin {
file 'java'
}
}
when:
def jvm = new Jvm(os, jdkDir, "1.8.0", JavaVersion.VERSION_1_8)
then:
jvm.toString().contains('dummyFolder')
}
def "locates MAC OS JDK9 install when java.home points to an EAP JDK 1.9 installation"() {
given:
OperatingSystem macOs = new OperatingSystem.MacOs()
TestFile software = tmpDir.createDir('software')
//http://openjdk.java.net/jeps/220
software.create {
Contents {
Home {
bin {
file 'java'
file 'javac'
file 'javadoc'
}
conf {
'logging.properties'
}
lib {
}
}
}
}
when:
System.properties['java.home'] = software.file('Contents/Home').absolutePath
System.properties['java.version'] = '1.9'
Jvm java9Vm = new Jvm(macOs)
then:
java9Vm.javaHome == software.file('Contents/Home')
java9Vm.javaExecutable == software.file('Contents/Home/bin/java')
java9Vm.javacExecutable == software.file('Contents/Home/bin/javac')
java9Vm.javadocExecutable == software.file('Contents/Home/bin/javadoc')
java9Vm.jre == null
java9Vm.toolsJar == null
java9Vm.standaloneJre == null
}
}