IEP-1247 Run CMake initial build for newly created project(idf.py reconfigure) #1051
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /******************************************************************************* | ||
| * Copyright 2024 Espressif Systems (Shanghai) PTE LTD. All rights reserved. | ||
| * Use is subject to license terms. | ||
| *******************************************************************************/ | ||
|
|
||
| package com.espressif.idf.core.util; | ||
|
|
||
| import org.eclipse.ui.console.ConsolePlugin; | ||
| import org.eclipse.ui.console.IConsole; | ||
| import org.eclipse.ui.console.MessageConsole; | ||
|
|
||
| public class ConsoleManager | ||
| { | ||
|
|
||
| private ConsoleManager() | ||
| { | ||
| } | ||
|
|
||
| public static MessageConsole getConsole(String consoleName) | ||
| { | ||
| MessageConsole console = findConsole(consoleName); | ||
| if (console == null) | ||
| { | ||
| console = new MessageConsole(consoleName, null); | ||
| ConsolePlugin.getDefault().getConsoleManager().addConsoles(new IConsole[] { console }); | ||
| } | ||
| ConsolePlugin.getDefault().getConsoleManager().showConsoleView(console); | ||
| return console; | ||
| } | ||
|
|
||
| private static MessageConsole findConsole(String consoleName) | ||
| { | ||
| for (IConsole existing : ConsolePlugin.getDefault().getConsoleManager().getConsoles()) | ||
| { | ||
| if (consoleName.equals(existing.getName())) | ||
| { | ||
| return (MessageConsole) existing; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. I dont understand the need for this class, maybe I am not clear on this. Just a question from my side that why do we need a separate class to just execute this command when we can do that in the Job we are creating for the console? There was a problem hiding this comment. Hi @alirana01, thanks for the review. I've created this class not only for this command but also for other idf commands that we have to execute in the console. My idea was that in the future we could refactor existing code and move other IDF commands and their preparation into this class to not scatter similar logic over the code base and to avoid duplicate code |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| /******************************************************************************* | ||
| * Copyright 2021 Espressif Systems (Shanghai) PTE LTD. All rights reserved. | ||
| * Use is subject to license terms. | ||
| *******************************************************************************/ | ||
|
|
||
| package com.espressif.idf.core.util; | ||
|
|
||
| import java.io.BufferedReader; | ||
| import java.io.IOException; | ||
| import java.io.InputStreamReader; | ||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import org.eclipse.core.resources.IProject; | ||
| import org.eclipse.core.runtime.CoreException; | ||
| import org.eclipse.core.runtime.IStatus; | ||
| import org.eclipse.core.runtime.Status; | ||
| import org.eclipse.debug.core.DebugPlugin; | ||
| import org.eclipse.debug.core.ILaunchConfiguration; | ||
| import org.eclipse.debug.core.ILaunchManager; | ||
| import org.eclipse.ui.console.MessageConsole; | ||
| import org.eclipse.ui.console.MessageConsoleStream; | ||
|
|
||
| import com.espressif.idf.core.IDFCorePlugin; | ||
| import com.espressif.idf.core.IDFEnvironmentVariables; | ||
| import com.espressif.idf.core.ProcessBuilderFactory; | ||
| import com.espressif.idf.core.build.ActiveLaunchConfigurationProvider; | ||
| import com.espressif.idf.core.build.IDFLaunchConstants; | ||
| import com.espressif.idf.core.logging.Logger; | ||
|
|
||
| public class IdfCommandExecutor | ||
| { | ||
|
|
||
| private final String target; | ||
| private final MessageConsole console; | ||
| private static final String CMAKE_ARGUMENTS = "cmake.arguments"; //$NON-NLS-1$ | ||
| private static final ActiveLaunchConfigurationProvider LAUNCH_CONFIG_PROVIDER = new ActiveLaunchConfigurationProvider(); | ||
|
|
||
| public IdfCommandExecutor(String target, MessageConsole console) | ||
| { | ||
| this.target = target; | ||
| this.console = console; | ||
| } | ||
|
|
||
| public IStatus executeReconfigure(IProject project) | ||
| { | ||
| console.activate(); | ||
| return runIdfReconfigureCommand(project); | ||
| } | ||
|
|
||
| private IStatus runIdfReconfigureCommand(IProject project) | ||
| { | ||
| ProcessBuilderFactory processRunner = new ProcessBuilderFactory(); | ||
| setBuildFolder(project); | ||
| List<String> arguments = prepareCmakeArguments(project); | ||
| Map<String, String> environment = new HashMap<>(new IDFEnvironmentVariables().getSystemEnvMap()); | ||
|
|
||
| try (MessageConsoleStream messageConsoleStream = console.newMessageStream()) | ||
| { | ||
| messageConsoleStream.println(String.join(" ", arguments)); //$NON-NLS-1$ | ||
| return runProcess(arguments, environment, processRunner, project, messageConsoleStream); | ||
| } | ||
| catch (IOException e1) | ||
| { | ||
| Logger.log(e1); | ||
| return IDFCorePlugin.errorStatus(e1.getMessage(), e1); | ||
| } | ||
| } | ||
|
|
||
| private List<String> prepareCmakeArguments(IProject project) | ||
| { | ||
| List<String> arguments = new ArrayList<>(); | ||
| arguments.add("cmake"); //$NON-NLS-1$ | ||
| arguments.add("-G"); //$NON-NLS-1$ | ||
| arguments.add("Ninja"); //$NON-NLS-1$ | ||
| arguments.add("-DPYTHON_DEPS_CHECKED=1"); //$NON-NLS-1$ | ||
| arguments.add("-DPYTHON=" + IDFUtil.getIDFPythonEnvPath()); //$NON-NLS-1$ | ||
| arguments.add("DESP_PLATFORM=1"); //$NON-NLS-1$ | ||
|
|
||
| String ccache = new IDFEnvironmentVariables().getEnvValue(IDFEnvironmentVariables.IDF_CCACHE_ENABLE); | ||
| ccache = ccache.isBlank() ? "0" : ccache; //$NON-NLS-1$ | ||
|
|
||
| arguments.add("DCCACHE_ENABLE=" + ccache); //$NON-NLS-1$ | ||
| arguments.add(project.getLocation().toOSString()); | ||
| arguments.add("-B"); //$NON-NLS-1$ | ||
| try | ||
| { | ||
| arguments.add(IDFUtil.getBuildDir(project)); | ||
| } | ||
| catch (CoreException e) | ||
| { | ||
| Logger.log(e); | ||
| } | ||
| return arguments; | ||
| } | ||
|
|
||
| private boolean setBuildFolder(IProject project) | ||
| { | ||
| String userArgs = getProperty(CMAKE_ARGUMENTS); | ||
| // Custom build directory | ||
| String[] cmakeArgumentsArr = userArgs.split(" "); //$NON-NLS-1$ | ||
| String customBuildDir = StringUtil.EMPTY; | ||
| for (int i = 0; i < cmakeArgumentsArr.length; i++) | ||
| { | ||
| if (cmakeArgumentsArr[i].equals("-B")) //$NON-NLS-1$ | ||
| { | ||
| customBuildDir = cmakeArgumentsArr[i + 1]; | ||
| break; | ||
| } | ||
| } | ||
| try | ||
| { | ||
| IDFUtil.setBuildDir(project, customBuildDir); | ||
| } | ||
| catch (CoreException e) | ||
| { | ||
| Logger.log(e); | ||
| } | ||
|
|
||
| return !customBuildDir.isBlank(); | ||
| } | ||
|
|
||
| public String getProperty(String name) | ||
| { | ||
| try | ||
| { | ||
| ILaunchConfiguration configuration = LAUNCH_CONFIG_PROVIDER.getActiveLaunchConfiguration(); | ||
| if (configuration != null | ||
| && configuration.getType().getIdentifier().equals(IDFLaunchConstants.DEBUG_LAUNCH_CONFIG_TYPE)) | ||
| { | ||
| configuration = getBoundConfiguration(configuration); | ||
| } | ||
| return configuration == null ? StringUtil.EMPTY : configuration.getAttribute(name, StringUtil.EMPTY); | ||
| } | ||
| catch (CoreException e) | ||
| { | ||
| Logger.log(e); | ||
| } | ||
| return StringUtil.EMPTY; | ||
| } | ||
|
|
||
| private ILaunchConfiguration getBoundConfiguration(ILaunchConfiguration configuration) throws CoreException | ||
| { | ||
| String bindedLaunchConfigName = configuration.getAttribute(IDFLaunchConstants.ATTR_LAUNCH_CONFIGURATION_NAME, | ||
| StringUtil.EMPTY); | ||
| ILaunchManager launchManager = DebugPlugin.getDefault().getLaunchManager(); | ||
| ILaunchConfiguration[] launchConfigurations = launchManager.getLaunchConfigurations(DebugPlugin.getDefault() | ||
| .getLaunchManager().getLaunchConfigurationType(IDFLaunchConstants.RUN_LAUNCH_CONFIG_TYPE)); | ||
| ILaunchConfiguration defaultConfiguration = launchConfigurations[0]; | ||
| return Stream.of(launchConfigurations).filter(config -> config.getName().contentEquals(bindedLaunchConfigName)) | ||
| .findFirst().orElse(defaultConfiguration); | ||
|
|
||
| } | ||
|
|
||
| private IStatus runProcess(List<String> arguments, Map<String, String> environment, | ||
| ProcessBuilderFactory processRunner, IProject project, MessageConsoleStream messageConsoleStream) | ||
| { | ||
| StringBuilder output = new StringBuilder(); | ||
| try (BufferedReader reader = new BufferedReader(new InputStreamReader( | ||
| processRunner.run(arguments, project.getLocation(), environment).getInputStream()))) | ||
| { | ||
| String line; | ||
| while ((line = reader.readLine()) != null) | ||
| { | ||
| output.append(line).append(System.lineSeparator()); | ||
| messageConsoleStream.println(line); | ||
| } | ||
| return new Status(IStatus.OK, IDFCorePlugin.PLUGIN_ID, output.toString()); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Logger.log(e); | ||
| return IDFCorePlugin.errorStatus(e.getMessage(), e); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add documentation and parameter validation.
The method logic is correct, but could benefit from these improvements:
📝 Committable suggestion