@systemfsoftware/vitest 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/LICENSE +203 -0
- package/README.md +236 -0
- package/dist/TestClock.d.ts +6 -0
- package/dist/TestClock.mjs +6 -0
- package/dist/compat.d.ts +11 -0
- package/dist/index.d.ts +735 -0
- package/dist/index.mjs +1523 -0
- package/dist/refusals-BQtDszyU.mjs +32 -0
- package/dist/refusals-_6e3GzVK.d.ts +37 -0
- package/dist/refusals.d.ts +3 -0
- package/dist/refusals.mjs +3 -0
- package/dist/utils.d.ts +197 -0
- package/dist/utils.mjs +227 -0
- package/package.json +75 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# @systemfsoftware/vitest
|
|
2
|
+
|
|
3
|
+
## 0.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- New `captureRunBinding`: an Effect that captures the running test's binding, so a testing library can run an effect elsewhere (e.g. inside a simulation kernel) and still have its `expect` calls counted as that test's assertions.
|
|
8
|
+
|
|
9
|
+
- `@systemfsoftware/differential-spec` depends on and imports `@systemfsoftware/vitest` by its own name instead of through an `@effect/vitest` alias. `@systemfsoftware/oxlint-config-recommended` enables the test-discipline rule under its new id `vitest-from-systemfsoftware-vitest`. `@systemfsoftware/vitest` documentation examples import from `@systemfsoftware/vitest`.
|
|
10
|
+
|
|
11
|
+
The lawful runner is published under its own name, `@systemfsoftware/vitest`, starting at `0.1.0`, so peers declared as `^0.1.0` accept its patch releases.
|
|
12
|
+
|
|
13
|
+
- Kernel runs are serialized. A run started while another is live now waits behind it, in arrival order, instead of failing: two runs never interleave, so a scenario never sees another run's decisions, and a suite whose cases drive the kernel can run its tests concurrently.
|
|
14
|
+
|
|
15
|
+
`@systemfsoftware/vitest` adds `captureRunBinding`, the running test's run binding. `bind(effect)` re-provides it to an effect a library runs on a runtime of its own — its own scheduler, a worker, a simulation kernel — so the checks inside it count as that test's assertions, report softly, and see the same `owned` regions.
|
|
16
|
+
|
|
17
|
+
`@systemfsoftware/effect-spec-runtime` runs a case that declares no live reason through that runner, and a case's annotations now reach the test's report.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright (c) 2026 Ryan Lee (systemfsoftware)
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright 2026 Ryan Lee (systemfsoftware)
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
# @systemfsoftware/vitest
|
|
2
|
+
|
|
3
|
+
A fork of [`@effect/vitest`](https://github.com/Effect-TS/effect/tree/main/packages/vitest) whose defaults make the lazy test a good test. Write the obvious thing and you get a fresh build of your services, a second run that catches leaked state, virtual time, checks that stop the test at its next step, and properties refuted against a constant impostor. Write the slop form and the refusal names the rewrite.
|
|
4
|
+
|
|
5
|
+
Everything upstream exports is still exported: `it`, `test`, `it.effect`, `it.live`, `it.scoped`, `it.each`, `it.layer`, `layer`, `describe`, `expect`, `it.prop`, `it.effect.prop`, `flakyTest`, `addEqualityTesters`, `makeMethods`, `describeWrapped`, and `export * from "vitest"`. Two things do differ from upstream: `describe` is the fork's lawful collector, and four accepted-input types are narrower — both are listed under [Compatibility](#compatibility-with-effectvitest). On top of that surface the fork adds six things: `owned`, `recordAssertion`, `captureRunBinding`, `layer(L, { shared: true })`, a lawful `it.prop`, and `VitestTestContext` — the running test's context, published so a library can read it. `layer`, `it.layer`, `flakyTest`, `it.prop`, `it.effect`, `it.live`, `describeWrapped` and `it` itself also take a data-last form (`it.effect(body, timeout?)(name)`, `layer(options)(L)`, `flakyTest(timeout?)(effect)`), so they pipe.
|
|
6
|
+
|
|
7
|
+
The defaults are forced, not opted into. Every package in this workspace imports `@systemfsoftware/vitest` by its own name, and published packages peer on it directly — nothing resolves through an alias to the upstream specifier.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add -D @systemfsoftware/vitest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Every workspace package and published library imports `@systemfsoftware/vitest` by its own name — there is no alias to the upstream specifier, so a manifest names the runner its tests actually run. Outside a pnpm workspace, install it directly:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# outside a pnpm workspace
|
|
19
|
+
npm install -D @systemfsoftware/vitest
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
> [!NOTE]
|
|
23
|
+
> `effect` and `vitest` are peer dependencies — you bring your own, on the `effect` 4.0.0-rc line.
|
|
24
|
+
|
|
25
|
+
## Quick start
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { expect, it, layer } from '@systemfsoftware/vitest'
|
|
29
|
+
import { Context, Effect, Layer, Ref } from 'effect'
|
|
30
|
+
|
|
31
|
+
class Store extends Context.Service<Store, Ref.Ref<ReadonlyArray<string>>>()('Store') {
|
|
32
|
+
static readonly layer = Layer.effect(Store, Ref.make<ReadonlyArray<string>>([]))
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
layer(Store.layer)('store', (it) => {
|
|
36
|
+
it.effect('starts from an empty store', () =>
|
|
37
|
+
Effect.gen(function*() {
|
|
38
|
+
const store = yield* Store
|
|
39
|
+
const items = yield* Ref.get(store)
|
|
40
|
+
expect(items).toEqual([])
|
|
41
|
+
}))
|
|
42
|
+
})
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The layer is built fresh for the test, and the test runs twice on two different builds. A test that only passes the first time is a test that leaked state.
|
|
46
|
+
|
|
47
|
+
## Layers
|
|
48
|
+
|
|
49
|
+
Every test gets its own build of its layers. A write to the store above is invisible to the next test in the block, and a nested `layer` inherits the block's sharing rather than rebuilding the outer layer per test.
|
|
50
|
+
|
|
51
|
+
`layer(L, { shared: true })` is the only way to build once for a block. The first test's write becomes the second test's input, and nothing in that block runs twice. Declare it deliberately: sharing is how state leaking between tests becomes the accepted norm.
|
|
52
|
+
|
|
53
|
+
## Leaked state
|
|
54
|
+
|
|
55
|
+
A passing test outside a declared-shared block runs a second time on a fresh build of its services. If the second run fails, the test fails as `LeakedState`, and the message carries the second run's failure:
|
|
56
|
+
|
|
57
|
+
> ✗ this test passed, then failed when run again on a fresh build of its services: something keeps state outside its layer, so tests here see each other's changes. The second run failed with: _the second run's failure_
|
|
58
|
+
|
|
59
|
+
That is how a module-level counter, a shared cache, or a process-global histogram gets reported instead of staying green. `it.live` is re-run too, so a real-resource suite gets the same check. A declared-shared block is the one exception.
|
|
60
|
+
|
|
61
|
+
## Concurrency and shuffle
|
|
62
|
+
|
|
63
|
+
Tests inside a block run concurrently and in shuffled order, and each concurrent test keeps its own failure list and assertion counts. Concurrency is what makes a cross-test leak reproducible: two tests that interleave are two tests whose state must not be shared. Nothing else pins their order.
|
|
64
|
+
|
|
65
|
+
A failure in a shuffled block names the seed the run used. Pass that seed back with `--sequence.seed=<seed>` and the same order replays, so an order-dependent failure stops being intermittent.
|
|
66
|
+
|
|
67
|
+
## Checks
|
|
68
|
+
|
|
69
|
+
`expect` records softly within one Effect step. Every failed check in the step is reported, and before any of the test's fibers takes its next step after a failed check, that fiber is interrupted — the step after a failed check never runs its side effects, which would only act on a state already known wrong. A child fiber is interrupted too. Anything thrown after a failed check is reported as `AfterFailedExpect`, most likely caused by the failure above it.
|
|
70
|
+
|
|
71
|
+
`toEqual` compares with Effect `Equal`, so two values that are structurally equal but different references are equal. A test that asserts nothing fails: the code under test returned something, so assert on it. A testing library whose checks are Effect-native can count them through `recordAssertion()`.
|
|
72
|
+
|
|
73
|
+
## Virtual time
|
|
74
|
+
|
|
75
|
+
Effect bodies run on virtual time that advances only when the test's fibers are idle. `Effect.sleep("3 seconds")` returns without waiting; on a deadline tie the background sleepers wake before the test fiber; fractional-millisecond schedules work.
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
import { expect, it } from '@systemfsoftware/vitest'
|
|
79
|
+
import { Clock, Effect } from 'effect'
|
|
80
|
+
|
|
81
|
+
it.effect('three seconds pass at once', () =>
|
|
82
|
+
Effect.gen(function*() {
|
|
83
|
+
const before = yield* Clock.currentTimeMillis
|
|
84
|
+
yield* Effect.sleep('3 seconds')
|
|
85
|
+
const after = yield* Clock.currentTimeMillis
|
|
86
|
+
expect(after - before).toEqual(3000)
|
|
87
|
+
}))
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
`TestClock.adjust` still moves the clock — on virtual time, adjusting is letting that much time pass, which is the one clock move a test can ask for. Effect v3 code that imports `TestClock` from `effect/TestClock` resolves to this fork's compat entry, `@systemfsoftware/vitest/TestClock`, through the shared Vitest config's `effect/TestClock` alias.
|
|
91
|
+
|
|
92
|
+
## Refusals
|
|
93
|
+
|
|
94
|
+
Each refusal states its rewrite, in the same words at compile time and at run time:
|
|
95
|
+
|
|
96
|
+
| Refused | The rewrite in the message |
|
|
97
|
+
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
98
|
+
| `expect(x).toBeDefined()`, `.toBeTruthy()`, `.toBeFalsy()`, and the negated `.not.toBeNull()`, `.not.toBeUndefined()` | Assert the value: `toEqual(expected)`; for a key that must exist: `toHaveProperty(key)` |
|
|
99
|
+
| `beforeEach` / `afterEach` | Build what a test needs inside it; services come fresh per test from `layer(Service.layer)((it) => { ... })` |
|
|
100
|
+
| an `async` test body | Return the Effect instead: `it.effect(name, () => Effect.gen(function* () { ... }))` |
|
|
101
|
+
| an Effect body that needs a service nothing provides | Pipe the body through `Effect.provide(Service.layer)`, or write the tests inside `layer(Service.layer)((it) => { ... })` |
|
|
102
|
+
| the positional `it.prop(name, [arbitraries], predicate)` | Name the function under test and pass a budget: `it.prop(name, { of, subject, runs }, holds)` |
|
|
103
|
+
| a test with no assertion (at run time only) | Assert on what the code returned: `expect(actual).toEqual(expected)` |
|
|
104
|
+
|
|
105
|
+
A presence refusal reads exactly like this:
|
|
106
|
+
|
|
107
|
+
> ✗ toBeDefined passes for almost any value the code returns. Assert the value: toEqual(expected); for a key that must exist: toHaveProperty(key).
|
|
108
|
+
|
|
109
|
+
`expect(<boolean>)` is a type error — a boolean can only report `expected false to be true`. Pass the two values instead: `expect(a).toEqual(b)`, which uses Effect `Equal`, or a predicate: `expect(value).toSatisfy(predicate)`. A boolean the code under test returned stays legal. `toBe` on primitives, `toBeTypeOf` and `toBeInstanceOf` are not refused.
|
|
110
|
+
|
|
111
|
+
## Properties
|
|
112
|
+
|
|
113
|
+
A property names the function under test. It runs `runs` times; omit `runs` and the run's configured default applies:
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
import { expect, it } from '@systemfsoftware/vitest'
|
|
117
|
+
import { Schema as S } from 'effect'
|
|
118
|
+
|
|
119
|
+
const sort = (xs: ReadonlyArray<number>): ReadonlyArray<number> => [...xs].sort((a, b) => a - b)
|
|
120
|
+
const isOrdered = (xs: ReadonlyArray<number>): boolean => xs.every((x, i) => i === 0 || (xs[i - 1] ?? x) <= x)
|
|
121
|
+
|
|
122
|
+
it.prop(
|
|
123
|
+
'sorting is ordered',
|
|
124
|
+
{ of: [S.Array(S.Int)], subject: sort },
|
|
125
|
+
(sort, [xs]) => isOrdered(sort(xs)),
|
|
126
|
+
)
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
`of` takes a tuple or a record of `Schema` arbitraries (`{ of: { list: S.Array(S.Int) } }`), and `holds` receives the subject first and the generated values second. `runs` is optional and must be a positive integer when given. The effective check options merge field by field: the property's own fields win over the configured default (`test.provide`, set by `@systemfsoftware/vitest-config`: 30 in a Stryker worker, 1000 in CI, 100 otherwise) over the built-in `runs: 100`, so `{ runs: 3 }` still inherits the configured `size` and caps. `it.effect.prop` is the same shape with `holds` returning `Effect<boolean>`. A verdict that is not a literal boolean, or an `Effect` of one, fails as `NonBooleanVerdict`; a `runs` that is not a positive integer — from the property or from the configured default — fails as `InvalidBudget`, naming where the bad value came from; the positional form fails as a type error and a refusal.
|
|
130
|
+
|
|
131
|
+
### The constant-impostor gate
|
|
132
|
+
|
|
133
|
+
After a property holds, it runs again against a constant impostor of its subject — a fake that returns the first output forever, whatever the input. Each subject is judged across every property in its file, when the file ends. If nothing in the file refutes the impostor, the file fails `VacuousProperty`:
|
|
134
|
+
|
|
135
|
+
> sort: no property in this file refuted the constant impostor of \`sort\`, so nothing here pins it down. … Laws that only relate outputs to each other (additivity, idempotence, commutativity, round trips through the subject) hold for such constants. Pin the output to the input: compare against an independent model (\`subject(x)\` equals a straightforward reimplementation), or conjoin a base case (\`subject([one])\` equals its known value). Also check that the body calls the \`subject\` it was given, not the imported implementation.
|
|
136
|
+
|
|
137
|
+
`sorting is ordered` alone is vacuous, because a constant empty array is also ordered. A law that pins the output to an input refutes the impostor for that subject:
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
it.law.model('agree with insertion sort', { of: [S.Array(S.Int)], subject: sort }, insertionSort)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Law kinds
|
|
144
|
+
|
|
145
|
+
`it.law.model` (an independent oracle), `it.law.metamorphic` (the input transform), `it.law.roundTrip` (the encode/decode pair) and `it.law.invariant` (a predicate on the output) are sugar over the same gate.
|
|
146
|
+
|
|
147
|
+
`it.law.idempotent` and `it.law.deterministic` are declared exempt. They skip the impostor gate, they are reported as exempt in the run, and they are the only exemptions:
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
it.law.idempotent('sorting twice changes nothing', { of: [S.Array(S.Int)], subject: sort, runs: 50 })
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Coverage classes
|
|
154
|
+
|
|
155
|
+
A property may declare coverage classes: labelled input predicates, each with a minimum share of runs.
|
|
156
|
+
|
|
157
|
+
```ts
|
|
158
|
+
it.prop(
|
|
159
|
+
'sorting is ordered',
|
|
160
|
+
{
|
|
161
|
+
of: [S.Array(S.Int)],
|
|
162
|
+
subject: sort,
|
|
163
|
+
runs: 400,
|
|
164
|
+
cover: { singletons: [(values) => values.length === 1, 0.9] },
|
|
165
|
+
},
|
|
166
|
+
(sort, [xs]) => isOrdered(sort(xs)),
|
|
167
|
+
)
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
A class fails only when a sequential statistical test is confident its share is below the minimum, and passes once it is confident the share is at least 0.9 of the minimum — QuickCheck's `checkCoverage` settings, certainty 10⁹ and tolerance 0.9. The tolerance is what lets the check terminate: a class sitting exactly on its minimum would otherwise draw forever. `runs` is therefore a minimum run count, not a maximum, and the failure names the label and the observed share.
|
|
171
|
+
|
|
172
|
+
## For testing libraries
|
|
173
|
+
|
|
174
|
+
A library that registers tests for its users wires in with two calls.
|
|
175
|
+
|
|
176
|
+
`owned(effect)` marks a region where `expect` throws instead of recording softly, so the enclosing Effect sees a failed check as a failure in its cause:
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import { owned } from '@systemfsoftware/vitest'
|
|
180
|
+
import { Effect } from 'effect'
|
|
181
|
+
|
|
182
|
+
// A library wraps the user's step; a failed check inside fails the step.
|
|
183
|
+
export const runStep = <A, E, R>(step: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> => owned(step)
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
`recordAssertion()` counts an Effect-native check as an assertion, so a test whose only judgement is the library's own passes the no-assertion gate:
|
|
187
|
+
|
|
188
|
+
```ts
|
|
189
|
+
import { recordAssertion } from '@systemfsoftware/vitest'
|
|
190
|
+
import { Effect } from 'effect'
|
|
191
|
+
|
|
192
|
+
export const recordVerdict = (): Effect.Effect<void> => Effect.sync(recordAssertion)
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
`captureRunBinding` is the test's run binding. `bind` re-provides it to an effect a library runs on a runtime of its own — its own scheduler, a worker, a simulation kernel — so the checks inside it count as that test's assertions, report softly, and see the same `owned` regions as the test. Capture it from the test's own fiber and bind the effect before handing it to the other runtime:
|
|
196
|
+
|
|
197
|
+
```ts
|
|
198
|
+
import { captureRunBinding } from '@systemfsoftware/vitest'
|
|
199
|
+
import { Effect } from 'effect'
|
|
200
|
+
|
|
201
|
+
export const runOnOwnScheduler = <A, E>(
|
|
202
|
+
program: Effect.Effect<A, E>,
|
|
203
|
+
): Effect.Effect<A, E> =>
|
|
204
|
+
Effect.gen(function*() {
|
|
205
|
+
const binding = yield* captureRunBinding
|
|
206
|
+
return yield* Effect.promise(() => Kernel.run(binding.bind(program)))
|
|
207
|
+
})
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
`VitestTestContext` is the running Vitest `TestContext` under the key `vitestTestContextKey`, provided on every test the fork runs. A library that carries its own view of the task context builds it on that key, so a case lane and a property lane read the same context:
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import { vitestTestContextKey } from '@systemfsoftware/vitest'
|
|
214
|
+
import { Context } from 'effect'
|
|
215
|
+
|
|
216
|
+
export const TaskRef = Context.Reference<{ annotate?: (message: string) => void } | null>(vitestTestContextKey, {
|
|
217
|
+
defaultValue: () => null,
|
|
218
|
+
})
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
## Compatibility with @effect/vitest
|
|
222
|
+
|
|
223
|
+
Everything upstream exports is still exported, and the fork adds behaviour rather than removing bindings: example tests, `it.each`, `toStrictEqual` and the other Vitest bindings stay. It is not a drop-in, though, in one behaviour and four accepted-input types:
|
|
224
|
+
|
|
225
|
+
- `describe` is the fork's lawful collector (R4), not upstream's: it forces the fork's concurrency and shuffle defaults and hands its body the fork's methods. Vitest's own collector — one test at a time, in declaration order — stays reachable as `import { describe } from 'vitest'`.
|
|
226
|
+
- `deepStrictEqual`, `notDeepStrictEqual`, `strictEqual` and `assertEquals` take no message argument. A data-last dual has to repeat its data-first twin parameter for parameter, so a trailing string cannot be told from an expected value; the message is refused rather than silently dropped.
|
|
227
|
+
- `skipIf` and `runIf` take a `boolean` condition where upstream took `unknown`, and `each` cases must be objects (`T extends object`). An `unknown` or `any` condition is refused by this repo's lint.
|
|
228
|
+
- `assertTrue` takes a `boolean` where upstream took `unknown`, for the same reason.
|
|
229
|
+
|
|
230
|
+
What else differs is what runs by default, what `expect` refuses, and what `toEqual` means — that is why the fork is imported under its own name rather than aliasing upstream.
|
|
231
|
+
|
|
232
|
+
This package is part of [systemfsoftware](https://github.com/systemfsoftware/systemfsoftware).
|
|
233
|
+
|
|
234
|
+
## License
|
|
235
|
+
|
|
236
|
+
MIT.
|
package/dist/compat.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Ambient-only: a `declare module` inside a module is an augmentation, and an augmentation cannot
|
|
3
|
+
* introduce a module TypeScript has never seen (`effect/TestClock` is not an effect v4 export), so this
|
|
4
|
+
* file emits no import/export. `src/mod.ts` references it, and the build copies it beside the bundled
|
|
5
|
+
* declarations so the bundled entry references it too.
|
|
6
|
+
*/
|
|
7
|
+
declare module 'effect/TestClock' {
|
|
8
|
+
import type * as Duration from 'effect/Duration'
|
|
9
|
+
import type * as Effect from 'effect/Effect'
|
|
10
|
+
export const adjust: (duration: Duration.Input) => Effect.Effect<void>
|
|
11
|
+
}
|