-
Notifications
You must be signed in to change notification settings - Fork 297
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.
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
Integrated code lifecycle
: Fix an issue with stale containers
#10005
Integrated code lifecycle
: Fix an issue with stale containers
#10005
Conversation
Integrated code lifecyle
: Parse build results before stopping containerIntegrated code lifecycle
: Parse build results before stopping container
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 pmd (7.8.0)src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.javaThe following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration. WalkthroughThe changes in this pull request focus on enhancing the error handling and resource management within the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (2)
341-345
: Enhance error logging for better debugging.The error message "Error while parsing test results" could be more specific about which operation failed (e.g., reading from stream, parsing XML, etc.).
- msg = "Error while parsing test results"; + msg = "Error while parsing test results: " + e.getMessage() + ". Operation: " + + (e instanceof IOException ? "reading from stream" : "parsing result data");
347-356
: Consider using try-with-resources for automatic resource management.While the current implementation correctly handles resource cleanup, using try-with-resources would make the code more concise and eliminate the need for explicit cleanup in the finally block.
- TarArchiveInputStream testResultsTarInputStream = null; - BuildResult buildResult; - try { - testResultsTarInputStream = buildJobContainerService.getArchiveFromContainer(containerId, + BuildResult buildResult; + try (TarArchiveInputStream testResultsTarInputStream = buildJobContainerService.getArchiveFromContainer(containerId, LOCALCI_WORKING_DIRECTORY + LOCALCI_RESULTS_DIRECTORY); + ) { buildResult = parseTestResults(testResultsTarInputStream, buildJob.buildConfig().branch(), assignmentRepoCommitHash, testRepoCommitHash, buildCompletedDate, buildJob.id()); buildResult.setBuildLogEntries(buildLogsMap.getAndTruncateBuildLogs(buildJob.id())); - } finally { - try { - if (testResultsTarInputStream != null) { - testResultsTarInputStream.close(); - } - } catch (IOException e) { - msg = "Could not close test results tar input stream"; - buildLogsMap.appendBuildLogEntry(buildJob.id(), msg); - log.error(msg, e); - }
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java
(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (1)
Pattern src/main/java/**/*.java
: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports
🔇 Additional comments (1)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (1)
323-325
: LGTM: Good variable initialization practice.
The initialization of variables outside the try block ensures proper scope and cleanup handling.
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested on TS1 and 3. I tested the following:
- Creating a programming exercise
- Edit a programming exercise
- Run plagiarism test for a programming exercise
- Cloning and pushing using http and ssh
- Editing auxilary repositories
- Asking Iris for help
Everything works perfectly
Integrated code lifecycle
: Parse build results before stopping containerIntegrated code lifecycle
: Fix an issue with stale containers by parsing build results before stopping container
Integrated code lifecycle
: Fix an issue with stale containers by parsing build results before stopping containerIntegrated code lifecycle
: Fix an issue with stale containers by parsing build results earlier
Integrated code lifecycle
: Fix an issue with stale containers by parsing build results earlierIntegrated code lifecycle
: Fix an issue with stale containers
Checklist
General
Server
Changes affecting Programming Exercises
Motivation and Context
In the current state, we try to stop the container directly after retrieving the result files. Afterwards, we try to parse the results.
There is an issue with larger files: the buffer isn't big enough to store the files, so it keeps the connection open, which for some reason completely hangs the container and blocks it from being stopped, which results in a hanging container that we can't kill.
This PR fixes this issue
Description
Parse results and close the stream before stopping the container.
Steps for Testing
Prerequisites:
Testserver States
Note
These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.
Review Progress
Performance Review
Code Review
Manual Tests
Performance Tests
Screenshots
Summary by CodeRabbit
Bug Fixes
New Features