User/beenachauhan/test wsladiag #13975

beena352 · 2025-12-23T23:29:12Z

Summary of the Pull Request:

This PR adds automated test coverage for the wsladiag CLI tool under test/windows.
The new tests exercise the supported commands and common error paths to ensure argument parsing, exit codes, and output behavior remain correct.

Specifically, the tests cover:
--help and -h behavior
list command output (both with and without active sessions)
shell command error paths (missing session name, invalid session name, verbose vs non-verbose)
Unknown and empty commands

PR Checklist

Closes: Link to issue #xxx
Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
Tests: Added/updated if needed and all pass
Localization: All end user facing strings can be localized
Dev docs: Added/updated if needed
Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

A new test file (WsladiagTests.cpp) is added to the Windows test suite. The tests invoke wsladiag.exe directly and validate:

Correct exit codes for valid and invalid commands
Whether output is written to stdout vs stderr as expected
That help text and error messages are shown consistently
That non-interactive error paths (e.g., invalid session name) fail fast and do not hang

The tests intentionally avoid interactive shell success cases and distro-dependent scenarios to keep the suite stable and fast. Assertions use substring matching rather than exact formatting to reduce flakiness.

Validation Steps Performed

Built the solution and confirmed wsladiag.exe is generated correctly

Ran the new test suite locally and verified all tests pass
Tested edge cases manually (e.g., running wsladiag with no arguments, invalid commands)
Verified test behavior in both scenarios: when WSLA sessions exist and when none exist
Confirmed tests fail appropriately when wsladiag.exe is not available

OneBlue · 2025-12-24T02:36:49Z

test/windows/WsladiagTests.cpp

+
+        const bool noSessions = (out.find(L"No WSLA sessions found.") != std::wstring::npos);
+
+        const bool hasTable = (out.find(L"WSLA session") != std::wstring::npos) && (out.find(L"ID") != std::wstring::npos) &&


I'd recommend having a utility method to verify the complete output. Something like:

ValidateOutput("list", "No WSLA sessions found.\r\n");

For instance. That would make writing future tests easier

(Same for below tests)

OneBlue · 2025-12-24T02:39:53Z

test/windows/WsladiagTests.cpp

