Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Built-in SARIF reports visualizer #1166

Merged
merged 5 commits into from
Oct 19, 2022
Merged

Conversation

mmvpm
Copy link
Collaborator

@mmvpm mmvpm commented Oct 17, 2022

Description

The SARIF report visualizer built into the IDEA plugin

All errors detected by UnitTestBot are displayed in the "Problems" tool window automatically after the test is generated:

image

The user can view the generated test for each error:

image

The user can also analyze the stack trace of the exception:

image

Fixes #972

Type of Change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Manual Scenario

  1. Run UTBot test generation on your Java project
  2. If errors have been detected (the SARIF report contains at least one) the "Problems" tool window will be automatically opened. If not, "Problems" tab will not be opened.
  3. For each problem the user has an opportunity to view the generated test and analyze the stack trace
  4. Double click on the problem navigates the user to the place in the source code where this problem was detected

Checklist:

  • The change followed the style guidelines of the UTBot project
  • Self-review of the code is passed
  • The change contains enough commentaries, particularly in hard-to-understand areas
  • New documentation is provided or existed one is altered
  • No new warnings
  • New tests have been added
  • All tests pass locally with my changes

@mmvpm mmvpm self-assigned this Oct 17, 2022
@alisevych
Copy link
Member

alisevych commented Oct 17, 2022

Risky disabled tests

Currently executions that are stopped on AccessControlException - Disabled due to sandbox - are not added to SARIF report as errors and are not displayed on Problems tab.
Same with the tests "Disabled due to possible JVM crash".

created a task for that: #1168

@alisevych
Copy link
Member

alisevych commented Oct 17, 2022

Usability enhancements:

There is a new tab opened on Problems window - each time test generations results contain problems.
Can we close the tab - if the same test class is generated?

Tabs with IDEA Inspections of code stays opened. So currently it is made just as it is designed in IDE.

That would be good to name the tabs shortly, currently 5 tabs are filling the width of the screen:

Only the first part can be changed 'UnitTestBotProfile'.
Probably we can leave just 'UnitTestBot'? word 'Profile' is added by IDEA.

image

@mmvpm mmvpm force-pushed the ideaseeker/utbot_instpection_tool_rd branch from 7aea587 to 69303b5 Compare October 19, 2022 07:55
@mmvpm mmvpm force-pushed the ideaseeker/utbot_instpection_tool_rd branch from 69303b5 to bbc1766 Compare October 19, 2022 07:56
@mmvpm mmvpm enabled auto-merge (squash) October 19, 2022 07:57
@mmvpm mmvpm merged commit 0a3d74c into main Oct 19, 2022
@mmvpm mmvpm deleted the ideaseeker/utbot_instpection_tool_rd branch October 19, 2022 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a built-in SARIF reports visualizer
4 participants