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