Skip to content

Commit f71479f

Browse files
muhammadahmadasifbhattimuhammadahmadasifbhatti
authored
feat(bench-test): Benchmark Testing (#2720)
Note: This PR is migrated from the [`agoric-sdk`](Agoric/agoric-sdk#10975). All the comments from [Mark's reviewed PR](Agoric/agoric-sdk#10982) are addressed. ### Description This is PR is just a minimalistic POC to create a small tool for the benchmark testing. ### How to run locally Run the command `yarn test` in the `packages/benchmark-test` folder. ### Pre-reqs of running `yarn test` Run the command `yarn install-engines` to ensure installation of V8 and XS engines in `$HOME/.esvu` for this package's `eshost`.
2 parents b350aaa + 8603663 commit f71479f

16 files changed

+1699
-14
lines changed

‎.github/workflows/ci.yml

+3
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ jobs:
8686
- name: Install dependencies
8787
run: yarn install --immutable
8888

89+
- name: Install Engines
90+
run: yarn workspace @endo/benchmark run install-engines
91+
8992
# end macro
9093

9194
- name: Run yarn build

‎packages/benchmark/CHANGELOG.md

Whitespace-only changes.

‎packages/benchmark/LICENSE

+201
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.

‎packages/benchmark/NEWS.md

Whitespace-only changes.

‎packages/benchmark/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# `@endo/benchmark`
2+
3+
This package just provides a minimalistic ava-like interface to run benchmark tests.
4+
5+
## How to run locally
6+
Run the command `yarn test` in the `packages/benchmark` folder.
7+
8+
## Pre-reqs of running `yarn test`
9+
Run the command `yarn install-engines` to ensure installation of V8 and XS engines in $HOME/.esvu for this package's `eshost`.

‎packages/benchmark/SECURITY.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The SES package and associated Endo packages are still undergoing development and security review, and all
6+
users are encouraged to use the latest version available. Security fixes will
7+
be made for the most recent branch only.
8+
9+
## Coordinated Vulnerability Disclosure of Security Bugs
10+
11+
SES stands for fearless cooperation, and strong security requires strong collaboration with security researchers. If you believe that you have found a security sensitive bug that should not be disclosed until a fix has been made available, we encourage you to report it. To report a bug in HardenedJS, you have several options that include:
12+
13+
* Reporting the issue to the [Agoric HackerOne vulnerability rewards program](https://hackerone.com/agoric).
14+
15+
* Sending an email to security at (@) agoric.com., encrypted or unencrypted. To encrypt, please use @Warner’s personal GPG key [A476E2E6 11880C98 5B3C3A39 0386E81B 11CAA07A](http://www.lothar.com/warner-gpg.html) .
16+
17+
* Sending a message on Keybase to `@agoric_security`, or sharing code and other log files via Keybase’s encrypted file system. ((_keybase_private/agoric_security,$YOURNAME).
18+
19+
* It is important to be able to provide steps that reproduce the issue and demonstrate its impact with a Proof of Concept example in an initial bug report. Before reporting a bug, a reporter may want to have another trusted individual reproduce the issue.
20+
21+
* A bug reporter can expect acknowledgment of a potential vulnerability reported through [[email protected]](mailto:[email protected]) within one business day of submitting a report. If an acknowledgement of an issue is not received within this time frame, especially during a weekend or holiday period, please reach out again. Any issues reported to the HackerOne program will be acknowledged within the time frames posted on the program page.
22+
* The bug triage team and Agoric code maintainers are primarily located in the San Francisco Bay Area with business hours in [Pacific Time](https://www.timeanddate.com/worldclock/usa/san-francisco) .
23+
24+
* For the safety and security of those who depend on the code, bug reporters should avoid publicly sharing the details of a security bug on Twitter, Discord, Telegram, or in public Github issues during the coordination process.
25+
26+
* Once a vulnerability report has been received and triaged:
27+
* Agoric code maintainers will confirm whether it is valid, and will provide updates to the reporter on validity of the report.
28+
* It may take up to 72 hours for an issue to be validated, especially if reported during holidays or on weekends.
29+
30+
* When the Agoric team has verified an issue, remediation steps and patch release timeline information will be shared with the reporter.
31+
* Complexity, severity, impact, and likelihood of exploitation are all vital factors that determine the amount of time required to remediate an issue and distribute a software patch.
32+
* If an issue is Critical or High Severity, Agoric code maintainers will release a security advisory to notify impacted parties to prepare for an emergency patch.
33+
* While the current industry standard for vulnerability coordination resolution is 90 days, Agoric code maintainers will strive to release a patch as quickly as possible.
34+
35+
When a bug patch is included in a software release, the Agoric code maintainers will:
36+
* Confirm the version and date of the software release with the reporter.
37+
* Provide information about the security issue that the software release resolves.
38+
* Credit the bug reporter for discovery by adding thanks in release notes, securing a CVE designation, or adding the researcher’s name to a Hall of Fame.

‎packages/benchmark/index.js

Whitespace-only changes.

‎packages/benchmark/install-engines.sh

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
#!/bin/sh
2+
3+
set -e
4+
5+
echo "yarn version: $(yarn --version)"
6+
7+
## Installing Engines and skiping if already installed ##
8+
are_engines_installed() {
9+
[ -f "$HOME/.esvu/bin/xs" ] && [ -f "$HOME/.esvu/bin/v8" ]
10+
}
11+
12+
if are_engines_installed; then
13+
echo "Engines already installed. Skipping installation."
14+
else
15+
echo "Installing engines..."
16+
INSTALL_OUTPU_XS=$(yarn dlx esvu install xs 2>&1) || INSTALL_STATUS_XS=$?
17+
INSTALL_OUTPU_V8=$(yarn dlx esvu install v8 2>&1) || INSTALL_STATUS_V8=$?
18+
fi
19+
20+
if [ -n "$INSTALL_STATUS_XS" ] || [ -n "$INSTALL_STATUS_V8" ]; then
21+
if are_engines_installed; then
22+
echo "Engines installed successfully despite esvu error."
23+
else
24+
echo "Error installing XS or V8:"
25+
echo "$INSTALL_OUTPU_XS"
26+
echo "$INSTALL_OUTPU_V8"
27+
exit 1
28+
fi
29+
fi
30+
31+
32+
## Making engine binaries executable ##
33+
chmod +x "$HOME/.esvu/bin/xs" "$HOME/.esvu/bin/v8"
34+
35+
36+
## Adding engines to eshost (if not already) ##
37+
if ! yarn eshost --list | grep -q '"xs"'; then
38+
yarn eshost --add "xs" xs "$HOME/.esvu/bin/xs"
39+
fi
40+
41+
if ! yarn eshost --list | grep -q '"v8"'; then
42+
yarn eshost --add "v8" d8 "$HOME/.esvu/bin/v8"
43+
fi
44+
45+
46+
yarn eshost --list

‎packages/benchmark/package.json

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"name": "@endo/benchmark",
3+
"version": "0.1.0",
4+
"private": true,
5+
"description": "Endo benchmarking ",
6+
"keywords": [],
7+
"author": "Endo contributors",
8+
"license": "Apache-2.0",
9+
"homepage": "https://github.com/endojs/endo/tree/master/packages/skel#readme",
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/endojs/endo.git",
13+
"directory": "packages/benchmark"
14+
},
15+
"bugs": {
16+
"url": "https://github.com/endojs/endo/issues"
17+
},
18+
"type": "module",
19+
"main": "./index.js",
20+
"module": "./index.js",
21+
"exports": {
22+
".": "./index.js",
23+
"./package.json": "./package.json"
24+
},
25+
"scripts": {
26+
"build": "exit 0",
27+
"lint": "yarn lint:types && yarn lint:eslint",
28+
"lint-check": "yarn lint",
29+
"lint-fix": "yarn lint:eslint --fix && yarn lint:types",
30+
"lint:eslint": "eslint '**/*.js'",
31+
"lint:types": "tsc",
32+
"postpack": "git clean -f '*.d.ts*'",
33+
"prepack": "tsc --build tsconfig.build.json",
34+
"install-engines": "./install-engines.sh",
35+
"test": "./run-tests.sh",
36+
"cpu-prof-test": "yarn rollup -c && node --jitless --cpu-prof dist/bundle.js"
37+
},
38+
"devDependencies": {
39+
"@endo/init": "workspace:^",
40+
"@endo/lockdown": "workspace:^",
41+
"@endo/pass-style": "workspace:^",
42+
"@rollup/plugin-commonjs": "^28.0.2",
43+
"@rollup/plugin-node-resolve": "^16.0.0",
44+
"@types/rollup": "^0.54.0",
45+
"c8": "^7.14.0",
46+
"eshost-cli": "^9.0.0",
47+
"esvu": "^1.2.16",
48+
"rollup": "^4.34.6",
49+
"tsd": "^0.31.2",
50+
"typescript": "~5.6.3"
51+
},
52+
"files": [
53+
"./*.d.ts",
54+
"./*.js",
55+
"./*.map",
56+
"LICENSE*",
57+
"SECURITY*",
58+
"dist",
59+
"lib",
60+
"src",
61+
"tools"
62+
],
63+
"publishConfig": {
64+
"access": "public"
65+
},
66+
"eslintConfig": {
67+
"extends": [
68+
"plugin:@endo/internal"
69+
]
70+
}
71+
}

‎packages/benchmark/rollup.config.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { nodeResolve } from '@rollup/plugin-node-resolve';
2+
3+
export default {
4+
input: 'test/index.test.js',
5+
output: {
6+
file: 'dist/bundle.js',
7+
format: 'iife',
8+
name: 'bundle',
9+
sourcemap: false,
10+
},
11+
plugins: [nodeResolve()],
12+
};

0 commit comments

Comments
 (0)