Enhancement/5235 upgrade cleans up downloads and extracted agent by kaanyalti · Pull Request #9386 · elastic/elastic-agent

kaanyalti · 2025-08-15T14:20:21Z

PR 5/6

Enhancement

What does this PR do?

Updates the download step to return path after download succeeds even in error cases
Adds deferred cleanup process in the upgrade function to cleanup download and extracted agent versioned home paths
Updates error handling sequence in the upgrade function to add download and versioned home paths in the cleanup list
Adds relevant tests

Why is it important?

Currently http and fs downloaders cleanup if they fail however if there is any other error (verifier errors) in the download process, the agent does not cleanup the downloaded artifacts
The upgrade process reverts the symlink changes and cleans up the new versioned home only after the symlink switch happens. If anything in between the downloaders and symlink switch fails, the agent does not clean up anything.

Checklist

I have read and understood the pull request guidelines of this project.
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
~~[ ] I have made corresponding changes to the documentation~~
~~[ ] I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
~~[ ] I have added an entry in ./changelog/fragments using the changelog tool~~
~~[ ] I have added an integration test or an E2E test~~

Disruptive User Impact

none

How to test this PR locally

Run the upgrade_test tests
Build the agent for windows, mac and linux
Try to upgrade from one version to another without sha512 and force verification failure and validate that the downloads directory is cleaned up.
The way I triggered the second cleanup scenario was by filling up the disk space just enough so that the agent can partially extract the downloaded archive but fails midway. Then I validated that the versioned home for the new agent is removed along with the downloads in the initial agent's versioned home directory.

Related issues

elasticmachine · 2025-08-15T14:20:25Z

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

kaanyalti · 2025-08-18T16:11:59Z

@pkoutsovasilis @michel-laterman the pr is ready for review

kaanyalti · 2025-09-04T15:14:38Z

Last commit has issues, looking into it

mergify · 2025-09-08T15:44:12Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent upstream/enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent
git merge upstream/main
git push upstream enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent

mergify · 2025-09-09T01:17:15Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent upstream/enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent
git merge upstream/main
git push upstream enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent

mergify · 2025-09-14T19:12:22Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent upstream/enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent
git merge upstream/main
git push upstream enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent

kaanyalti · 2025-09-18T12:32:26Z

@ycombinator @michel-laterman I will merge changes from target to address ci failures, and will request reviews again, sorry for the inconvenience. I put a post about this in the team channel

…nd_extracted_agent

elastic-sonarqube · 2025-09-18T16:01:41Z

Quality Gate passed

Issues
2 New issues
1 Fixed issue
0 Accepted issues

Measures
0 Security Hotspots
89.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

elasticmachine · 2025-09-18T16:27:35Z

💚 Build Succeeded

Buildkite Build
Commit: bdd1a5d

History

💔 Build #26977 failed f2963b2
💛 Build #26848 was flaky 5732d40
💚 Build #26746 succeeded 9c67e8b
💚 Build #26383 succeeded 66935ec
💛 Build #26376 was flaky ae00198

cc @kaanyalti

github-actions · 2025-09-18T16:55:54Z

@Mergifyio backport 8.18 8.19 9.0 9.1

mergify · 2025-09-18T16:56:11Z

backport 8.18 8.19 9.0 9.1

✅ Backports have been created

Details

#10036 [8.18] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent has been created for branch 8.18 but encountered conflicts
#10037 [8.19] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent has been created for branch 8.19 but encountered conflicts
#10038 [9.0] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent has been created for branch 9.0 but encountered conflicts
#10039 [9.1] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent has been created for branch 9.1 but encountered conflicts

* enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade.go # internal/pkg/agent/application/upgrade/upgrade_test.go

* enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade_test.go

…stic#9386) * enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader

