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.slf4j.Logger;
026import org.slf4j.LoggerFactory;
027
028/**
029 * Configurer for a file manager that detects and applies classpath paths that contain JPMS modules
030 * to the module path.
031 *
032 * <p>If classpath inheritance or module fixing is disabled in the compiler, this will not run.
033 *
034 * <p>This fixes some common configuration issues when IDEs invoke JUnit.
035 *
036 * @author Ashley Scopes
037 * @since 0.0.1
038 */
039public final class JctFileManagerJvmClassPathModuleConfigurer
040    implements JctFileManagerConfigurer {
041
042  private static final Logger log = LoggerFactory
043      .getLogger(JctFileManagerJvmClassPathModuleConfigurer.class);
044
045  private final JctCompiler compiler;
046
047  /**
048   * Initialise the configurer with the desired compiler.
049   *
050   * @param compiler the compiler to wrap.
051   */
052  public JctFileManagerJvmClassPathModuleConfigurer(JctCompiler compiler) {
053    this.compiler = compiler;
054  }
055
056  @Override
057  public JctFileManager configure(JctFileManager fileManager) {
058    log.debug(
059        "Copying any misplaced modules that exist within the class path onto the module path"
060    );
061
062    SpecialLocationUtils
063        .currentClassPathLocations()
064        .stream()
065        .peek(loc -> log
066            .atTrace()
067            .setMessage("Adding {} ({}) to file manager module path (inherited from JVM))")
068            .addArgument(() -> StringUtils.quoted(loc.toAbsolutePath()))
069            .addArgument(() -> StringUtils.quoted(loc.toUri()))
070            .log())
071        .map(ModuleDiscoverer::findModulesIn)
072        .flatMap(Set::stream)
073        .peek(module -> log
074            .atDebug()
075            .setMessage("Discovered module {}")
076            .addArgument(module)
077            .log())
078        // File manager will pull out the actual modules automatically.
079        .forEach(module -> fileManager.addPath(
080            StandardLocation.MODULE_PATH,
081            module.createPathRoot()
082        ));
083
084    return fileManager;
085  }
086
087  @Override
088  public boolean isEnabled() {
089    return compiler.isInheritClassPath() && compiler.isFixJvmModulePathMismatch();
090  }
091}