com.metsci.glimpse.util.ugly.ModuleAccessChecker Maven / Gradle / Ivy
/*
* Copyright (c) 2020, Metron, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Metron, Inc. nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL METRON, INC. BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.metsci.glimpse.util.ugly;
import static com.metsci.glimpse.util.logging.LoggerUtils.getLogger;
import static java.util.Collections.singleton;
import static java.util.logging.Level.SEVERE;
import java.lang.management.ManagementFactory;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.google.common.collect.ImmutableSet;
/**
* Checks whether caller modules have the access they expect to packages in other
* modules. This is useful for detecting missing {@code --add-opens} JVM args, for
* example.
*
* The particular approach used to do the check is unspecified and subject to change.
*/
public class ModuleAccessChecker
{
private static final Logger logger = getLogger( ModuleAccessChecker.class );
protected static class Warning
{
public final String missingJvmArg;
public final Level logLevel;
public Warning( String missingJvmArg, Level logLevel )
{
this.missingJvmArg = missingJvmArg;
this.logLevel = logLevel;
}
@Override
public int hashCode( )
{
int prime = 30671;
int result = 1;
result = prime * result + Objects.hashCode( this.missingJvmArg );
result = prime * result + Objects.hashCode( this.logLevel );
return result;
}
@Override
public boolean equals( Object o )
{
if ( o == this ) return true;
if ( o == null ) return false;
if ( o.getClass( ) != this.getClass( ) ) return false;
Warning other = ( Warning ) o;
return ( Objects.equals( other.missingJvmArg, this.missingJvmArg )
&& Objects.equals( other.logLevel, this.logLevel ) );
}
}
protected static void logWarning( String jvmArg, Level logLevel )
{
logWarnings( singleton( new Warning( jvmArg, logLevel ) ) );
}
protected static void logWarnings( Collection warnings )
{
if ( warnings.size( ) == 1 )
{
Warning warning = warnings.iterator( ).next( );
logger.log( warning.logLevel, "Missing expected JVM arg: " + warning.missingJvmArg );
}
else if ( warnings.size( ) > 1 )
{
StringBuilder message = new StringBuilder( "Missing expected JVM args: " );
Level maxLogLevel = null;
for ( Warning warning : warnings )
{
message.append( System.lineSeparator( ) );
message.append( " " );
message.append( warning.missingJvmArg );
if ( maxLogLevel == null || warning.logLevel.intValue( ) > maxLogLevel.intValue( ) )
{
maxLogLevel = warning.logLevel;
}
}
logger.log( maxLogLevel, message.toString( ) );
}
}
protected static final ThreadLocal> activeWarnings = new ThreadLocal<>( );
public static void coalesceModuleAccessWarnings( Runnable task )
{
if ( activeWarnings.get( ) != null )
{
// Already inside a coalescer
task.run( );
}
else
{
LinkedHashSet warnings = new LinkedHashSet<>( );
activeWarnings.set( warnings );
try
{
task.run( );
logWarnings( warnings );
}
finally
{
activeWarnings.set( null );
}
}
}
protected static final ImmutableSet jvmArgs = ImmutableSet.copyOf( ManagementFactory.getRuntimeMXBean( ).getInputArguments( ) );
protected static final Set checkedJvmArgs = ConcurrentHashMap.newKeySet( );
protected static void expectJvmArg( String jvmArg, Level logLevel )
{
if ( checkedJvmArgs.add( jvmArg ) && !jvmArgs.contains( jvmArg ) )
{
Set warnings = activeWarnings.get( );
if ( warnings == null )
{
// No active coalescer, so log the warning immediately
logWarning( jvmArg, logLevel );
}
else
{
// Defer the warning until the end of the active coalescer
warnings.add( new Warning( jvmArg, logLevel ) );
}
}
}
protected static final boolean jvmSupportsModules = doesJvmSupportModules( );
protected static boolean doesJvmSupportModules( )
{
try
{
Class.forName( "java.lang.Module" );
return true;
}
catch ( ClassNotFoundException e )
{
return false;
}
}
public static void expectInternalApiAccess( Class fromClass, String toModuleName, String toPackageName )
{
expectAccess( "--add-exports", fromClass, toModuleName, toPackageName, SEVERE );
}
public static void expectInternalApiAccess( Class fromClass, String toModuleName, String toPackageName, Level logLevel )
{
expectAccess( "--add-exports", fromClass, toModuleName, toPackageName, logLevel );
}
public static void expectDeepReflectiveAccess( Class fromClass, String toModuleName, String toPackageName )
{
expectAccess( "--add-opens", fromClass, toModuleName, toPackageName, SEVERE );
}
public static void expectDeepReflectiveAccess( Class fromClass, String toModuleName, String toPackageName, Level logLevel )
{
expectAccess( "--add-opens", fromClass, toModuleName, toPackageName, logLevel );
}
protected static void expectAccess( String jvmFlag, Class fromClass, String toModuleName, String toPackageName, Level logLevel )
{
if ( jvmSupportsModules )
{
String fromModuleName = getModuleName( fromClass );
String jvmArg = jvmFlag + "=" + toModuleName + "/" + toPackageName + "=" + ( fromModuleName != null ? fromModuleName : "ALL-UNNAMED" );
expectJvmArg( jvmArg, logLevel );
}
}
/**
* Returns the name of the module that contains the given class, or null if
* the given class is not contained in a named module (either because it is
* in the unnamed pseudo-module, or because the running JVM does not support
* modules).
*/
protected static String getModuleName( Class clazz )
{
try
{
Object module = Class.class.getMethod( "getModule" ).invoke( clazz );
Object moduleName = Class.forName( "java.lang.Module" ).getMethod( "getName" ).invoke( module );
return ( ( String ) moduleName );
}
catch ( Exception e )
{
return null;
}
}
}