Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,36 @@ public Object inrange(List<Object> args) {
String range = ConditionParser.toString(args.get(1));
return versionParser.parseVersionRange(range).contains(versionParser.parseVersion(version));
}

/**
* Checks whether a given executable can be found in the system PATH, or – if an
* absolute / relative path is supplied – whether that path itself is an executable file.
*
* <p>Usage examples in a profile {@code <condition>}:
* <pre>
* executable('musl-gcc')
* executable('x86_64-linux-musl-gcc')
* executable('/usr/bin/musl-gcc')
* </pre>
*
* <p>When a plain name (without path separators) is given the function searches every
* directory listed in the {@code PATH} environment variable. On Windows, the platform
* executable extensions ({@code .exe}, {@code .cmd}, {@code .bat}, {@code .com}) are
* tried automatically when the name does not already carry an extension.
*
* @param args A list containing a single string argument: the executable name or path
* @return {@code true} if the executable is found and is a regular, executable file,
* {@code false} otherwise
* @throws IllegalArgumentException if the number of arguments is not exactly one
*/
public Object executable(List<Object> args) {
if (args.size() != 1) {
throw new IllegalArgumentException("executable function requires exactly one argument");
}
String name = ConditionParser.toString(args.get(0));
if (name == null || name.isBlank()) {
return false;
}
return ExecutableFinder.isExecutableInPath(name, context);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.maven.impl.model.profile;

import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import org.apache.maven.api.services.model.ProfileActivationContext;

/**
* Helper that implements the OS-aware PATH search used by the {@code executable()} condition function.
*
* <p>The search strategy is:
* <ol>
* <li>If {@code name} contains a path separator (i.e. it already looks like a path), treat it as
* an absolute or relative file path and check it directly.</li>
* <li>Otherwise, retrieve the {@code PATH} value from the activation context's system properties
* (Maven normalises env vars to {@code env.PATH} / {@code env.Path} etc.) and split it by the
* platform path separator. Each directory is searched in order.</li>
* <li>On Windows, when the candidate does not already have one of the known executable extensions
* ({@code .exe}, {@code .cmd}, {@code .bat}, {@code .com}), those extensions are appended and
* tried as well.</li>
* </ol>
*
* @since 4.x
*/
class ExecutableFinder {

/** Windows-specific executable file extensions, in search order. */
private static final String[] WINDOWS_EXTENSIONS = {".exe", ".cmd", ".bat", ".com"};

/** The system property key under which Maven exposes the {@code PATH} environment variable. */
private static final String ENV_PATH_KEY = "env.PATH";

private ExecutableFinder() {}

/**
* Returns {@code true} when {@code name} resolves to an executable file.
*
* @param name the executable name (e.g. {@code "musl-gcc"}) or an absolute/relative path
* @param context the current profile activation context
* @return {@code true} if the executable is found and is a regular, executable file
*/
static boolean isExecutableInPath(String name, ProfileActivationContext context) {
boolean isWindows = isWindows();

// If the name already contains a path separator treat it as a direct path.
if (name.contains("/") || name.contains(File.separator)) {
Path candidate = Paths.get(name);
return isExecutableFile(candidate, isWindows);
}

// --- plain name: search PATH ---
String pathValue = getPathValue(context);
if (pathValue == null || pathValue.isBlank()) {
return false;
}

String[] dirs = pathValue.split(File.pathSeparator, -1);
for (String dir : dirs) {
if (dir.isBlank()) {
continue;
}
Path base = Paths.get(dir).resolve(name);
if (isExecutableFile(base, isWindows)) {
return true;
}
// On Windows also try known executable extensions (unless already present).
if (isWindows && !hasWindowsExtension(name)) {
for (String ext : WINDOWS_EXTENSIONS) {
Path withExt = Paths.get(dir).resolve(name + ext);
if (isExecutableFile(withExt, isWindows)) {
return true;
}
}
}
}
return false;
}

// -----------------------------------------------------------------------
// Package-private helpers (visible to tests)
// -----------------------------------------------------------------------

/**
* Retrieves the PATH value from the activation context.
*
* <p>Maven places env vars in system properties as {@code env.<NAME>}. On Windows, env var names
* are normalised to upper-case, so we first try {@code env.PATH} and fall back to a direct
* {@link System#getenv(String)} call to handle edge cases.
*
* @param context the profile activation context
* @return the raw PATH string, or {@code null} if not available
*/
static String getPathValue(ProfileActivationContext context) {
// Maven stores env vars as "env.<NAME>" (upper-cased on Windows)
String pathValue = context.getSystemProperty(ENV_PATH_KEY);
if (pathValue == null) {
// Fallback: try the OS environment directly (works in tests that do not populate
// env-based system properties).
pathValue = System.getenv("PATH");
}
return pathValue;
}

/**
* Returns the list of candidate names to probe for a given executable name on the current OS.
* On Windows the known executable extensions are appended when the name has none.
*
* @param name the bare executable name (no directory part)
* @param isWindows whether the current OS is Windows
* @return ordered list of candidate file names to probe in each PATH directory
*/
static List<String> candidateNames(String name, boolean isWindows) {
List<String> candidates = new ArrayList<>();
candidates.add(name);
if (isWindows && !hasWindowsExtension(name)) {
for (String ext : WINDOWS_EXTENSIONS) {
candidates.add(name + ext);
}
}
return candidates;
}

// -----------------------------------------------------------------------
// Private utilities
// -----------------------------------------------------------------------

private static boolean isWindows() {
return System.getProperty("os.name", "").toLowerCase(Locale.ROOT).contains("windows");
}

/**
* Returns {@code true} if {@code path} is a regular file that the JVM considers executable.
* On Windows, any regular file is treated as potentially executable (the OS itself uses the
* extension to decide); the {@link Files#isExecutable} check is still applied so that
* read-only / locked files are excluded.
*/
private static boolean isExecutableFile(Path path, boolean isWindows) {
if (!Files.isRegularFile(path)) {
return false;
}
// On Windows Files.isExecutable() always returns true for regular files – that is fine
// because we are already filtering by extension in the caller. On Unix we rely on the
// execute bit.
return isWindows || Files.isExecutable(path);
}

private static boolean hasWindowsExtension(String name) {
String lower = name.toLowerCase(Locale.ROOT);
for (String ext : WINDOWS_EXTENSIONS) {
if (lower.endsWith(ext)) {
return true;
}
}
return false;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -490,4 +490,80 @@ protected ProfileActivationContext newFileContext(Path path) {
protected ProfileActivationContext newFileContext() {
return newFileContext(tempDir);
}

// -----------------------------------------------------------------------
// executable() tests (MNG-8768)
// -----------------------------------------------------------------------

/**
* Puts a fake executable into a temporary directory and activates a profile only when
* that directory is on the PATH – confirming the PATH-search logic end-to-end.
*/
@Test
void testExecutablePresentInPath() throws Exception {
// Create a fake executable in the temp dir
Path fakeExec = tempDir.resolve("my-fake-tool");
Files.createFile(fakeExec);
// Make it executable on POSIX systems; on Windows Files.isExecutable() returns true anyway
fakeExec.toFile().setExecutable(true);

String pathValue = tempDir.toAbsolutePath().toString();
Map<String, String> sysProps = Map.of("env.PATH", pathValue);

Profile profile = newProfile("executable('my-fake-tool')");
assertActivation(true, profile, newContext(null, sysProps));
}

/**
* Verifies that the function returns false for a name that is definitely not on PATH.
*/
@Test
void testExecutableNotInPath() {
// Use an empty/nonexistent PATH so that nothing can be found
Map<String, String> sysProps = Map.of("env.PATH", "");

Profile profile = newProfile("executable('this-tool-does-not-exist-anywhere-42')");
assertActivation(false, profile, newContext(null, sysProps));
}

/**
* An absolute path to an existing executable file must resolve to true.
*/
@Test
void testExecutableWithAbsolutePath() throws Exception {
Path fakeExec = tempDir.resolve("abs-tool");
Files.createFile(fakeExec);
fakeExec.toFile().setExecutable(true);

String absPath = fakeExec.toAbsolutePath().toString().replace('\\', '/');
Profile profile = newProfile("executable('" + absPath + "')");

// PATH content does not matter for absolute paths
assertActivation(true, profile, newContext(null, Map.of("env.PATH", "")));
}

/**
* An absolute path to a non-existent file must resolve to false.
*/
@Test
void testExecutableAbsolutePathMissing() {
Profile profile = newProfile("executable('/no/such/executable/path/42/bin/tool')");
assertActivation(false, profile, newContext(null, Map.of("env.PATH", "")));
}

/**
* not(executable(...)) must invert the result correctly.
*/
@Test
void testExecutableNegated() throws Exception {
Path fakeExec = tempDir.resolve("neg-tool");
Files.createFile(fakeExec);
fakeExec.toFile().setExecutable(true);

String pathValue = tempDir.toAbsolutePath().toString();
Map<String, String> sysProps = Map.of("env.PATH", pathValue);

assertActivation(false, newProfile("not(executable('neg-tool'))"), newContext(null, sysProps));
assertActivation(true, newProfile("not(executable('no-such-neg-tool'))"), newContext(null, sysProps));
}
}
Loading