Skip to content

Commit e5706ac

Browse files
gmoonclaude
gmoon
and
claude
committed
Initial commit: @forkzero/s3-website-test-kit 0.1.0
Target-agnostic Artillery load + conformance tests for S3 static-website semantics. Core scenarios run against native S3 website hosting or s3proxy; s3proxy-only scenarios (health) are split out. Extracted from gmoon/s3proxy shared-testing; utils normalized to ESM. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
0 parents  commit e5706ac

26 files changed

Lines changed: 1476 additions & 0 deletions

‎.github/workflows/ci.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
validate:
12+
name: Validate
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: 22
19+
cache: 'npm'
20+
- run: npm ci
21+
- run: npm run validate
22+
- run: npm pack --dry-run

‎.github/workflows/release.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Release
2+
on:
3+
release:
4+
types: [published]
5+
workflow_dispatch:
6+
7+
# npm trusted publishing (OIDC): no stored NPM_TOKEN. Requires a Trusted
8+
# Publisher configured for @forkzero/s3-website-test-kit on npmjs.com
9+
# (repo forkzero/s3-website-test-kit, workflow release.yml). id-token: write
10+
# lets the runner request the OIDC token.
11+
permissions:
12+
contents: read
13+
id-token: write
14+
15+
jobs:
16+
release:
17+
name: Release
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-node@v4
22+
with:
23+
node-version: 22
24+
registry-url: 'https://registry.npmjs.org'
25+
cache: 'npm'
26+
27+
- run: npm ci
28+
- run: npm run validate
29+
- run: npm pack --dry-run
30+
31+
# OIDC trusted publishing needs npm >= 11.5.1.
32+
- name: Upgrade npm for trusted publishing
33+
run: npm install -g npm@latest
34+
35+
- name: Publish to npm
36+
# Scoped package -> --access public makes it publicly installable.
37+
# Auth is the OIDC exchange; provenance is attached automatically.
38+
run: npm publish --access public

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
*.tgz
3+
test-results-*.json
4+
performance-comparison-*.json
5+
artillery-report-*.json
6+
.DS_Store

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.

‎README.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# @forkzero/s3-website-test-kit
2+
3+
Target-agnostic [Artillery](https://www.artillery.io/) load and conformance
4+
tests for **S3 static-website semantics**: index documents, streaming, range
5+
requests, custom error documents, and URL encoding. The suite is just HTTP GETs
6+
against a base URL, so you can point it at:
7+
8+
- **native S3 static website hosting** (`bucket.s3-website-<region>.amazonaws.com`),
9+
- **[s3proxy](https://github.com/gmoon/s3proxy)** in front of a private bucket
10+
(npm package `gmoon/s3proxy` or container `forkzero/s3proxy-docker`),
11+
- or anything else serving the same objects.
12+
13+
Run the same suite against native S3 and against s3proxy, then diff the results
14+
to prove parity (and measure overhead). That is the point of the kit.
15+
16+
## Install
17+
18+
```bash
19+
npm install --save-dev @forkzero/s3-website-test-kit artillery
20+
```
21+
22+
`artillery` is a peer dependency, so you control its version.
23+
24+
## Scenarios: core vs s3proxy
25+
26+
- **`scenarios/core/`** - portable. Every request is valid against native S3
27+
website hosting *and* s3proxy (static files, streaming, `206` range, `403`
28+
on a private object, `404` -> error document, special-character keys, HEAD).
29+
- **`scenarios/s3proxy/`** - target-specific. `health.yml` hits `/health`,
30+
which s3proxy serves but native S3 website hosting does not. Only run it
31+
against an s3proxy target.
32+
33+
## Usage
34+
35+
Resolve asset paths with the package helpers:
36+
37+
```js
38+
import { config, scenario, paths } from '@forkzero/s3-website-test-kit';
39+
40+
config('load-test.yml'); // -> /abs/.../configs/load-test.yml
41+
scenario('core/load-test.yml'); // -> /abs/.../scenarios/core/load-test.yml
42+
scenario('s3proxy/health.yml'); // -> /abs/.../scenarios/s3proxy/health.yml
43+
```
44+
45+
Or point the Artillery CLI at the installed files. Override `--target` to choose
46+
what you are testing:
47+
48+
```bash
49+
# Against native S3 website hosting
50+
artillery run \
51+
--target http://my-bucket.s3-website-us-east-1.amazonaws.com \
52+
--config node_modules/@forkzero/s3-website-test-kit/configs/load-test.yml \
53+
node_modules/@forkzero/s3-website-test-kit/scenarios/core/load-test.yml
54+
55+
# Against s3proxy
56+
artillery run \
57+
--target http://localhost:8080 \
58+
--config node_modules/@forkzero/s3-website-test-kit/configs/load-test.yml \
59+
node_modules/@forkzero/s3-website-test-kit/scenarios/core/load-test.yml
60+
```
61+
62+
Set `TEST_ENVIRONMENT` (e.g. `native-s3`, `s3proxy-docker`, `s3proxy-npm`) to
63+
label the run in the JSON summary the `test-runner.js` processor emits.
64+
65+
## Contents
66+
67+
```
68+
configs/ Artillery config files (phases, processor wiring)
69+
scenarios/core/ Portable S3-website scenarios (native S3 and s3proxy)
70+
scenarios/s3proxy/ s3proxy-only scenarios (health)
71+
utils/ Shared processor (test-runner.js) and results comparator
72+
test-data/ Script to create the required objects in your S3 test bucket
73+
```
74+
75+
### Comparing two runs
76+
77+
`test-runner.js` writes a JSON summary per run; `results-parser.js` diffs two of
78+
them, for example native S3 vs s3proxy:
79+
80+
```bash
81+
npx s3-website-perf-compare compare \
82+
--docker-results test-results-native-s3-<ts>.json \
83+
--npm-results test-results-s3proxy-<ts>.json
84+
```
85+
86+
## Test data requirements
87+
88+
Your S3 test bucket must contain these objects (see `test-data/setup-s3-data.sh`):
89+
90+
- `index.html` (~338 bytes) - basic HTML
91+
- `large.bin` (10 MB) - large binary for streaming
92+
- `test1m.tmp` (1 MB) - medium file
93+
- `zerobytefile` (0 bytes) - empty file
94+
- `unauthorized.html` - object that returns 403
95+
- `404.html` (or your configured error document)
96+
- a filename with special characters, for URL-encoding tests
97+
98+
## License
99+
100+
Apache-2.0

‎configs/artillery-config-perf-ecs.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
config:
2+
target: "https://s3proxy.forkzero.com"
3+
plugins:
4+
expect: {}
5+
phases:
6+
- duration: 60
7+
arrivalRate: 10
8+
name: warm up phase
9+
- duration: 120
10+
arrivalRate: 5
11+
rampTo: 100
12+
name: Ramp up load
13+
- duration: 600
14+
arrivalRate: 100
15+
name: Sustained load

‎configs/artillery-config-quick.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
config:
2+
ensure:
3+
maxErrorRate: 1
4+
plugins:
5+
expect: {}
6+
phases:
7+
- duration: 5
8+
arrivalRate: 4

0 commit comments

Comments
 (0)