Skip to content

Add initial description of summary module for the OverallArchitecture.md #1405

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 15, 2022
Merged

Add initial description of summary module for the OverallArchitecture.md #1405

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8200770
Added some docs
amandelpie Nov 21, 2022
78123a6
Merge branch 'main' into amandelpie/add_two_cents
amandelpie Nov 29, 2022
489fd21
Merge branch 'main' into amandelpie/add_two_cents
amandelpie Dec 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/OverallArchitecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,22 @@ TODO (Maxim Pelevin)
TODO (Sergey Pospelov)

### Summaries
TODO (Alexey Zinoviev)
The summarization process includes the generation of the following meta-information:
- method names for tests
- display names for tests
- JavaDocs for tests
- simple comments for group of tests (regions)

Each of these stages can be turned off by changing
the settings located in ```org.utbot.summary.UtSummarySettings```.

If the summarization process for some reason was failed at one of the stages due to an error or insufficient information,
then the test method receives a unique name and no more meta-information.

The approach to generating meta-information depends on the type of UtExection for which the meta-information is being created and can vary significantly.
Also, JavaDocs built in two modes: as plain text or in especial format enriched with the custom java tags.

This subsystem is fully located in the ```utbot-summary``` module.

### Sarif report
TODO (Nikita Stroganov)
Expand Down