Refactored data clumps with the help of LLMs (research project) #3867
Conversation
There was a problem hiding this comment.
I'm not part of the JUnit Team. But I thought this PR looked interesting. And I left some suggestions, hope you find them useful.
Overall I think this refactoring has the right idea. Extracting the counter was the right action and does improve things. But this refactoring also unlocked some benefits that are not yet utilized.
junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/extension/HandlerCallCounter.java
Outdated
Show resolved
Hide resolved
| } | ||
|
|
||
| @Test | ||
| void classLevelExceptionHandlersRethrowException() { | ||
| LauncherDiscoveryRequest request = request().selectors(selectClass(RethrowingTestCase.class)).build(); | ||
| EngineExecutionResults executionResults = executeTests(request); | ||
|
|
||
| assertEquals(1, RethrowExceptionHandler.beforeAllCalls, "Exception should handled in @BeforeAll"); | ||
| assertEquals(1, RethrowExceptionHandler.afterAllCalls, "Exception should handled in @AfterAll"); | ||
| assertEquals(1, RethrowExceptionHandler.callCounter.getBeforeAllCalls(), |
There was a problem hiding this comment.
With the introduction of the HandlerCallCounter there is no need to store the counts as a field in the handler. You could now declare a HandlerCallCounter rethrowCounter as a static field on LifecycleMethodExecutionExceptionHandlerTests and reference that everywhere. I.e.
assertEquals(1, rethrowCounter.getBeforeAllCalls(), "Exception should handled in @BeforeAll");
With some thoughtfully chosen method and field names this would reduce the verbosity of the code a bit and keep the whole assertion on a single line.
junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/extension/HandlerCallCounter.java
Outdated
Show resolved
Hide resolved
| public void incrementBeforeAllCalls() { | ||
| beforeAllCalls++; | ||
| } | ||
|
|
||
| public void incrementBeforeEachCalls() { | ||
| beforeEachCalls++; | ||
| } | ||
|
|
||
| public void incrementAfterEachCalls() { | ||
| afterEachCalls++; | ||
| } | ||
|
|
||
| public void incrementAfterAllCalls() { | ||
| afterAllCalls++; | ||
| } | ||
|
|
||
| public int getBeforeAllCalls() { | ||
| return beforeAllCalls; | ||
| } | ||
|
|
||
| public int getBeforeEachCalls() { | ||
| return beforeEachCalls; | ||
| } | ||
|
|
||
| public int getAfterEachCalls() { | ||
| return afterEachCalls; | ||
| } | ||
|
|
||
| public int getAfterAllCalls() { | ||
| return afterAllCalls; | ||
| } |
There was a problem hiding this comment.
Since this class is only a local test helper, I don't think we need to encapsulate the fields. Therefore, I think these methods should be inlined.
|
Thank you very much for the feedback. @marcphilipp I have just applied the suggested changes. @mpkorstanje While I like your reasoning, I think this should be part of a larger redesign of the test classes. I haven't implement your proposal for now but I would be happy to do so if others concur |
compf
force-pushed
the
refactor_data_clumps
branch
from
eb0cf99
to
3f75c2f
Compare
|
@compf Thanks! 👍 |
Overview
Hello maintainers,
I am conducting a master thesis project focused on enhancing code quality through automated refactoring of data clumps, assisted by Large Language Models (LLMs).
Data clump definition
A data clump exists if
See also the following UML diagram as an example
I believe these refactoring can contribute to the project by reducing complexity and enhancing readability of your source code.
Pursuant to the EU AI Act, I fully disclose the use of LLMs in generating these refactorings, emphasizing that all changes have undergone human review for quality assurance.
Even if you decide not to integrate my changes to your codebase (which is perfectly fine), I ask you to fill out a feedback survey, which will be scientifically evaluated to determine the acceptance of AI-supported refactorings. You can find the feedback survey under https://campus.lamapoll.de/Data-clump-refactoring/en
Thank you for considering my contribution. I look forward to your feedback. If you have any other questions or comments, feel free to write a comment, or email me under tschoemaker@uni-osnabrueck.de .
Best regards,
Timo Schoemaker
Department of Computer Science
University of Osnabrück
I hereby agree to the terms of the JUnit Contributor License Agreement.
Definition of Done
@APIannotations