diff --git a/cli/src/main/java/com/devonfw/tools/ide/common/SystemPath.java b/cli/src/main/java/com/devonfw/tools/ide/common/SystemPath.java index a1bb433b3..d7e0fa975 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/common/SystemPath.java +++ b/cli/src/main/java/com/devonfw/tools/ide/common/SystemPath.java @@ -9,6 +9,7 @@ import java.util.Iterator; import java.util.List; import java.util.Map; +import java.util.regex.Pattern; import java.util.stream.Stream; import com.devonfw.tools.ide.context.IdeContext; @@ -67,7 +68,8 @@ public SystemPath(String envPath, Path softwarePath, char pathSeparator, IdeCont } else { Path duplicate = this.tool2pathMap.putIfAbsent(tool, path); if (duplicate != null) { - context.warning("Duplicated tool path for tool: {} at path: {} with duplicated path: {}.", tool, path, duplicate); + context.warning("Duplicated tool path for tool: {} at path: {} with duplicated path: {}.", tool, path, + duplicate); } } } @@ -211,22 +213,45 @@ public String toString(boolean bash) { return sb.toString(); } - private void appendPath(Path path, StringBuilder sb, char separator, boolean bash) { + private static void appendPath(Path path, StringBuilder sb, char separator, boolean bash) { if (sb.length() > 0) { sb.append(separator); } String pathString = path.toString(); if (bash && (pathString.length() > 3) && (pathString.charAt(1) == ':')) { - char slash = pathString.charAt(2); - if ((slash == '\\') || (slash == '/')) { - char drive = Character.toLowerCase(pathString.charAt(0)); - if ((drive >= 'a') && (drive <= 'z')) { - pathString = "/" + drive + pathString.substring(2).replace('\\', '/'); - } - } + pathString = convertWindowsPathToUnixPath(pathString); } sb.append(pathString); } + /** + * Method to convert a valid Windows path string representation to its corresponding one in Unix format. + * + * @param pathString The Windows path string to convert. + * @return The converted Unix path string. + */ + public static String convertWindowsPathToUnixPath(String pathString) { + + char slash = pathString.charAt(2); + if ((slash == '\\') || (slash == '/')) { + char drive = Character.toLowerCase(pathString.charAt(0)); + if ((drive >= 'a') && (drive <= 'z')) { + pathString = "/" + drive + pathString.substring(2).replace('\\', '/'); + } + } + return pathString; + } + + /** + * Method to validate if a given path string is a Windows path or not + * + * @param pathString The string to check if it is a Windows path string. + * @return {@code true} if it is a valid windows path string, else {@code false}. + */ + public static boolean isValidWindowsPath(String pathString) { + + String windowsFilePathRegEx = "([a-zA-Z]:)?(\\\\[a-zA-Z0-9\\s_.-]+)+\\\\?"; + return Pattern.matches(windowsFilePathRegEx, pathString); + } } diff --git a/cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java b/cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java index cc2f4568c..c21898906 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java +++ b/cli/src/main/java/com/devonfw/tools/ide/context/GitContextImpl.java @@ -17,6 +17,7 @@ import com.devonfw.tools.ide.log.IdeSubLogger; import com.devonfw.tools.ide.process.ProcessContext; import com.devonfw.tools.ide.process.ProcessErrorHandling; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.process.ProcessResult; /** @@ -96,7 +97,7 @@ public void pullOrClone(String gitRepoUrl, Path targetRepository) { initializeProcessContext(targetRepository); if (Files.isDirectory(targetRepository.resolve(".git"))) { // checks for remotes - ProcessResult result = this.processContext.addArg("remote").run(true, false); + ProcessResult result = this.processContext.addArg("remote").run(ProcessMode.DEFAULT_CAPTURE); List remotes = result.getOut(); if (remotes.isEmpty()) { String message = targetRepository @@ -183,7 +184,7 @@ public void clone(GitUrl gitRepoUrl, Path targetRepository) { this.processContext.addArg("-q"); } this.processContext.addArgs("--recursive", parsedUrl, "--config", "core.autocrlf=false", "."); - result = this.processContext.run(true, false); + result = this.processContext.run(ProcessMode.DEFAULT_CAPTURE); if (!result.isSuccessful()) { this.context.warning("Git failed to clone {} into {}.", parsedUrl, targetRepository); } @@ -198,7 +199,7 @@ public void pull(Path targetRepository) { initializeProcessContext(targetRepository); ProcessResult result; // pull from remote - result = this.processContext.addArg("--no-pager").addArg("pull").run(true, false); + result = this.processContext.addArg("--no-pager").addArg("pull").run(ProcessMode.DEFAULT_CAPTURE); if (!result.isSuccessful()) { Map remoteAndBranchName = retrieveRemoteAndBranchName(); @@ -211,7 +212,7 @@ public void pull(Path targetRepository) { private Map retrieveRemoteAndBranchName() { Map remoteAndBranchName = new HashMap<>(); - ProcessResult remoteResult = this.processContext.addArg("branch").addArg("-vv").run(true, false); + ProcessResult remoteResult = this.processContext.addArg("branch").addArg("-vv").run(ProcessMode.DEFAULT_CAPTURE); List remotes = remoteResult.getOut(); if (!remotes.isEmpty()) { for (String remote : remotes) { @@ -242,14 +243,14 @@ public void reset(Path targetRepository, String remoteName, String branchName) { initializeProcessContext(targetRepository); ProcessResult result; // check for changed files - result = this.processContext.addArg("diff-index").addArg("--quiet").addArg("HEAD").run(true, false); + result = this.processContext.addArg("diff-index").addArg("--quiet").addArg("HEAD").run(ProcessMode.DEFAULT_CAPTURE); if (!result.isSuccessful()) { // reset to origin/master context.warning("Git has detected modified files -- attempting to reset {} to '{}/{}'.", targetRepository, remoteName, branchName); - result = this.processContext.addArg("reset").addArg("--hard").addArg(remoteName + "/" + branchName).run(true, - false); + result = this.processContext.addArg("reset").addArg("--hard").addArg(remoteName + "/" + branchName) + .run(ProcessMode.DEFAULT_CAPTURE); if (!result.isSuccessful()) { context.warning("Git failed to reset {} to '{}/{}'.", remoteName, branchName, targetRepository); @@ -265,12 +266,12 @@ public void cleanup(Path targetRepository) { ProcessResult result; // check for untracked files result = this.processContext.addArg("ls-files").addArg("--other").addArg("--directory").addArg("--exclude-standard") - .run(true, false); + .run(ProcessMode.DEFAULT_CAPTURE); if (!result.getOut().isEmpty()) { // delete untracked files context.warning("Git detected untracked files in {} and is attempting a cleanup.", targetRepository); - result = this.processContext.addArg("clean").addArg("-df").run(true, false); + result = this.processContext.addArg("clean").addArg("-df").run(ProcessMode.DEFAULT_CAPTURE); if (!result.isSuccessful()) { context.warning("Git failed to clean the repository {}.", targetRepository); diff --git a/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContext.java b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContext.java index f2c6cc4a0..5630b4931 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContext.java +++ b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContext.java @@ -132,7 +132,7 @@ default ProcessContext addArgs(List... args) { */ default int run() { - return run(false, false).getExitCode(); + return run(ProcessMode.DEFAULT).getExitCode(); } /** @@ -140,28 +140,9 @@ default int run() { * arguments}. Will reset the {@link #addArgs(String...) arguments} but not the {@link #executable(Path) command} for * sub-sequent calls. * - * @param capture - {@code true} to capture standard {@link ProcessResult#getOut() out} and - * {@link ProcessResult#getErr() err} in the {@link ProcessResult}, {@code false} otherwise (to redirect out - * and err). + * @param processMode {@link ProcessMode} * @return the {@link ProcessResult}. */ - default ProcessResult run(boolean capture) { - - return run(capture, false); - } - - /** - * Runs the previously configured {@link #executable(Path) command} with the configured {@link #addArgs(String...) - * arguments}. Will reset the {@link #addArgs(String...) arguments} but not the {@link #executable(Path) command} for - * sub-sequent calls. - * - * @param capture - {@code true} to capture standard {@link ProcessResult#getOut() out} and - * {@link ProcessResult#getErr() err} in the {@link ProcessResult}, {@code false} otherwise (to redirect out - * and err). - * @param runInBackground {@code true}, the process of the command will be run as background process, {@code false} - * otherwise (it will be run as foreground process). - * @return the {@link ProcessResult}. - */ - ProcessResult run(boolean capture, boolean runInBackground); + ProcessResult run(ProcessMode processMode); } diff --git a/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContextImpl.java b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContextImpl.java index 4fb1556f9..cf8fd6f84 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContextImpl.java +++ b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessContextImpl.java @@ -14,6 +14,7 @@ import java.util.stream.Collectors; import com.devonfw.tools.ide.cli.CliException; +import com.devonfw.tools.ide.common.SystemPath; import com.devonfw.tools.ide.context.IdeContext; import com.devonfw.tools.ide.environment.VariableLine; import com.devonfw.tools.ide.log.IdeSubLogger; @@ -44,9 +45,6 @@ public ProcessContextImpl(IdeContext context) { super(); this.context = context; this.processBuilder = new ProcessBuilder(); - // TODO needs to be configurable for GUI - // this.processBuilder.inheritIO(); - this.processBuilder.redirectOutput(Redirect.INHERIT).redirectError(Redirect.INHERIT); this.errorHandling = ProcessErrorHandling.THROW; Map environment = this.processBuilder.environment(); for (VariableLine var : this.context.getVariables().collectExportedVariables()) { @@ -98,11 +96,11 @@ public ProcessContext withEnvVar(String key, String value) { } @Override - public ProcessResult run(boolean capture, boolean isBackgroundProcess) { + public ProcessResult run(ProcessMode processMode) { - if (isBackgroundProcess) { - this.context - .warning("TODO https://github.com/devonfw/IDEasy/issues/9 Implement background process functionality"); + // TODO ProcessMode needs to be configurable for GUI + if (processMode == ProcessMode.DEFAULT) { + this.processBuilder.redirectOutput(Redirect.INHERIT).redirectError(Redirect.INHERIT); } if (this.executable == null) { @@ -111,31 +109,30 @@ public ProcessResult run(boolean capture, boolean isBackgroundProcess) { String executableName = this.executable.toString(); // pragmatic solution to avoid copying lists/arrays this.arguments.add(0, executableName); - String fileExtension = FilenameUtil.getExtension(executableName); - boolean isBashScript = "sh".equals(fileExtension) || hasSheBang(this.executable); - if (isBashScript) { - String bash = "bash"; - if (this.context.getSystemInfo().isWindows()) { - String findBashOnWindowsResult = findBashOnWindows(); - if (findBashOnWindowsResult != null) { - bash = findBashOnWindowsResult; - } - } - this.arguments.add(0, bash); - } - this.processBuilder.command(this.arguments); + + checkAndHandlePossibleBashScript(executableName); + if (this.context.debug().isEnabled()) { String message = createCommandMessage(" ..."); this.context.debug(message); } + try { - if (capture) { + + if (processMode == ProcessMode.DEFAULT_CAPTURE) { this.processBuilder.redirectOutput(Redirect.PIPE).redirectError(Redirect.PIPE); + } else if (processMode.isBackground()) { + modifyArgumentsOnBackgroundProcess(processMode); } + + this.processBuilder.command(this.arguments); + + Process process = this.processBuilder.start(); + List out = null; List err = null; - Process process = this.processBuilder.start(); - if (capture) { + + if (processMode == ProcessMode.DEFAULT_CAPTURE) { try (BufferedReader outReader = new BufferedReader(new InputStreamReader(process.getInputStream()));) { out = outReader.lines().collect(Collectors.toList()); } @@ -143,25 +140,19 @@ public ProcessResult run(boolean capture, boolean isBackgroundProcess) { err = errReader.lines().collect(Collectors.toList()); } } - int exitCode = process.waitFor(); - ProcessResult result = new ProcessResultImpl(exitCode, out, err); - if (!result.isSuccessful() && (this.errorHandling != ProcessErrorHandling.NONE)) { - String message = createCommandMessage(" failed with exit code " + exitCode + "!"); - if (this.errorHandling == ProcessErrorHandling.THROW) { - throw new CliException(message, exitCode); - } - IdeSubLogger level; - if (this.errorHandling == ProcessErrorHandling.ERROR) { - level = this.context.error(); - } else if (this.errorHandling == ProcessErrorHandling.WARNING) { - level = this.context.warning(); - } else { - level = this.context.error(); - level.log("Internal error: Undefined error handling {}", this.errorHandling); - } - level.log(message); + + int exitCode; + if (processMode.isBackground()) { + exitCode = ProcessResult.SUCCESS; + } else { + exitCode = process.waitFor(); } + + ProcessResult result = new ProcessResultImpl(exitCode, out, err); + performLogOnError(result, exitCode); + return result; + } catch (Exception e) { String msg = e.getMessage(); if ((msg == null) || msg.isEmpty()) { @@ -259,4 +250,98 @@ private String findBashOnWindows() { throw new IllegalStateException("Could not find Bash. Please install Git for Windows and rerun."); } -} + private void checkAndHandlePossibleBashScript(String executableName) { + + String fileExtension = FilenameUtil.getExtension(executableName); + boolean isBashScript = "sh".equals(fileExtension) || hasSheBang(this.executable); + if (isBashScript) { + String bash = "bash"; + if (this.context.getSystemInfo().isWindows()) { + String findBashOnWindowsResult = findBashOnWindows(); + if (findBashOnWindowsResult != null) { + bash = findBashOnWindowsResult; + } + } + this.arguments.add(0, bash); + } + } + + private void performLogOnError(ProcessResult result, int exitCode) { + + if (!result.isSuccessful() && (this.errorHandling != ProcessErrorHandling.NONE)) { + String message = createCommandMessage(" failed with exit code " + exitCode + "!"); + if (this.errorHandling == ProcessErrorHandling.THROW) { + throw new CliException(message, exitCode); + } + IdeSubLogger level; + if (this.errorHandling == ProcessErrorHandling.ERROR) { + level = this.context.error(); + } else if (this.errorHandling == ProcessErrorHandling.WARNING) { + level = this.context.warning(); + } else { + level = this.context.error(); + level.log("Internal error: Undefined error handling {}", this.errorHandling); + } + level.log(message); + } + } + + private void modifyArgumentsOnBackgroundProcess(ProcessMode processMode) { + + if (processMode == ProcessMode.BACKGROUND) { + this.processBuilder.redirectOutput(Redirect.INHERIT).redirectError(Redirect.INHERIT); + } else if (processMode == ProcessMode.BACKGROUND_SILENT) { + this.processBuilder.redirectOutput(Redirect.DISCARD).redirectError(Redirect.DISCARD); + } else { + throw new IllegalStateException("Cannot handle non background process mode!"); + } + + String bash = "bash"; + + // try to use bash in windows to start the process + if (context.getSystemInfo().isWindows()) { + + String findBashOnWindowsResult = findBashOnWindows(); + if (findBashOnWindowsResult != null) { + + bash = findBashOnWindowsResult; + + } else { + context.warning( + "Cannot start background process in windows! No bash installation found, output will be discarded."); + this.processBuilder.redirectOutput(Redirect.DISCARD).redirectError(Redirect.DISCARD); + return; + } + } + + String commandToRunInBackground = buildCommandToRunInBackground(); + + this.arguments.clear(); + this.arguments.add(bash); + this.arguments.add("-c"); + commandToRunInBackground += " & disown"; + this.arguments.add(commandToRunInBackground); + + } + + private String buildCommandToRunInBackground() { + + if (context.getSystemInfo().isWindows()) { + + StringBuilder stringBuilder = new StringBuilder(); + + for (String argument : this.arguments) { + + if (SystemPath.isValidWindowsPath(argument)) { + argument = SystemPath.convertWindowsPathToUnixPath(argument); + } + + stringBuilder.append(argument); + stringBuilder.append(" "); + } + return stringBuilder.toString().trim(); + } else { + return this.arguments.stream().map(Object::toString).collect(Collectors.joining(" ")); + } + } +} \ No newline at end of file diff --git a/cli/src/main/java/com/devonfw/tools/ide/process/ProcessMode.java b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessMode.java new file mode 100644 index 000000000..478b9fba3 --- /dev/null +++ b/cli/src/main/java/com/devonfw/tools/ide/process/ProcessMode.java @@ -0,0 +1,51 @@ +package com.devonfw.tools.ide.process; + +/** + * The ProcessMode defines how to start the command process and how output streams are handled using + * {@link ProcessBuilder}. Modes that can be used: {@link #BACKGROUND} {@link #BACKGROUND_SILENT} {@link #DEFAULT} + * {@link #DEFAULT_CAPTURE} + */ +public enum ProcessMode { + /** + * The process of the command will be run like a background process. Technically the parent process will simply not + * await its child process and a shell is used to start the process. The parent process will get the output of the + * child process using {@link ProcessBuilder.Redirect#INHERIT}. In Unix systems the equivalent of appending an '& + * disown' is used to detach the subprocess from its parent process. In Unix terms, the shell will not send a SIGHUP + * signal but the process remains connected to the terminal so that output is still received. (Only '&' is not used + * because it just removes awaiting but not sending of SIGHUP. Using nohup would simply result in redirecting output + * to a nohup.out file.) + */ + BACKGROUND, + /** + * Like {@link #BACKGROUND}. Instead of redirecting the output to the parent process, the output is redirected to the + * 'null file' using {@link ProcessBuilder.Redirect#DISCARD}. + */ + BACKGROUND_SILENT, + /** + * The process will be started according {@link ProcessBuilder.Redirect#INHERIT} without any detaching of parent + * process and child process. This setting makes the child process dependant from the parent process! (If you close + * the parent process the child process will also be terminated.) + */ + DEFAULT, + /** + * The process will be started according {@link ProcessBuilder.Redirect#PIPE} and the standard output and standard + * error streams will be captured from the parent process. In other words, they will be printed in the console of the + * parent process. This setting makes the child process dependant from the parent process! (If you close the parent + * process the child process will also be terminated.) + */ + DEFAULT_CAPTURE; + + /** + * Method to check if the ProcessMode is a background process. + * + * @return {@code true} if the {@link ProcessMode} is {@link ProcessMode#BACKGROUND} or + * {@link ProcessMode#BACKGROUND_SILENT}, {@code false} if not. + */ + public boolean isBackground() { + + return this == BACKGROUND || this == BACKGROUND_SILENT; + } + + // TODO ADD EXTERNAL_WINDOW_MODE IN FUTURE Issue: https://github.com/devonfw/IDEasy/issues/218 + +} diff --git a/cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java b/cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java index be36fbc78..4193c221b 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java +++ b/cli/src/main/java/com/devonfw/tools/ide/tool/ToolCommandlet.java @@ -19,6 +19,7 @@ import com.devonfw.tools.ide.os.MacOsHelper; import com.devonfw.tools.ide.process.ProcessContext; import com.devonfw.tools.ide.process.ProcessErrorHandling; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.property.StringListProperty; import com.devonfw.tools.ide.util.FilenameUtil; import com.devonfw.tools.ide.version.VersionIdentifier; @@ -81,20 +82,19 @@ public final Set getTags() { @Override public void run() { - runTool(false, null, this.arguments.asArray()); + runTool(ProcessMode.DEFAULT, null, this.arguments.asArray()); } /** * Ensures the tool is installed and then runs this tool with the given arguments. * - * @param runInBackground {@code true}, the process of the command will be run as background process, {@code false} - * otherwise (it will be run as foreground process). + * @param processMode see {@link ProcessMode} * @param toolVersion the explicit version (pattern) to run. Typically {@code null} to ensure the configured version * is installed and use that one. Otherwise, the specified version will be installed in the software repository * without touching and IDE installation and used to run. * @param args the command-line arguments to run the tool. */ - public void runTool(boolean runInBackground, VersionIdentifier toolVersion, String... args) { + public void runTool(ProcessMode processMode, VersionIdentifier toolVersion, String... args) { Path binaryPath; Path toolPath = Path.of(getBinaryName()); @@ -104,19 +104,20 @@ public void runTool(boolean runInBackground, VersionIdentifier toolVersion, Stri } else { throw new UnsupportedOperationException("Not yet implemented!"); } - ProcessContext pc = this.context.newProcess().errorHandling(ProcessErrorHandling.WARNING).executable(binaryPath).addArgs(args); + ProcessContext pc = this.context.newProcess().errorHandling(ProcessErrorHandling.WARNING).executable(binaryPath) + .addArgs(args); - pc.run(false, runInBackground); + pc.run(processMode); } /** * @param toolVersion the explicit {@link VersionIdentifier} of the tool to run. * @param args the command-line arguments to run the tool. - * @see ToolCommandlet#runTool(boolean, VersionIdentifier, String...) + * @see ToolCommandlet#runTool(ProcessMode, VersionIdentifier, String...) */ public void runTool(VersionIdentifier toolVersion, String... args) { - runTool(false, toolVersion, args); + runTool(ProcessMode.DEFAULT, toolVersion, args); } /** @@ -210,11 +211,12 @@ private Path getProperInstallationSubDirOf(Path path) { try (Stream stream = Files.list(path)) { Path[] subFiles = stream.toArray(Path[]::new); if (subFiles.length == 0) { - throw new CliException("The downloaded package for the tool " + this.tool + " seems to be empty as you can check in the extracted folder " + path); + throw new CliException("The downloaded package for the tool " + this.tool + + " seems to be empty as you can check in the extracted folder " + path); } else if (subFiles.length == 1) { String filename = subFiles[0].getFileName().toString(); - if (!filename.equals(IdeContext.FOLDER_BIN) && !filename.equals(IdeContext.FOLDER_CONTENTS) && !filename.endsWith(".app") - && Files.isDirectory(subFiles[0])) { + if (!filename.equals(IdeContext.FOLDER_BIN) && !filename.equals(IdeContext.FOLDER_CONTENTS) + && !filename.endsWith(".app") && Files.isDirectory(subFiles[0])) { return getProperInstallationSubDirOf(subFiles[0]); } } @@ -384,8 +386,10 @@ public String getInstalledEdition(Path toolPath) { } return edition; } catch (IOException e) { - throw new IllegalStateException("Couldn't determine the edition of " + getName() + " from the directory structure of its software path " + toolPath - + ", assuming the name of the parent directory of the real path of the software path to be the edition " + "of the tool.", e); + throw new IllegalStateException("Couldn't determine the edition of " + getName() + + " from the directory structure of its software path " + toolPath + + ", assuming the name of the parent directory of the real path of the software path to be the edition " + + "of the tool.", e); } } @@ -450,8 +454,9 @@ public void setVersion(VersionIdentifier version, boolean hint) { this.context.info("{}={} has been set in {}", name, version, settingsVariables.getSource()); EnvironmentVariables declaringVariables = variables.findVariable(name); if ((declaringVariables != null) && (declaringVariables != settingsVariables)) { - this.context.warning("The variable {} is overridden in {}. Please remove the overridden declaration in order to make the change affect.", name, - declaringVariables.getSource()); + this.context.warning( + "The variable {} is overridden in {}. Please remove the overridden declaration in order to make the change affect.", + name, declaringVariables.getSource()); } if (hint) { this.context.info("To install that version call the following command:"); @@ -494,8 +499,9 @@ public void setEdition(String edition, boolean hint) { this.context.info("{}={} has been set in {}", name, edition, settingsVariables.getSource()); EnvironmentVariables declaringVariables = variables.findVariable(name); if ((declaringVariables != null) && (declaringVariables != settingsVariables)) { - this.context.warning("The variable {} is overridden in {}. Please remove the overridden declaration in order to make the change affect.", name, - declaringVariables.getSource()); + this.context.warning( + "The variable {} is overridden in {}. Please remove the overridden declaration in order to make the change affect.", + name, declaringVariables.getSource()); } if (hint) { this.context.info("To install that edition call the following command:"); diff --git a/cli/src/main/java/com/devonfw/tools/ide/tool/eclipse/Eclipse.java b/cli/src/main/java/com/devonfw/tools/ide/tool/eclipse/Eclipse.java index 133c65d31..917f55d01 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/tool/eclipse/Eclipse.java +++ b/cli/src/main/java/com/devonfw/tools/ide/tool/eclipse/Eclipse.java @@ -15,6 +15,7 @@ import com.devonfw.tools.ide.log.IdeLogLevel; import com.devonfw.tools.ide.process.ProcessContext; import com.devonfw.tools.ide.process.ProcessErrorHandling; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.process.ProcessResult; import com.devonfw.tools.ide.tool.ide.IdeToolCommandlet; import com.devonfw.tools.ide.tool.ide.PluginDescriptor; @@ -39,7 +40,7 @@ public Eclipse(IdeContext context) { protected void runIde(String... args) { install(true); - runEclipse(false, + runEclipse(ProcessMode.BACKGROUND, CliArgument.prepend(args, "gui", "-showlocation", this.context.getIdeHome().getFileName().toString())); } @@ -53,22 +54,21 @@ public boolean install(boolean silent) { /** * Runs eclipse application. * - * @param log - {@code true} to run in log mode without opening a window and capture the output, {@code false} - * otherwise (run in GUI mode). + * @param processMode - the {@link ProcessMode}. * @param args the individual arguments to pass to eclipse. * @return the {@link ProcessResult}. */ - protected ProcessResult runEclipse(boolean log, String... args) { + protected ProcessResult runEclipse(ProcessMode processMode, String... args) { Path toolPath = Path.of(getBinaryName()); ProcessContext pc = this.context.newProcess(); - if (log) { + if (processMode == ProcessMode.DEFAULT_CAPTURE) { pc.errorHandling(ProcessErrorHandling.ERROR); } pc.executable(toolPath); Path configurationPath = getPluginsInstallationPath().resolve("configuration"); this.context.getFileAccess().mkdirs(configurationPath); - if (log) { + if (processMode == ProcessMode.DEFAULT_CAPTURE) { pc.addArg("-consoleLog").addArg("-nosplash"); } else { pc.addArg("-clean"); @@ -80,14 +80,16 @@ protected ProcessResult runEclipse(boolean log, String... args) { Path javaPath = getCommandlet(Java.class).getToolBinPath(); pc.addArg("-vm").addArg(javaPath); pc.addArgs(args); - return pc.run(log, false); + + return pc.run(processMode); + } @Override public void installPlugin(PluginDescriptor plugin) { - ProcessResult result = runEclipse(true, "org.eclipse.equinox.p2.director", "-repository", plugin.getUrl(), - "-installIU", plugin.getId()); + ProcessResult result = runEclipse(ProcessMode.DEFAULT_CAPTURE, "org.eclipse.equinox.p2.director", "-repository", + plugin.getUrl(), "-installIU", plugin.getId()); if (result.isSuccessful()) { for (String line : result.getOut()) { if (line.contains("Overall install request is satisfiable")) { diff --git a/cli/src/main/java/com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java b/cli/src/main/java/com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java index 4bb4800c8..ac7a2a1f6 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java +++ b/cli/src/main/java/com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java @@ -15,6 +15,7 @@ import com.devonfw.tools.ide.common.Tag; import com.devonfw.tools.ide.context.IdeContext; import com.devonfw.tools.ide.io.FileAccess; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.tool.LocalToolCommandlet; import com.devonfw.tools.ide.tool.ToolCommandlet; import com.devonfw.tools.ide.tool.eclipse.Eclipse; @@ -207,7 +208,7 @@ public void run() { */ protected void runIde(String... args) { - runTool(false,null, args); + runTool(ProcessMode.DEFAULT, null, args); } /** diff --git a/cli/src/main/java/com/devonfw/tools/ide/tool/jmc/Jmc.java b/cli/src/main/java/com/devonfw/tools/ide/tool/jmc/Jmc.java index 0c316cfbf..97d2f339c 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/tool/jmc/Jmc.java +++ b/cli/src/main/java/com/devonfw/tools/ide/tool/jmc/Jmc.java @@ -10,9 +10,9 @@ import com.devonfw.tools.ide.common.Tag; import com.devonfw.tools.ide.context.IdeContext; import com.devonfw.tools.ide.io.FileAccess; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.tool.LocalToolCommandlet; import com.devonfw.tools.ide.tool.ToolCommandlet; -import com.devonfw.tools.ide.tool.java.Java; /** * {@link ToolCommandlet} for JDK Mission @@ -33,7 +33,8 @@ public Jmc(IdeContext context) { @Override public boolean doInstall(boolean silent) { - // TODO https://github.com/devonfw/IDEasy/issues/209 currently outcommented as this breaks the tests, real fix needed asap + // TODO https://github.com/devonfw/IDEasy/issues/209 currently outcommented as this breaks the tests, real fix + // needed asap // getCommandlet(Java.class).install(); return super.doInstall(silent); } @@ -41,7 +42,7 @@ public boolean doInstall(boolean silent) { @Override public void run() { - runTool(true, null, this.arguments.asArray()); + runTool(ProcessMode.BACKGROUND, null, this.arguments.asArray()); } @Override @@ -57,7 +58,9 @@ public void postInstall() { moveFilesAndDirs(oldBinaryPath, toolPath); fileAccess.delete(oldBinaryPath); } else { - this.context.info("JMC binary folder not found at {} - ignoring as this legacy problem may be resolved in newer versions.", oldBinaryPath); + this.context.info( + "JMC binary folder not found at {} - ignoring as this legacy problem may be resolved in newer versions.", + oldBinaryPath); } } diff --git a/cli/src/main/java/com/devonfw/tools/ide/tool/terraform/Terraform.java b/cli/src/main/java/com/devonfw/tools/ide/tool/terraform/Terraform.java index e99d1264b..33e49e34f 100644 --- a/cli/src/main/java/com/devonfw/tools/ide/tool/terraform/Terraform.java +++ b/cli/src/main/java/com/devonfw/tools/ide/tool/terraform/Terraform.java @@ -4,6 +4,7 @@ import com.devonfw.tools.ide.common.Tag; import com.devonfw.tools.ide.context.IdeContext; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.tool.LocalToolCommandlet; import com.devonfw.tools.ide.tool.ToolCommandlet; @@ -26,6 +27,6 @@ public Terraform(IdeContext context) { protected void postInstall() { super.postInstall(); - runTool(false, null, "-install-autocomplete"); + runTool(ProcessMode.DEFAULT, null, "-install-autocomplete"); } } diff --git a/cli/src/test/java/com/devonfw/tools/ide/common/SystemPathTest.java b/cli/src/test/java/com/devonfw/tools/ide/common/SystemPathTest.java new file mode 100644 index 000000000..0b8656bee --- /dev/null +++ b/cli/src/test/java/com/devonfw/tools/ide/common/SystemPathTest.java @@ -0,0 +1,49 @@ +package com.devonfw.tools.ide.common; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +/** + * Unit tests of {@link SystemPath}. + */ +public class SystemPathTest { + + @ParameterizedTest + @ValueSource(strings = { "C:\\Users\\User\\Documents\\My Pictures\\photo.jpg", + "C:\\Windows\\System32\\drivers\\etc.sys", "D:\\Projects\\ProjectA\\source\\main.py" }) + public void SystemPathShouldRecognizeWindowsPaths(String pathStringToTest) { + + // act + boolean testResult = SystemPath.isValidWindowsPath(pathStringToTest); + assertThat(testResult).isTrue(); + + } + + @ParameterizedTest + @ValueSource(strings = { "-kill", "none", "--help", "/usr/local/bin/firefox.exe" }) + public void SystemPathShouldRecognizeNonWindowsPaths(String pathStringToTest) { + + // act + boolean testResult = SystemPath.isValidWindowsPath(pathStringToTest); + assertThat(testResult).isFalse(); + + } + + @Test + public void SystemPathShouldConvertWindowsPathToUnixPath() { + + // arrange + String windowsPathString = "C:\\Users\\User\\test.exe"; + String expectedUnixPathString = "/c/Users/User/test.exe"; + + // act + String resultPath = SystemPath.convertWindowsPathToUnixPath(windowsPathString); + + // assert + assertThat(resultPath).isEqualTo(expectedUnixPathString); + } + +} diff --git a/cli/src/test/java/com/devonfw/tools/ide/context/GitContextProcessContextMock.java b/cli/src/test/java/com/devonfw/tools/ide/context/GitContextProcessContextMock.java index f79a2f6bb..eb257edff 100644 --- a/cli/src/test/java/com/devonfw/tools/ide/context/GitContextProcessContextMock.java +++ b/cli/src/test/java/com/devonfw/tools/ide/context/GitContextProcessContextMock.java @@ -10,6 +10,7 @@ import com.devonfw.tools.ide.process.ProcessContext; import com.devonfw.tools.ide.process.ProcessErrorHandling; +import com.devonfw.tools.ide.process.ProcessMode; import com.devonfw.tools.ide.process.ProcessResult; import com.devonfw.tools.ide.process.ProcessResultImpl; @@ -75,7 +76,7 @@ public ProcessContext withEnvVar(String key, String value) { } @Override - public ProcessResult run(boolean capture, boolean isBackgroundProcess) { + public ProcessResult run(ProcessMode processMode) { Path gitFolderPath = this.directory.resolve(".git"); // deletes a newly added folder diff --git a/cli/src/test/java/com/devonfw/tools/ide/process/ProcessContextImplTest.java b/cli/src/test/java/com/devonfw/tools/ide/process/ProcessContextImplTest.java new file mode 100644 index 000000000..025161d07 --- /dev/null +++ b/cli/src/test/java/com/devonfw/tools/ide/process/ProcessContextImplTest.java @@ -0,0 +1,218 @@ +package com.devonfw.tools.ide.process; + +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.argThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.lang.reflect.Field; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.EnumSource; +import org.junit.platform.commons.util.ReflectionUtils; + +import com.devonfw.tools.ide.context.AbstractIdeContextTest; +import com.devonfw.tools.ide.context.IdeContext; +import com.devonfw.tools.ide.context.IdeTestContext; +import com.devonfw.tools.ide.log.IdeLogLevel; + +/** + * Unit tests of {@link ProcessContextImpl}. + */ +public class ProcessContextImplTest extends AbstractIdeContextTest { + + private ProcessContextImpl processConttextUnderTest; + + private Process processMock; + + private ProcessBuilder mockProcessBuilder; + + private IdeContext context; + + @BeforeEach + public void setUp() throws Exception { + + mockProcessBuilder = mock(ProcessBuilder.class); + String projectPath = "workspaces/foo-test/my-git-repo"; + context = newContext("basic", projectPath, false); + processConttextUnderTest = new ProcessContextImpl(context); + + Field field = ReflectionUtils.findFields(ProcessContextImpl.class, f -> f.getName().equals("processBuilder"), + ReflectionUtils.HierarchyTraversalMode.TOP_DOWN).get(0); + + field.setAccessible(true); + field.set(processConttextUnderTest, mockProcessBuilder); + field.setAccessible(false); + + // underTest needs executable + Field underTestExecutable = ReflectionUtils.findFields(ProcessContextImpl.class, + f -> f.getName().equals("executable"), ReflectionUtils.HierarchyTraversalMode.TOP_DOWN).get(0); + underTestExecutable.setAccessible(true); + underTestExecutable.set(processConttextUnderTest, + PATH_PROJECTS.resolve("_ide/software/nonExistingBinaryForTesting")); + underTestExecutable.setAccessible(false); + + processMock = mock(Process.class); + when(mockProcessBuilder.start()).thenReturn(processMock); + + when(mockProcessBuilder.redirectOutput(ProcessBuilder.Redirect.PIPE)).thenReturn(mockProcessBuilder); + when(mockProcessBuilder.redirectError(ProcessBuilder.Redirect.PIPE)).thenReturn(mockProcessBuilder); + when(mockProcessBuilder.redirectOutput(ProcessBuilder.Redirect.DISCARD)).thenReturn(mockProcessBuilder); + when(mockProcessBuilder.redirectError(ProcessBuilder.Redirect.DISCARD)).thenReturn(mockProcessBuilder); + when(mockProcessBuilder.redirectOutput(ProcessBuilder.Redirect.INHERIT)).thenReturn(mockProcessBuilder); + when(mockProcessBuilder.redirectError(ProcessBuilder.Redirect.INHERIT)).thenReturn(mockProcessBuilder); + + } + + @Test + public void missingExecutableShouldThrowIllegalState() throws Exception { + + // arrange + String expectedMessage = "Missing executable to run process!"; + + Field underTestExecutable = ReflectionUtils.findFields(ProcessContextImpl.class, + f -> f.getName().equals("executable"), ReflectionUtils.HierarchyTraversalMode.TOP_DOWN).get(0); + underTestExecutable.setAccessible(true); + underTestExecutable.set(processConttextUnderTest, null); + underTestExecutable.setAccessible(false); + + // act & assert + Exception exception = assertThrows(IllegalStateException.class, () -> { + processConttextUnderTest.run(ProcessMode.DEFAULT); + }); + + String actualMessage = exception.getMessage(); + + assertThat(actualMessage).isEqualTo(expectedMessage); + } + + @Test + public void onSuccessfulProcessStartReturnSuccessResult() throws Exception { + + // arrange + + when(processMock.waitFor()).thenReturn(ProcessResult.SUCCESS); + + // act + ProcessResult result = processConttextUnderTest.run(ProcessMode.DEFAULT); + + // assert + verify(mockProcessBuilder).redirectOutput( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.INHERIT))); + + verify(mockProcessBuilder).redirectError( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.INHERIT))); + assertThat(result.isSuccessful()).isTrue(); + + } + + @Test + public void enablingCaptureShouldRedirectAndCaptureStreamsCorrectly() throws Exception { + + // arrange + when(processMock.waitFor()).thenReturn(ProcessResult.SUCCESS); + String outputText = "hello world"; + String errorText = "error"; + + try (InputStream outputStream = new ByteArrayInputStream(outputText.getBytes()); + InputStream errorStream = new ByteArrayInputStream(errorText.getBytes())) { + + when(processMock.getInputStream()).thenReturn(outputStream); + + when(processMock.getErrorStream()).thenReturn(errorStream); + + // act + ProcessResult result = processConttextUnderTest.run(ProcessMode.DEFAULT_CAPTURE); + + // assert + verify(mockProcessBuilder).redirectOutput( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.PIPE))); + + verify(mockProcessBuilder).redirectError( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.PIPE))); + + assertThat(outputText).isEqualTo(result.getOut().get(0)); + assertThat(errorText).isEqualTo(result.getErr().get(0)); + } + } + + @ParameterizedTest + @EnumSource(value = ProcessMode.class, names = { "BACKGROUND", "BACKGROUND_SILENT" }) + public void enablingBackgroundProcessShouldNotBeAwaitedAndShouldNotPassStreams(ProcessMode processMode) + throws Exception { + + // arrange + when(processMock.waitFor()).thenReturn(ProcessResult.SUCCESS); + + // act + ProcessResult result = processConttextUnderTest.run(processMode); + + // assert + if (processMode == ProcessMode.BACKGROUND) { + verify(mockProcessBuilder).redirectOutput( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.INHERIT))); + + verify(mockProcessBuilder).redirectError( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.INHERIT))); + } else if (processMode == ProcessMode.BACKGROUND_SILENT) { + verify(mockProcessBuilder).redirectOutput( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.DISCARD))); + + verify(mockProcessBuilder).redirectError( + (ProcessBuilder.Redirect) argThat(arg -> arg.equals(ProcessBuilder.Redirect.DISCARD))); + } + + verify(processMock, never()).waitFor(); + + assertThat(result.getOut()).isNull(); + assertThat(result.getErr()).isNull(); + + } + + @Test + public void unsuccessfulProcessShouldThrowIllegalState() throws Exception { + + // arrange + when(processMock.waitFor()).thenReturn(ProcessResult.TOOL_NOT_INSTALLED); + + processConttextUnderTest.errorHandling(ProcessErrorHandling.THROW); + + // act & assert + assertThrows(IllegalStateException.class, () -> { + processConttextUnderTest.run(ProcessMode.DEFAULT); + }); + + } + + @ParameterizedTest + @EnumSource(value = ProcessErrorHandling.class, names = { "WARNING", "ERROR" }) + public void ProcessWarningAndErrorShouldBeLogged(ProcessErrorHandling processErrorHandling) throws Exception { + + // arrange + when(processMock.waitFor()).thenReturn(ProcessResult.TOOL_NOT_INSTALLED); + processConttextUnderTest.errorHandling(processErrorHandling); + String expectedMessage = "failed with exit code 4!"; + // act + processConttextUnderTest.run(ProcessMode.DEFAULT); + + // assert + IdeLogLevel level = convertToIdeLogLevel(processErrorHandling); + assertLogMessage((IdeTestContext) context, level, expectedMessage, true); + } + + private IdeLogLevel convertToIdeLogLevel(ProcessErrorHandling processErrorHandling) { + + return switch (processErrorHandling) { + case NONE, THROW -> null; + case WARNING -> IdeLogLevel.WARNING; + case ERROR -> IdeLogLevel.ERROR; + }; + } + +} diff --git a/pom.xml b/pom.xml index 0a51732b8..524bbc6dc 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 @@ -33,6 +34,12 @@ 3.24.2 test + + org.mockito + mockito-core + 5.10.0 + test + @@ -99,74 +106,74 @@ Jörg Hohwiller hohwille@users.sourceforge.net Capgemini - + admin designer developer +1 - + trippl Thomas Rippl - + developer +1 - + markusschuh Markus Schuh Capgemini - + contributor +1 - + maybeec Malte Brunnlieb Capgemini - + contributor +1 - + ediekman Erik Diekmann Capgemini - + contributor +1 - + nricheton Nicolas Richeton Capgemini - + contributor +1 - +