@spine-event-engine/testing 2.0.0-snapshot.2
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/LICENSE +201 -0
- package/README.md +80 -0
- package/REFERENCE.md +47 -0
- package/dist/black-box/black-box.d.ts +195 -0
- package/dist/black-box/black-box.d.ts.map +1 -0
- package/dist/black-box/black-box.js +601 -0
- package/dist/black-box/black-box.js.map +1 -0
- package/dist/black-box/internal-test-access.d.ts +5 -0
- package/dist/black-box/internal-test-access.d.ts.map +1 -0
- package/dist/black-box/internal-test-access.js +18 -0
- package/dist/black-box/internal-test-access.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +35 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Black-box testing for Spine applications
|
|
2
|
+
|
|
3
|
+
Use this package to test a bounded context through the same local server and
|
|
4
|
+
Node client boundary used by an application. `BlackBox` is the end-user test
|
|
5
|
+
API; applications do not need internal test utilities.
|
|
6
|
+
|
|
7
|
+
For detailed contracts intended for coding agents, see the
|
|
8
|
+
[REFERENCE.md documentation for agents](REFERENCE.md).
|
|
9
|
+
|
|
10
|
+
## 💡 Why use it?
|
|
11
|
+
|
|
12
|
+
- ✅ Tests a complete bounded context through real Spine services.
|
|
13
|
+
- ✅ Posts commands, reads query-side views, and observes subscriptions as a
|
|
14
|
+
user.
|
|
15
|
+
- ✅ Runs on an ephemeral local server with predictable cleanup.
|
|
16
|
+
- ✅ Waits for genuinely asynchronous results with bounded polling.
|
|
17
|
+
|
|
18
|
+
## 🚀 Start a test
|
|
19
|
+
|
|
20
|
+
Create a `BlackBox` from a built context or its builder. It starts an ephemeral
|
|
21
|
+
local server and closes it when the test is finished.
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
// docs-snippet-path: packages/testing/src/black-box/black-box.ts
|
|
25
|
+
import { BlackBox } from "@spine-event-engine/testing";
|
|
26
|
+
import { BoundedContext } from "@spine-event-engine/server";
|
|
27
|
+
|
|
28
|
+
const box = await BlackBox.from(BoundedContext.singleTenant("Tasks"));
|
|
29
|
+
const guest = box.asGuest();
|
|
30
|
+
await box.close();
|
|
31
|
+
void guest;
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Create a named scope when a test needs to act as a particular user. Scopes send
|
|
35
|
+
queries, post commands, and create subscriptions through the public client API.
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
// docs-snippet-path: packages/testing/src/black-box/black-box.ts
|
|
39
|
+
import type { BlackBox } from "@spine-event-engine/testing";
|
|
40
|
+
|
|
41
|
+
declare const box: BlackBox;
|
|
42
|
+
const alice = box.onBehalfOf("alice");
|
|
43
|
+
// await alice.post(command);
|
|
44
|
+
// const result = await alice.send(query);
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## ⏳ Observe an asynchronous result
|
|
48
|
+
|
|
49
|
+
Use `eventually()` only for a result that becomes visible later. Assert an
|
|
50
|
+
immediate command result directly instead of polling for it.
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
// docs-snippet-path: packages/testing/src/black-box/black-box.ts
|
|
54
|
+
import type { BlackBox } from "@spine-event-engine/testing";
|
|
55
|
+
|
|
56
|
+
declare const box: BlackBox;
|
|
57
|
+
const value = await box.eventually(
|
|
58
|
+
async () => "ready",
|
|
59
|
+
(result: string) => result === "ready",
|
|
60
|
+
{ timeoutMs: 500, intervalMs: 5 },
|
|
61
|
+
);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`BlackBox.from()` accepts fixed `tenant`, `zoneId`, `timeoutMs`, and
|
|
65
|
+
`intervalMs` options. Time values must be positive integers. `close()` cancels
|
|
66
|
+
subscriptions created by the box, closes its client, and then closes the local
|
|
67
|
+
server.
|
|
68
|
+
|
|
69
|
+
## ⚠️ Test boundary
|
|
70
|
+
|
|
71
|
+
`BlackBox` tests one local Node process. It does not prove browser behavior,
|
|
72
|
+
cross-process delivery, authentication infrastructure, or a production storage
|
|
73
|
+
deployment. Choose the application’s real storage factory only when an
|
|
74
|
+
integration test intentionally covers that provider.
|
|
75
|
+
|
|
76
|
+
## 🔗 Learn more
|
|
77
|
+
|
|
78
|
+
- [Todo example tests](../../examples/todo/README.md)
|
|
79
|
+
- [Server](../server/README.md)
|
|
80
|
+
- [Reference for coding agents](REFERENCE.md)
|
package/REFERENCE.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @spine-event-engine/testing reference
|
|
2
|
+
|
|
3
|
+
This reference describes the public test API for coding agents.
|
|
4
|
+
|
|
5
|
+
## Entry point
|
|
6
|
+
|
|
7
|
+
Import `BlackBox`, `BlackBoxClosedError`, `BlackBoxTimeoutError`, and their
|
|
8
|
+
option/scope types from `@spine-event-engine/testing`. Do not use the package's
|
|
9
|
+
internal test access or the server's `BoundedContextFixture` as application
|
|
10
|
+
test APIs.
|
|
11
|
+
|
|
12
|
+
`BlackBox.from(contextOrBuilder, options?)` accepts a built `BoundedContext` or
|
|
13
|
+
`BoundedContextBuilder`, builds a builder asynchronously, starts a local
|
|
14
|
+
`Server`, and connects a Node client. The returned box is ready to use. Options
|
|
15
|
+
are fixed for its lifetime:
|
|
16
|
+
|
|
17
|
+
- `tenant` is required by a multitenant context and must not be supplied to a
|
|
18
|
+
single-tenant context;
|
|
19
|
+
- `zoneId` defaults to the framework's valid zone value;
|
|
20
|
+
- `timeoutMs` defaults to 500 and `intervalMs` defaults to 5; both must be
|
|
21
|
+
positive integers.
|
|
22
|
+
|
|
23
|
+
`asGuest()` creates an immutable guest scope. `onBehalfOf(actor)` creates an
|
|
24
|
+
immutable actor scope; actor text is validated by the client contract.
|
|
25
|
+
`BlackBoxScope` includes the Node client request operations and adds
|
|
26
|
+
`postEvent(schema, message)` for a direct event post in a test.
|
|
27
|
+
|
|
28
|
+
## Waiting and lifecycle
|
|
29
|
+
|
|
30
|
+
`eventually(read, accept, options?)` retries `read` until `accept` returns true
|
|
31
|
+
or the deadline is reached. It returns the accepted value, throws
|
|
32
|
+
`BlackBoxTimeoutError` at the deadline, and rejects invalid timing values. It
|
|
33
|
+
stops waiting when close begins.
|
|
34
|
+
|
|
35
|
+
`close()` is idempotent and returns one shared completion promise. It stops new
|
|
36
|
+
operations, cancels tracked subscriptions, closes the client, then closes the
|
|
37
|
+
local server. Operations begun after close starts throw `BlackBoxClosedError`.
|
|
38
|
+
|
|
39
|
+
Subscriptions created by a scope are inactive until `activate()` and must be
|
|
40
|
+
ended with `cancel()`. The box tracks them so cleanup remains safe if a test
|
|
41
|
+
fails before it cancels one.
|
|
42
|
+
|
|
43
|
+
## Limits
|
|
44
|
+
|
|
45
|
+
BlackBox deliberately makes no guarantees about browser behavior, remote
|
|
46
|
+
servers, clustered delivery, authentication, or production persistence. Use
|
|
47
|
+
application integration tests for those boundaries.
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
import { type Message, type MessageShape } from "@bufbuild/protobuf";
|
|
2
|
+
import type { GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
3
|
+
import { type ClientRequest } from "@spine-event-engine/client-node";
|
|
4
|
+
import { type TenantId, type ZoneId } from "@spine-event-engine/proto";
|
|
5
|
+
import { BoundedContext, type BoundedContextBuilder } from "@spine-event-engine/server";
|
|
6
|
+
/**
|
|
7
|
+
* Fixed configuration for one runner-neutral BlackBox session.
|
|
8
|
+
*/
|
|
9
|
+
export interface BlackBoxOptions {
|
|
10
|
+
/**
|
|
11
|
+
* Fixed tenant for this BlackBox; required only by multitenant contexts.
|
|
12
|
+
*/
|
|
13
|
+
readonly tenant?: string | TenantId;
|
|
14
|
+
/**
|
|
15
|
+
* Fixed IANA time zone for every operation in this BlackBox.
|
|
16
|
+
*/
|
|
17
|
+
readonly zoneId?: string | ZoneId;
|
|
18
|
+
/**
|
|
19
|
+
* Maximum time an eventual read may wait, as a positive integer. Defaults to 500 milliseconds.
|
|
20
|
+
*/
|
|
21
|
+
readonly timeoutMs?: number;
|
|
22
|
+
/**
|
|
23
|
+
* Delay between eventual read attempts, as a positive integer. Defaults to 5 milliseconds.
|
|
24
|
+
*/
|
|
25
|
+
readonly intervalMs?: number;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Stable error thrown when an eventual read cannot satisfy its predicate.
|
|
29
|
+
*/
|
|
30
|
+
export declare class BlackBoxTimeoutError extends Error {
|
|
31
|
+
/**
|
|
32
|
+
* Creates a timeout error.
|
|
33
|
+
*
|
|
34
|
+
* @param timeoutMs The elapsed wait limit in milliseconds.
|
|
35
|
+
*/
|
|
36
|
+
constructor(timeoutMs: number);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Stable error thrown when an operation is attempted after BlackBox close begins.
|
|
40
|
+
*/
|
|
41
|
+
export declare class BlackBoxClosedError extends Error {
|
|
42
|
+
/**
|
|
43
|
+
* Creates a closed error.
|
|
44
|
+
*/
|
|
45
|
+
constructor();
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* One immutable actor scope within a BlackBox.
|
|
49
|
+
*/
|
|
50
|
+
export interface BlackBoxScope extends ClientRequest {
|
|
51
|
+
/**
|
|
52
|
+
* Posts a direct domain event through this actor scope.
|
|
53
|
+
*
|
|
54
|
+
* @param schema The schema of the event message.
|
|
55
|
+
* @param message The event message to post.
|
|
56
|
+
* @returns A promise that resolves after the event is posted.
|
|
57
|
+
*/
|
|
58
|
+
postEvent<Schema extends GenMessage<Message>>(schema: Schema, message: MessageShape<Schema>): Promise<void>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* A runner-neutral public-client test facade over one local bounded context.
|
|
62
|
+
*/
|
|
63
|
+
export declare class BlackBox {
|
|
64
|
+
#private;
|
|
65
|
+
private constructor();
|
|
66
|
+
/**
|
|
67
|
+
* Starts an ephemeral local server and public client for a context or builder.
|
|
68
|
+
*
|
|
69
|
+
* @param contextOrBuilder The bounded context or builder to exercise.
|
|
70
|
+
* @param options The tenant, zone, and eventual-wait options.
|
|
71
|
+
* @returns A ready BlackBox.
|
|
72
|
+
*/
|
|
73
|
+
static from(contextOrBuilder: BoundedContext | BoundedContextBuilder, options?: BlackBoxOptions): Promise<BlackBox>;
|
|
74
|
+
/**
|
|
75
|
+
* Creates the guest scope.
|
|
76
|
+
*
|
|
77
|
+
* @returns An immutable guest request scope.
|
|
78
|
+
*/
|
|
79
|
+
asGuest(): BlackBoxScope;
|
|
80
|
+
/**
|
|
81
|
+
* Creates an immutable scope for one actor.
|
|
82
|
+
*
|
|
83
|
+
* @param actor The actor identifier for requests and direct events.
|
|
84
|
+
* @returns An immutable actor request scope.
|
|
85
|
+
*/
|
|
86
|
+
onBehalfOf(actor: string): BlackBoxScope;
|
|
87
|
+
/**
|
|
88
|
+
* Reads repeatedly until the predicate accepts or the bounded wait expires.
|
|
89
|
+
*
|
|
90
|
+
* @param read The value-producing operation to retry.
|
|
91
|
+
* @param accept The predicate that accepts a produced value.
|
|
92
|
+
* @param options Optional wait limits for this operation.
|
|
93
|
+
* @returns The first accepted value.
|
|
94
|
+
*/
|
|
95
|
+
eventually<Value>(read: () => Value | Promise<Value>, accept: (value: Value) => boolean, options?: Pick<BlackBoxOptions, "timeoutMs" | "intervalMs">): Promise<Value>;
|
|
96
|
+
/**
|
|
97
|
+
* Stops admission, cancels owned subscriptions, and closes the client and server once.
|
|
98
|
+
*
|
|
99
|
+
* @returns A shared promise that resolves after cleanup completes.
|
|
100
|
+
*/
|
|
101
|
+
close(): Promise<void>;
|
|
102
|
+
private closeOnce;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Internal operations exposed only through the unexported test-access module.
|
|
106
|
+
*/
|
|
107
|
+
export interface BlackBoxTestAccess {
|
|
108
|
+
/**
|
|
109
|
+
* Creates a BlackBox with supplied closeable resources.
|
|
110
|
+
*
|
|
111
|
+
* @param resources The test client, server, and optional subscriptions.
|
|
112
|
+
* @returns A BlackBox that owns the supplied resources.
|
|
113
|
+
*/
|
|
114
|
+
create(resources: BlackBoxTestResources): BlackBox;
|
|
115
|
+
/**
|
|
116
|
+
* Returns a generic subscription-like handle for lifecycle regression tests.
|
|
117
|
+
*
|
|
118
|
+
* @param blackBox The BlackBox that owns the handle.
|
|
119
|
+
* @param handle The cancelable async handle to track.
|
|
120
|
+
* @returns The tracked handle.
|
|
121
|
+
*/
|
|
122
|
+
track(blackBox: BlackBox, handle: BlackBoxTestHandle): AsyncIterable<unknown> & {
|
|
123
|
+
cancel(): Promise<void>;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Opens a BlackBox through supplied lifecycle seams for startup regression tests.
|
|
127
|
+
*
|
|
128
|
+
* @param resources The test startup and connection operations.
|
|
129
|
+
* @returns A BlackBox created through the supplied operations.
|
|
130
|
+
*/
|
|
131
|
+
open(resources: BlackBoxTestStartup): Promise<BlackBox>;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Provides internal-only lifecycle seams for BlackBox regression tests.
|
|
135
|
+
*/
|
|
136
|
+
export declare const BlackBoxTestAccess: BlackBoxTestAccess;
|
|
137
|
+
/**
|
|
138
|
+
* Internal resources accepted by the BlackBox lifecycle test seam.
|
|
139
|
+
*/
|
|
140
|
+
export interface BlackBoxTestResources {
|
|
141
|
+
/**
|
|
142
|
+
* Closes the test client.
|
|
143
|
+
*/
|
|
144
|
+
readonly client: {
|
|
145
|
+
close(): Promise<void>;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* Closes the test server.
|
|
149
|
+
*/
|
|
150
|
+
readonly server: {
|
|
151
|
+
close(): Promise<void>;
|
|
152
|
+
};
|
|
153
|
+
/**
|
|
154
|
+
* Lists subscriptions to close with the BlackBox.
|
|
155
|
+
*/
|
|
156
|
+
readonly subscriptions?: readonly {
|
|
157
|
+
cancel(): Promise<void>;
|
|
158
|
+
}[];
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Internal async handle accepted by the BlackBox lifecycle test seam.
|
|
162
|
+
*/
|
|
163
|
+
export type BlackBoxTestHandle = {
|
|
164
|
+
/**
|
|
165
|
+
* Cancels the tracked handle.
|
|
166
|
+
*
|
|
167
|
+
* @returns A promise that resolves after cancellation completes.
|
|
168
|
+
*/
|
|
169
|
+
cancel(): Promise<void>;
|
|
170
|
+
} & AsyncIterable<unknown>;
|
|
171
|
+
/**
|
|
172
|
+
* Internal startup operations accepted by the BlackBox lifecycle test seam.
|
|
173
|
+
*/
|
|
174
|
+
export interface BlackBoxTestStartup {
|
|
175
|
+
/**
|
|
176
|
+
* Starts the test server.
|
|
177
|
+
*
|
|
178
|
+
* @returns A closeable test server.
|
|
179
|
+
*/
|
|
180
|
+
readonly start: () => Promise<{
|
|
181
|
+
close(): Promise<void>;
|
|
182
|
+
}>;
|
|
183
|
+
/**
|
|
184
|
+
* Connects the test client to the started server.
|
|
185
|
+
*
|
|
186
|
+
* @param server The server returned by start.
|
|
187
|
+
* @returns A closeable test client.
|
|
188
|
+
*/
|
|
189
|
+
readonly connect: (server: {
|
|
190
|
+
close(): Promise<void>;
|
|
191
|
+
}) => {
|
|
192
|
+
close(): Promise<void>;
|
|
193
|
+
};
|
|
194
|
+
}
|
|
195
|
+
//# sourceMappingURL=black-box.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"black-box.d.ts","sourceRoot":"","sources":["../../src/black-box/black-box.ts"],"names":[],"mappings":"AAcA,OAAO,EAAiB,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACpF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAKL,KAAK,aAAa,EAGnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAOL,KAAK,QAAQ,EACb,KAAK,MAAM,EACZ,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,EAG3B,MAAM,4BAA4B,CAAC;AAGpC;;GAEG;AACH,MAAM,WAAW,eAAe;IAG9B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;IAG7C;;;;OAIG;gBACS,SAAS,EAAE,MAAM;CAI9B;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAG5C;;OAEG;;CAKJ;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa;IAGlD;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,SAAS,UAAU,CAAC,OAAO,CAAC,EAC1C,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAaD;;GAEG;AACH,qBAAa,QAAQ;;IAanB,OAAO;IAyBP;;;;;;OAMG;WACU,IAAI,CACf,gBAAgB,EAAE,cAAc,GAAG,qBAAqB,EACxD,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;OAIG;IACH,OAAO,IAAI,aAAa;IAKxB;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa;IAKxC;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,EACpB,IAAI,EAAE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EAClC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,EACjC,OAAO,GAAE,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,YAAY,CAAM,GAC9D,OAAO,CAAC,KAAK,CAAC;IAoBjB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAgDR,SAAS;CAexB;AA4BD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAGjC;;;;;OAKG;IACH,MAAM,CAAC,SAAS,EAAE,qBAAqB,GAAG,QAAQ,CAAC;IAEnD;;;;;;OAMG;IACH,KAAK,CACH,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,kBAAkB,GACzB,aAAa,CAAC,OAAO,CAAC,GAAG;QAAE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAExD;;;;;OAKG;IACH,IAAI,CAAC,SAAS,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzD;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAoD/B,CAAC;AAyDH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAGpC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE;QAAE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE;QAAE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS;QAAE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,EAAE,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAG/B;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAGlC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,OAAO,CAAC;QAAE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE;QAAE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,KAAK;QAAE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;CACtF"}
|