@aerokit/test 0.0.0-stage → 15.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/LICENSE +277 -0
- package/README.md +107 -2
- package/package.json +34 -4
- package/src/api.js +41 -0
- package/src/env.js +3 -0
- package/src/fixtures.js +29 -0
- package/src/flows/a11y.js +86 -0
- package/src/flows/crud.js +121 -0
- package/src/flows/list.js +82 -0
- package/src/flows/multilingual.js +68 -0
- package/src/flows/my.js +156 -0
- package/src/flows/rest.js +57 -0
- package/src/flows/shell.js +17 -0
- package/src/form.js +214 -0
- package/src/index.js +30 -0
- package/src/sample-values.js +287 -0
- package/src/session.js +19 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
Eclipse Public License - v 2.0
|
|
2
|
+
|
|
3
|
+
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
|
|
4
|
+
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
|
|
5
|
+
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
|
|
6
|
+
|
|
7
|
+
1. DEFINITIONS
|
|
8
|
+
|
|
9
|
+
"Contribution" means:
|
|
10
|
+
|
|
11
|
+
a) in the case of the initial Contributor, the initial content
|
|
12
|
+
Distributed under this Agreement, and
|
|
13
|
+
|
|
14
|
+
b) in the case of each subsequent Contributor:
|
|
15
|
+
i) changes to the Program, and
|
|
16
|
+
ii) additions to the Program;
|
|
17
|
+
where such changes and/or additions to the Program originate from
|
|
18
|
+
and are Distributed by that particular Contributor. A Contribution
|
|
19
|
+
"originates" from a Contributor if it was added to the Program by
|
|
20
|
+
such Contributor itself or anyone acting on such Contributor's behalf.
|
|
21
|
+
Contributions do not include changes or additions to the Program that
|
|
22
|
+
are not Modified Works.
|
|
23
|
+
|
|
24
|
+
"Contributor" means any person or entity that Distributes the Program.
|
|
25
|
+
|
|
26
|
+
"Licensed Patents" mean patent claims licensable by a Contributor which
|
|
27
|
+
are necessarily infringed by the use or sale of its Contribution alone
|
|
28
|
+
or when combined with the Program.
|
|
29
|
+
|
|
30
|
+
"Program" means the Contributions Distributed in accordance with this
|
|
31
|
+
Agreement.
|
|
32
|
+
|
|
33
|
+
"Recipient" means anyone who receives the Program under this Agreement
|
|
34
|
+
or any Secondary License (as applicable), including Contributors.
|
|
35
|
+
|
|
36
|
+
"Derivative Works" shall mean any work, whether in Source Code or other
|
|
37
|
+
form, that is based on (or derived from) the Program and for which the
|
|
38
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
39
|
+
represent, as a whole, an original work of authorship.
|
|
40
|
+
|
|
41
|
+
"Modified Works" shall mean any work in Source Code or other form that
|
|
42
|
+
results from an addition to, deletion from, or modification of the
|
|
43
|
+
contents of the Program, including, for purposes of clarity any new file
|
|
44
|
+
in Source Code form that contains any contents of the Program. Modified
|
|
45
|
+
Works shall not include works that contain only declarations,
|
|
46
|
+
interfaces, types, classes, structures, or files of the Program solely
|
|
47
|
+
in each case in order to link to, bind by name, or subclass the Program
|
|
48
|
+
or Modified Works thereof.
|
|
49
|
+
|
|
50
|
+
"Distribute" means the acts of a) distributing or b) making available
|
|
51
|
+
in any manner that enables the transfer of a copy.
|
|
52
|
+
|
|
53
|
+
"Source Code" means the form of a Program preferred for making
|
|
54
|
+
modifications, including but not limited to software source code,
|
|
55
|
+
documentation source, and configuration files.
|
|
56
|
+
|
|
57
|
+
"Secondary License" means either the GNU General Public License,
|
|
58
|
+
Version 2.0, or any later versions of that license, including any
|
|
59
|
+
exceptions or additional permissions as identified by the initial
|
|
60
|
+
Contributor.
|
|
61
|
+
|
|
62
|
+
2. GRANT OF RIGHTS
|
|
63
|
+
|
|
64
|
+
a) Subject to the terms of this Agreement, each Contributor hereby
|
|
65
|
+
grants Recipient a non-exclusive, worldwide, royalty-free copyright
|
|
66
|
+
license to reproduce, prepare Derivative Works of, publicly display,
|
|
67
|
+
publicly perform, Distribute and sublicense the Contribution of such
|
|
68
|
+
Contributor, if any, and such Derivative Works.
|
|
69
|
+
|
|
70
|
+
b) Subject to the terms of this Agreement, each Contributor hereby
|
|
71
|
+
grants Recipient a non-exclusive, worldwide, royalty-free patent
|
|
72
|
+
license under Licensed Patents to make, use, sell, offer to sell,
|
|
73
|
+
import and otherwise transfer the Contribution of such Contributor,
|
|
74
|
+
if any, in Source Code or other form. This patent license shall
|
|
75
|
+
apply to the combination of the Contribution and the Program if, at
|
|
76
|
+
the time the Contribution is added by the Contributor, such addition
|
|
77
|
+
of the Contribution causes such combination to be covered by the
|
|
78
|
+
Licensed Patents. The patent license shall not apply to any other
|
|
79
|
+
combinations which include the Contribution. No hardware per se is
|
|
80
|
+
licensed hereunder.
|
|
81
|
+
|
|
82
|
+
c) Recipient understands that although each Contributor grants the
|
|
83
|
+
licenses to its Contributions set forth herein, no assurances are
|
|
84
|
+
provided by any Contributor that the Program does not infringe the
|
|
85
|
+
patent or other intellectual property rights of any other entity.
|
|
86
|
+
Each Contributor disclaims any liability to Recipient for claims
|
|
87
|
+
brought by any other entity based on infringement of intellectual
|
|
88
|
+
property rights or otherwise. As a condition to exercising the
|
|
89
|
+
rights and licenses granted hereunder, each Recipient hereby
|
|
90
|
+
assumes sole responsibility to secure any other intellectual
|
|
91
|
+
property rights needed, if any. For example, if a third party
|
|
92
|
+
patent license is required to allow Recipient to Distribute the
|
|
93
|
+
Program, it is Recipient's responsibility to acquire that license
|
|
94
|
+
before distributing the Program.
|
|
95
|
+
|
|
96
|
+
d) Each Contributor represents that to its knowledge it has
|
|
97
|
+
sufficient copyright rights in its Contribution, if any, to grant
|
|
98
|
+
the copyright license set forth in this Agreement.
|
|
99
|
+
|
|
100
|
+
e) Notwithstanding the terms of any Secondary License, no
|
|
101
|
+
Contributor makes additional grants to any Recipient (other than
|
|
102
|
+
those set forth in this Agreement) as a result of such Recipient's
|
|
103
|
+
receipt of the Program under the terms of a Secondary License
|
|
104
|
+
(if permitted under the terms of Section 3).
|
|
105
|
+
|
|
106
|
+
3. REQUIREMENTS
|
|
107
|
+
|
|
108
|
+
3.1 If a Contributor Distributes the Program in any form, then:
|
|
109
|
+
|
|
110
|
+
a) the Program must also be made available as Source Code, in
|
|
111
|
+
accordance with section 3.2, and the Contributor must accompany
|
|
112
|
+
the Program with a statement that the Source Code for the Program
|
|
113
|
+
is available under this Agreement, and informs Recipients how to
|
|
114
|
+
obtain it in a reasonable manner on or through a medium customarily
|
|
115
|
+
used for software exchange; and
|
|
116
|
+
|
|
117
|
+
b) the Contributor may Distribute the Program under a license
|
|
118
|
+
different than this Agreement, provided that such license:
|
|
119
|
+
i) effectively disclaims on behalf of all other Contributors all
|
|
120
|
+
warranties and conditions, express and implied, including
|
|
121
|
+
warranties or conditions of title and non-infringement, and
|
|
122
|
+
implied warranties or conditions of merchantability and fitness
|
|
123
|
+
for a particular purpose;
|
|
124
|
+
|
|
125
|
+
ii) effectively excludes on behalf of all other Contributors all
|
|
126
|
+
liability for damages, including direct, indirect, special,
|
|
127
|
+
incidental and consequential damages, such as lost profits;
|
|
128
|
+
|
|
129
|
+
iii) does not attempt to limit or alter the recipients' rights
|
|
130
|
+
in the Source Code under section 3.2; and
|
|
131
|
+
|
|
132
|
+
iv) requires any subsequent distribution of the Program by any
|
|
133
|
+
party to be under a license that satisfies the requirements
|
|
134
|
+
of this section 3.
|
|
135
|
+
|
|
136
|
+
3.2 When the Program is Distributed as Source Code:
|
|
137
|
+
|
|
138
|
+
a) it must be made available under this Agreement, or if the
|
|
139
|
+
Program (i) is combined with other material in a separate file or
|
|
140
|
+
files made available under a Secondary License, and (ii) the initial
|
|
141
|
+
Contributor attached to the Source Code the notice described in
|
|
142
|
+
Exhibit A of this Agreement, then the Program may be made available
|
|
143
|
+
under the terms of such Secondary Licenses, and
|
|
144
|
+
|
|
145
|
+
b) a copy of this Agreement must be included with each copy of
|
|
146
|
+
the Program.
|
|
147
|
+
|
|
148
|
+
3.3 Contributors may not remove or alter any copyright, patent,
|
|
149
|
+
trademark, attribution notices, disclaimers of warranty, or limitations
|
|
150
|
+
of liability ("notices") contained within the Program from any copy of
|
|
151
|
+
the Program which they Distribute, provided that Contributors may add
|
|
152
|
+
their own appropriate notices.
|
|
153
|
+
|
|
154
|
+
4. COMMERCIAL DISTRIBUTION
|
|
155
|
+
|
|
156
|
+
Commercial distributors of software may accept certain responsibilities
|
|
157
|
+
with respect to end users, business partners and the like. While this
|
|
158
|
+
license is intended to facilitate the commercial use of the Program,
|
|
159
|
+
the Contributor who includes the Program in a commercial product
|
|
160
|
+
offering should do so in a manner which does not create potential
|
|
161
|
+
liability for other Contributors. Therefore, if a Contributor includes
|
|
162
|
+
the Program in a commercial product offering, such Contributor
|
|
163
|
+
("Commercial Contributor") hereby agrees to defend and indemnify every
|
|
164
|
+
other Contributor ("Indemnified Contributor") against any losses,
|
|
165
|
+
damages and costs (collectively "Losses") arising from claims, lawsuits
|
|
166
|
+
and other legal actions brought by a third party against the Indemnified
|
|
167
|
+
Contributor to the extent caused by the acts or omissions of such
|
|
168
|
+
Commercial Contributor in connection with its distribution of the Program
|
|
169
|
+
in a commercial product offering. The obligations in this section do not
|
|
170
|
+
apply to any claims or Losses relating to any actual or alleged
|
|
171
|
+
intellectual property infringement. In order to qualify, an Indemnified
|
|
172
|
+
Contributor must: a) promptly notify the Commercial Contributor in
|
|
173
|
+
writing of such claim, and b) allow the Commercial Contributor to control,
|
|
174
|
+
and cooperate with the Commercial Contributor in, the defense and any
|
|
175
|
+
related settlement negotiations. The Indemnified Contributor may
|
|
176
|
+
participate in any such claim at its own expense.
|
|
177
|
+
|
|
178
|
+
For example, a Contributor might include the Program in a commercial
|
|
179
|
+
product offering, Product X. That Contributor is then a Commercial
|
|
180
|
+
Contributor. If that Commercial Contributor then makes performance
|
|
181
|
+
claims, or offers warranties related to Product X, those performance
|
|
182
|
+
claims and warranties are such Commercial Contributor's responsibility
|
|
183
|
+
alone. Under this section, the Commercial Contributor would have to
|
|
184
|
+
defend claims against the other Contributors related to those performance
|
|
185
|
+
claims and warranties, and if a court requires any other Contributor to
|
|
186
|
+
pay any damages as a result, the Commercial Contributor must pay
|
|
187
|
+
those damages.
|
|
188
|
+
|
|
189
|
+
5. NO WARRANTY
|
|
190
|
+
|
|
191
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
192
|
+
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
|
|
193
|
+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
|
|
194
|
+
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
|
|
195
|
+
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
|
|
196
|
+
PURPOSE. Each Recipient is solely responsible for determining the
|
|
197
|
+
appropriateness of using and distributing the Program and assumes all
|
|
198
|
+
risks associated with its exercise of rights under this Agreement,
|
|
199
|
+
including but not limited to the risks and costs of program errors,
|
|
200
|
+
compliance with applicable laws, damage to or loss of data, programs
|
|
201
|
+
or equipment, and unavailability or interruption of operations.
|
|
202
|
+
|
|
203
|
+
6. DISCLAIMER OF LIABILITY
|
|
204
|
+
|
|
205
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
206
|
+
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
|
|
207
|
+
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
208
|
+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
|
|
209
|
+
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
210
|
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
211
|
+
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
|
|
212
|
+
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
|
|
213
|
+
POSSIBILITY OF SUCH DAMAGES.
|
|
214
|
+
|
|
215
|
+
7. GENERAL
|
|
216
|
+
|
|
217
|
+
If any provision of this Agreement is invalid or unenforceable under
|
|
218
|
+
applicable law, it shall not affect the validity or enforceability of
|
|
219
|
+
the remainder of the terms of this Agreement, and without further
|
|
220
|
+
action by the parties hereto, such provision shall be reformed to the
|
|
221
|
+
minimum extent necessary to make such provision valid and enforceable.
|
|
222
|
+
|
|
223
|
+
If Recipient institutes patent litigation against any entity
|
|
224
|
+
(including a cross-claim or counterclaim in a lawsuit) alleging that the
|
|
225
|
+
Program itself (excluding combinations of the Program with other software
|
|
226
|
+
or hardware) infringes such Recipient's patent(s), then such Recipient's
|
|
227
|
+
rights granted under Section 2(b) shall terminate as of the date such
|
|
228
|
+
litigation is filed.
|
|
229
|
+
|
|
230
|
+
All Recipient's rights under this Agreement shall terminate if it
|
|
231
|
+
fails to comply with any of the material terms or conditions of this
|
|
232
|
+
Agreement and does not cure such failure in a reasonable period of
|
|
233
|
+
time after becoming aware of such noncompliance. If all Recipient's
|
|
234
|
+
rights under this Agreement terminate, Recipient agrees to cease use
|
|
235
|
+
and distribution of the Program as soon as reasonably practicable.
|
|
236
|
+
However, Recipient's obligations under this Agreement and any licenses
|
|
237
|
+
granted by Recipient relating to the Program shall continue and survive.
|
|
238
|
+
|
|
239
|
+
Everyone is permitted to copy and distribute copies of this Agreement,
|
|
240
|
+
but in order to avoid inconsistency the Agreement is copyrighted and
|
|
241
|
+
may only be modified in the following manner. The Agreement Steward
|
|
242
|
+
reserves the right to publish new versions (including revisions) of
|
|
243
|
+
this Agreement from time to time. No one other than the Agreement
|
|
244
|
+
Steward has the right to modify this Agreement. The Eclipse Foundation
|
|
245
|
+
is the initial Agreement Steward. The Eclipse Foundation may assign the
|
|
246
|
+
responsibility to serve as the Agreement Steward to a suitable separate
|
|
247
|
+
entity. Each new version of the Agreement will be given a distinguishing
|
|
248
|
+
version number. The Program (including Contributions) may always be
|
|
249
|
+
Distributed subject to the version of the Agreement under which it was
|
|
250
|
+
received. In addition, after a new version of the Agreement is published,
|
|
251
|
+
Contributor may elect to Distribute the Program (including its
|
|
252
|
+
Contributions) under the new version.
|
|
253
|
+
|
|
254
|
+
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
|
|
255
|
+
receives no rights or licenses to the intellectual property of any
|
|
256
|
+
Contributor under this Agreement, whether expressly, by implication,
|
|
257
|
+
estoppel or otherwise. All rights in the Program not expressly granted
|
|
258
|
+
under this Agreement are reserved. Nothing in this Agreement is intended
|
|
259
|
+
to be enforceable by any entity that is not a Contributor or Recipient.
|
|
260
|
+
No third-party beneficiary rights are created under this Agreement.
|
|
261
|
+
|
|
262
|
+
Exhibit A - Form of Secondary Licenses Notice
|
|
263
|
+
|
|
264
|
+
"This Source Code may also be made available under the following
|
|
265
|
+
Secondary Licenses when the conditions for such availability set forth
|
|
266
|
+
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
|
|
267
|
+
version(s), and exceptions or additional permissions here}."
|
|
268
|
+
|
|
269
|
+
Simply including a copy of this Agreement, including this Exhibit A
|
|
270
|
+
is not sufficient to license the Source Code under Secondary Licenses.
|
|
271
|
+
|
|
272
|
+
If it is not possible or desirable to put the notice in a particular
|
|
273
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
274
|
+
file in a relevant directory) where a recipient would be likely to
|
|
275
|
+
look for such a notice.
|
|
276
|
+
|
|
277
|
+
You may add additional accurate notices of copyright ownership.
|
package/README.md
CHANGED
|
@@ -1,3 +1,108 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @aerokit/test (published as the `@aerokit/sdk/test` subpath)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> **Publishing note:** this package is NOT published standalone - the release workflow bundles
|
|
4
|
+
> `src/` into the `@aerokit/sdk` npm package as its `./test` subpath export (the npm token cannot
|
|
5
|
+
> create new packages in the scope). Consumers depend on `@aerokit/sdk` and import
|
|
6
|
+
> `@aerokit/sdk/test` / `@aerokit/sdk/test/fixtures`; this folder stays the source of truth and the
|
|
7
|
+
> local-development identity (`file:` installs during development resolve `@aerokit/test` directly).
|
|
8
|
+
|
|
9
|
+
Generic [Playwright](https://playwright.dev) runner that executes an intent module's generated
|
|
10
|
+
`<name>.test` manifest against a running Eclipse Dirigible instance. The manifest (emitted by the
|
|
11
|
+
`AppTestIntentGenerator` in `engine-intent`, alongside `.edm`/`.model`/`.bpmn`/...) says WHAT the
|
|
12
|
+
app promises — entities, layouts, fields, seeds, languages; this package knows HOW to verify a
|
|
13
|
+
promise against the generated Harmonia UI and the reused REST controllers. So one runner, versioned
|
|
14
|
+
alongside the templates whose markup it drives, checks every generated app the same way.
|
|
15
|
+
|
|
16
|
+
This is the app-integration-test surface (drives a browser + the REST layer from outside the
|
|
17
|
+
instance). It is distinct from `@aerokit/sdk/junit`, the in-instance server-side unit-test facade.
|
|
18
|
+
|
|
19
|
+
## Use from a module
|
|
20
|
+
|
|
21
|
+
A module keeps a tiny `test/` harness at its **repo root** (outside the published project folder, so
|
|
22
|
+
it never enters the registry or the npm package):
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
// test/app.spec.js
|
|
26
|
+
import { fileURLToPath } from 'node:url';
|
|
27
|
+
import { runTest } from '@aerokit/sdk/test';
|
|
28
|
+
|
|
29
|
+
runTest(fileURLToPath(new URL('../<project>/<name>.test', import.meta.url)));
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
// test/package.json
|
|
34
|
+
{
|
|
35
|
+
"type": "module",
|
|
36
|
+
"scripts": { "test": "playwright test" },
|
|
37
|
+
"devDependencies": { "@aerokit/test": "*", "@playwright/test": "^1.45" }
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
BASE_URL=http://localhost:8080 npm test # defaults: admin/admin, installed Chrome
|
|
43
|
+
APPTEST_SHELL=1 npm test # also assert the shared-shell menu item
|
|
44
|
+
APPTEST_A11Y=strict npm test # fail on serious/critical accessibility violations
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Env: `BASE_URL` (default `http://localhost:8080`), `APPTEST_USERNAME`/`APPTEST_PASSWORD`
|
|
48
|
+
(default `admin`/`admin`), `APPTEST_SHELL` (opt-in shared-shell flow), `APPTEST_A11Y` (`report`
|
|
49
|
+
default, `strict`, `off` - the accessibility flow).
|
|
50
|
+
|
|
51
|
+
## Flows per entity
|
|
52
|
+
|
|
53
|
+
- **list** — the shell breadcrumb naming the list by its plural label, the declared columns, and
|
|
54
|
+
(when `expectSeedData`) a row. An entity whose manifest carries `list` renders exactly those
|
|
55
|
+
columns, in order, and a field left off it must have no header at all; without `list` the columns
|
|
56
|
+
are the fields whose `major` is not `false`.
|
|
57
|
+
- **crud** — UI create → filter → row appears; edit via the row menu → save (a `document` saves in
|
|
58
|
+
place, so the walk leaves through Cancel); delete via the row menu → confirm → gone. A walk
|
|
59
|
+
that fails halfway still removes its test row over REST. An entity without a `route` (a composition
|
|
60
|
+
child with no page of its own) has no list, crud, multilingual or shell flow.
|
|
61
|
+
- **rest** — the same CRUD over the generated Java controllers via `APIRequestContext` (isolates
|
|
62
|
+
backend vs UI failures), asserting the manifest's field names bind and delete yields 404 — or,
|
|
63
|
+
for an entity a `whenDeleted: refuse` process guards, that the refused record is still served.
|
|
64
|
+
- **multilingual** — switch the shared language key, reload, a seeded row shows its translated name.
|
|
65
|
+
The assertion waits for the list's own data GET and allows 15 s; a failure names the
|
|
66
|
+
`Accept-Language` that GET sent, whether its body carried the expected word, and the table's first
|
|
67
|
+
row, so a slow render reads differently from a missing translation.
|
|
68
|
+
- **my** — the personal (my) surface WIRE contract, when the manifest marks an entity `personal`:
|
|
69
|
+
create through the scoped `<Entity>MyController` (owner FK forced server-side), every `sensitive`
|
|
70
|
+
field null on the personal wire, the own row in the personal list, foreign rows 404 (when the
|
|
71
|
+
owner relation is optional), own-row delete. Skips with a pointer when the test user has no
|
|
72
|
+
identity mapping (seed the dev identity row). Personal *UI* parity (resolved labels, chat,
|
|
73
|
+
calendar on the Personal shell) is deliberately not asserted yet — it tracks the personal-template
|
|
74
|
+
parity fixes.
|
|
75
|
+
- **shell** (opt-in) — the shared application shell's nav item opens the module SPA in its iframe.
|
|
76
|
+
- **a11y** — axe-core scans the list page and the create form against WCAG 2.1 A/AA and attaches
|
|
77
|
+
each page's result (`axe-<Entity>-<page>.json`) to the test report. `APPTEST_A11Y=report`
|
|
78
|
+
(default) only reports - a module's first release; `strict` also fails on a `serious` or
|
|
79
|
+
`critical` violation; `off` skips it. Needs `@axe-core/playwright` in the harness
|
|
80
|
+
`devDependencies` (the flow skips itself without it). Contrast against Harmonia's own
|
|
81
|
+
`--primary` is not counted in strict mode: the default palette misses 4.5:1 there, which the
|
|
82
|
+
component library fixes; every other contrast failure is.
|
|
83
|
+
|
|
84
|
+
Test records carry an `APPTEST-` prefix and are removed in teardown; seed data is never mutated.
|
|
85
|
+
A field the app owns rather than the user — a `number:` series, a calculated or `readOnly:` value —
|
|
86
|
+
is never written or flipped by a flow (the manifest marks it `readOnly`). A relation the form renders
|
|
87
|
+
read-only — a `calculatedActionOnUpdate`, a platform-owned FK — carries the same flag and is never
|
|
88
|
+
picked in the UI. A field declaring a
|
|
89
|
+
`pattern:` gets a value of that shape rather than the marker string. An optional `pattern:` field
|
|
90
|
+
whose shape none of the sample candidates has (an IBAN, say) is left empty; a required one keeps the
|
|
91
|
+
marker, so the controller's 400 names the field. Relations an `agree` check names are picked so
|
|
92
|
+
their targets agree; a composite `uniqueKeys` entry is given a relation combination no live row
|
|
93
|
+
carries, and the rest and crud flows skip with the key named when every combination tried is taken.
|
|
94
|
+
A relation carrying `pickable` is sampled only from the rows its rule admits — the chooser offers no
|
|
95
|
+
other, so a record built from one would never save — and one carrying `forbiddenTarget` only from
|
|
96
|
+
rows the record's own `forbidWhen` does not refuse, which is what the REST flow needs, having no
|
|
97
|
+
picker to read. When no row is left, a required relation fails naming the rule's own message rather
|
|
98
|
+
than "no rows".
|
|
99
|
+
|
|
100
|
+
## Custom UI hooks
|
|
101
|
+
|
|
102
|
+
`runTest(manifest, { extend })` (`runAppTest` remains a deprecated alias):
|
|
103
|
+
|
|
104
|
+
- `widgets: { '<widget>': async (page, field, value) => ... }` — custom widget fillers.
|
|
105
|
+
- `entities: { <Entity>: { skip: ['delete'], beforeCreate, afterCreate } }` — per-entity hooks.
|
|
106
|
+
|
|
107
|
+
Hand-written specs live in `test/custom/*.spec.js` and import `@aerokit/test/fixtures`
|
|
108
|
+
(pre-logged-in `test`, an `api` client, `expect`) so login/baseURL/cleanup come free.
|
package/package.json
CHANGED
|
@@ -1,6 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aerokit/test",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "15.0.0",
|
|
4
|
+
"description": "Generic Playwright runner that executes an intent module's generated <name>.test manifest against a running Eclipse Dirigible instance",
|
|
5
|
+
"license": "EPL-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "src/index.js",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": "./src/index.js",
|
|
10
|
+
"./fixtures": "./src/fixtures.js"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"src"
|
|
14
|
+
],
|
|
15
|
+
"keywords": [
|
|
16
|
+
"dirigible",
|
|
17
|
+
"playwright",
|
|
18
|
+
"integration-test",
|
|
19
|
+
"intent",
|
|
20
|
+
"low-code"
|
|
21
|
+
],
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "https://github.com/eclipse-dirigible/dirigible.git",
|
|
25
|
+
"directory": "npm/test"
|
|
26
|
+
},
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"@playwright/test": ">=1.45",
|
|
29
|
+
"@axe-core/playwright": ">=4.10"
|
|
30
|
+
},
|
|
31
|
+
"peerDependenciesMeta": {
|
|
32
|
+
"@axe-core/playwright": {
|
|
33
|
+
"optional": true
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
package/src/api.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Thin REST client over the generated Java controllers described by the manifest.
|
|
2
|
+
export function makeApi(request, manifest) {
|
|
3
|
+
const url = (entity, suffix = '') => manifest.restBase + entity.api + suffix;
|
|
4
|
+
|
|
5
|
+
async function asJson(response) {
|
|
6
|
+
if (!response.ok()) {
|
|
7
|
+
// APIResponse has no request(); report url + status + body
|
|
8
|
+
throw new Error(`${response.url()} -> ${response.status()} ${await response.text()}`);
|
|
9
|
+
}
|
|
10
|
+
const text = await response.text();
|
|
11
|
+
return text ? JSON.parse(text) : undefined;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
return {
|
|
15
|
+
list: (entity, limit = 20) => request.get(url(entity, `?$limit=${limit}`)).then(asJson),
|
|
16
|
+
// absolute controller path (a cross-model relation target owned by another module)
|
|
17
|
+
listPath: (path, limit = 20) => request.get(`${path}?$limit=${limit}`).then(asJson),
|
|
18
|
+
getPath: (path) => request.get(path).then(asJson),
|
|
19
|
+
count: (entity) => request.get(url(entity, '/count')).then(asJson).then((body) => (typeof body === 'number' ? body : body.count)),
|
|
20
|
+
get: (entity, id) => request.get(url(entity, '/' + id)).then(asJson),
|
|
21
|
+
getResponse: (entity, id) => request.get(url(entity, '/' + id)),
|
|
22
|
+
// the generated controller's filtered read (what the list's filters POST): [{ propertyName, operator, value }]
|
|
23
|
+
search: (entity, conditions) => request.post(url(entity, '/search'), { data: { conditions } }).then(asJson),
|
|
24
|
+
create: (entity, data) => request.post(url(entity), { data }).then(asJson),
|
|
25
|
+
update: (entity, id, data) => request.put(url(entity, '/' + id), { data }).then(asJson),
|
|
26
|
+
// Answers whether the row is gone. A record whose process declares `whenDeleted: refuse` is
|
|
27
|
+
// REFUSED with 409 while that instance runs (dirigible #7074) - the guard doing its job, not a
|
|
28
|
+
// failure, so the caller is told rather than thrown at and its cleanup completes either way.
|
|
29
|
+
// Every other failing status still throws.
|
|
30
|
+
remove: async (entity, id) => {
|
|
31
|
+
const response = await request.delete(url(entity, '/' + id));
|
|
32
|
+
if (response.status() === 409 && entity.deleteGuardedByProcess?.length) {
|
|
33
|
+
return false;
|
|
34
|
+
}
|
|
35
|
+
if (!response.ok()) {
|
|
36
|
+
throw new Error(`DELETE ${response.url()} -> ${response.status()} ${await response.text()}`);
|
|
37
|
+
}
|
|
38
|
+
return true;
|
|
39
|
+
},
|
|
40
|
+
};
|
|
41
|
+
}
|
package/src/env.js
ADDED
package/src/fixtures.js
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { expect, test as base } from '@playwright/test';
|
|
2
|
+
import { BASE_URL } from './env.js';
|
|
3
|
+
import { login } from './session.js';
|
|
4
|
+
|
|
5
|
+
// Pre-authenticated Playwright test:
|
|
6
|
+
// - authState: worker-scoped form login, one session per worker
|
|
7
|
+
// - storageState: every page starts logged in
|
|
8
|
+
// - api: an APIRequestContext carrying the same session, for REST-level checks
|
|
9
|
+
export const test = base.extend({
|
|
10
|
+
authState: [
|
|
11
|
+
async ({ browser }, use) => {
|
|
12
|
+
await use(await login(browser));
|
|
13
|
+
},
|
|
14
|
+
{ scope: 'worker' },
|
|
15
|
+
],
|
|
16
|
+
storageState: async ({ authState }, use) => {
|
|
17
|
+
await use(authState);
|
|
18
|
+
},
|
|
19
|
+
api: async ({ playwright, authState }, use) => {
|
|
20
|
+
const request = await playwright.request.newContext({
|
|
21
|
+
baseURL: BASE_URL,
|
|
22
|
+
storageState: authState,
|
|
23
|
+
});
|
|
24
|
+
await use(request);
|
|
25
|
+
await request.dispose();
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
export { expect };
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { expect, test } from '../fixtures.js';
|
|
2
|
+
import { CALENDAR_OR_SLOTS, listCrumb } from './list.js';
|
|
3
|
+
|
|
4
|
+
// The WCAG 2.1 level AA conformance rules, and the level A ones it includes (dirigible #7645).
|
|
5
|
+
const WCAG_21_AA = ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'];
|
|
6
|
+
const ENFORCED_IMPACTS = new Set(['serious', 'critical']);
|
|
7
|
+
|
|
8
|
+
// report (default): attach every page's axe result to the test report and pass - the first
|
|
9
|
+
// release of a module. strict: also fail on a serious or critical violation. off: no scan.
|
|
10
|
+
const MODE = process.env.APPTEST_A11Y ?? 'report';
|
|
11
|
+
|
|
12
|
+
// Harmonia's default palette fails contrast against its own --primary (white on it, and it as link
|
|
13
|
+
// text in dark mode); that is fixed in the component library, so strict mode does not fail an app
|
|
14
|
+
// for it. Any other contrast failure still counts.
|
|
15
|
+
const PRIMARY_COLOR = () => {
|
|
16
|
+
const probe = document.createElement('div');
|
|
17
|
+
probe.style.color = 'var(--primary)';
|
|
18
|
+
document.body.appendChild(probe);
|
|
19
|
+
const color = getComputedStyle(probe).color;
|
|
20
|
+
probe.remove();
|
|
21
|
+
const context = document.createElement('canvas').getContext('2d');
|
|
22
|
+
context.fillStyle = color;
|
|
23
|
+
context.fillRect(0, 0, 1, 1);
|
|
24
|
+
const [r, g, b] = context.getImageData(0, 0, 1, 1).data;
|
|
25
|
+
return '#' + [r, g, b].map((v) => v.toString(16).padStart(2, '0')).join('');
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
function sameColor(measured, expected) {
|
|
29
|
+
if (typeof measured !== 'string' || measured.length !== 7 || !expected) return false;
|
|
30
|
+
for (let channel = 1; channel < 7; channel += 2) {
|
|
31
|
+
const a = parseInt(measured.slice(channel, channel + 2), 16);
|
|
32
|
+
const b = parseInt(expected.slice(channel, channel + 2), 16);
|
|
33
|
+
if (Math.abs(a - b) > 2) return false;
|
|
34
|
+
}
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function onPrimary(node, primary) {
|
|
39
|
+
return (node.any ?? []).some((check) => sameColor(check.data?.fgColor, primary) || sameColor(check.data?.bgColor, primary));
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
async function axeBuilder() {
|
|
43
|
+
try {
|
|
44
|
+
return (await import('@axe-core/playwright')).default;
|
|
45
|
+
} catch {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// The list page and the create form of every entity with a page of its own, scanned by axe-core.
|
|
51
|
+
export function a11yFlow(manifest, entity) {
|
|
52
|
+
if (MODE === 'off' || !entity.route) return;
|
|
53
|
+
test(`${entity.name}: list and form pages pass axe-core (WCAG 2.1 AA)`, async ({ page }, testInfo) => {
|
|
54
|
+
const AxeBuilder = await axeBuilder();
|
|
55
|
+
test.skip(!AxeBuilder, 'add @axe-core/playwright to the harness devDependencies to run the accessibility flow');
|
|
56
|
+
|
|
57
|
+
const calendar = entity.layout === 'calendar' || entity.layout === 'slots';
|
|
58
|
+
const pages = [['list', entity.route, () => (calendar ? page.locator(CALENDAR_OR_SLOTS).first() : listCrumb(page, entity))]];
|
|
59
|
+
if (!calendar && !entity.hierarchy) {
|
|
60
|
+
pages.push(['form', entity.route + '/create', () => page.locator('input, select, textarea').filter({ visible: true }).first()]);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const findings = [];
|
|
64
|
+
for (const [name, route, ready] of pages) {
|
|
65
|
+
await page.goto(manifest.standaloneShell + route);
|
|
66
|
+
await expect(ready()).toBeVisible();
|
|
67
|
+
const results = await new AxeBuilder({ page }).withTags(WCAG_21_AA).analyze();
|
|
68
|
+
await testInfo.attach(`axe-${entity.name}-${name}.json`, {
|
|
69
|
+
body: JSON.stringify(results, null, 2),
|
|
70
|
+
contentType: 'application/json',
|
|
71
|
+
});
|
|
72
|
+
const primary = await page.evaluate(PRIMARY_COLOR);
|
|
73
|
+
for (const violation of results.violations) {
|
|
74
|
+
if (!ENFORCED_IMPACTS.has(violation.impact)) continue;
|
|
75
|
+
const nodes = violation.nodes.filter((node) => !(violation.id === 'color-contrast' && onPrimary(node, primary)));
|
|
76
|
+
if (nodes.length) {
|
|
77
|
+
const targets = nodes.slice(0, 5).map((node) => node.target.join(' ')).join(', ');
|
|
78
|
+
findings.push(`${name}: [${violation.impact}] ${violation.id} - ${violation.help} (${nodes.length} elements: ${targets})`);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (MODE === 'strict') {
|
|
83
|
+
expect(findings, 'serious or critical WCAG 2.1 AA violations:\n' + findings.join('\n')).toEqual([]);
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
}
|