Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document how to run unit tests in slang-test documentation #4771

Closed
cheneym2 opened this issue Aug 2, 2024 · 1 comment
Closed

Document how to run unit tests in slang-test documentation #4771

cheneym2 opened this issue Aug 2, 2024 · 1 comment
Assignees
@aleino-nv
Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase

Comments

@cheneym2
Copy link
Collaborator

cheneym2 commented Aug 2, 2024

It's not clear that unit tests are part of slang-test according to the documentation: ./tools/slang-test/README.md

The document should be clear about how unit tests fit in, and most importantly, how to run them. It's hard to discover how to do this without better documentation. Also, the command is finicky, requiring a slash to get working:

Running all gfx unit tests:

BAD $ ./build/Release/bin/slang-test.exe gfx-unit-test-tool
GOOD $ ./build/Release/bin/slang-test.exe /gfx-unit-test-tool
GOOD $ ./build/Release/bin/slang-test.exe gfx-unit-test-tool/

Similarly, slang-unit-test-tool is a suite of "vanilla" tests.

$ ./build/Release/bin/slang-test.exe slang-unit-test-tool/
@cheneym2 cheneym2 added kind:documentation areas where we can improve documentation in codebase goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang labels Aug 2, 2024
@cheneym2 cheneym2 mentioned this issue Feb 25, 2025
Merged
aleino-nv added a commit to aleino-nv/slang that referenced this issue Feb 27, 2025
@aleino-nv
Document how unit tests are defined and run
b4ac2d4 
This closes issue shader-slang#4771.
@aleino-nv
Copy link
Collaborator

Issue #4771 is also related to this: you need full path to slang-test.exe or else it doesn't work.

@aleino-nv aleino-nv self-assigned this Mar 3, 2025
aleino-nv added a commit that referenced this issue Mar 3, 2025
@aleino-nv
Document how unit tests are defined and run
c34852d 
This closes issue #4771.
@aleino-nv aleino-nv mentioned this issue Mar 3, 2025
Closed
aleino-nv added a commit to aleino-nv/slang that referenced this issue Mar 3, 2025
@aleino-nv
Document how unit tests are defined and run
c83c383 
This closes issue shader-slang#4771.
aleino-nv added a commit that referenced this issue Mar 3, 2025
@aleino-nv
Document how unit tests are defined and run (#6448)
a99ee55 
This closes issue #4771.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aleino-nv aleino-nv

Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cheneym2 @aleino-nv