Self-documenting settings template #1420

Vassiliy-Kudryashov · 2022-11-24T17:40:20Z

Description

There is new helper to be used from Gradle task. It converts UtSettings.kt to resource file settings.properties.
So, actual state of UtSettings.kt (properties, defauls, relevant documentation comments) will allways be converted to bundled resource file we publish along with the plugin as top-level entry inside utbot-intellij-{version}.jar file.
Note, the template contains commented lines only so we free to change our hardcoded defaults later and re-write outdated template with new one until it's customized by user.
Just after IDE start (namely when plugin loads its settings) we check if settings.properties is presented in user's local file system as {home}/.utbot/settings.properties:

If not we create it from the resource template together with the folder is need.
If file already exists we copy resource template only if there are no custom (provided by user) values inside to persist existing users' configuration "as is".

Fixes #1412

Type of Change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Manual Scenarios

Scenario 1

Delete {home}/.utbot folder if exists.
Start IDE, wait for project loading.
The folder {home}/.utbot should be created automatically, for Windows it also should be marked as "hidden file".
There should be template file settings.properties inside.
If you delete the file it should appear again after IDE restart.

Scenario 2

Clear the file {home}/.utbot/settings.properties, leave just one line inside: disableCoroutinesDebug=true
Start IDE, wait for project loading.
As soon as property file contains defaults, it should be re-writen with template.

Scenario 3

Clear the file {home}/.utbot/settings.properties, leave just one line inside: disableCoroutinesDebug=false
Start IDE, wait for project loading.
As soon as property file contains custom value, it should stay as is.

Checklist (remove irrelevant options):

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

Experiments with Gradle tasks

…, documentation

UTSettings.kt -> settings.properties, first iteration with several yet-not-parsed (skipped) properties

Split Single description for bunch options to dedicated ones in code Get rid of default value description in code Skip <a href... lines Support both var/val options Add empty lines between description/enum values/default to make output more user-friendly

…s wording in sourcecode

Save template to user's local file if absent Add some documentation comments

…ent to TestCaseGenerator.kt:300 some time ago) Get rid of unused property singleSelector Delete resource file settings.properties that is designed to be re-generated locally from the repository

…er-defined custom settings Make newly created ".utbot" folder hidden under Windows only

Make all properties commented to be free switch our hardcoded defaults later if any.

alisevych · 2022-11-25T14:25:28Z

Some ideas from our discussion with @Vassiliy-Kudryashov and @olganaumenko:

Create settings.properties.template near to settings.properties - and recreate it every time the plugin is installed.
That can be useful to have the template with the current version of settings.
Select the most important settings. Which can be suggested first to the user.
They can be listed above all others. And described separately in docs.

EgorkaKulikov

LNVGTM, but it seems to be our way now. Discussed verbally with Vasya. Some potential mines are going to be removed in further implementations.
Also I suggest to test it in branch before merge.

alisevych · 2022-11-29T13:32:45Z

@Vassiliy-Kudryashov Please check:
the changed settings are not applied (or may be not parsed)
Checked utBotGenerationTimeoutInMillis and useCustomJavaDocTags - not applied.
They are applied correctly with plugin built from main.

To reproduce

Removed existing settings.properties file
Installed build from this branch
Restarted IDE
Opened generated settings.properties file
Uncommented the line with utBotGenerationTimeoutInMillis and changed value to 1000
Restarted IDE once more
Open UnitTestBot dialog

Expected behavior

Test generation timeout should be 1 sec

Actual behavior

Default test generation timeout is applied - 60 sec

Additional context

The same issue is when executing runIde task.
The issue is not reproducing in main - the change of this setting is applied.

alisevych · 2022-11-29T14:07:18Z

@Vassiliy-Kudryashov Could you please correct the naming of treatAssertAsErrorSuit to treatAssertAsErrorSuite?

alisevych · 2022-11-29T15:05:44Z

@Vassiliy-Kudryashov
Also the usability question:

after UnitTestBot plugin installation there are 2 IDE restarts needed to apply new settings:

To generate settings.properties template
To apply changes in properties-file
Could we consider some improvements for this? Probably a discussion would help?

alisevych · 2022-11-29T15:19:10Z

@Vassiliy-Kudryashov @Domonion
Could you please advise if we can log the settings that differ from default ones?
One the step of IDE start or when the test run is performed.
That can explain some issues and help with reproducing customer's bugs.

Change copyright in the license template to utbot.org

