-
Notifications
You must be signed in to change notification settings - Fork 1.7k
CLI: Added container prune #40306
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
Draft
AmelBawa-msft
wants to merge
2
commits into
feature/wsl-for-apps
Choose a base branch
from
user/amelbawa/container-prune
base: feature/wsl-for-apps
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
CLI: Added container prune #40306
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /*++ | ||
|
|
||
| Copyright (c) Microsoft. All rights reserved. | ||
|
|
||
| Module Name: | ||
|
|
||
| ContainerPruneCommand.cpp | ||
|
|
||
| Abstract: | ||
|
|
||
| Implementation of command execution logic. | ||
|
|
||
| --*/ | ||
|
|
||
| #include "ContainerCommand.h" | ||
| #include "CLIExecutionContext.h" | ||
| #include "ContainerTasks.h" | ||
| #include "SessionTasks.h" | ||
| #include "Task.h" | ||
|
|
||
| using namespace wsl::windows::wslc::execution; | ||
| using namespace wsl::windows::wslc::task; | ||
| using namespace wsl::shared; | ||
|
|
||
| namespace wsl::windows::wslc { | ||
| // Container Prune Command | ||
| std::vector<Argument> ContainerPruneCommand::GetArguments() const | ||
| { | ||
| return { | ||
| Argument::Create(ArgType::Session), | ||
| }; | ||
| } | ||
|
|
||
| std::wstring ContainerPruneCommand::ShortDescription() const | ||
| { | ||
| return Localization::WSLCCLI_ContainerPruneDesc(); | ||
| } | ||
|
|
||
| std::wstring ContainerPruneCommand::LongDescription() const | ||
| { | ||
| return Localization::WSLCCLI_ContainerPruneLongDesc(); | ||
| } | ||
|
|
||
| void ContainerPruneCommand::ExecuteInternal(CLIExecutionContext& context) const | ||
| { | ||
| context // | ||
| << CreateSession // | ||
| << PruneContainers; | ||
| } | ||
| } // namespace wsl::windows::wslc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /*++ | ||
|
|
||
| Copyright (c) Microsoft. All rights reserved. | ||
|
|
||
| Module Name: | ||
|
|
||
| WSLCE2EContainerPruneTests.cpp | ||
|
|
||
| Abstract: | ||
|
|
||
| This file contains end-to-end tests for WSLC container prune command. | ||
| --*/ | ||
|
|
||
| #include "precomp.h" | ||
| #include "windows/Common.h" | ||
| #include "WSLCExecutor.h" | ||
| #include "WSLCE2EHelpers.h" | ||
|
|
||
| namespace WSLCE2ETests { | ||
| using namespace wsl::shared; | ||
|
|
||
| class WSLCE2EContainerPruneTests | ||
| { | ||
| WSLC_TEST_CLASS(WSLCE2EContainerPruneTests) | ||
|
|
||
| static constexpr auto TestContainerName1 = L"prune-test-1"; | ||
| static constexpr auto TestContainerName2 = L"prune-test-2"; | ||
| static constexpr auto TestContainerRunning = L"prune-test-running"; | ||
|
|
||
| TEST_CLASS_SETUP(ClassSetup) | ||
| { | ||
| EnsureImageIsLoaded(DebianImage); | ||
| return true; | ||
| } | ||
|
|
||
| TEST_CLASS_CLEANUP(ClassCleanup) | ||
| { | ||
| EnsureContainerDoesNotExist(TestContainerName1); | ||
| EnsureContainerDoesNotExist(TestContainerName2); | ||
| EnsureContainerDoesNotExist(TestContainerRunning); | ||
| return true; | ||
| } | ||
|
|
||
| TEST_METHOD_SETUP(MethodSetup) | ||
| { | ||
| EnsureContainerDoesNotExist(TestContainerName1); | ||
| EnsureContainerDoesNotExist(TestContainerName2); | ||
| EnsureContainerDoesNotExist(TestContainerRunning); | ||
| return true; | ||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_HelpCommand) | ||
| { | ||
| const auto result = RunWslc(L"container prune --help"); | ||
| result.Verify({.Stdout = GetHelpMessage(), .Stderr = L"", .ExitCode = 0}); | ||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_NoStoppedContainers) | ||
| { | ||
| const auto result = RunWslc(L"container prune"); | ||
| result.Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyStdoutContains(result, L"Total reclaimed space:"); | ||
|
||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_StoppedContainer) | ||
| { | ||
| // Create a stopped container | ||
| RunWslc(std::format(L"container create --name {} {}", TestContainerName1, DebianImage.NameAndTag())).Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyContainerIsListed(TestContainerName1, L"created"); | ||
|
|
||
| const auto result = RunWslc(L"container prune"); | ||
| result.Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyStdoutContains(result, L"Deleted:"); | ||
| VerifyStdoutContains(result, L"Total reclaimed space:"); | ||
|
|
||
| // Verify the container was actually removed | ||
| VerifyContainerIsNotListed(TestContainerName1); | ||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_MultipleStoppedContainers) | ||
| { | ||
| // Create two stopped containers | ||
| RunWslc(std::format(L"container create --name {} {}", TestContainerName1, DebianImage.NameAndTag())).Verify({.Stderr = L"", .ExitCode = 0}); | ||
| RunWslc(std::format(L"container create --name {} {}", TestContainerName2, DebianImage.NameAndTag())).Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyContainerIsListed(TestContainerName1, L"created"); | ||
| VerifyContainerIsListed(TestContainerName2, L"created"); | ||
|
|
||
| const auto result = RunWslc(L"container prune"); | ||
| result.Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyStdoutContains(result, L"Total reclaimed space:"); | ||
|
|
||
| // Verify both containers were removed | ||
| VerifyContainerIsNotListed(TestContainerName1); | ||
| VerifyContainerIsNotListed(TestContainerName2); | ||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_RunningContainerNotPruned) | ||
| { | ||
| // Start a running container | ||
| RunWslc(std::format(L"container run -d --name {} {} sleep infinity", TestContainerRunning, DebianImage.NameAndTag())) | ||
| .Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| auto cleanup = wil::scope_exit([&]() { EnsureContainerDoesNotExist(TestContainerRunning); }); | ||
|
|
||
| VerifyContainerIsListed(TestContainerRunning, L"running"); | ||
|
|
||
| const auto result = RunWslc(L"container prune"); | ||
| result.Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| // Running container should still exist after prune | ||
| VerifyContainerIsListed(TestContainerRunning, L"running"); | ||
| } | ||
|
|
||
| WSLC_TEST_METHOD(WSLCE2E_Container_Prune_IdempotentSecondPrune) | ||
| { | ||
| // Create and prune a container, then prune again | ||
| RunWslc(std::format(L"container create --name {} {}", TestContainerName1, DebianImage.NameAndTag())).Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| RunWslc(L"container prune").Verify({.Stderr = L"", .ExitCode = 0}); | ||
| VerifyContainerIsNotListed(TestContainerName1); | ||
|
|
||
| // Second prune should succeed with nothing to prune | ||
| const auto result = RunWslc(L"container prune"); | ||
| result.Verify({.Stderr = L"", .ExitCode = 0}); | ||
|
|
||
| VerifyStdoutContains(result, L"Total reclaimed space:"); | ||
| } | ||
|
|
||
| private: | ||
| const TestImage& DebianImage = DebianTestImage(); | ||
|
|
||
| static void VerifyStdoutContains(const WSLCExecutionResult& result, const std::wstring& substring) | ||
| { | ||
| for (const auto& line : result.GetStdoutLines()) | ||
| { | ||
| if (line.find(substring) != std::wstring::npos) | ||
| { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| VERIFY_FAIL(std::format(L"Expected stdout to contain '{}'", substring).c_str()); | ||
| } | ||
|
|
||
| std::wstring GetHelpMessage() const | ||
| { | ||
| std::wstringstream output; | ||
| output << GetWslcHeader() // | ||
| << GetDescription() // | ||
| << GetUsage() // | ||
| << GetAvailableOptions(); | ||
| return output.str(); | ||
| } | ||
|
|
||
| std::wstring GetDescription() const | ||
| { | ||
| return Localization::WSLCCLI_ContainerPruneLongDesc() + L"\r\n\r\n"; | ||
| } | ||
|
|
||
| std::wstring GetUsage() const | ||
| { | ||
| return L"Usage: wslc container prune [<options>]\r\n\r\n"; | ||
| } | ||
|
|
||
| std::wstring GetAvailableOptions() const | ||
| { | ||
| std::wstringstream options; | ||
| options << L"The following options are available:\r\n" | ||
| << L" --session " << Localization::WSLCCLI_SessionIdArgDescription() << L"\r\n" | ||
| << L" -?,--help " << Localization::WSLCCLI_HelpArgDescription() << L"\r\n" | ||
| << L"\r\n"; | ||
| return options.str(); | ||
| } | ||
| }; | ||
| } // namespace WSLCE2ETests | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
This assumes
results.Containersis valid and populated after callingPruneContainers(nullptr, 0, 0, &results), but no buffer is allocated/provided for container IDs. If the underlying API expects a caller-provided buffer (common for COM-style “get required size then allocate then call again”), this will read from an uninitialized pointer and/or produce incomplete results. If the API allocates memory, there’s also no ownership/cleanup shown, which risks leaking. Please update this to follow the API’s documented allocation pattern (e.g., two-pass call to obtain required size then allocate, or wrap returned memory in an owning RAII type and free it appropriately) and only iterate when the container list pointer is valid for the duration needed.