Skip to content

Commit d3f6039

Browse files
feat: add webapp-testing skill from official Claude Code templates
Add Playwright-based web application testing skill to both repository directories. This skill provides toolkit for testing local web applications with support for frontend verification, UI debugging, browser screenshots, and console log viewing. Includes: - SKILL.md with comprehensive testing guidance and decision trees - Helper script (scripts/with_server.py) for server lifecycle management - Example automation scripts for common testing patterns - Support for both static HTML and dynamic web application testing The skill will be included when running create-rule.js due to explicit skills folder handling added previously.
1 parent 8fce25d commit d3f6039

File tree

12 files changed

+1024
-0
lines changed

12 files changed

+1024
-0
lines changed
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
name: webapp-testing
3+
description: Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.
4+
license: Complete terms in LICENSE.txt
5+
---
6+
7+
# Web Application Testing
8+
9+
To test local web applications, write native Python Playwright scripts.
10+
11+
**Helper Scripts Available**:
12+
- `scripts/with_server.py` - Manages server lifecycle (supports multiple servers)
13+
14+
**Always run scripts with `--help` first** to see usage. DO NOT read the source until you try running the script first and find that a customized solution is abslutely necessary. These scripts can be very large and thus pollute your context window. They exist to be called directly as black-box scripts rather than ingested into your context window.
15+
16+
## Decision Tree: Choosing Your Approach
17+
18+
```
19+
User task → Is it static HTML?
20+
├─ Yes → Read HTML file directly to identify selectors
21+
│ ├─ Success → Write Playwright script using selectors
22+
│ └─ Fails/Incomplete → Treat as dynamic (below)
23+
24+
└─ No (dynamic webapp) → Is the server already running?
25+
├─ No → Run: python scripts/with_server.py --help
26+
│ Then use the helper + write simplified Playwright script
27+
28+
└─ Yes → Reconnaissance-then-action:
29+
1. Navigate and wait for networkidle
30+
2. Take screenshot or inspect DOM
31+
3. Identify selectors from rendered state
32+
4. Execute actions with discovered selectors
33+
```
34+
35+
## Example: Using with_server.py
36+
37+
To start a server, run `--help` first, then use the helper:
38+
39+
**Single server:**
40+
```bash
41+
python scripts/with_server.py --server "npm run dev" --port 5173 -- python your_automation.py
42+
```
43+
44+
**Multiple servers (e.g., backend + frontend):**
45+
```bash
46+
python scripts/with_server.py \
47+
--server "cd backend && python server.py" --port 3000 \
48+
--server "cd frontend && npm run dev" --port 5173 \
49+
-- python your_automation.py
50+
```
51+
52+
To create an automation script, include only Playwright logic (servers are managed automatically):
53+
```python
54+
from playwright.sync_api import sync_playwright
55+
56+
with sync_playwright() as p:
57+
browser = p.chromium.launch(headless=True) # Always launch chromium in headless mode
58+
page = browser.new_page()
59+
page.goto('http://localhost:5173') # Server already running and ready
60+
page.wait_for_load_state('networkidle') # CRITICAL: Wait for JS to execute
61+
# ... your automation logic
62+
browser.close()
63+
```
64+
65+
## Reconnaissance-Then-Action Pattern
66+
67+
1. **Inspect rendered DOM**:
68+
```python
69+
page.screenshot(path='/tmp/inspect.png', full_page=True)
70+
content = page.content()
71+
page.locator('button').all()
72+
```
73+
74+
2. **Identify selectors** from inspection results
75+
76+
3. **Execute actions** using discovered selectors
77+
78+
## Common Pitfall
79+
80+
**Don't** inspect the DOM before waiting for `networkidle` on dynamic apps
81+
**Do** wait for `page.wait_for_load_state('networkidle')` before inspection
82+
83+
## Best Practices
84+
85+
- **Use bundled scripts as black boxes** - To accomplish a task, consider whether one of the scripts available in `scripts/` can help. These scripts handle common, complex workflows reliably without cluttering the context window. Use `--help` to see usage, then invoke directly.
86+
- Use `sync_playwright()` for synchronous scripts
87+
- Always close the browser when done
88+
- Use descriptive selectors: `text=`, `role=`, CSS selectors, or IDs
89+
- Add appropriate waits: `page.wait_for_selector()` or `page.wait_for_timeout()`
90+
91+
## Reference Files
92+
93+
- **examples/** - Examples showing common patterns:
94+
- `element_discovery.py` - Discovering buttons, links, and inputs on a page
95+
- `static_html_automation.py` - Using file:// URLs for local HTML
96+
- `console_logging.py` - Capturing console logs during automation
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
from playwright.sync_api import sync_playwright
2+
3+
# Example: Capturing console logs during browser automation
4+
5+
url = 'http://localhost:5173' # Replace with your URL
6+
7+
console_logs = []
8+
9+
with sync_playwright() as p:
10+
browser = p.chromium.launch(headless=True)
11+
page = browser.new_page(viewport={'width': 1920, 'height': 1080})
12+
13+
# Set up console log capture
14+
def handle_console_message(msg):
15+
console_logs.append(f"[{msg.type}] {msg.text}")
16+
print(f"Console: [{msg.type}] {msg.text}")
17+
18+
page.on("console", handle_console_message)
19+
20+
# Navigate to page
21+
page.goto(url)
22+
page.wait_for_load_state('networkidle')
23+
24+
# Interact with the page (triggers console logs)
25+
page.click('text=Dashboard')
26+
page.wait_for_timeout(1000)
27+
28+
browser.close()
29+
30+
# Save console logs to file
31+
with open('/mnt/user-data/outputs/console.log', 'w') as f:
32+
f.write('\n'.join(console_logs))
33+
34+
print(f"\nCaptured {len(console_logs)} console messages")
35+
print(f"Logs saved to: /mnt/user-data/outputs/console.log")
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
from playwright.sync_api import sync_playwright
2+
3+
# Example: Discovering buttons and other elements on a page
4+
5+
with sync_playwright() as p:
6+
browser = p.chromium.launch(headless=True)
7+
page = browser.new_page()
8+
9+
# Navigate to page and wait for it to fully load
10+
page.goto('http://localhost:5173')
11+
page.wait_for_load_state('networkidle')
12+
13+
# Discover all buttons on the page
14+
buttons = page.locator('button').all()
15+
print(f"Found {len(buttons)} buttons:")
16+
for i, button in enumerate(buttons):
17+
text = button.inner_text() if button.is_visible() else "[hidden]"
18+
print(f" [{i}] {text}")
19+
20+
# Discover links
21+
links = page.locator('a[href]').all()
22+
print(f"\nFound {len(links)} links:")
23+
for link in links[:5]: # Show first 5
24+
text = link.inner_text().strip()
25+
href = link.get_attribute('href')
26+
print(f" - {text} -> {href}")
27+
28+
# Discover input fields
29+
inputs = page.locator('input, textarea, select').all()
30+
print(f"\nFound {len(inputs)} input fields:")
31+
for input_elem in inputs:
32+
name = input_elem.get_attribute('name') or input_elem.get_attribute('id') or "[unnamed]"
33+
input_type = input_elem.get_attribute('type') or 'text'
34+
print(f" - {name} ({input_type})")
35+
36+
# Take screenshot for visual reference
37+
page.screenshot(path='/tmp/page_discovery.png', full_page=True)
38+
print("\nScreenshot saved to /tmp/page_discovery.png")
39+
40+
browser.close()

0 commit comments

Comments
 (0)