Quote and clean path in the process command list

This commit is contained in:
Erik C. Thauvin 2025-03-24 10:06:41 -07:00
parent 7d5b50641c
commit e6d5c6c38f
Signed by: erik
GPG key ID: 776702A6A2DA330E

View file

@ -28,6 +28,7 @@ import java.nio.file.Path;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.List; import java.util.List;
import java.util.Locale;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.logging.Logger; import java.util.logging.Logger;
@ -55,6 +56,8 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
"snakeyaml-engine-", "snakeyaml-engine-",
"trove4j-"); "trove4j-");
private static final Logger LOGGER = Logger.getLogger(DetektOperation.class.getName()); private static final Logger LOGGER = Logger.getLogger(DetektOperation.class.getName());
private static final String OS_NAME =
System.getProperty("os.name") != null ? System.getProperty("os.name").toLowerCase(Locale.US) : null;
private final Collection<File> classpath_ = new ArrayList<>(); private final Collection<File> classpath_ = new ArrayList<>();
private final Collection<File> config_ = new ArrayList<>(); private final Collection<File> config_ = new ArrayList<>();
private final Collection<String> excludes_ = new ArrayList<>(); private final Collection<String> excludes_ = new ArrayList<>();
@ -290,6 +293,17 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
return classPath(paths.stream().map(File::new).toList()); return classPath(paths.stream().map(File::new).toList());
} }
private String cleanPath(File path) {
return cleanPath(path.getAbsolutePath());
}
private String cleanPath(String path) {
if (isWindows()) {
return path.replaceAll("\\\\", "\\\\\\\\");
}
return path;
}
/** /**
* Paths to the config files ({@code path/to/config.yml}). * Paths to the config files ({@code path/to/config.yml}).
* *
@ -323,7 +337,6 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
return configStrings(List.of(configs)); return configStrings(List.of(configs));
} }
/** /**
* Paths to the config files ({@code path/to/config.yml}). * Paths to the config files ({@code path/to/config.yml}).
* *
@ -509,7 +522,7 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
if (project_ != null) { if (project_ != null) {
args.add(javaTool()); args.add(javaTool());
args.add("-cp"); args.add("-cp");
args.add(getDetektJarList(project_.libBldDirectory())); args.add('"' + getDetektJarList(project_.libBldDirectory()) + '"');
args.add("io.gitlab.arturbosch.detekt.cli.Main"); args.add("io.gitlab.arturbosch.detekt.cli.Main");
// all-rules // all-rules
@ -525,13 +538,13 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
// base-path // base-path
if (isNotBlank(basePath_)) { if (isNotBlank(basePath_)) {
args.add("--base-path"); args.add("--base-path");
args.add(basePath_); args.add('"' + cleanPath(basePath_) + '"');
} }
// baseline // baseline
if (isNotBlank(baseline_)) { if (isNotBlank(baseline_)) {
args.add("--baseline"); args.add("--baseline");
args.add(baseline_); args.add('"' + cleanPath(baseline_) + '"');
} }
// build-upon-default-config // build-upon-default-config
@ -542,19 +555,20 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
// classpath // classpath
if (!classpath_.isEmpty()) { if (!classpath_.isEmpty()) {
args.add("--classpath"); args.add("--classpath");
args.add(String.join(File.pathSeparator, classpath_.stream().map(File::getAbsolutePath).toList())); args.add('"' + String.join(':' + File.pathSeparator, classpath_.stream().map(this::cleanPath).toList())
+ '"');
} }
// config // config
if (!config_.isEmpty()) { if (!config_.isEmpty()) {
args.add("-config"); args.add("-config");
args.add(String.join(";", config_.stream().map(File::getAbsolutePath).toList())); args.add('"' + String.join(";", config_.stream().map(this::cleanPath).toList()) + '"');
} }
// config-resource // config-resource
if (isNotBlank(configResource_)) { if (isNotBlank(configResource_)) {
args.add("--config-resource"); args.add("--config-resource");
args.add(configResource_); args.add('"' + cleanPath(configResource_) + '"');
} }
// create-baseline // create-baseline
@ -575,7 +589,7 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
// excludes // excludes
if (!excludes_.isEmpty()) { if (!excludes_.isEmpty()) {
args.add("--excludes"); args.add("--excludes");
args.add(String.join(",", excludes_)); args.add('"' + String.join(",", excludes_.stream().map(this::cleanPath).toList()) + '"');
} }
// generate-config // generate-config
@ -586,19 +600,19 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
// includes // includes
if (!includes_.isEmpty()) { if (!includes_.isEmpty()) {
args.add("--includes"); args.add("--includes");
args.add(String.join(",", includes_)); args.add('"' + String.join(",", includes_.stream().map(this::cleanPath).toList()) + '"');
} }
// input // input
if (!input_.isEmpty()) { if (!input_.isEmpty()) {
args.add("--input"); args.add("--input");
args.add(String.join(",", input_.stream().map(File::getAbsolutePath).toList())); args.add('"' + String.join(",", input_.stream().map(this::cleanPath).toList()) + '"');
} }
// jdk-home // jdk-home
if (isNotBlank(jdkHome_)) { if (isNotBlank(jdkHome_)) {
args.add("--jdk-home"); args.add("--jdk-home");
args.add(jdkHome_); args.add('"' + cleanPath(jdkHome_) + '"');
} }
// jvm-target // jvm-target
@ -627,14 +641,14 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
// plugins // plugins
if (!plugins_.isEmpty()) { if (!plugins_.isEmpty()) {
args.add("--plugins"); args.add("--plugins");
args.add(String.join(",", plugins_.stream().map(File::getAbsolutePath).toList())); args.add('"' + String.join(",", plugins_.stream().map(this::cleanPath).toList()) + '"');
} }
// report // report
if (!report_.isEmpty()) { if (!report_.isEmpty()) {
report_.forEach(it -> { report_.forEach(it -> {
args.add("--report"); args.add("--report");
args.add(it.id().name().toLowerCase() + ":" + it.path()); args.add(it.id().name().toLowerCase() + ":\"" + cleanPath(it.path()) + '"');
}); });
} }
@ -693,7 +707,7 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
if (!f.getName().endsWith("-sources.jar") && !f.getName().endsWith("-javadoc.jar")) { if (!f.getName().endsWith("-sources.jar") && !f.getName().endsWith("-javadoc.jar")) {
for (var m : DETEKT_JARS) { for (var m : DETEKT_JARS) {
if (f.getName().startsWith(m)) { if (f.getName().startsWith(m)) {
jars.add(f.getAbsolutePath()); jars.add(cleanPath(f));
break; break;
} }
} }
@ -819,6 +833,15 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
return s != null && !s.isBlank(); return s != null && !s.isBlank();
} }
/**
* Determines if the current operating system is Windows.
*
* @return true if the operating system is Windows, false otherwise.
*/
private boolean isWindows() {
return OS_NAME != null && OS_NAME.contains("win");
}
/** /**
* EXPERIMENTAL: Use a custom JDK home directory to include into the * EXPERIMENTAL: Use a custom JDK home directory to include into the
* classpath. * classpath.