diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f91f646 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..473a4bf --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,28 @@ +name: CI + +on: + push: + branches: + - "**" + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 17 + + - name: Set up Gradle + uses: gradle/actions/setup-gradle@v4 + + - name: Build and test + run: ./gradlew build diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..9c92f9f --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,33 @@ +name: Publish + +on: + release: + types: + - published + workflow_dispatch: + +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 17 + + - name: Set up Gradle + uses: gradle/actions/setup-gradle@v4 + + - name: Publish to GitHub Packages + env: + GITHUB_ACTOR: ${{ github.actor }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_REPOSITORY: ${{ github.repository }} + run: ./gradlew publish diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5c4ac6d --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build + +# Ignore Kotlin plugin data +.kotlin diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..441623f --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,107 @@ +import org.gradle.api.tasks.testing.logging.TestExceptionFormat +import org.gradle.jvm.tasks.Jar + +plugins { + `java-library` + `maven-publish` +} + +repositories { + mavenCentral() +} + +val javacExports = listOf( + "jdk.compiler/com.sun.tools.javac.api", + "jdk.compiler/com.sun.tools.javac.code", + "jdk.compiler/com.sun.tools.javac.tree", + "jdk.compiler/com.sun.tools.javac.util", +) + +val java8Compiler = javaToolchains.compilerFor { + languageVersion = JavaLanguageVersion.of(8) +} + +dependencies { + compileOnly(files(java8Compiler.map { it.metadata.installationPath.file("lib/tools.jar") })) + testImplementation(libs.junit.jupiter) + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } + withSourcesJar() +} + +tasks.named("compileJava") { + javaCompiler = java8Compiler + sourceCompatibility = JavaVersion.VERSION_1_8.toString() + targetCompatibility = JavaVersion.VERSION_1_8.toString() +} + +tasks.named("compileTestJava") { + sourceCompatibility = JavaVersion.VERSION_17.toString() + targetCompatibility = JavaVersion.VERSION_17.toString() +} + +tasks.withType().configureEach { + useJUnitPlatform() + jvmArgs(javacExports.map { export -> "--add-exports=$export=ALL-UNNAMED" }) + testLogging { + exceptionFormat = TestExceptionFormat.FULL + } +} + +tasks.named("jar") { + manifest { + attributes["Automatic-Module-Name"] = "net.ikvm.javarefplugin" + } +} + +publishing { + publications { + create("mavenJava") { + from(components["java"]) + artifactId = rootProject.name + pom { + name = "java-ref-plugin" + description = project.description.toString() + url = "https://github.com/ikvmnet/java-ref-plugin" + licenses { + license { + name = "MIT License" + url = "https://opensource.org/licenses/MIT" + } + } + developers { + developer { + id = "ikvmnet" + name = "IKVM" + } + } + scm { + connection = "scm:git:https://github.com/ikvmnet/java-ref-plugin.git" + developerConnection = "scm:git:ssh://git@github.com/ikvmnet/java-ref-plugin.git" + url = "https://github.com/ikvmnet/java-ref-plugin" + } + } + } + } + repositories { + maven { + name = "GitHubPackages" + val repositoryPath = providers.environmentVariable("GITHUB_REPOSITORY") + .orElse("ikvmnet/java-ref-plugin") + url = uri("https://maven.pkg.github.com/${repositoryPath.get()}") + credentials { + username = providers.gradleProperty("githubUsername") + .orElse(providers.environmentVariable("GITHUB_ACTOR")) + .orNull + password = providers.gradleProperty("githubToken") + .orElse(providers.environmentVariable("GITHUB_TOKEN")) + .orNull + } + } + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..112c2e4 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +org.gradle.configuration-cache=true +group=net.ikvm +version=0.1.0-SNAPSHOT +description=Javac plugin that rewrites concrete method bodies into NoSuchMethodError throws for reference-only API artifacts. diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..6b19d51 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,5 @@ +[versions] +junit-jupiter = "6.0.1" + +[libraries] +junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..df6a6ad --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..b9bb139 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original 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 +# +# https://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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..24c62d5 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..7466a45 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,5 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" +} + +rootProject.name = "java-ref-plugin" diff --git a/src/main/java/net/ikvm/javarefplugin/JavaRefPlugin.java b/src/main/java/net/ikvm/javarefplugin/JavaRefPlugin.java new file mode 100644 index 0000000..2961b5d --- /dev/null +++ b/src/main/java/net/ikvm/javarefplugin/JavaRefPlugin.java @@ -0,0 +1,46 @@ +package net.ikvm.javarefplugin; + +import com.sun.source.util.JavacTask; +import com.sun.source.util.Plugin; +import com.sun.source.util.TaskEvent; +import com.sun.source.util.TaskListener; +import com.sun.tools.javac.api.BasicJavacTask; +import com.sun.tools.javac.util.Context; +import java.util.Collections; +import java.util.IdentityHashMap; +import java.util.Set; + +public final class JavaRefPlugin implements Plugin { + + public static final String NAME = "JavaRef"; + + @Override + public String getName() { + return NAME; + } + + @Override + public void init(JavacTask task, String... args) { + Context context = ((BasicJavacTask) task).getContext(); + MethodBodyStripper stripper = new MethodBodyStripper(context); + Set processedUnits = Collections.newSetFromMap(new IdentityHashMap<>()); + + task.addTaskListener(new TaskListener() { + @Override + public void started(TaskEvent event) { + } + + @Override + public void finished(TaskEvent event) { + if (event.getKind() != TaskEvent.Kind.ENTER) { + return; + } + + Object unit = event.getCompilationUnit(); + if (unit != null && processedUnits.add(unit)) { + stripper.strip(unit); + } + } + }); + } +} diff --git a/src/main/java/net/ikvm/javarefplugin/MethodBodyStripper.java b/src/main/java/net/ikvm/javarefplugin/MethodBodyStripper.java new file mode 100644 index 0000000..3cc3e0f --- /dev/null +++ b/src/main/java/net/ikvm/javarefplugin/MethodBodyStripper.java @@ -0,0 +1,128 @@ +package net.ikvm.javarefplugin; + +import com.sun.tools.javac.code.Flags; +import com.sun.tools.javac.tree.JCTree; +import com.sun.tools.javac.tree.TreeMaker; +import com.sun.tools.javac.tree.TreeTranslator; +import com.sun.tools.javac.util.Context; +import com.sun.tools.javac.util.List; +import com.sun.tools.javac.util.ListBuffer; +import com.sun.tools.javac.util.Name; +import com.sun.tools.javac.util.Names; + +final class MethodBodyStripper extends TreeTranslator { + + private static final String STRIPPED_MESSAGE = "Method body stripped by JavaRef plugin."; + + private final TreeMaker maker; + private final Names names; + private boolean inAnnotationType; + + MethodBodyStripper(Context context) { + this.maker = TreeMaker.instance(context); + this.names = Names.instance(context); + } + + void strip(Object compilationUnit) { + ((JCTree) compilationUnit).accept(this); + } + + @Override + public void visitClassDef(JCTree.JCClassDecl tree) { + boolean previousInAnnotationType = inAnnotationType; + inAnnotationType = (tree.mods.flags & Flags.ANNOTATION) != 0; + super.visitClassDef(tree); + inAnnotationType = previousInAnnotationType; + result = tree; + } + + @Override + public void visitMethodDef(JCTree.JCMethodDecl tree) { + super.visitMethodDef(tree); + + if (tree.body == null || inAnnotationType || shouldKeepBody(tree)) { + result = tree; + return; + } + + tree.body = maker.Block(0, replacementStatements(tree)); + result = tree; + } + + private boolean shouldKeepBody(JCTree.JCMethodDecl tree) { + long flags = tree.mods.flags; + if ((flags & (Flags.ABSTRACT | Flags.NATIVE)) != 0) { + return true; + } + + return (flags & Flags.SYNTHETIC) != 0 && !isConstructor(tree); + } + + private boolean isConstructor(JCTree.JCMethodDecl tree) { + return tree.name == names.init; + } + + private List replacementStatements(JCTree.JCMethodDecl tree) { + ListBuffer statements = new ListBuffer<>(); + + if (isConstructor(tree)) { + JCTree.JCStatement constructorInvocation = findConstructorInvocation(tree.body.stats); + if (constructorInvocation != null) { + statements.append(constructorInvocation); + } + } + + statements.append( + maker.Throw( + maker.NewClass( + null, + List.nil(), + memberAccess("java.lang.NoSuchMethodError"), + List.of(maker.Literal(STRIPPED_MESSAGE)), + null + ) + ) + ); + + return statements.toList(); + } + + private JCTree.JCStatement findConstructorInvocation(List statements) { + if (statements.isEmpty()) { + return null; + } + + JCTree.JCStatement first = statements.head; + if (first instanceof JCTree.JCExpressionStatement) { + JCTree.JCExpressionStatement expressionStatement = (JCTree.JCExpressionStatement) first; + if (!(expressionStatement.expr instanceof JCTree.JCMethodInvocation)) { + return null; + } + + JCTree.JCMethodInvocation invocation = (JCTree.JCMethodInvocation) expressionStatement.expr; + Name invokedName = null; + if (invocation.meth instanceof JCTree.JCIdent) { + JCTree.JCIdent ident = (JCTree.JCIdent) invocation.meth; + invokedName = ident.name; + } else if (invocation.meth instanceof JCTree.JCFieldAccess) { + JCTree.JCFieldAccess fieldAccess = (JCTree.JCFieldAccess) invocation.meth; + invokedName = fieldAccess.name; + } + + if (invokedName == names._this || invokedName == names._super) { + return first; + } + } + + return null; + } + + private JCTree.JCExpression memberAccess(String qualifiedName) { + String[] elements = qualifiedName.split("\\."); + JCTree.JCExpression expression = maker.Ident(names.fromString(elements[0])); + for (int i = 1; i < elements.length; i++) { + expression = maker.Select(expression, names.fromString(elements[i])); + } + return expression; + } +} diff --git a/src/main/resources/META-INF/services/com.sun.source.util.Plugin b/src/main/resources/META-INF/services/com.sun.source.util.Plugin new file mode 100644 index 0000000..e7d8ddf --- /dev/null +++ b/src/main/resources/META-INF/services/com.sun.source.util.Plugin @@ -0,0 +1 @@ +net.ikvm.javarefplugin.JavaRefPlugin diff --git a/src/test/java/net/ikvm/javarefplugin/JavaRefPluginTest.java b/src/test/java/net/ikvm/javarefplugin/JavaRefPluginTest.java new file mode 100644 index 0000000..35a5466 --- /dev/null +++ b/src/test/java/net/ikvm/javarefplugin/JavaRefPluginTest.java @@ -0,0 +1,248 @@ +package net.ikvm.javarefplugin; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.io.InputStream; +import java.lang.invoke.MethodHandle; +import java.lang.invoke.MethodHandles; +import java.lang.invoke.MethodType; +import java.lang.reflect.InvocationTargetException; +import java.net.URL; +import java.net.URLClassLoader; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import javax.tools.Diagnostic; +import javax.tools.DiagnosticCollector; +import javax.tools.JavaCompiler; +import javax.tools.JavaFileObject; +import javax.tools.StandardJavaFileManager; +import javax.tools.ToolProvider; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +class JavaRefPluginTest { + + @TempDir + Path tempDir; + + @Test + void stripsStaticMethodsAndConstructorsWhileKeepingFields() throws Exception { + CompilationResult result = compile( + Map.of( + "example/Sample.java", + """ + package example; + + public class Sample { + public static final String CONSTANT = "hello"; + + public Sample() { + } + + public static String greeting() { + return CONSTANT; + } + } + """ + ) + ); + + Class sampleClass = result.loadClass("example.Sample"); + + assertNotNull(sampleClass.getField("CONSTANT")); + assertEquals("hello", sampleClass.getField("CONSTANT").get(null)); + + InvocationTargetException staticFailure = + assertThrows(InvocationTargetException.class, () -> sampleClass.getMethod("greeting").invoke(null)); + assertTrue(staticFailure.getCause() instanceof NoSuchMethodError); + + InvocationTargetException constructorFailure = + assertThrows(InvocationTargetException.class, () -> sampleClass.getConstructor().newInstance()); + assertTrue(constructorFailure.getCause() instanceof NoSuchMethodError); + } + + @Test + void keepsExplicitConstructorChainingValid() throws Exception { + CompilationResult result = compile( + Map.of( + "example/Base.java", + """ + package example; + + public class Base { + public Base(String name) { + } + } + """, + "example/Child.java", + """ + package example; + + public class Child extends Base { + public Child() { + super("parent"); + } + } + """ + ) + ); + + Class childClass = result.loadClass("example.Child"); + InvocationTargetException constructorFailure = + assertThrows(InvocationTargetException.class, () -> childClass.getConstructor().newInstance()); + assertTrue(constructorFailure.getCause() instanceof NoSuchMethodError); + } + + @Test + void stripsInterfaceDefaultAndStaticMethods() throws Exception { + CompilationResult result = compile( + Map.of( + "example/SampleInterface.java", + """ + package example; + + public interface SampleInterface { + default String value() { + return "value"; + } + + static String helper() { + return "helper"; + } + } + """ + ) + ); + + Class interfaceClass = result.loadClass("example.SampleInterface"); + + InvocationTargetException staticFailure = + assertThrows(InvocationTargetException.class, () -> interfaceClass.getMethod("helper").invoke(null)); + assertTrue(staticFailure.getCause() instanceof NoSuchMethodError); + + Object proxy = java.lang.reflect.Proxy.newProxyInstance( + result.classLoader(), + new Class[] { interfaceClass }, + (instance, method, arguments) -> { + throw new UnsupportedOperationException(method.getName()); + } + ); + + MethodHandle handle = MethodHandles.privateLookupIn(interfaceClass, MethodHandles.lookup()) + .findSpecial(interfaceClass, "value", MethodType.methodType(String.class), interfaceClass) + .bindTo(proxy); + + NoSuchMethodError defaultFailure = assertThrows(NoSuchMethodError.class, handle::invokeWithArguments); + assertEquals("Method body stripped by JavaRef plugin.", defaultFailure.getMessage()); + } + + @Test + void stripsImplicitDefaultConstructors() throws Exception { + CompilationResult result = compile( + Map.of( + "example/ImplicitConstructor.java", + """ + package example; + + public class ImplicitConstructor { + } + """ + ) + ); + + Class type = result.loadClass("example.ImplicitConstructor"); + InvocationTargetException constructorFailure = + assertThrows(InvocationTargetException.class, () -> type.getConstructor().newInstance()); + assertTrue(constructorFailure.getCause() instanceof NoSuchMethodError); + } + + @Test + void pluginClassesTargetJava8Bytecode() throws Exception { + assertEquals(52, classFileMajorVersion(JavaRefPlugin.class)); + assertEquals(52, classFileMajorVersion(MethodBodyStripper.class)); + } + + private CompilationResult compile(Map sources) throws IOException { + JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); + DiagnosticCollector diagnostics = new DiagnosticCollector<>(); + Path sourceDirectory = Files.createDirectories(tempDir.resolve("src")); + Path classesDirectory = Files.createDirectories(tempDir.resolve("classes")); + List sourceFiles = new ArrayList<>(); + + for (Map.Entry source : sources.entrySet()) { + Path file = sourceDirectory.resolve(source.getKey()); + Files.createDirectories(file.getParent()); + Files.writeString(file, source.getValue(), StandardCharsets.UTF_8); + sourceFiles.add(file.toFile()); + } + + try (StandardJavaFileManager fileManager = compiler.getStandardFileManager(diagnostics, null, StandardCharsets.UTF_8)) { + Iterable units = fileManager.getJavaFileObjectsFromFiles(sourceFiles); + List options = List.of( + "-proc:none", + "-classpath", + System.getProperty("java.class.path"), + "-d", + classesDirectory.toString(), + "-Xplugin:" + JavaRefPlugin.NAME + ); + Boolean success = compiler.getTask(null, fileManager, diagnostics, options, null, units).call(); + + assertTrue(Boolean.TRUE.equals(success), () -> diagnostics.getDiagnostics() + .stream() + .map(JavaRefPluginTest::formatDiagnostic) + .collect(Collectors.joining(System.lineSeparator()))); + } + + return new CompilationResult(classesDirectory); + } + + private static String formatDiagnostic(Diagnostic diagnostic) { + String source = diagnostic.getSource() == null ? "" : diagnostic.getSource().getName(); + return source + ":" + diagnostic.getLineNumber() + ": " + diagnostic.getMessage(null); + } + + private static int classFileMajorVersion(Class type) throws IOException { + try (InputStream input = type.getResourceAsStream(type.getSimpleName() + ".class")) { + assertNotNull(input); + + byte[] header = new byte[8]; + int offset = 0; + while (offset < header.length) { + int read = input.read(header, offset, header.length - offset); + if (read < 0) { + throw new IOException("Unexpected end of class file for " + type.getName()); + } + offset += read; + } + + return ((header[6] & 0xff) << 8) | (header[7] & 0xff); + } + } + + private static final class CompilationResult { + private final URLClassLoader classLoader; + + private CompilationResult(Path classesDirectory) throws IOException { + URL url = classesDirectory.toUri().toURL(); + this.classLoader = new URLClassLoader(new URL[] { url }, JavaRefPluginTest.class.getClassLoader()); + } + + private Class loadClass(String name) throws Exception { + return Class.forName(name, true, classLoader); + } + + private URLClassLoader classLoader() { + return classLoader; + } + } +}