+
+    static std::wstring BuildWsladiagCmd(const std::wstring& args)
+    {
+        const auto exePath = wsl::windows::common::wslutil::GetBasePath() / L"wsladiag.exe";


GetBasePath() won't work here since it will look up the current process's executable folder.

To get the installation folder where wsladiag.exe is, use : wsl::windows::common::wslutil::GetMsiPackagePath()

OneBlue · 2025-12-26T17:21:28Z

src/windows/wsladiag/wsladiag.cpp

    catch (...)
    {
        const auto hr = wil::ResultFromCaughtException();
+        if (hr == E_INVALIDARG)


I would recommend against this, because the service API might return that, and in that case we wouldn't want to show the usage.

To show command line parsing errors, I would recommend using something similar to this:

WSL/src/windows/common/WslClient.cpp

Line 1905 in cec99af

auto strings = wsl::windows::common::wslutil::ErrorToString(context->ReportedError().value());

For the user errors to work, we'd need to explicitely enable them, like this:

wsl::windows::common::EnableContextualizedErrors(false);

And then create an execution context that we initialize in main (probably with new entrypoint value for wsladiag):

wsl::windows::common::ExecutionContext context{Context::WslaDiag};

Then we can use context to actually get the error string when an exception is thrown

OneBlue · 2025-12-26T17:22:18Z

test/windows/WsladiagTests.cpp

+    // Initialize the tests
+    TEST_CLASS_SETUP(TestClassSetup)
+    {
+        VERIFY_ARE_EQUAL(LxsstuInitialize(FALSE), TRUE);


This is specific to WSL and isn't needed for WSLA tests

Same for LxsstuUninitialize(FALSE); below

OneBlue · 2025-12-26T17:24:31Z

test/windows/WsladiagTests.cpp

+    // Validate that list command output shows either no sessions message or session table
+    static void ValidateListOutput(const std::wstring& out)
+    {
+        const bool noSessions = out.find(L"No WSLA sessions found.") != std::wstring::npos;


Sorry if I was unclear in my previous comment. What I was suggesting was to have a method that takes the expected output as a parameter and do the validation. Something like:

void ValidateWslaDiagOutput(const std::string& Cmd, const std::string& ExpectedOutput);

So we can something like:

ValidateWslaDiagOutput("list", "<expected output>");

OneBlue · 2025-12-26T17:25:26Z

test/windows/WsladiagTests.cpp

+    TEST_METHOD(UnknownCommand_ShowsUsage)
+    {
+        auto [out, err, code] = RunWsladiag(L"blah");
+        VERIFY_ARE_NOT_EQUAL(0, code);


I'd recommend validating that the error code is 1 explicitly, since that's what we expect

OneBlue · 2025-12-31T23:24:39Z

src/windows/wsladiag/wsladiag.cpp

 {
+    wsl::windows::common::EnableContextualizedErrors(false);
+
+    std::optional<ExecutionContext> context;


nit: context is always set to the same value, so it doesn't need to be an std::optional

OneBlue · 2025-12-31T23:26:56Z

test/windows/WsladiagTests.cpp

+        auto [out, err, code] = RunWsladiag(L"blah");
+        VERIFY_ARE_EQUAL(1, code);
+
+        const std::wstring combined = out + err;


nit: I'd recommend validating both fds separately. For instance error messages should always be on stderr, not stdout

OneBlue · 2025-12-31T23:28:04Z

test/windows/WsladiagTests.cpp

+    static void ValidateWslaDiagOutput(const std::wstring& cmd, const std::wstring& expectedSubstring)
+    {
+        auto [out, err, code] = RunWsladiag(cmd);
+        const std::wstring combined = out + err;


Same here, I'd recommend having two parameters, one for each output so we can validate them separately.

I'll also recommend validating the entire strings, that way we'll catch if anything unexpected is printed

OneBlue requested changes Dec 24, 2025

View reviewed changes

beena352 force-pushed the user/beenachauhan/test_wsladiag branch from 15256c5 to 5e41ecf Compare December 24, 2025 21:29

OneBlue requested changes Dec 26, 2025

View reviewed changes

beena352 force-pushed the user/beenachauhan/test_wsladiag branch 2 times, most recently from f08388e to 87b8180 Compare December 30, 2025 23:50

OneBlue reviewed Dec 31, 2025

View reviewed changes

beena352 added 10 commits January 2, 2026 13:43

Refactor wsladiag CLI parsing and fix shell PTY handling

2f3acb1

Rename ArgumentParser flag to stopOnUnknownArgs

68b43d2

Rename ArgumentParser constructor flag to stopOnUnknownArgs

33542d7

WIP: local test changes

72eea12

Add argument and error-handling tests for wsladiag

12877e8

test/windows/WsladiagTests.cpp

2dd650a

Remove duplicate help flag test

7f961c8

Use GetMsiPackagePath() for wsladiag.exe location lookup

4fb58e4

Refine wsladiag test assertions

b7d8bb5

Fix WsladiagTests Shell_MissingName_ShowsError validation

c5a97ae

beena352 force-pushed the user/beenachauhan/test_wsladiag branch from 87b8180 to c5a97ae Compare January 2, 2026 21:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

User/beenachauhan/test wsladiag #13975

User/beenachauhan/test wsladiag #13975

beena352 commented Dec 23, 2025

Uh oh!

OneBlue Dec 24, 2025

Uh oh!

OneBlue Dec 24, 2025

Uh oh!

OneBlue Dec 24, 2025

Uh oh!

OneBlue Dec 26, 2025

Uh oh!

OneBlue Dec 26, 2025

Uh oh!

OneBlue Dec 26, 2025

Uh oh!

OneBlue Dec 26, 2025

Uh oh!

OneBlue Dec 26, 2025

Uh oh!

OneBlue Dec 31, 2025

Uh oh!

OneBlue Dec 31, 2025

Uh oh!

OneBlue Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		const bool noSessions = (out.find(L"No WSLA sessions found.") != std::wstring::npos);

		const bool hasTable = (out.find(L"WSLA session") != std::wstring::npos) && (out.find(L"ID") != std::wstring::npos) &&

User/beenachauhan/test wsladiag #13975

Are you sure you want to change the base?

User/beenachauhan/test wsladiag #13975

Conversation

beena352 commented Dec 23, 2025

Summary of the Pull Request:

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants