Skip to content

fix: close outFile before returning on copy error in Unpack and DeCompress#7648

Open
Ahmad-Faraj wants to merge 1 commit into
karmada-io:masterfrom
Ahmad-Faraj:fix/close-file-on-copy-error
Open

fix: close outFile before returning on copy error in Unpack and DeCompress#7648
Ahmad-Faraj wants to merge 1 commit into
karmada-io:masterfrom
Ahmad-Faraj:fix/close-file-on-copy-error

Conversation

@Ahmad-Faraj

@Ahmad-Faraj Ahmad-Faraj commented Jun 21, 2026

Copy link
Copy Markdown

What type of PR is this?

/kind bug

What this PR does / why we need it

Unpack in operator/pkg/util and DeCompress in pkg/karmadactl/cmdinit/utils both open a file per tar entry inside a loop. When ioCopyN returns an error, the function returns without closing the open *os.File, leaking the file descriptor.

The successful outFile.Close() was also discarding its return value. On NFS and similar filesystems, write errors only surface at close time, so a failed write could return success with a truncated file.

Which issue(s) this PR fixes

None (self-found)

Special notes for your reviewer

Both functions have the same bug; Unpack is in operator/ and DeCompress in karmadactl/cmdinit/utils/.

Does this PR introduce a user-facing change?

No.

…press

Both Unpack (operator/pkg/util) and DeCompress (karmadactl/cmdinit/utils)
open a file per tar entry but do not close it when ioCopyN returns an
error, leaking the file descriptor. Also the successful close call ignored
the return value; on some filesystems (e.g. NFS) close can fail after a
buffered write, so the error is now propagated.

Signed-off-by: Ahmed Faraj <ahmed.faraj@datajar.co>
Signed-off-by: Ahmad-Faraj <ahmedfrag4040@gmail.com>
@karmada-bot karmada-bot added the kind/bug Categorizes issue or PR as related to a bug. label Jun 21, 2026
@karmada-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign zhzhuang-zju for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot

Copy link
Copy Markdown
Contributor

Welcome @Ahmad-Faraj! It looks like this is your first PR to karmada-io/karmada 🎉

@karmada-bot karmada-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 21, 2026
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request improves the robustness of the Unpack and DeCompress utility functions by addressing potential file descriptor leaks and silent write failures. By ensuring that file handles are properly closed during error scenarios and validating the return status of file closures, the system can now reliably detect and report issues that were previously ignored.

Highlights

  • File Descriptor Leak Prevention: Added explicit outFile.Close() calls before returning errors during file copy operations to prevent resource leaks when extraction fails.
  • Improved Error Handling: Updated successful file closure to check and propagate return values, ensuring that write errors on filesystems like NFS are correctly surfaced.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request improves resource cleanup and error handling during file decompression and unpacking. Specifically, in operator/pkg/util/util.go and pkg/karmadactl/cmdinit/utils/util.go, the code now ensures that the output file is closed if ioCopyN fails, and it properly checks and handles any error returned by outFile.Close() during normal execution. There are no review comments, so I have no additional feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.05%. Comparing base (7edc6e6) to head (872c160).

Files with missing lines Patch % Lines
operator/pkg/util/util.go 0.00% 2 Missing and 1 partial ⚠️
pkg/karmadactl/cmdinit/utils/util.go 0.00% 2 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #7648   +/-   ##
=======================================
  Coverage   42.04%   42.05%           
=======================================
  Files         879      879           
  Lines       54827    54831    +4     
=======================================
+ Hits        23053    23058    +5     
+ Misses      30027    30026    -1     
  Partials     1747     1747           
Flag Coverage Δ
unittests 42.05% <0.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zhzhuang-zju

Copy link
Copy Markdown
Contributor

/retest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/bug Categorizes issue or PR as related to a bug. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants