IEP-374: GCOV Reports view and creation #817
Conversation
WalkthroughThis update introduces significant enhancements to the ESP-IDF plugin for Eclipse, focusing on Gcov integration for code coverage analysis. It adds utility classes and methods for managing Gcov files, commands for instant Gcov data dumping, and a new view for displaying Gcov reports. Additionally, the update expands Python dependencies installation to include Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 10
Files selected for processing (18)
- bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1 hunks)
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java (1 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/plugin.xml (1 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/common/LaunchConfigHandler.java (1 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (2 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java (1 hunks)
- bundles/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java (1 hunks)
- bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF (1 hunks)
- bundles/com.espressif.idf.ui/plugin.xml (4 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/LogMessagesThread.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/InstallEspIdfPage.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/ManageToolsInstallationWizardPage.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/InstallToolsHandler.java (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/Messages.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/messages.properties (1 hunks)
Files skipped from review due to trivial changes (9)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/plugin.xml
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java
- bundles/com.espressif.idf.ui/plugin.xml
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/LogMessagesThread.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/ManageToolsInstallationWizardPage.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/InstallToolsHandler.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/Messages.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/messages.properties
Additional comments (Suppressed): 10
bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF (2)
41-45: The new dependency
org.eclipse.core.variables;bundle-version="3.5.100"has been added. Ensure that this version of the package is available in the environment where this plugin will be deployed.49-54: The new package
com.espressif.idf.ui.gcovis being exported. This aligns with the PR summary which mentioned the addition of a new package for handling Gcov files and reports.bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (2)
30-46: The new dependencies added are all related to the Linux Tools project, which includes tools for Linux development in general and some specific to embedded systems. Given that this PR is about adding Gcov support, these additions make sense. However, please verify if all these dependencies are necessary for your feature. Unnecessary dependencies can lead to a bloated application and potential version conflicts.
47-47: Ensure that the JavaSE-11 execution environment is still appropriate with the addition of these new dependencies. Some may require a newer version of Java.
bundles/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java (1)
- 192-193: Ensure that the new method
handlePythonDependenciesInstall()inInstallToolsHandlerclass correctly installs bothwebsocket-clientandgcovrpackages as mentioned in the PR summary.bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java (1)
- 1-4: Ensure that the copyright notice is up-to-date and correctly formatted.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/InstallEspIdfPage.java (1)
- 38-38: The import statement for
LogMessagesThreadhas been moved. Ensure that this change does not affect the order of execution or dependencies in the code.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java (3)
570-576: The method
handlePipDependenciesInstall()is called here. Ensure that all calls to the old methodhandleWebSocketClientInstall()throughout the codebase have been updated to this new method.870-873: The method name has been changed from
handleWebSocketClientInstall()tohandlePipDependenciesInstall(). This change reflects the fact that the method now handles the installation of more than just the WebSocket client.885-887: The
gcovrpackage has been added to the list of packages to install. This package is necessary for generating Gcov reports.
...ressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
Show resolved
Hide resolved
...s/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java
Show resolved
Hide resolved
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java
Show resolved
Hide resolved
....gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/common/LaunchConfigHandler.java
Outdated
Show resolved
Hide resolved
....gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/common/LaunchConfigHandler.java
Outdated
Show resolved
Hide resolved
....gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/common/LaunchConfigHandler.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Files selected for processing (1)
- bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1 hunks)
Additional comments (Suppressed): 1
bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1)
- 25-47: The new dependencies added to the manifest file are related to Linux tools, profiling, Docker, and Gcov. Ensure that these new dependencies do not introduce any compatibility issues with the existing codebase or the target runtime environment. Also, verify if all these dependencies are necessary for the project's requirements.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Files selected for processing (1)
- bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1 hunks)
Additional comments (Suppressed): 1
bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1)
- 25-46: The new dependencies added to the manifest file are related to Linux tools, profiling, Docker, and Gcov. Ensure that these new dependencies do not introduce any breaking changes or conflicts with existing dependencies. Also, verify if all these new dependencies are necessary for the functionality of the bundle.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Files selected for processing (2)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java (1 hunks)
Additional comments (Suppressed): 1
bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (1)
- 38-43: The import statement for
LaunchConfigurationWorkingCopyhas been removed, which is a good change if it's not being used in the code. Removing unused imports helps to keep the code clean and maintainable.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java
Outdated
Show resolved
Hide resolved
...ressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
Show resolved
Hide resolved
...ressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (3)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties (1 hunks)
Files skipped from review due to trivial changes (3)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (1)
- tests/com.espressif.idf.ui.test/META-INF/MANIFEST.MF (1 hunks)
Additional comments (Suppressed): 2
tests/com.espressif.idf.ui.test/META-INF/MANIFEST.MF (2)
13-34: Ensure that all the newly added dependencies are available in the build environment and they are compatible with each other. Also, verify if these new dependencies introduce any breaking changes or conflicts with existing code.
35-37: The
Import-Packagedirective is used to specify the packages that this bundle requires from other bundles. Ensure that the imported packages are available and compatible with the current version of the project.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Hi @alirana01, thanks for the PR, mostly looks good to me. I wrote down some notes. I would also consider removing too deep nesting in some places and using lambda expressions instead of anonymous classes where it is possible to increase readability, but that's not that critical and up to you.
I will also make a functionality review a little bit later.
| ILaunchConfiguration launchConfig = finalActiveLaunch.getLaunchConfiguration(); | ||
| Display.getDefault().asyncExec(() -> { | ||
| String projectName; | ||
| try | ||
| { | ||
| projectName = launchConfig.getAttribute( | ||
| ICDTLaunchConfigurationConstants.ATTR_PROJECT_NAME, StringUtil.EMPTY); | ||
|
|
||
| if (!projectName.isEmpty()) | ||
| { | ||
| IProject project = ResourcesPlugin.getWorkspace().getRoot() | ||
| .getProject(projectName); |
There was a problem hiding this comment.
I think we can get the project directly from the launch configuration's mapped resources. Something like this: configuration.getMappedResources()[0].getProject(); or something like this if you want to avoid null checks:
IResource[] resources = null;
try
{
resources = config.getMappedResources();
}
catch (CoreException e)
{
Logger.log(e);
}
Optional<IProject> projectOptional = resources == null ? Optional.empty()
: Stream.of(resources).filter(Objects::nonNull)
.filter(resource -> resource.getType() == IResource.PROJECT).map(IResource::getProject)
.findFirst();
}
There was a problem hiding this comment.
I am not clear on this we can use that approach but this should be fine too I think since the attribute ID comes from internal static constant
| GcovFileView gcovFileView = (GcovFileView) page | ||
| .showView(GcovFileView.ID); |
There was a problem hiding this comment.
I'm not sure if that's okay to use the class from the UI package here, since it can cause cyclic dependency later. Isn't it better to move this handler to the com.espressif.idf.ui.handlers package?
There was a problem hiding this comment.
There are some launch class dependencies there that are required and I am not sure if that can be good to add this package as a dependency to ui project
| IFile file = (IFile) item.getData(); | ||
|
|
||
| if (item != null && file != null) |
| if (getSelectedProject() == null) | ||
| { | ||
| setSelectedProject(GcovUtility.getSelectedProject()); | ||
| } |
There was a problem hiding this comment.
Is the Utility class really necessary for this? I believe we can retrieve a mapped project from the active launch configuration at this moment, can't we?
There was a problem hiding this comment.
I did this because we may have multiple projects and user can right click on the project and launch this view
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (1)
- releng/com.espressif.idf.target/com.espressif.idf.target.target (2 hunks)
Files skipped from review due to trivial changes (1)
- releng/com.espressif.idf.target/com.espressif.idf.target.target
| <unit id="org.eclipse.linuxtools.dataviewers.feature.feature.group" version="8.11.0.202306052033"/> | ||
| <unit id="org.eclipse.linuxtools.gprof.feature.feature.group" version="8.11.0.202306052033"/> | ||
| <unit id="org.eclipse.linuxtools.profiling.feature.group" version="8.11.0.202306052033"/> | ||
| <unit id="org.eclipse.linuxtools.profiling.remote.feature.group" version="8.11.0.202306052033"/> |
There was a problem hiding this comment.
Hi @alirana01 Do we need all the features from the linuxtools? I thought we only need org.eclipse.linuxtools.gcov-feature? Also avoid mentioning a specific version so that it will continue to work with the latest versions when it's available.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (1)
- releng/com.espressif.idf.target/com.espressif.idf.target.target (2 hunks)
Files skipped from review due to trivial changes (1)
- releng/com.espressif.idf.target/com.espressif.idf.target.target
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Files selected for processing (1)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (1 hunks)
Additional comments (Suppressed): 5
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (5)
73-128: The
createPartControlmethod is responsible for creating the UI components of the view. It creates a table with multiple columns and sets up listeners for various events such as double-clicking on a row. The method also adds a "Refresh" action to the toolbar, which calls therefreshListmethod when clicked. This method seems well-structured and doesn't appear to have any significant issues.130-141: This
selectionChangedmethod updates the selected project based on the current selection in the workbench. It checks if the selection is an instance ofIStructuredSelectionand if the first element of the selection is an instance ofIProject. If both conditions are met, it sets the selected project. This method seems to be implemented correctly.269-273: The
setFocusmethod sets the focus to the table when the view is focused. This method seems to be implemented correctly.275-280: The
disposemethod removes the selection listener from the page and calls the superclass's dispose method. This method seems to be implemented correctly.282-290: The
getSelectedProjectandsetSelectedProjectmethods are simple getter and setter methods for theselectedProjectfield. These methods seem to be implemented correctly.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (3)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties (1 hunks)
Files skipped from review due to trivial changes (3)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties
There was a problem hiding this comment.
Review Status
Actionable comments generated: 10
Files selected for processing (20)
- bundles/com.espressif.idf.core/META-INF/MANIFEST.MF (1 hunks)
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java (1 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/plugin.xml (1 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (3 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java (1 hunks)
- bundles/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java (1 hunks)
- bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF (1 hunks)
- bundles/com.espressif.idf.ui/plugin.xml (4 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/LogMessagesThread.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/InstallEspIdfPage.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/ManageToolsInstallationWizardPage.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/InstallToolsHandler.java (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/Messages.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/messages.properties (1 hunks)
- releng/com.espressif.idf.target/com.espressif.idf.target.target (2 hunks)
Files skipped from review due to trivial changes (10)
- bundles/com.espressif.idf.core/META-INF/MANIFEST.MF
- bundles/com.espressif.idf.debug.gdbjtag.openocd/plugin.xml
- bundles/com.espressif.idf.ui/plugin.xml
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/LogMessagesThread.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/Messages.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/messages.properties
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/Messages.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/messages.properties
- releng/com.espressif.idf.target/com.espressif.idf.target.target
Additional comments (Suppressed): 14
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/ManageToolsInstallationWizardPage.java (1)
- 54-61: The import statement for
LogMessagesThreadhas been moved from the old hunk to the new one. Ensure that this change does not affect the functionality of the code, as the order of import statements can sometimes matter in certain contexts.bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF (2)
41-45: The new hunk adds two dependencies:
org.eclipse.core.variablesandorg.eclipse.ltk.core.refactoring. Ensure that these dependencies are compatible with the rest of your project and that they don't introduce any breaking changes. Also, verify that the specified version fororg.eclipse.core.variablesis correct.49-54: New packages
com.espressif.idf.ui.gcovandcom.espressif.idf.ui.dialogshave been added to the exported packages list. Make sure that these packages are intended to be exposed to other bundles and that they contain only the classes and interfaces that should be publicly accessible.bundles/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java (1)
- 190-196: The method
handlePythonDependenciesInstall()is now being called instead of the previoushandleWebSocketClientInstall(). Ensure that this change doesn't affect other parts of the codebase that rely on the WebSocket client being installed by this method. Also, verify that the new method correctly handles the installation of Python dependencies as expected.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/wizard/pages/InstallEspIdfPage.java (1)
- 36-44: The import statements are rearranged, and there is no addition or removal of any imports. Ensure that the new arrangement doesn't violate your project's code style guidelines.
bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (3)
22-28: The import statement for
DsfExecutorhas been added. Ensure that this new import does not conflict with any existing code and is used appropriately in the subsequent code.38-43: The import statement for
LaunchConfigurationWorkingCopyfromorg.eclipse.debug.internal.corehas been removed and replaced withILaunchConfigurationWorkingCopyfromorg.eclipse.debug.core. This change could potentially affect the functionality of the code if methods specific toLaunchConfigurationWorkingCopywere being used. Please verify that this change doesn't break any existing functionality.74-91: As per the previous discussion, the
getSession()andgetDsfExecutor()methods have been overridden to make them publicly accessible. The changes are approved as they meet the requirement stated.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java (3)
574-580: The method
handlePipDependenciesInstall()is called here, which now installs thegcovrPython package. Ensure that this new dependency does not conflict with other parts of the system and that it's compatible with the current Python environment.982-985: The method name has been changed from
handleWebSocketClientInstall()tohandlePipDependenciesInstall(). Verify that all calls to this method throughout the codebase have been updated to match the new method name.997-999: The
gcovrpackage is added as a new Python dependency. Make sure that this package is compatible with the existing Python environment and doesn't introduce any conflicts with other dependencies.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/update/InstallToolsHandler.java (3)
96-103: The task name for the monitor has been updated to reflect the new functionality of installing Python dependencies. Ensure that the corresponding message in
Messages.InstallToolsHandler_InstallingPythonDepMsgis correctly set to indicate this change.219-225: The method
handlePythonDependenciesInstall()has been introduced to handle the installation of Python dependencies, specificallywebsocket-clientandgcovr. This is a change from the previous version where onlywebsocket-clientwas installed. Make sure that the addition ofgcovrdoes not introduce any compatibility issues with the existing system.264-278: The check for installed dependencies now includes
gcovralong withwebsocket-client. If both are found, the function returns an OK status. If not, it attempts to install both. This is a change from the previous version where onlywebsocket-clientwas checked and installed. Ensure that the installation process handles potential errors or failures when installinggcovr.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java
Show resolved
Hide resolved
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java
Show resolved
Hide resolved
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java
Show resolved
Hide resolved
....debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java
Show resolved
Hide resolved
....debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java
Show resolved
Hide resolved
....debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java
Outdated
Show resolved
Hide resolved
....debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java
Show resolved
Hide resolved
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
Show resolved
Hide resolved
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
Show resolved
Hide resolved
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileView.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files ignored due to filter (6)
- docs/images/GcovCodeCoverage/gcov-1.png
- docs/images/GcovCodeCoverage/gcov-2.png
- docs/images/GcovCodeCoverage/gcov-3.png
- docs/images/GcovCodeCoverage/gcov-4.png
- docs/images/GcovCodeCoverage/gcov-5.png
- docs/images/GcovCodeCoverage/gcov-6.png
Files selected for processing (1)
- README.md (2 hunks)
Files skipped from review due to trivial changes (1)
- README.md
Rate Limit ExceededYou have exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 29 minutes and 59 seconds before requesting another review. To re-trigger a review, convert this PR to a draft and then mark it as ready for review again. Alternatively, you can push a new commit to this PR. |
Rate Limit ExceededYou have exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 29 minutes and 59 seconds before requesting another review. To re-trigger a review, convert this PR to a draft and then mark it as ready for review again. Alternatively, you can push a new commit to this PR. |
alirana01
changed the title
| org.eclipse.embedcdt.core;visibility:=reexport, | ||
| org.eclipse.linuxtools.gcov.core, | ||
| org.eclipse.linuxtools.gcov.docs, | ||
| org.eclipse.linuxtools.gcov.launch, | ||
| org.eclipse.linuxtools.binutils, | ||
| org.eclipse.linuxtools.gprof, | ||
| org.eclipse.linuxtools.gprof.docs, | ||
| org.eclipse.linuxtools.gprof.launch, | ||
| org.eclipse.linuxtools.tools.launch.core, | ||
| org.eclipse.linuxtools.tools.launch.ui, | ||
| org.eclipse.linuxtools.dataviewers, | ||
| org.eclipse.linuxtools.dataviewers.charts, | ||
| org.eclipse.linuxtools.dataviewers.piechart, | ||
| org.eclipse.linuxtools.docker.core, | ||
| org.eclipse.linuxtools.docker.ui, | ||
| org.eclipse.linuxtools.profiling.docs, | ||
| org.eclipse.linuxtools.profiling.launch, | ||
| org.eclipse.linuxtools.profiling.ui, | ||
| org.eclipse.core.variables |
There was a problem hiding this comment.
Could we add what is mandatory here?
| <command | ||
| defaultHandler="com.espressif.idf.debug.gdbjtag.openocd.gcov.GcovDumpHandler" | ||
| id="com.espressif.idf.gcov.instant" | ||
| name="GCOV Instant"> |
There was a problem hiding this comment.
Can we follow same convention as esp-idf Gcov Instant https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/app_trace.html#gcov-source-code-coverage
| defaultHandler="com.espressif.idf.debug.gdbjtag.openocd.gcov.GcovDumpHandler" | ||
| id="com.espressif.idf.gcov.hardcoded" | ||
| name="GCOV Hard-coded"> | ||
| </command> |
There was a problem hiding this comment.
...ressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
Show resolved
Hide resolved
| <unit id="org.eclipse.linuxtools.profiling.feature.group" version="0.0.0"/> | ||
| <unit id="org.eclipse.linuxtools.profiling.remote.feature.group" version="0.0.0"/> |
There was a problem hiding this comment.
Can you check if we need all of them? Probably, we need only org.eclipse.linuxtools.gcov.feature.group
|
Hi @AndriiFilippov Please verify this |
kolipakakondal
added
enhancement
|
@alirana01 hi ! Tested under: Able to generate reports using Generate Hard-coded GCOV Dump: but getting the console error: Also was not able to use "Generate Instant Runtime GCOV Dump". Even after restar OpenOCD or Reset the board by issuing the reset command via telnet like it mentioned https://github.com/espressif/esp-idf/blob/master/examples/system/gcov/README.md#openocd-out-of-sync Getting error: Also, there is identical icons for different actions: |
|
@kolipakakondal I discussed this with Ivan seems like an issue from the OpenOCD I will discuss this with Erhan or Alexey Lipshin and will try to resolve this for now I dont think so its a good idea to push this with the release because the icons are also missing and I dont want to push it without proper confirmation from the other team Further discussion here |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (3)
- README_CN.md (15 hunks)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java (1 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/gcov/GcovFileViewCommandHandler.java (1 hunks)
Additional comments: 9
README_CN.md (9)
- 46-46: The addition of the "GCOV Code Coverage and Dump Generation" section to the table of contents is clear and correctly links to the new section further down in the document. This change effectively informs users about the new feature available in the ESP-IDF Eclipse plugin.
- 61-63: The update to the prerequisites section, specifically the addition of the Eclipse IDE C/C++ Development Tool version requirement, is a necessary and helpful clarification for users setting up their development environment. It ensures that users install a compatible version of Eclipse, preventing potential compatibility issues.
- 87-87: The instruction to select "Espressif IDF" from the list during the plugin installation process is clear and straightforward. This step is crucial for users to correctly install the ESP-IDF Eclipse plugin, and the explanation is concise and to the point.
- 207-207: The addition of instructions for configuring the serial port output in Eclipse is a valuable update for users. It guides them through the process of setting up the ESP-IDF Serial Monitor, which is essential for debugging and monitoring the output of ESP-IDF projects.
- 219-219: The update to the ESP-IDF Serial Monitor settings, specifically the addition of instructions for setting the character and line limits, is a useful enhancement. It allows users to customize the Serial Monitor according to their preferences, improving the usability of the tool.
- 280-280: The addition of the "ESP-IDF Terminal" section provides users with instructions on how to open a local terminal window within Eclipse. This feature enhances the development experience by allowing users to access ESP-IDF terminal commands directly from the Eclipse environment.
- 317-317: The update to the environment variables configuration section is crucial for ensuring that users correctly set up their development environment. It provides clear instructions on how to manually configure essential environment variables if they are not automatically set up by the ESP-IDF tool installer.
- 415-429: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [402-426]
The addition of the troubleshooting section, including error logs, console view logs, and the Espressif IDF Toolchain Console, is a significant improvement. It provides users with guidance on how to diagnose and resolve issues that may arise during development, making the plugin more user-friendly and accessible.
- 553-585: The detailed explanation of the GCOV Code Coverage and Dump Generation feature is a valuable addition to the README. It guides users through the process of generating and viewing GCOV reports within Eclipse, enhancing the plugin's functionality for code coverage analysis. However, it's important to ensure that the links provided in this section are accessible and lead to the correct resources.
Verification successful
The links provided in the GCOV Code Coverage and Dump Generation section are accessible. The first link redirects to a new URL, which is a common practice and does not hinder access to the intended content. The second link directly leads to the accessible README.md file. Therefore, the detailed explanation and the links are correctly guiding users through the process as intended.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the accessibility of the provided links in the GCOV section. curl -I https://github.com/espressif/esp-idf/blob/master/examples/system/gcov/ curl -I https://github.com/espressif/esp-idf/blob/master/examples/system/gcov/README.mdLength of output: 9051
| @Override | ||
| public Object execute(ExecutionEvent event) throws ExecutionException | ||
| { | ||
| IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); | ||
| if (window == null) | ||
| { | ||
| throw new ExecutionException("Active workbench window cannot be retrieved"); | ||
| } | ||
|
|
||
| IWorkbenchPage page = window.getActivePage(); | ||
| if (page == null) | ||
| { | ||
| throw new ExecutionException("Active page cannot be retrieved"); | ||
| } | ||
|
|
||
| try | ||
| { | ||
| GcovUtility.clearSelectedProject(); | ||
| page.showView(GcovFileView.ID); | ||
| } | ||
| catch (PartInitException e) | ||
| { | ||
| Logger.log(UIPlugin.getDefault(), "Failed to initialize GcovFileView: " + e.getMessage(), e); | ||
| } | ||
| return null; | ||
| } |
There was a problem hiding this comment.
The implementation of the execute method correctly retrieves the active workbench window and page, and then attempts to show the GcovFileView. However, there are a couple of areas that could be improved for robustness and maintainability:
- Exception Handling: The method throws
ExecutionExceptionfor nullwindoworpage, which is appropriate. However, consider logging these exceptions using the project's logging mechanism for better traceability. - Clearing Selected Project: Before showing the view,
GcovUtility.clearSelectedProject()is called. Ensure this action does not have unintended side effects on other parts of the application that might rely on the previously selected project.
| @Override | ||
| public Object execute(ExecutionEvent event) throws ExecutionException | ||
| { | ||
| isInstant = event.getCommand().getId().equals(INSTANT_ID); | ||
| ILaunchManager launchManager = DebugPlugin.getDefault().getLaunchManager(); | ||
| ILaunch[] launches = launchManager.getLaunches(); | ||
| ILaunch launchActive = null; | ||
| for (ILaunch launch : launches) | ||
| { | ||
| if (!launch.isTerminated()) | ||
| { | ||
| launchActive = launch; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| DsfServicesTracker dsfServicesTracker = ((Launch) launchActive).getDsfServicesTracker(); | ||
| ICommandControlService commandControlService = dsfServicesTracker.getService(ICommandControlService.class); | ||
| DsfExecutor dsfExecutor = ((Launch) launchActive).getDsfExecutor(); | ||
| IRunControl runControl = dsfServicesTracker.getService(IRunControl.class); | ||
| ICommandControlDMContext controlDmc = DMContexts.getAncestorOfType(commandControlService.getContext(), | ||
| ICommandControlDMContext.class); | ||
| IProcesses processControl = dsfServicesTracker.getService(IProcesses.class); | ||
| processControl.getProcessesBeingDebugged(controlDmc, new DataRequestMonitor<IDMContext[]>(dsfExecutor, null) | ||
| { | ||
| @Override | ||
| protected void handleSuccess() | ||
| { | ||
| executionDMContext = (IExecutionDMContext) (getData()[0]); | ||
| } | ||
| }); | ||
| final ILaunch finalActiveLaunch = launchActive; | ||
| runControl.suspend(executionDMContext, new RequestMonitor(dsfExecutor, null) | ||
| { | ||
| @Override | ||
| protected void handleSuccess() | ||
| { | ||
| commandControlService.queueCommand(new CLICommand<>(commandControlService.getContext(), | ||
| isInstant ? "mon esp gcov dump" : "mon esp gcov"), new ImmediateDataRequestMonitor<>() | ||
| { | ||
| @Override | ||
| protected void handleSuccess() | ||
| { | ||
| runControl.resume(executionDMContext, new RequestMonitor(dsfExecutor, null)); | ||
| ILaunchConfiguration launchConfig = finalActiveLaunch.getLaunchConfiguration(); | ||
| Display.getDefault().asyncExec(() -> { | ||
| String projectName; | ||
| try | ||
| { | ||
| projectName = launchConfig.getAttribute( | ||
| ICDTLaunchConfigurationConstants.ATTR_PROJECT_NAME, StringUtil.EMPTY); | ||
|
|
||
| if (!projectName.isEmpty()) | ||
| { | ||
| IProject project = ResourcesPlugin.getWorkspace().getRoot() | ||
| .getProject(projectName); | ||
| if (project != null && project.exists()) | ||
| { | ||
| GcovUtility.setSelectedProject(project); | ||
| IWorkbenchWindow window = PlatformUI.getWorkbench() | ||
| .getActiveWorkbenchWindow(); | ||
| if (window != null) | ||
| { | ||
| IWorkbenchPage page = window.getActivePage(); | ||
| if (page != null) | ||
| { | ||
| try | ||
| { | ||
| GcovFileView gcovFileView = (GcovFileView) page | ||
| .showView(GcovFileView.ID); | ||
| page.activate(gcovFileView); | ||
|
|
||
| } | ||
| catch (PartInitException e) | ||
| { | ||
| Logger.log(e); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| catch (CoreException e) | ||
| { | ||
| Logger.log(e); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| protected void handleError() | ||
| { | ||
| Logger.log("Error Occurred while running dump comand resuming debug operation"); | ||
| runControl.resume(executionDMContext, new RequestMonitor(dsfExecutor, null)); | ||
| } | ||
| }); | ||
| } | ||
| }); | ||
| return null; | ||
| } |
There was a problem hiding this comment.
The execute method in GcovDumpHandler performs several critical operations to handle gcov dump commands. Here are some areas for improvement and considerations:
- Launch Selection: The method selects the first non-terminated launch it finds. This approach might not always select the correct or expected launch if multiple are active. Consider implementing a more precise selection mechanism.
- Service Retrieval and Null Checks: Services are retrieved from the
DsfServicesTrackerwithout null checks. Adding null checks before using these services can prevent potentialNullPointerExceptions. - UI Thread Operations: The method updates the UI from within the
Display.getDefault().asyncExecblock. Ensure that all UI-related operations are correctly encapsulated within this block to avoid SWT thread access violations. - Error Handling: The method logs errors but does not inform the user of failures directly. Consider improving user feedback for errors, especially for operations like
runControl.resumein thehandleErrorblock of the command execution.
Description
New feature to add the ability to create and view the gcov reports inside the eclipse
Fixes # (IEP-374)
Type of change
Please delete options that are not relevant.
How has this been tested?
Creating gcov reports using the gcov example
Test Configuration:
Checklist
Summary by CodeRabbit
Summary by CodeRabbit
handleWebSocketClientInstall()tohandlePythonDependenciesInstall(), reflecting the change in dependency installation process.gcovrpackage along withwebsocket-client.