001/*
002 * Copyright (C) 2022 - 2023, 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.SpecialLocationUtils;
021import io.github.ascopes.jct.workspaces.impl.WrappingDirectoryImpl;
022import javax.tools.StandardLocation;
023import org.apiguardian.api.API;
024import org.apiguardian.api.API.Status;
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,
033 * this will not run.
034 *
035 * <p>This fixes some common configuration issues when IDEs invoke JUnit.
036 *
037 * @author Ashley Scopes
038 * @since 0.0.1 (0.0.1-M7)
039 */
040@API(since = "0.0.1", status = Status.STABLE)
041public final class JctFileManagerJvmClassPathModuleConfigurer implements JctFileManagerConfigurer {
042
043  private static final Logger LOGGER = LoggerFactory
044      .getLogger(JctFileManagerJvmClassPathModuleConfigurer.class);
045
046  private final JctCompiler<?, ?> compiler;
047
048  /**
049   * Initialise the configurer with the desired compiler.
050   *
051   * @param compiler the compiler to wrap.
052   */
053  public JctFileManagerJvmClassPathModuleConfigurer(JctCompiler<?, ?> compiler) {
054    this.compiler = compiler;
055  }
056
057  @Override
058  public JctFileManager configure(JctFileManager fileManager) {
059    LOGGER.debug(
060        "Copying any misplaced modules that exist within the class path onto the module path"
061    );
062
063    SpecialLocationUtils
064        .currentClassPathLocations()
065        .stream()
066        .peek(
067            loc -> LOGGER.trace("Adding {} to file manager module path (inherited from JVM)", loc))
068        .map(WrappingDirectoryImpl::new)
069        // File manager will pull out the actual modules automatically.
070        .forEach(dir -> fileManager.addPath(StandardLocation.MODULE_PATH, dir));
071
072    return fileManager;
073  }
074
075  @Override
076  public boolean isEnabled() {
077    return compiler.isInheritClassPath() && compiler.isFixJvmModulePathMismatch();
078  }
079}