Conversation
- Changes in Main.java needed to be repeated in copied classes. - Repaired and updated maven-dependencies and Java-modules - Fixed typo in action-template
- USEWriter was not used for System.out and System.err - Added initialization at the very beginning of main() - Added further encoding information
There was a problem hiding this comment.
Pull Request Overview
This PR updates the USE project to version 7.5.0 from version 7.1.1, including dependency updates, refactoring of shell integration tests, and various documentation improvements.
- Version bumped to 7.5.0 across all modules and copyright year updated to 2025
- Shell integration tests (ShellIT.java) uncommented and refactored to run in-process instead of spawning external processes
- Dependency versions updated (Guava, Lombok, FXGL)
Reviewed Changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| pom.xml | Updated project version to 7.5.0 |
| use-core/pom.xml | Updated version and Guava dependency |
| use-core/src/main/java/org/tzi/use/config/Options.java | Updated version and copyright year |
| use-gui/pom.xml | Updated version, dependencies (Guava, FXGL, Lombok), and added compiler plugin configuration |
| use-gui/src/main/java/module-info.java | Reorganized module requirements |
| use-gui/src/main/java/org/tzi/use/main/gui/Main.java | Added USEWriter initialization and fixed comment typo |
| use-gui/src/main/java/org/tzi/use/gui/mainFX/MainWindow.java | Added pluginRuntime parameter to ClassDiagramView constructor |
| use-gui/src/main/java/org/tzi/use/gui/views/diagrams/elements/edges/EdgeBase.java | Updated JavaDoc and removed unused import |
| use-gui/src/it/java/org/tzi/use/main/shell/ShellIT.java | Refactored integration tests to run in-process |
| use-assembly/pom.xml | Updated version and added dependency |
| .idea/encodings.xml | Added encoding configuration entries |
| .github/ISSUE_TEMPLATE/version_update.md | Fixed typo in template |
Files not reviewed (1)
- .idea/encodings.xml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
use-gui/src/main/java/org/tzi/use/gui/views/diagrams/elements/edges/EdgeBase.java
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 12 changed files in this pull request and generated 9 comments.
Files not reviewed (1)
- .idea/encodings.xml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * </ol> | ||
| * </p> | ||
| * | ||
| * <p>All {@code .use</code> and </code><code>.in} files must share the same name, e.g., t555.use and t555.in for test |
There was a problem hiding this comment.
The JavaDoc has inconsistent HTML/JavaDoc tag formatting. The opening {@code .use is not properly closed, and there's an extra </code> tag followed by <code>. This should be {@code .use} and {@code .in} for consistency.
| * <p>All {@code .use</code> and </code><code>.in} files must share the same name, e.g., t555.use and t555.in for test | |
| * <p>All {@code .use} and {@code .in} files must share the same name, e.g., t555.use and t555.in for test |
| * | ||
| * <p>If an integration test fails, two additional files are created: | ||
| * <ol> | ||
| * <li>{@code {testcasename}.expected</code> - The expected output calculated from the <code>{testcase}.in}-file</li> |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code {testcasename}.expected is not properly closed and switches to HTML </code> tag. Similarly, <code>{testcase}.in} mixes HTML with JavaDoc. Should use {@code {testcasename}.expected} and {@code {testcase}.in} consistently.
| public class ShellIT { | ||
|
|
||
| /** | ||
| * This TestFactory enumerates the {@code .in</code>-files in th folder <code>testfiles/shell}. |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code .in is not properly closed with } but instead uses </code>, and <code>testfiles/shell uses HTML tags and is not properly closed. Should consistently use {@code .in} and {@code testfiles/shell}.
| * This TestFactory enumerates the {@code .in</code>-files in th folder <code>testfiles/shell}. | ||
| * For each file a {@code DynamicTest} is created with the name of the file. | ||
| * | ||
| * @return A {@code Stream</code> with one <code>DynamicTest</code> for each <code>*.in}-file. |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code Stream is not properly closed with } but uses </code> instead. The remaining parts use HTML <code> tags. Should consistently use {@code Stream}, {@code DynamicTest}, and {@code *.in} throughout.
| * a given testinput-file given as a {@code Path} | ||
| * to a {@code DynamicTest}. | ||
| * | ||
| * @return A {@code DynamicTest</code> that uses the function <code>assertShellExpression} |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code DynamicTest is not properly closed with } but uses </code> instead, and <code>assertShellExpression uses HTML tag and is not properly closed. Should consistently use {@code DynamicTest} and {@code assertShellExpression}.
| * <p>The process is as follows: | ||
| * <ol> | ||
| * <li>A command file and the expected output are created by examining the input file (via {@code createCommandFile}).</li> | ||
| * <li>USE is executed using the {@code useFile</code> and the created command file (<code>runUSE}).</li> |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code useFile is not properly closed with } but uses </code> instead, and <code>runUSE uses HTML tag and is not properly closed. Should consistently use {@code useFile} and {@code runUSE}.
| * Compares the two lists of strings {@code expectedOutput} | ||
| * and {@code actualOutput}. | ||
| * If they differ, two files are written at the location of the | ||
| * {@code testFile</code>. One with the expected output (<code>.expected}) |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code testFile is not properly closed with } but uses </code> instead, and <code>.expected uses HTML tag and is not properly closed. Should consistently use {@code testFile} and {@code .expected}.
| * {@code testFile</code>. One with the expected output (<code>.expected}) | ||
| * and one with the actual output ({@code .actual}). | ||
| * | ||
| * @param testFile The {@code Path</code> to the <code>testFile} |
There was a problem hiding this comment.
Inconsistent JavaDoc tag usage: {@code Path is not properly closed with } but uses </code> instead, and <code>testFile uses HTML tag and is not properly closed. Should consistently use {@code Path} and {@code testFile}.
| * {@code testFile</code>. One with the expected output (<code>.expected}) | |
| * and one with the actual output ({@code .actual}). | |
| * | |
| * @param testFile The {@code Path</code> to the <code>testFile} | |
| * {@code testFile}. One with the expected output ({@code .expected}) | |
| * and one with the actual output ({@code .actual}). | |
| * | |
| * @param testFile The {@code Path} to the {@code testFile} |
| * | ||
| * @param useFile Path to the USE model to load on startup | ||
| * @param cmdFile Path to the commands file to execute | ||
| * @return A {@code List} of strings. Each string is one line of output. |
There was a problem hiding this comment.
The return type is documented as {@code List} but the method signature at line 260 returns Stream<String>. The JavaDoc should be updated to {@code Stream} to match the actual return type.
| * @return A {@code List} of strings. Each string is one line of output. | |
| * @return A {@code Stream} of strings. Each string is one line of output. |
Prepared relase of USE 7.5.0