* Convert 'UTSettings.kt' into '.utbot/settings.properties' * Add Apache 2.0 license to settings.properties output and tune comments wording in sourcecode * Add template generation to gradle build process * Add AbstractSettings.areCustomized() ability to tell template from user-defined custom settings * Make all properties commented to be free switch our hardcoded defaults later if any. * Fix an issue with always-default settings state. * Change copyright in the license template to utbot.org * Fix a misprint in UtSettings property name "treatAssertAsErrorSuite"

Vassiliy-Kudryashov and others added 13 commits November 17, 2022 10:06

Convert 'UTSettings.kt' into '.utbot/settings.properties'

e2e53f2

Experiments with Gradle tasks

Parsing UtSettings.kt line by line to get name, type, possible values…

0fc356d

…, documentation

Misprint

e397cda

Grade task "generateConfigTemplate"

bfda1de

UTSettings.kt -> settings.properties, first iteration with several yet-not-parsed (skipped) properties

Add TODOs for myself

5e567df

Implementation of added TODOs

e5b879c

Add Apache 2.0 license to settings.properties output and tune comment…

02cc183

…s wording in sourcecode

Add generated template to keep is in repository as well

b2a4581

Add template generation to gradle build process

52c60b7

Save template to user's local file if absent Add some documentation comments

Get rid of unused property timeslotForOneToplevelMethodTraversalMs (W…

bc40dbf

…ent to TestCaseGenerator.kt:300 some time ago) Get rid of unused property singleSelector Delete resource file settings.properties that is designed to be re-generated locally from the repository

Add AbstractSettings.areCustomized() ability to tell template from us…

8ab1578

…er-defined custom settings Make newly created ".utbot" folder hidden under Windows only

Fix misprints in Apache license text.

7cc19c0

Make all properties commented to be free switch our hardcoded defaults later if any.

Vassiliy-Kudryashov requested a review from denis-fokin November 24, 2022 17:40

Merge branch 'main' into Vassiliy-Kudryashov/experiments

5c83685

Merge branch 'main' into Vassiliy-Kudryashov/experiments

2b9373d

Vassiliy-Kudryashov changed the title ~~Vassiliy kudryashov/experiments~~ Self-documenting settings template Nov 28, 2022

Vassiliy-Kudryashov requested review from EgorkaKulikov and removed request for denis-fokin November 28, 2022 10:30

Merge branch 'main' into Vassiliy-Kudryashov/experiments

aee42d6

EgorkaKulikov approved these changes Nov 28, 2022

View reviewed changes

alisevych mentioned this pull request Nov 29, 2022

If invalid value is set for a property in settings.properties, default value should be applied #1437

Closed

Vassiliy-Kudryashov and others added 3 commits December 2, 2022 18:52

Fix an issue with always-default settings state.

5c1328f

Change copyright in the license template to utbot.org

Fix a misprint in UtSettings property name "treatAssertAsErrorSuite"

270aa3c

Merge branch 'main' into Vassiliy-Kudryashov/experiments

bd6dde8

Vassiliy-Kudryashov enabled auto-merge (squash) December 2, 2022 15:58

Fix a misprint in UtSettings property name "treatAssertAsErrorSuite"

b6e4ea7

Vassiliy-Kudryashov merged commit 31a983b into main Dec 2, 2022

Vassiliy-Kudryashov deleted the Vassiliy-Kudryashov/experiments branch December 2, 2022 16:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Self-documenting settings template #1420

Self-documenting settings template #1420

Vassiliy-Kudryashov commented Nov 24, 2022

alisevych commented Nov 25, 2022

EgorkaKulikov left a comment

alisevych commented Nov 29, 2022 •

edited

Loading

alisevych commented Nov 29, 2022

alisevych commented Nov 29, 2022

alisevych commented Nov 29, 2022

Self-documenting settings template #1420

Self-documenting settings template #1420

Conversation

Vassiliy-Kudryashov commented Nov 24, 2022

Description

Type of Change

How Has This Been Tested?

Manual Scenarios

Checklist (remove irrelevant options):

alisevych commented Nov 25, 2022

EgorkaKulikov left a comment

Choose a reason for hiding this comment

alisevych commented Nov 29, 2022 • edited Loading

alisevych commented Nov 29, 2022

alisevych commented Nov 29, 2022

alisevych commented Nov 29, 2022

alisevych commented Nov 29, 2022 •

edited

Loading