microsoft / STL

MSVC's implementation of the C++ Standard Library.
Other
9.88k stars 1.45k forks source link

libcxx: Unskip some condvar tests #4721

Closed Arup-Chauhan closed 1 week ago

Arup-Chauhan commented 2 weeks ago

Addressing the removal of lines mentioning condvar or condvarany in tests/libcxx/expected_results.txt. These tests were previously skipped due to reliance on timing assumptions, which have been resolved upstream.

No reference issue was raised for this PR to fix

Context: The skipped tests mentioned in the text file were dependent on timing assumptions. The upstream issue has been addressed and fixed in this LLVM commit.

Changes: Every line mentioning condvar or condvarany in tests/libcxx/expected_results.txt has been removed. Rationale: The LLVM repository is used as a submodule. Once the problem is fixed in the submodule, we can unskip these tests, ensuring they run as intended.

Testing Execution: Ran all the tests across all test suites to confirm the removal of condvar and condvarany entries. Results: Tests were executed as expected, ensuring no adverse effects from the removal.

frederick-vs-ja commented 2 weeks ago

These 3 tests still failed since the elapsed time was less than the timeout.

Perhaps we should skip them again.

Arup-Chauhan commented 2 weeks ago

These 3 tests still failed since the elapsed time was less than the timeout.

  • std/thread/thread.condition/thread.condition.condvarany/wait_for.pass.cpp
  • std/thread/thread.condition/thread.condition.condvarany/wait_until.pass.cpp
  • std/thread/thread.condition/thread.condition.condvarany/wait_until_pred.pass.cpp

Perhaps we should skip them again.

You want me to modify the test cases to skip these ones? maybe I can try doing that.

StephanTLavavej commented 2 weeks ago

Yeah, there are definitely remaining sporadic failures which will need to be re-skipped, thanks @frederick-vs-ja. From looking at the logs, I agree that those 3 are the ones that need to be re-skipped.

@Arup-Chauhan Please note that you can rerun just the affected test directories, which is way faster than a full test pass. (I do appreciate that you ran all of the tests at least once - that increases our confidence that the tests work on more than just maintainer and CI machines! :heart_eyes_cat:) On my local machine, the first time I ran these directories they passed, but the second time I got one of those tests to fail. Here's how I ran the affected directories and then inspected the logs:

Click to expand how I ran the tests: ``` D:\GitHub\STL\out\x64>python tests\utils\stl-lit\stl-lit.py -o testing_x64.log -Dnotags=ASAN --order=random ..\..\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvar ..\..\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvarany -- Testing: 81 tests, 32 workers -- [...] Testing Time: 18.14s Total Discovered Tests: 81 Skipped: 27 (33.33%) Passed : 54 (66.67%) D:\GitHub\STL\out\x64>python tests\utils\stl-lit\stl-lit.py -o testing_x64.log -Dnotags=ASAN --order=random ..\..\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvar ..\..\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvarany -- Testing: 81 tests, 32 workers -- [...] ******************** Failed Tests (1): libc++ :: std/thread/thread.condition/thread.condition.condvarany/wait_for.pass.cpp:0 Testing Time: 16.11s Total Discovered Tests: 81 Skipped: 27 (33.33%) Passed : 53 (65.43%) Failed : 1 (1.23%) D:\GitHub\STL\out\x64>python ..\..\tools\scripts\print_failures.py testing_x64.log code: FAIL name: libc++ :: std/thread/thread.condition/thread.condition.condvarany/wait_for.pass.cpp:0 output: Build setup steps: Build steps: Command: "C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.41.33901\bin\HostX64\x64\cl.EXE" "D:\GitHub\STL\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvarany\wait_for.pass.cpp" "-ID:\GitHub\STL\out\x64\out\inc" "-ID:\GitHub\STL\llvm-project\libcxx\test\support" "-ID:\GitHub\STL\tests\std\include" "/nologo" "/Od" "/W4" "/w14061" "/w14242" "/w14265" "/w14582" "/w14583" "/w14587" "/w14588" "/w14749" "/w14841" "/w14842" "/w15038" "/w15214" "/w15215" "/w15216" "/w15217" "/w15262" "/sdl" "/WX" "/D_ENABLE_STL_INTERNAL_CHECK" "/bigobj" "/EHsc" "/MTd" "/std:c++latest" "/permissive-" "/utf-8" "/FImsvc_stdlib_force_include.h" "/FIvso1913897.hpp" "/wd4643" "/D_STL_CALL_ABORT_INSTEAD_OF_INVALID_PARAMETER" "/analyze:autolog-" "/Zc:preprocessor" "/wd6262" "-FeD:\GitHub\STL\out\x64\tests\libcxx\std\thread\thread.condition\thread.condition.condvarany\Output\wait_for.pass.cpp.dir\0\wait_for.pass.exe" "-link" "-LIBPATH:D:\GitHub\STL\out\x64\out\lib\amd64" "-LIBPATH:C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.41.33901\lib\x64" "/MANIFEST:EMBED" Exit Code: 0 (0x0) Standard Output: -- wait_for.pass.cpp -- Intellisense response file steps: Test setup steps: Test steps: Test step failed unexpectedly. Command: "D:\GitHub\STL\out\x64\tests\libcxx\std\thread\thread.condition\thread.condition.condvarany\Output\wait_for.pass.cpp.dir\0\wait_for.pass.exe" Exit Code: 3 (0x3) Standard Error: -- Assertion failed: elapsed >= timeout, file D:\GitHub\STL\llvm-project\libcxx\test\std\thread\thread.condition\thread.condition.condvarany\wait_for.pass.cpp, line 107 abort() has been called-- ================================================== ```
Arup-Chauhan commented 2 weeks ago

@Arup-Chauhan please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
  3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

StephanTLavavej commented 2 weeks ago

Perfect, thanks! I expect to create a merge batch this week (after performing a Patch Tuesday toolset update tomorrow).

Arup-Chauhan commented 2 weeks ago

Perfect, thanks! I expect to create a merge batch this week (after performing a Patch Tuesday toolset update tomorrow).

Thanks! @StephanTLavavej , looking forward to more contributions!

StephanTLavavej commented 2 weeks ago

I'm mirroring this to the MSVC-internal repo - please notify me if any further changes are pushed.

Arup-Chauhan commented 2 weeks ago

I'm mirroring this to the MSVC-internal repo - please notify me if any further changes are pushed.

Sure, I feel for now we will be waiting for the LLVM or other condvar/condvarany issues raised here that are directly related to this. Might need to link this PR to them if needed in future.

StephanTLavavej commented 2 weeks ago

Two more condvarany tests failed sporadically in the MSVC-internal repo (wait_for_pred.pass.cpp and notify_one.pass.cpp). Since we've realized that the STL is buggy, I re-skipped all condvarany tests (notify_all.pass.cpp is virtually certain to be affected too), moved them to the "STL BUGS" section, and cited #4723.

Arup-Chauhan commented 2 weeks ago

@StephanTLavavej is there any work to be done here? As in, are there any modifications to be done in the expectd_test_results.txt file, in order to get this PR to be merged?

Or will we wait to work on Issue #4723 first?

StephanTLavavej commented 2 weeks ago

Good question - the answer is that no action is needed, I've already updated the PR and will land it soon. This is part of the boring work that I take care of so contributors can have fun :joy_cat:

Arup-Chauhan commented 1 week ago

Just to mention @StephanTLavavej, thank you for making things easier for us!

Cheers to my first PR merge as well 😄

StephanTLavavej commented 1 week ago

Thanks for improving this test coverage, and congratulations on your second microsoft/STL commit! :cat2: :rocket: :smile_cat: