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