Add Qtest library that uses class constraints
#2013
Conversation
sezna
requested review from
cesarzc,
DmitryVasilevsky and
swernli
as code owners
|
@sezna I am curious why are we having a QTest library in the new QDK instead of |
|
Hey @Manvi-Agrawal, thanks for pointing that out. The classic QDK test mechanism was backed by Xunit and C#. The modern QDK has no connection to dotnet or Xunit. We do acknowledge that some things are different in the modern QDK from the classic QDK, and dropping dotnet was a very intentional choice for us. It is possible we will add the In general, with the Modern QDK, we prioritize the Python and VS Code experiences. So any further design work done on testing will prioritize the testing experience in those environments. |
github-actions
bot
requested review from
billti,
tcNickolas,
minestarks and
idavis
as code owners
| /// test results instead of printing out to output. | ||
| /// | ||
| /// # Input | ||
| /// Takes a list of test cases. A test case is a tuple of `(String, () -> T, 'T)`, where |
There was a problem hiding this comment.
Nit: (String, () => T, 'T)
| /// This is a good alternative to `CheckAllTestCases` when you want custom output based on the results of your tests, | ||
| /// or more control over how test results are rendered. | ||
| /// # Input | ||
| /// Takes a list of test cases. A test case is a tuple of `(String, () -> T, 'T)`, where |
There was a problem hiding this comment.
Nit: Similarly here. (String, () => T, 'T) and the corresponding example update
|
|
||
| Fact( | ||
| not Functions.CheckAllTestCases(sample_tests), | ||
| "Test harness failed to return false for a failing tests." |
There was a problem hiding this comment.
Nit: for a failing test/for the failing test(s).
|
|
||
| function MeasureSignedIntTests() : (String, Int, (Qubit[]) => (), (Qubit[]) => Int, Int)[] { | ||
| [ | ||
| ("0b0001 == 1", 4, (qs) => X(qs[0]), (qs) => MeasureSignedInteger(qs, 4), 1), |
There was a problem hiding this comment.
@sezna , it seems these tests should not pass since the signature of QTest.Operations.TestCases was changed. Do the current library tests get checked in CI or am I missing something here?
There was a problem hiding this comment.
Hey Manvi, I'm not seeing an issue here. The function call here does indeed use the latest api.
There was a problem hiding this comment.
@sezna, I realized it now, that this still accepts a tuple containing 5 values. I think I got confused by 2 factors:
- Incorrect doc string : this seems to be copy paste of the functions namespace. Could you please fix it?
- Unnecessary braces around (Qubit[]) in method signature: Its written as
(Qubit[])=> ()here and inOperations.qs. This can be written asQubit[] => ().
This PR introduces Qtest, a library for running Q# unit tests. It includes two namespaces:
Functionsfor testing functions andOperationsfor testing operations.Operationsalso allows for qubit state preparation before tests.To demonstrate, I converted
MeasureSignedIntTests()insigned/src/Tests.qsto use Qtest. The result is fewer lines of code and clearer test intentions. Additionally, all tests run before reporting any failures, unlike the current behavior which stops at the first failure.I haven't converted all existing Q# tests yet, as that's beyond this PR's scope. This PR aims to validate the API's utility before proceeding with further conversions.