…and extracted agent (#10036) * Enhancement/5235 upgrade cleans up downloads and extracted agent (#9386) * enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade.go # internal/pkg/agent/application/upgrade/upgrade_test.go * resolved merge conflicts --------- Co-authored-by: Kaan Yalti <kaan.yalti@elastic.co>

…and extracted agent (#10037) * Enhancement/5235 upgrade cleans up downloads and extracted agent (#9386) * enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade.go # internal/pkg/agent/application/upgrade/upgrade_test.go * resolved merge conflicts --------- Co-authored-by: Kaan Yalti <kaan.yalti@elastic.co>

…nd extracted agent (#10038) * Enhancement/5235 upgrade cleans up downloads and extracted agent (#9386) * enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade_test.go * resolved merge conflicts --------- Co-authored-by: Kaan Yalti <kaan.yalti@elastic.co>

…nd extracted agent (#10039) * Enhancement/5235 upgrade cleans up downloads and extracted agent (#9386) * enhancement(5235): added comments describing updates in error handling. returning path in error cases if the download is completed * enhancement(5235): added wrapper var for verifier constructor in download step to improve testability * enhancement(5235): added test for downloadArtifact verifier errors * enhancement(5235): addded cleanupPaths slice. added deferred call to remove paths in the cleanupPaths slice * enhancement(5235): add archive and hash path to cleanup paths after artifact download * enhancement(5235): update error handling after unpack. add new versioned home to cleanup paths enhancement(5235): move newHome declaration * enhancement(5235): added upgrade cleanup test * enhancement(5235): added changelog fragment enhancement(5235): updated changelog fragment * enhancement(5235): fix errors in step_download after rebase * enhancement(5235): fix error in step_download_test after rebase * enhancement(5235): refactor disk space error check and path cleanup into one deferred call * enhancement(5235): refactored verifier factory and updated relevant download tests * enhancement(5235): removed separate test for cleanup, added cleanup checks in error handling test * enhancement(5235): changed function name in verifier * enhancement(5235): using AddHashExtension instead of hard coded hash extension string in upgrader (cherry picked from commit ab23962) # Conflicts: # internal/pkg/agent/application/upgrade/upgrade_test.go * resolved merge conflicts --------- Co-authored-by: Kaan Yalti <kaan.yalti@elastic.co>

kaanyalti requested a review from a team as a code owner August 15, 2025 14:20

kaanyalti requested review from michel-laterman and pkoutsovasilis August 15, 2025 14:20

kaanyalti added Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team backport-active-all Automated backport with mergify to all the active branches labels Aug 15, 2025

mergify bot assigned kaanyalti Aug 15, 2025

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch from 28b43e0 to e4d304a Compare August 15, 2025 14:27

michalpristas reviewed Aug 19, 2025

View reviewed changes

Comment thread internal/pkg/agent/application/upgrade/step_download.go Outdated

Comment thread internal/pkg/agent/application/upgrade/upgrade.go Outdated

Comment thread internal/pkg/agent/application/upgrade/upgrade.go

Comment thread internal/pkg/agent/application/upgrade/upgrade.go Outdated

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch from 0174246 to 8186da8 Compare August 20, 2025 12:52

kaanyalti requested review from michalpristas and ycombinator August 20, 2025 13:05

kaanyalti marked this pull request as draft September 2, 2025 13:06

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch from 8186da8 to 033782f Compare September 4, 2025 15:13

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch from 033782f to bbc909a Compare September 4, 2025 15:16

kaanyalti changed the title ~~Enhancement/5235 upgrade cleanup downloads and extracted agent~~ Enhancement/5235 upgrade cleans up downloads and extracted agent Sep 8, 2025

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch 2 times, most recently from ae00198 to 66935ec Compare September 8, 2025 18:34

kaanyalti force-pushed the enhancement/5235_upgrade_cleanup_downloads_and_extracted_agent branch from 66935ec to 9c67e8b Compare September 12, 2025 17:25

kaanyalti requested a review from michel-laterman September 17, 2025 13:08

ycombinator reviewed Sep 17, 2025

View reviewed changes

Comment thread internal/pkg/agent/application/upgrade/artifact/download/verifier.go

kaanyalti requested a review from ycombinator September 17, 2025 15:36

ycombinator approved these changes Sep 17, 2025

View reviewed changes

Merge branch 'main' into enhancement/5235_upgrade_cleanup_downloads_a…

bdd1a5d

…nd_extracted_agent

kaanyalti enabled auto-merge (squash) September 18, 2025 15:05

michel-laterman approved these changes Sep 18, 2025

View reviewed changes

kaanyalti merged commit ab23962 into elastic:main Sep 18, 2025
23 checks passed

This was referenced Sep 18, 2025

[8.18] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent #10036

Merged

[8.19] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent #10037

Merged

mergify bot mentioned this pull request Sep 18, 2025

[9.0] (backport #9386) Enhancement/5235 upgrade cleans up downloads and extracted agent #10038

Merged

4 tasks

Conversation

kaanyalti commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Disruptive User Impact

How to test this PR locally

Related issues

Uh oh!

elasticmachine commented Aug 15, 2025

Uh oh!

kaanyalti commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaanyalti commented Sep 4, 2025

Uh oh!

mergify bot commented Sep 8, 2025

Uh oh!

mergify bot commented Sep 9, 2025

Uh oh!

mergify bot commented Sep 14, 2025

Uh oh!

Uh oh!

kaanyalti commented Sep 18, 2025

Uh oh!

elastic-sonarqube bot commented Sep 18, 2025

Quality Gate passed

Uh oh!

elasticmachine commented Sep 18, 2025

💚 Build Succeeded

History

Uh oh!

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

mergify bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kaanyalti commented Aug 15, 2025 •

edited

Loading

mergify bot commented Sep 18, 2025 •

edited

Loading