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

Disable test generation for synthetic methods of data classes #1191 #1192

Merged
merged 2 commits into from
Oct 31, 2022
Merged

Disable test generation for synthetic methods of data classes #1191 #1192

merged 2 commits into from
Oct 31, 2022

Conversation

volivan239
Copy link
Collaborator

@volivan239 volivan239 commented Oct 19, 2022 •
edited
Loading

Description

Added filters so that autogenerated by Kotlin methods of data classes are not tested by plugin/cli/contestEstimator

Fixes #1191

Type of Change

  • Minor bug fix (non-breaking small changes)

How Has This Been Tested?

Manual Scenario

Tested the behavior in plugin -- autogenerated methods are not added to memberlist (unless they are overridden).
In cli tests for autogenerated methods are also not generated.

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
  • New tests have been added
  • All tests pass locally with my changes

@volivan239 volivan239 force-pushed the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch 2 times, most recently from 2f9f48e to 8911095 Compare October 25, 2022 09:58
@volivan239 volivan239 marked this pull request as ready for review October 25, 2022 12:06
Damtev
Damtev requested changes Oct 26, 2022
View reviewed changes
Copy link
Member

@Damtev Damtev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a bit more docs, please

utbot-framework/src/main/kotlin/org/utbot/framework/util/SyntheticMethods.kt Outdated
Comment on lines 8 to 14
if (method.classId.isEnum)
method.humanReadableName.substringBefore('(') in KnownSyntheticMethodNames.enumSyntheticMethodNames
else
false
return method.name in KnownSyntheticMethodNames.enumSyntheticMethodNames

if (method.classId.isData)
return KnownSyntheticMethodNames.dataClassSyntheticMethodNames.any { it.matches(method.name) }

return false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when may be better here, I suppose

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible here? isEnum and isData are just properties...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a simple one, like

when {
    method.classId.isEnum -> ...
    method.classId.isData -> ...
    else -> ...
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

utbot-framework/src/main/kotlin/org/utbot/framework/util/SyntheticMethods.kt Outdated
"hashCode",
"toString",
"copy",
"copy\\\$default",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this method? Add some comments about it, please

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is JVM-synthetic and needed when copy is called with default parameters, after last commit it is not needed here.

utbot-framework/src/main/kotlin/org/utbot/framework/util/SyntheticMethods.kt Outdated
@@ -17,4 +21,14 @@ fun isKnownSyntheticMethod(method: ExecutableId): Boolean =
private object KnownSyntheticMethodNames {
/** List with names of enum methods that are autogenerated */
val enumSyntheticMethodNames = listOf("values", "valueOf")

/** List with names of data classes methods that are autogenerated in Kotlin */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention that they are actually regexps, please

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, also changed the property name for more clarity

Damtev
Damtev requested changes Oct 26, 2022
View reviewed changes
Copy link
Member

@Damtev Damtev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about overridden methods in data classes for CLI?

utbot-framework/src/main/kotlin/org/utbot/framework/util/SyntheticMethods.kt Outdated
Comment on lines 11 to 12
if (method.classId.isData)
return KnownSyntheticMethodNames.dataClassSyntheticMethodNames.any { it.matches(method.name) }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I right that CLI will not generate test methods for overridden "synthetic" methods in data classes (equals, for example)?

Copy link
Collaborator Author

@volivan239 volivan239 Oct 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, and it seems difficult (or impossible) to check if the method is not compiler-generated but overridden by user (but if you know the way, I would appreciate hearing it). Added a comment to code about this.

@volivan239 volivan239 force-pushed the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch from 8911095 to 31ada23 Compare October 26, 2022 14:30
@volivan239 volivan239 requested a review from Damtev October 26, 2022 14:37
@volivan239 volivan239 force-pushed the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch from 31ada23 to 9b1dc38 Compare October 26, 2022 15:01
@volivan239 volivan239 force-pushed the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch from 9b1dc38 to b9ffd0f Compare October 28, 2022 20:21
@volivan239 volivan239 force-pushed the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch from b9ffd0f to 0867c5a Compare October 31, 2022 09:49
@volivan239 volivan239 enabled auto-merge (squash) October 31, 2022 09:50
@volivan239 volivan239 merged commit 145da7d into main Oct 31, 2022
@volivan239 volivan239 deleted the volivan239/disable_test_generation_for_synthetic_dataclass_methods branch October 31, 2022 10:28
@volivan239 volivan239 mentioned this pull request Nov 9, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Damtev Damtev Damtev approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

We shouldn't generate tests for synthetic methods of data classes
2 participants
@volivan239 @Damtev