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.

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

Jump to bottom

Introduce custom JavaDoc tags to structure test summaries #565

Closed
onewhl opened this issue Jul 21, 2022 · 0 comments · Fixed by #585
Closed

Introduce custom JavaDoc tags to structure test summaries #565

onewhl opened this issue Jul 21, 2022 · 0 comments · Fixed by #585
Assignees
@onewhl
Labels
comp-summaries Something related to the method names, code comments and display names generation

Comments

@onewhl
Copy link
Member

onewhl commented Jul 21, 2022

Description

Currently, summaries are hard to read because of formatting issues and a lot of details they contain.
We can introduce custom JavaDoc tags that would make summaries more structured and clear.

Expected behavior

Plugin supports custom JavaDoc tags. For example, @methodUnderTest, @classUnderTest, @expectedResult, @actualResult.
@onewhl onewhl added the comp-summaries Something related to the method names, code comments and display names generation label Jul 21, 2022
@onewhl onewhl self-assigned this Jul 21, 2022
@korifey korifey moved this to Todo in UTBot Java Jul 21, 2022
onewhl added a commit that referenced this issue Jul 22, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
e757f8a
onewhl added a commit that referenced this issue Jul 22, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
36a1965
onewhl added a commit that referenced this issue Jul 25, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
1497a97
@onewhl onewhl mentioned this issue Jul 25, 2022
Merged
7 tasks
onewhl added a commit that referenced this issue Jul 26, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
18d3585
onewhl added a commit that referenced this issue Jul 27, 2022
@onewhl
Fill value of utbot.iterates tag #565
3fa8cad
@amandelpie amandelpie mentioned this issue Jul 27, 2022
Closed
onewhl added a commit that referenced this issue Jul 28, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
17986fd
onewhl added a commit that referenced this issue Aug 2, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
a2f36a6
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
d2706a3
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
f29bdba
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
97b5111
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Fill value of utbot.iterates tag #565
de3d274
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
539401e
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
e2e53f9
onewhl added a commit that referenced this issue Aug 3, 2022
@onewhl
Add summary tests for MinStack #565
710a3f3
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
9b92938
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
b5fe16c
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
26cb72b
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Fill value of utbot.iterates tag #565
051317d
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
91a475e
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
13e85bb
onewhl added a commit that referenced this issue Aug 4, 2022
@onewhl
Add summary tests for MinStack #565
12da9ed
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
79c9122
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
692df39
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
9a2476e
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Fill value of utbot.iterates tag #565
7ed52a3
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
c7de027
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
ffdc0ee
onewhl added a commit that referenced this issue Aug 17, 2022
@onewhl
Add summary tests for MinStack #565
1076077
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
62d79ee
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
6b7710b
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
f95c2e6
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Fill value of utbot.iterates tag #565
4f6c271
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
4a58319
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
4692a99
onewhl added a commit that referenced this issue Aug 22, 2022
@onewhl
Add summary tests for MinStack #565
73d6548
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
d17ea26
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
e379994
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
edb7c4e
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Fill value of utbot.iterates tag #565
f8f1854
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
a421f8b
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
60a69d8
onewhl added a commit that referenced this issue Aug 23, 2022
@onewhl
Add summary tests for MinStack #565
2004ae7
@onewhl onewhl mentioned this issue Aug 23, 2022
Closed
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Introduce custom plugin's JavaDoc tags #565
e88bd65
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Render UtBot custom JavaDoc tags correctly #565
43c4cf0
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Add an option to generate summaries using custom JavaDoc tags #565
760594f
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Fill value of utbot.iterates tag #565
050550f
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Collect info about Invoke, Iterate, and Return sections #565
ca86976
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Add unit tests for summaries with custom JavaDoc tags #565
6ae1157
onewhl added a commit that referenced this issue Aug 24, 2022
@onewhl
Add summary tests for MinStack #565
8d4063b
amandelpie pushed a commit that referenced this issue Aug 24, 2022
@onewhl
Introduce custom JavaDoc tags #565 (#585)
7c95c43 
* Introduce custom plugin's JavaDoc tags #565

* Render UtBot custom JavaDoc tags correctly #565

* Add an option to generate summaries using custom JavaDoc tags #565

* Fill value of utbot.iterates tag #565

* Collect info about Invoke, Iterate, and Return sections #565

* Review fixes

* Add unit tests for summaries with custom JavaDoc tags #565

* Fix after rebasing

* Add summary tests for MinStack #565

* Fix broken tests

* Add <pre> tag only in case when custom javadoc tags are not used

* Use a full exception name instead of simple name to build inline link correctly

* Minor refactoring

* Minor refactoring: avoid code duplication

* Add DocCustomTagStatement and CgCustomTagStatement

* Refactored code to avoid code duplication

* Fix tests: add full name for classes

* Add JUnit extension to control USE_CUSTOM_TAGS setting

* Move useCustomJavaDocTags to UtSettings, make useFuzzing true

* Remove unused import and fix broken tests

* Fix broken tests

* Add comments, remove unused method

* Review fixes: fixed formatting, removed redundant types

* Review fixes: fixed formatting, removed useless overriding methods

* Review fixes: extracted method, polished code

* fix after rebasing

* fix after rebasing

* review fixes

* fix rendering after updating to idea 2022.1. now we don't need to generate comment content with HTML tags, we need only replace custom tags' names with their messages to make it look nice
Repository owner moved this from Todo to Done in UTBot Java Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@onewhl onewhl

Labels
comp-summaries Something related to the method names, code comments and display names generation
Projects
UTBot Java
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce custom JavaDoc tags #565 UnitTestBot/UTBotJava
1 participant
@onewhl