001/* 002 * Copyright (C) 2022 - 2024, the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package io.github.ascopes.jct.filemanagers.config; 017 018import io.github.ascopes.jct.compilers.JctCompiler; 019import io.github.ascopes.jct.filemanagers.JctFileManager; 020import io.github.ascopes.jct.utils.ModuleDiscoverer; 021import io.github.ascopes.jct.utils.SpecialLocationUtils; 022import io.github.ascopes.jct.utils.StringUtils; 023import java.util.Set; 024import javax.tools.StandardLocation; 025import org.apiguardian.api.API; 026import org.apiguardian.api.API.Status; 027import org.slf4j.Logger; 028import org.slf4j.LoggerFactory; 029 030/** 031 * Configurer for a file manager that detects and applies classpath paths that contain JPMS modules 032 * to the module path. 033 * 034 * <p>If classpath inheritance or module fixing is disabled in the compiler, this will not run. 035 * 036 * <p>This fixes some common configuration issues when IDEs invoke JUnit. 037 * 038 * @author Ashley Scopes 039 * @since 0.0.1 040 */ 041@API(since = "0.0.1", status = Status.STABLE) 042public final class JctFileManagerJvmClassPathModuleConfigurer 043 implements JctFileManagerConfigurer { 044 045 private static final Logger log = LoggerFactory 046 .getLogger(JctFileManagerJvmClassPathModuleConfigurer.class); 047 048 private final JctCompiler compiler; 049 050 /** 051 * Initialise the configurer with the desired compiler. 052 * 053 * @param compiler the compiler to wrap. 054 */ 055 public JctFileManagerJvmClassPathModuleConfigurer(JctCompiler compiler) { 056 this.compiler = compiler; 057 } 058 059 @Override 060 public JctFileManager configure(JctFileManager fileManager) { 061 log.debug( 062 "Copying any misplaced modules that exist within the class path onto the module path" 063 ); 064 065 SpecialLocationUtils 066 .currentClassPathLocations() 067 .stream() 068 .peek(loc -> log 069 .atTrace() 070 .setMessage("Adding {} ({}) to file manager module path (inherited from JVM))") 071 .addArgument(() -> StringUtils.quoted(loc.toAbsolutePath())) 072 .addArgument(() -> StringUtils.quoted(loc.toUri())) 073 .log()) 074 .map(ModuleDiscoverer::findModulesIn) 075 .flatMap(Set::stream) 076 .peek(module -> log 077 .atDebug() 078 .setMessage("Discovered module {}") 079 .addArgument(module) 080 .log()) 081 // File manager will pull out the actual modules automatically. 082 .forEach(module -> fileManager.addPath( 083 StandardLocation.MODULE_PATH, 084 module.createPathRoot() 085 )); 086 087 return fileManager; 088 } 089 090 @Override 091 public boolean isEnabled() { 092 return compiler.isInheritClassPath() && compiler.isFixJvmModulePathMismatch(); 093 } 094}