io.github.ascopes.jct.filemanagers.config.JctFileManagerJvmClassPathModuleConfigurer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2022 - 2024, the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.github.ascopes.jct.filemanagers.config;

import io.github.ascopes.jct.compilers.JctCompiler;
import io.github.ascopes.jct.filemanagers.JctFileManager;
import io.github.ascopes.jct.utils.ModuleDiscoverer;
import io.github.ascopes.jct.utils.SpecialLocationUtils;
import io.github.ascopes.jct.utils.StringUtils;
import java.util.Set;
import javax.tools.StandardLocation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Configurer for a file manager that detects and applies classpath paths that contain JPMS modules
 * to the module path.
 *
 * If classpath inheritance or module fixing is disabled in the compiler, this will not run.
 *
 * This fixes some common configuration issues when IDEs invoke JUnit.
 *
 * @author Ashley Scopes
 * @since 0.0.1
 */
public final class JctFileManagerJvmClassPathModuleConfigurer
    implements JctFileManagerConfigurer {

  private static final Logger log = LoggerFactory
      .getLogger(JctFileManagerJvmClassPathModuleConfigurer.class);

  private final JctCompiler compiler;

  /**
   * Initialise the configurer with the desired compiler.
   *
   * @param compiler the compiler to wrap.
   */
  public JctFileManagerJvmClassPathModuleConfigurer(JctCompiler compiler) {
    this.compiler = compiler;
  }

  @Override
  public JctFileManager configure(JctFileManager fileManager) {
    log.debug(
        "Copying any misplaced modules that exist within the class path onto the module path"
    );

    SpecialLocationUtils
        .currentClassPathLocations()
        .stream()
        .peek(loc -> log
            .atTrace()
            .setMessage("Adding {} ({}) to file manager module path (inherited from JVM))")
            .addArgument(() -> StringUtils.quoted(loc.toAbsolutePath()))
            .addArgument(() -> StringUtils.quoted(loc.toUri()))
            .log())
        .map(ModuleDiscoverer::findModulesIn)
        .flatMap(Set::stream)
        .peek(module -> log
            .atDebug()
            .setMessage("Discovered module {}")
            .addArgument(module)
            .log())
        // File manager will pull out the actual modules automatically.
        .forEach(module -> fileManager.addPath(
            StandardLocation.MODULE_PATH,
            module.createPathRoot()
        ));

    return fileManager;
  }

  @Override
  public boolean isEnabled() {
    return compiler.isInheritClassPath() && compiler.isFixJvmModulePathMismatch();
  }
}