synapse-hub 0.0.0-stage → 2.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/.agents/agents/failure-analyst.md +47 -0
- package/.agents/agents/live-explorer.md +41 -0
- package/.agents/agents/orchestrator.md +43 -0
- package/.agents/agents/pom-crafter.md +81 -0
- package/.agents/agents/quality-gatekeeper.md +47 -0
- package/.agents/agents/test-runner.md +43 -0
- package/.agents/rules/context-engineering.md +88 -0
- package/.agents/rules/git-push-protocol.md +101 -0
- package/.agents/rules/graphify.md +14 -0
- package/.agents/rules/lessons-learned.md +23 -0
- package/.agents/rules/mandatory-playwright-live.md +29 -0
- package/.agents/rules/skill-precedence.md +42 -0
- package/.agents/rules/systematic-debugging.md +99 -0
- package/.agents/skills/agent-orchestration-multi-agent-optimize/SKILL.md +239 -0
- package/.agents/skills/antigravity-test-sentinel/SKILL.md +64 -0
- package/.agents/skills/api-network-mocking-interception/SKILL.md +142 -0
- package/.agents/skills/api-spec-to-e2e-matrix/SKILL.md +70 -0
- package/.agents/skills/architecture-decision-records/SKILL.md +441 -0
- package/.agents/skills/auth-session-and-cookie-manager/SKILL.md +72 -0
- package/.agents/skills/backend-load-and-stress-patterns/SKILL.md +214 -0
- package/.agents/skills/bats-testing-patterns/SKILL.md +100 -0
- package/.agents/skills/bats-testing-patterns/resources/implementation-playbook.md +614 -0
- package/.agents/skills/clean-pom-crafter/SKILL.md +75 -0
- package/.agents/skills/clean-pom-crafter/examples/standard_test_case.groovy +28 -0
- package/.agents/skills/clean-pom-crafter/references/pom_patterns.groovy +138 -0
- package/.agents/skills/code-refactoring-refactor-clean/SKILL.md +64 -0
- package/.agents/skills/code-refactoring-refactor-clean/resources/implementation-playbook.md +879 -0
- package/.agents/skills/db-state-verifier-and-seeder/SKILL.md +123 -0
- package/.agents/skills/e2e-testing-patterns/SKILL.md +103 -0
- package/.agents/skills/e2e-testing-patterns/resources/implementation-playbook.md +522 -0
- package/.agents/skills/failure-autopsy-and-healing/SKILL.md +54 -0
- package/.agents/skills/failure-autopsy-and-healing/references/healing_matrix.md +64 -0
- package/.agents/skills/failure-autopsy-and-healing/references/qa_investigation_protocol.md +56 -0
- package/.agents/skills/failure-autopsy-and-healing/scripts/triage_failures.sh +98 -0
- package/.agents/skills/file-and-report-validator/SKILL.md +90 -0
- package/.agents/skills/flaky-test-sentinel-and-quarantine/SKILL.md +114 -0
- package/.agents/skills/github-actions-templates/SKILL.md +334 -0
- package/.agents/skills/graphify-impact-analyzer/SKILL.md +78 -0
- package/.agents/skills/katalon-cli-runner/SKILL.md +76 -0
- package/.agents/skills/katalon-cli-runner/references/groovy-patterns.md +209 -0
- package/.agents/skills/katalon-cli-runner/references/katalon-api.md +155 -0
- package/.agents/skills/katalon-cli-runner/references/runner_commands.md +67 -0
- package/.agents/skills/lam-script-generator/SKILL.md +83 -0
- package/.agents/skills/playwright-live-interaction/SKILL.md +86 -0
- package/.agents/skills/playwright-live-interaction/references/advanced_superpowers.md +160 -0
- package/.agents/skills/playwright-live-interaction/references/compact_accessibility_snapshots.md +75 -0
- package/.agents/skills/playwright-live-interaction/references/recipes.md +388 -0
- package/.agents/skills/playwright-live-interaction/references/swarm_orchestration.md +134 -0
- package/.agents/skills/security-dast-sentinel/SKILL.md +176 -0
- package/.agents/skills/self-healing-locator/SKILL.md +73 -0
- package/.agents/skills/synthetic-test-data-generator/SKILL.md +135 -0
- package/.agents/skills/token-and-context-optimizer/SKILL.md +70 -0
- package/.agents/skills/visual-regression-sentinel/SKILL.md +62 -0
- package/.agents/skills/wcag-audit-patterns/SKILL.md +77 -0
- package/.agents/skills/wcag-audit-patterns/resources/implementation-playbook.md +541 -0
- package/.agents/skills/web-vitals-and-performance-profiler/SKILL.md +65 -0
- package/.agents/templates/completion_report.md +57 -0
- package/.agents/workflows/graphify.md +10 -0
- package/.agents/workflows/test-impact.md +15 -0
- package/.agents/workflows/verify.md +34 -0
- package/AGENTS.md +115 -0
- package/README.md +394 -2
- package/bin/agent-qa.js +90 -0
- package/package.json +59 -4
- package/skills_manifest.json +262 -0
- package/templates/PROJECT_AI_GUIDE_TEMPLATE.md +97 -0
- package/templates/PROJECT_STATE_TEMPLATE.md +20 -0
- package/tools/TOOLS_RUNBOOK.md +298 -0
- package/tools/agent_canary.py +501 -0
- package/tools/analyze_project.py +242 -0
- package/tools/api_drift_sentinel.py +208 -0
- package/tools/auto_heal.py +189 -0
- package/tools/browser_helpers.js +593 -0
- package/tools/bug_reporter.py +224 -0
- package/tools/cache_resolver.py +846 -0
- package/tools/check_env.py +288 -0
- package/tools/ci_healing_hook.py +128 -0
- package/tools/cli.py +402 -0
- package/tools/config_decoupler.py +253 -0
- package/tools/db_sandbox.py +341 -0
- package/tools/distill_log.py +152 -0
- package/tools/e2e_flow_prober.ps1 +65 -0
- package/tools/flaky_detector.py +222 -0
- package/tools/fuzz_payloads.py +197 -0
- package/tools/generate_allure_report.ps1 +30 -0
- package/tools/generate_api_matrix.py +193 -0
- package/tools/generate_tc_from_story.py +182 -0
- package/tools/generate_test_reports.ps1 +135 -0
- package/tools/git_pre_commit_guard.py +203 -0
- package/tools/heal_pr_automator.py +195 -0
- package/tools/heuristic_locator_matcher.py +202 -0
- package/tools/infer_linter.py +238 -0
- package/tools/lint_ai_docs.py +254 -0
- package/tools/lookup_tc.py +165 -0
- package/tools/lookup_xpath.py +167 -0
- package/tools/matrix_sharder.py +146 -0
- package/tools/mcp_excel_server.ps1 +251 -0
- package/tools/mcp_server.py +490 -0
- package/tools/micro_mutator.py +309 -0
- package/tools/network_mock_shield.py +170 -0
- package/tools/omni_emitter.py +500 -0
- package/tools/omni_parser.py +435 -0
- package/tools/omni_transpiler.py +168 -0
- package/tools/pinpoint_failure.py +88 -0
- package/tools/project_state.py +169 -0
- package/tools/repo_map.json +12 -0
- package/tools/repo_map.py +277 -0
- package/tools/repo_map.txt +7 -0
- package/tools/safety_firewall.py +245 -0
- package/tools/setup_project.py +265 -0
- package/tools/smart_visual_masker.py +134 -0
- package/tools/test_impact.py +321 -0
- package/tools/tms_sync_bridge.py +342 -0
- package/tools/trace_data_flow.py +240 -0
- package/tools/traffic_session_converter.py +256 -0
- package/tools/universal_ir.py +480 -0
- package/tools/validate_groovy_scripts.py +173 -0
- package/tools/verify_all.py +496 -0
- package/tools/verify_all.sh +4 -0
- package/tools/visual_diff_canvas.py +142 -0
- package/tools/visual_som_helper.py +418 -0
- package/tools/wcag_audit.py +214 -0
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: graphify-impact-analyzer
|
|
3
|
+
description: >-
|
|
4
|
+
AST Knowledge Graph exploration, Architecture Navigation, and Zero-Waste Test Impact Analysis
|
|
5
|
+
across multi-module test cases using Graphify and tools/test_impact.py.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Graphify Impact Analyzer — AST Knowledge Graph Navigation & Zero-Waste Impact Analysis
|
|
9
|
+
|
|
10
|
+
Specialized skill for navigating the codebase's AST Knowledge Graph (`graphify-out/graph.json`), executing sub-second dependency queries, and performing **Zero-Waste Test Impact Analysis** to execute only tests affected by code modifications.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Core Capabilities
|
|
15
|
+
|
|
16
|
+
1. **Deterministic AST Parsing (Zero API Cost):**
|
|
17
|
+
- Automatically maps files, classes, methods, and test scripts into `graphify-out/graph.json`.
|
|
18
|
+
- Replaces blind, expensive full-corpus grepping with targeted graph traversals.
|
|
19
|
+
|
|
20
|
+
2. **Automated Test Impact Analysis (Zero Waste):**
|
|
21
|
+
- When any Page Class in `Keywords/<project>/pages/` or `pages/*.ts` is modified, the impact analyzer computes reverse dependencies in `graph.json`.
|
|
22
|
+
- Pinpoints the exact subset of Test Cases affected, reducing CI/CD execution time by up to 90+%.
|
|
23
|
+
|
|
24
|
+
3. **God Node & Technical Debt Detection:**
|
|
25
|
+
- Detects over-coupled classes and guides safe, modular refactoring.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 2. Test Impact Analysis Workflow (`tools/test_impact.py`)
|
|
30
|
+
|
|
31
|
+
Run impact analysis before dispatching test suites:
|
|
32
|
+
|
|
33
|
+
### 2.1. Check Impact of Modified Page Class
|
|
34
|
+
```bash
|
|
35
|
+
python3 tools/test_impact.py -f Keywords/pages/CategoryPage.groovy
|
|
36
|
+
```
|
|
37
|
+
*Output:*
|
|
38
|
+
- Target File: `Keywords/pages/CategoryPage.groovy`
|
|
39
|
+
- Directly Impacted: **12 / 250 TCs**
|
|
40
|
+
- Skipped: **238 TCs**
|
|
41
|
+
- Time Saved: **95.2%**
|
|
42
|
+
|
|
43
|
+
### 2.2. Automatically Analyze Git Changes
|
|
44
|
+
```bash
|
|
45
|
+
python3 tools/test_impact.py --git-diff
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 2.3. Output Machine-Readable JSON (For CI/CD Pipelines)
|
|
49
|
+
```bash
|
|
50
|
+
python3 tools/test_impact.py --git-diff --json
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 3. Knowledge Graph CLI Navigation Commands
|
|
56
|
+
|
|
57
|
+
| Command | Purpose | Example |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| `graphify explain "<Node>"` | Explain a Page Class or Script and its connections | `graphify explain "UserAdminPage"` |
|
|
60
|
+
| `graphify path "<A>" "<B>"` | Find shortest path between two classes/scripts | `graphify path "LoginPage" "BasePage"` |
|
|
61
|
+
| `graphify query "<Concept>"` | Query a concept or test case subgraph | `graphify query "TC-101"` |
|
|
62
|
+
| `graphify update .` | Refresh AST graph after code modifications (No LLM needed) | `graphify update .` |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 4. Visual Artifacts
|
|
67
|
+
|
|
68
|
+
- **2D/3D Interactive Visualizer:** `graphify-out/graph.html`
|
|
69
|
+
- **Call-flow & Mermaid Diagrams:** `graphify-out/callflow.html`
|
|
70
|
+
- **Architectural Summary Report:** `graphify-out/GRAPH_REPORT.md`
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 5. Agent Operational Guardrails
|
|
75
|
+
|
|
76
|
+
1. **Before modifying any Page Class:** Run `python3 tools/test_impact.py -f <path>` to identify dependent Test Cases.
|
|
77
|
+
2. **After modifying code:** Run `graphify update .` to keep the knowledge graph synchronized.
|
|
78
|
+
3. **DoD Compliance:** Always verify that all changes pass `python3 tools/verify_all.py`.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: katalon-cli-runner
|
|
3
|
+
description: Adaptive CLI execution manager for Katalon / Gradle headless test runners, supporting licensing fallback, zombie driver termination, and Allure report compilation. Use specifically when running enterprise Groovy/Katalon test suites.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Katalon CLI & Enterprise Runner — Dual-Mode Execution Management
|
|
7
|
+
|
|
8
|
+
Specialized skill for managing, dispatching, and monitoring enterprise Katalon test runs across different licensing states (**Licensed Headless KRE** vs **Free Community Mode**), integrated with Allure reporting and automated driver cleanup.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 1. Adaptive Dual-Mode Execution Strategy
|
|
13
|
+
|
|
14
|
+
| Licensing State | Recommended Mode | Response Time | Licensing Cost |
|
|
15
|
+
|---|---|:---:|:---:|
|
|
16
|
+
| **KRE License Available** | **Mode 1: Headless KRE CLI** (CI/CD or Terminal) | Batch-oriented | Licensed |
|
|
17
|
+
| **No License Available** | **Mode 2A: Katalon Studio GUI (Free Edition)** (Suite Acceptance) | 5–10 mins | **$0** |
|
|
18
|
+
| **No License Available** | **Mode 2B: Playwright Live Interaction** (Selector probing / logic check) | **< 200 ms** | **$0** |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. Pre-Flight Quality Check
|
|
23
|
+
|
|
24
|
+
Before launching heavy CLI runs, execute fast pre-flight verification:
|
|
25
|
+
```bash
|
|
26
|
+
python3 -c "
|
|
27
|
+
import glob
|
|
28
|
+
for p in glob.glob('Keywords/**/*.groovy', recursive=True) + glob.glob('Scripts/**/*.groovy', recursive=True):
|
|
29
|
+
with open(p, 'rb') as fp:
|
|
30
|
+
assert fp.read(3) != b'\xef\xbb\xbf', f'BOM detected: {p}'
|
|
31
|
+
print('[PASS] Pre-flight passed: 100% UTF-8 No BOM')
|
|
32
|
+
"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 3. License Recovery & Process Cleanup
|
|
38
|
+
|
|
39
|
+
1. **License Expiration Handling:** When `License quota exceeded` occurs, halt batch retries immediately and switch to Playwright live validation or local GUI.
|
|
40
|
+
2. **Zombie Chromedriver & Java Process Termination:**
|
|
41
|
+
```powershell
|
|
42
|
+
# Windows process cleanup
|
|
43
|
+
Get-Process -Name "chromedriver", "katalon" -ErrorAction SilentlyContinue | Stop-Process -Force
|
|
44
|
+
```
|
|
45
|
+
```bash
|
|
46
|
+
# Unix process cleanup
|
|
47
|
+
pkill -f chromedriver || true
|
|
48
|
+
pkill -f katalon || true
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 4. Standard Headless Execution Commands
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Execute specific Test Suite via KRE CLI in pure headless mode
|
|
57
|
+
katalonc -noSplash -runMode=console \
|
|
58
|
+
-projectPath="$(pwd)/project.prj" \
|
|
59
|
+
-retry=0 \
|
|
60
|
+
-testSuitePath="Test Suites/TS_SmokeTest" \
|
|
61
|
+
-browserType="Chrome (headless)" \
|
|
62
|
+
-executionProfile="default" \
|
|
63
|
+
-apiKey="$KATALON_API_KEY"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 5. Definition of Done (DoD)
|
|
69
|
+
|
|
70
|
+
1. **Exit Code = 0:** Runner completes cleanly without runtime crash.
|
|
71
|
+
2. **Clean JUnit XML:** Results XML contains 0 `<failure>` or `<error>` tags.
|
|
72
|
+
3. **Compile Allure Report:** `allure generate ./allure-results -o ./Reports/allure-report --clean`.
|
|
73
|
+
4. If failures occur, immediately dispatch failure autopsy:
|
|
74
|
+
```bash
|
|
75
|
+
python3 tools/pinpoint_failure.py
|
|
76
|
+
```
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Groovy Patterns for Katalon Studio
|
|
2
|
+
|
|
3
|
+
This document provides common Groovy patterns and best practices for Katalon Studio custom keywords and test scripts.
|
|
4
|
+
|
|
5
|
+
## Custom Keyword Structure
|
|
6
|
+
|
|
7
|
+
### Basic Custom Keyword Class
|
|
8
|
+
|
|
9
|
+
```groovy
|
|
10
|
+
package com.enterprise.keywords
|
|
11
|
+
|
|
12
|
+
import com.kms.katalon.core.annotation.Keyword
|
|
13
|
+
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
|
|
14
|
+
import internal.GlobalVariable
|
|
15
|
+
|
|
16
|
+
class LoginKeywords {
|
|
17
|
+
|
|
18
|
+
@Keyword
|
|
19
|
+
def login(String username, String password) {
|
|
20
|
+
WebUI.setText(findTestObject('Page_Login/input_Username'), username)
|
|
21
|
+
WebUI.setEncryptedText(findTestObject('Page_Login/input_Password'), password)
|
|
22
|
+
WebUI.click(findTestObject('Page_Login/btn_Login'))
|
|
23
|
+
WebUI.waitForPageLoad(GlobalVariable.timeout)
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
@Keyword
|
|
27
|
+
def loginWithGlobalVariables() {
|
|
28
|
+
login(GlobalVariable.username, GlobalVariable.password)
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
@Keyword
|
|
32
|
+
def verifyLoginSuccess() {
|
|
33
|
+
WebUI.verifyElementPresent(findTestObject('Page_Dashboard/header_Welcome'),
|
|
34
|
+
GlobalVariable.timeout)
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Static Keywords
|
|
40
|
+
|
|
41
|
+
When keywords don't need instance state, make them static:
|
|
42
|
+
|
|
43
|
+
```groovy
|
|
44
|
+
package com.enterprise.utils
|
|
45
|
+
|
|
46
|
+
import com.kms.katalon.core.annotation.Keyword
|
|
47
|
+
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
|
|
48
|
+
|
|
49
|
+
class NavigationUtils {
|
|
50
|
+
|
|
51
|
+
@Keyword
|
|
52
|
+
static def navigateToPage(String pageName) {
|
|
53
|
+
String url = "${GlobalVariable.baseUrl}/${pageName}"
|
|
54
|
+
WebUI.navigateToUrl(url)
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
@Keyword
|
|
58
|
+
static def refreshUntilElementVisible(TestObject element, int maxAttempts = 5) {
|
|
59
|
+
int attempts = 0
|
|
60
|
+
while (attempts < maxAttempts) {
|
|
61
|
+
if (WebUI.verifyElementVisible(element, FailureHandling.OPTIONAL)) {
|
|
62
|
+
return true
|
|
63
|
+
}
|
|
64
|
+
WebUI.refresh()
|
|
65
|
+
attempts++
|
|
66
|
+
}
|
|
67
|
+
return false
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Common Patterns
|
|
73
|
+
|
|
74
|
+
### Wait and Retry Pattern
|
|
75
|
+
|
|
76
|
+
```groovy
|
|
77
|
+
@Keyword
|
|
78
|
+
def waitAndRetry(TestObject element, int maxAttempts = 3, int delaySeconds = 2) {
|
|
79
|
+
for (int i = 0; i < maxAttempts; i++) {
|
|
80
|
+
try {
|
|
81
|
+
WebUI.waitForElementPresent(element, delaySeconds)
|
|
82
|
+
return true
|
|
83
|
+
} catch (Exception e) {
|
|
84
|
+
if (i == maxAttempts - 1) {
|
|
85
|
+
throw e
|
|
86
|
+
}
|
|
87
|
+
WebUI.delay(delaySeconds)
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
return false
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Conditional Element Interaction
|
|
95
|
+
|
|
96
|
+
```groovy
|
|
97
|
+
@Keyword
|
|
98
|
+
def clickIfPresent(TestObject element, int timeout = 5) {
|
|
99
|
+
if (WebUI.verifyElementPresent(element, timeout, FailureHandling.OPTIONAL)) {
|
|
100
|
+
WebUI.click(element)
|
|
101
|
+
return true
|
|
102
|
+
}
|
|
103
|
+
return false
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
@Keyword
|
|
107
|
+
def closePopupIfExists(TestObject closeButton) {
|
|
108
|
+
if (WebUI.verifyElementVisible(closeButton, FailureHandling.OPTIONAL)) {
|
|
109
|
+
WebUI.click(closeButton)
|
|
110
|
+
WebUI.delay(1)
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Dynamic Object Creation
|
|
116
|
+
|
|
117
|
+
```groovy
|
|
118
|
+
@Keyword
|
|
119
|
+
def clickDynamicElement(String xpath) {
|
|
120
|
+
TestObject dynamicObject = new TestObject()
|
|
121
|
+
dynamicObject.addProperty('xpath', ConditionType.EQUALS, xpath)
|
|
122
|
+
WebUI.click(dynamicObject)
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
@Keyword
|
|
126
|
+
def findElementByText(String tagName, String text) {
|
|
127
|
+
String xpath = "//${tagName}[contains(text(), '${text}')]"
|
|
128
|
+
TestObject element = new TestObject()
|
|
129
|
+
element.addProperty('xpath', ConditionType.EQUALS, xpath)
|
|
130
|
+
return element
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Data-Driven Helpers
|
|
135
|
+
|
|
136
|
+
```groovy
|
|
137
|
+
@Keyword
|
|
138
|
+
def executeWithTestData(String testDataName, Closure action) {
|
|
139
|
+
TestData data = findTestData(testDataName)
|
|
140
|
+
int rowCount = data.getRowNumbers()
|
|
141
|
+
|
|
142
|
+
for (int i = 1; i <= rowCount; i++) {
|
|
143
|
+
def row = [:]
|
|
144
|
+
data.getColumnNames().each { col ->
|
|
145
|
+
row[col] = data.getValue(col, i)
|
|
146
|
+
}
|
|
147
|
+
action(row)
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Page Object Pattern
|
|
153
|
+
|
|
154
|
+
```groovy
|
|
155
|
+
package com.enterprise.pages
|
|
156
|
+
|
|
157
|
+
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
|
|
158
|
+
import internal.GlobalVariable
|
|
159
|
+
|
|
160
|
+
class LoginPage {
|
|
161
|
+
|
|
162
|
+
def open() {
|
|
163
|
+
WebUI.navigateToUrl(GlobalVariable.loginUrl)
|
|
164
|
+
return this
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
def login(String username, String password) {
|
|
168
|
+
// Implementation
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Error Handling and Logging
|
|
174
|
+
|
|
175
|
+
```groovy
|
|
176
|
+
import com.kms.katalon.core.util.KeywordUtil
|
|
177
|
+
|
|
178
|
+
@Keyword
|
|
179
|
+
def performActionWithErrorHandling(Closure action) {
|
|
180
|
+
try {
|
|
181
|
+
action()
|
|
182
|
+
KeywordUtil.markPassed("Action completed successfully")
|
|
183
|
+
} catch (Exception e) {
|
|
184
|
+
KeywordUtil.logInfo("Error occurred: ${e.message}")
|
|
185
|
+
WebUI.takeScreenshot()
|
|
186
|
+
KeywordUtil.markFailed("Action failed: ${e.message}")
|
|
187
|
+
throw e
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
@Keyword
|
|
192
|
+
def safeClick(TestObject element, String elementName = "Element") {
|
|
193
|
+
try {
|
|
194
|
+
WebUI.waitForElementClickable(element, 10)
|
|
195
|
+
WebUI.click(element)
|
|
196
|
+
KeywordUtil.logInfo("Clicked on ${elementName}")
|
|
197
|
+
} catch (Exception e) {
|
|
198
|
+
KeywordUtil.markWarning("Could not click ${elementName}: ${e.message}")
|
|
199
|
+
WebUI.takeScreenshot()
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Best Practices
|
|
205
|
+
|
|
206
|
+
1. **Use Descriptive Names**: Use clear, readable keyword names.
|
|
207
|
+
2. **Handle Timeouts Gracefully**: Always set explicit wait timeouts rather than hard sleeps.
|
|
208
|
+
3. **Parameterize Magic Numbers**: Define constants for retries and timeouts.
|
|
209
|
+
4. **Failure Handling**: Use `FailureHandling.STOP_ON_FAILURE` for critical steps, `OPTIONAL` for transient dialogs.
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Katalon Built-in Keywords API Reference
|
|
2
|
+
|
|
3
|
+
This document provides a reference for Katalon Studio's most commonly used built-in keywords.
|
|
4
|
+
|
|
5
|
+
## WebUI Keywords
|
|
6
|
+
|
|
7
|
+
Katalon's WebUI keywords are accessed via `com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords` (commonly imported as `WebUI`).
|
|
8
|
+
|
|
9
|
+
### Navigation Keywords
|
|
10
|
+
|
|
11
|
+
- `WebUI.openBrowser(url)` - Open a browser and navigate to URL
|
|
12
|
+
- `WebUI.navigateToUrl(url)` - Navigate to a URL in the current browser
|
|
13
|
+
- `WebUI.closeBrowser()` - Close the current browser
|
|
14
|
+
- `WebUI.back()` - Navigate back in browser history
|
|
15
|
+
- `WebUI.forward()` - Navigate forward in browser history
|
|
16
|
+
- `WebUI.refresh()` - Refresh the current page
|
|
17
|
+
- `WebUI.switchToWindowIndex(index)` - Switch to a browser window by index
|
|
18
|
+
- `WebUI.switchToWindowTitle(title)` - Switch to a browser window by title
|
|
19
|
+
- `WebUI.switchToWindowUrl(url)` - Switch to a browser window by URL
|
|
20
|
+
|
|
21
|
+
### Element Interaction Keywords
|
|
22
|
+
|
|
23
|
+
- `WebUI.click(testObject)` - Click on an element
|
|
24
|
+
- `WebUI.doubleClick(testObject)` - Double-click on an element
|
|
25
|
+
- `WebUI.rightClick(testObject)` - Right-click on an element
|
|
26
|
+
- `WebUI.setText(testObject, text)` - Set text for an input field
|
|
27
|
+
- `WebUI.sendKeys(testObject, text)` - Send keyboard input to an element
|
|
28
|
+
- `WebUI.clearText(testObject)` - Clear text from an input field
|
|
29
|
+
- `WebUI.selectOptionByValue(testObject, value, isRegex)` - Select dropdown option by value
|
|
30
|
+
- `WebUI.selectOptionByLabel(testObject, label, isRegex)` - Select dropdown option by label
|
|
31
|
+
- `WebUI.selectOptionByIndex(testObject, index)` - Select dropdown option by index
|
|
32
|
+
- `WebUI.check(testObject)` - Check a checkbox
|
|
33
|
+
- `WebUI.uncheck(testObject)` - Uncheck a checkbox
|
|
34
|
+
- `WebUI.uploadFile(testObject, filePath)` - Upload a file to a file input
|
|
35
|
+
|
|
36
|
+
### Wait Keywords
|
|
37
|
+
|
|
38
|
+
- `WebUI.waitForElementPresent(testObject, timeoutInSeconds)` - Wait for element to be present in DOM
|
|
39
|
+
- `WebUI.waitForElementVisible(testObject, timeoutInSeconds)` - Wait for element to be visible
|
|
40
|
+
- `WebUI.waitForElementClickable(testObject, timeoutInSeconds)` - Wait for element to be clickable
|
|
41
|
+
- `WebUI.waitForElementNotPresent(testObject, timeoutInSeconds)` - Wait for element to not be present
|
|
42
|
+
- `WebUI.waitForElementNotVisible(testObject, timeoutInSeconds)` - Wait for element to not be visible
|
|
43
|
+
- `WebUI.waitForPageLoad(timeoutInSeconds)` - Wait for page to fully load
|
|
44
|
+
- `WebUI.delay(timeInSeconds)` - Pause execution for specified seconds
|
|
45
|
+
|
|
46
|
+
### Verification Keywords
|
|
47
|
+
|
|
48
|
+
- `WebUI.verifyElementPresent(testObject, timeoutInSeconds)` - Verify element is present
|
|
49
|
+
- `WebUI.verifyElementVisible(testObject)` - Verify element is visible
|
|
50
|
+
- `WebUI.verifyElementClickable(testObject)` - Verify element is clickable
|
|
51
|
+
- `WebUI.verifyElementNotPresent(testObject, timeoutInSeconds)` - Verify element is not present
|
|
52
|
+
- `WebUI.verifyElementText(testObject, expectedText)` - Verify element contains expected text
|
|
53
|
+
- `WebUI.verifyTextPresent(text, isRegex)` - Verify text is present on the page
|
|
54
|
+
- `WebUI.verifyElementAttributeValue(testObject, attribute, expectedValue, timeoutInSeconds)` - Verify element attribute value
|
|
55
|
+
|
|
56
|
+
### Get Keywords
|
|
57
|
+
|
|
58
|
+
- `WebUI.getText(testObject)` - Get text content of an element
|
|
59
|
+
- `WebUI.getAttribute(testObject, attribute)` - Get attribute value of an element
|
|
60
|
+
- `WebUI.getCSSValue(testObject, propertyName)` - Get CSS property value
|
|
61
|
+
- `WebUI.getUrl()` - Get current page URL
|
|
62
|
+
- `WebUI.getWindowTitle()` - Get current window title
|
|
63
|
+
|
|
64
|
+
### Screenshot Keywords
|
|
65
|
+
|
|
66
|
+
- `WebUI.takeScreenshot(filePath)` - Take a screenshot and save to file
|
|
67
|
+
- `WebUI.takeFullPageScreenshot(filePath)` - Take a full-page screenshot
|
|
68
|
+
|
|
69
|
+
## Mobile Keywords
|
|
70
|
+
|
|
71
|
+
Katalon's Mobile keywords are accessed via `com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords` (commonly imported as `Mobile`).
|
|
72
|
+
|
|
73
|
+
### Common Mobile Keywords
|
|
74
|
+
|
|
75
|
+
- `Mobile.startApplication(appPath)` - Start a mobile application
|
|
76
|
+
- `Mobile.closeApplication()` - Close the current application
|
|
77
|
+
- `Mobile.tap(testObject, timeout)` - Tap on a mobile element
|
|
78
|
+
- `Mobile.setText(testObject, text, timeout)` - Set text in a mobile input
|
|
79
|
+
- `Mobile.getText(testObject, timeout)` - Get text from a mobile element
|
|
80
|
+
- `Mobile.verifyElementExist(testObject, timeout)` - Verify mobile element exists
|
|
81
|
+
- `Mobile.scrollToText(text)` - Scroll until specified text is visible
|
|
82
|
+
- `Mobile.swipe(startX, startY, endX, endY)` - Perform a swipe gesture
|
|
83
|
+
|
|
84
|
+
## Web Service (API) Keywords
|
|
85
|
+
|
|
86
|
+
Katalon's Web Service keywords are accessed via `com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords` (commonly imported as `WS`).
|
|
87
|
+
|
|
88
|
+
### API Keywords
|
|
89
|
+
|
|
90
|
+
- `WS.sendRequest(requestObject)` - Send a web service request
|
|
91
|
+
- `WS.verifyResponseStatusCode(response, statusCode)` - Verify HTTP response status code
|
|
92
|
+
- `WS.verifyElementPropertyValue(response, locator, expectedValue)` - Verify JSON/XML element value
|
|
93
|
+
- `WS.getElementPropertyValue(response, locator)` - Get value from JSON/XML response
|
|
94
|
+
- `WS.verifyElementsCount(response, locator, expectedCount)` - Verify count of elements in response
|
|
95
|
+
|
|
96
|
+
## Utility Keywords
|
|
97
|
+
|
|
98
|
+
### Checkpoint Keywords
|
|
99
|
+
|
|
100
|
+
- `findCheckpoint(checkpointName)` - Find a checkpoint by name
|
|
101
|
+
|
|
102
|
+
### Test Case Keywords
|
|
103
|
+
|
|
104
|
+
- `findTestCase(testCasePath)` - Find a test case by path
|
|
105
|
+
- `WebUI.callTestCase(testCase, variables)` - Call another test case
|
|
106
|
+
|
|
107
|
+
### Test Data Keywords
|
|
108
|
+
|
|
109
|
+
- `findTestData(testDataName)` - Find test data by name
|
|
110
|
+
|
|
111
|
+
### Object Repository Keywords
|
|
112
|
+
|
|
113
|
+
- `findTestObject(objectPath)` - Find a test object from Object Repository
|
|
114
|
+
- `findTestObject(objectPath, variables)` - Find a test object with variable bindings
|
|
115
|
+
|
|
116
|
+
## Global Variables
|
|
117
|
+
|
|
118
|
+
Access global variables defined in profiles using `internal.GlobalVariable`:
|
|
119
|
+
|
|
120
|
+
```groovy
|
|
121
|
+
import internal.GlobalVariable
|
|
122
|
+
|
|
123
|
+
// Access a global variable
|
|
124
|
+
String url = GlobalVariable.baseUrl
|
|
125
|
+
String username = GlobalVariable.username
|
|
126
|
+
int timeout = GlobalVariable.waitTimeout
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Failure Handling
|
|
130
|
+
|
|
131
|
+
Control how test execution handles failures using `com.kms.katalon.core.model.FailureHandling`:
|
|
132
|
+
|
|
133
|
+
- `FailureHandling.STOP_ON_FAILURE` - Stop test execution on failure (default)
|
|
134
|
+
- `FailureHandling.CONTINUE_ON_FAILURE` - Continue execution even if step fails
|
|
135
|
+
- `FailureHandling.OPTIONAL` - Mark step as optional, continue regardless of result
|
|
136
|
+
|
|
137
|
+
Example:
|
|
138
|
+
```groovy
|
|
139
|
+
WebUI.verifyElementPresent(findTestObject('optionalElement'), 5, FailureHandling.OPTIONAL)
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Annotations for Custom Keywords
|
|
143
|
+
|
|
144
|
+
When creating custom keywords, use the `@Keyword` annotation:
|
|
145
|
+
|
|
146
|
+
```groovy
|
|
147
|
+
import com.kms.katalon.core.annotation.Keyword
|
|
148
|
+
|
|
149
|
+
class MyKeywords {
|
|
150
|
+
@Keyword
|
|
151
|
+
def myCustomKeyword(String param) {
|
|
152
|
+
// Implementation
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
```
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# CLI Runner Commands & Enterprise Test Suites Registry
|
|
2
|
+
|
|
3
|
+
Reference documentation for the `katalon-cli-runner` skill.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Environment Variable Configuration (.env)
|
|
8
|
+
```bash
|
|
9
|
+
KATALON_API_KEY="your_actual_api_key_here"
|
|
10
|
+
KATALON_PROJECT_PATH="/path/to/project"
|
|
11
|
+
TELEGRAM_BOT_TOKEN="your_bot_token"
|
|
12
|
+
TELEGRAM_CHAT_ID="your_chat_id"
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 2. Platform-Specific Execution Commands (KRE CLI)
|
|
18
|
+
|
|
19
|
+
### 2.1. Windows Environment (PowerShell Runner)
|
|
20
|
+
```powershell
|
|
21
|
+
# Run Test Suite with API Key
|
|
22
|
+
powershell -ExecutionPolicy Bypass -File .\run_tests_windows.ps1 -Suite "Test Suites/07_QuanTriDuLieu" -ApiKey $env:KATALON_API_KEY
|
|
23
|
+
|
|
24
|
+
# Run single Test Suite for debugging:
|
|
25
|
+
powershell -ExecutionPolicy Bypass -File .\run_tests_windows.ps1 -Suite "Test Suites/Group_07_01_CumCongNghiep"
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### 2.2. macOS / Linux CLI (Headless Full HD)
|
|
29
|
+
```bash
|
|
30
|
+
# Run Test Suite
|
|
31
|
+
katalonc \
|
|
32
|
+
-noSplash \
|
|
33
|
+
-runMode=console \
|
|
34
|
+
-projectPath="$(pwd)/project.prj" \
|
|
35
|
+
-retry=0 \
|
|
36
|
+
-testSuitePath="Test Suites/07_QuanTriDuLieu" \
|
|
37
|
+
-browserType="Chrome (headless)" \
|
|
38
|
+
-executionProfile="default" \
|
|
39
|
+
-apiKey="$KATALON_API_KEY" \
|
|
40
|
+
--args="-headless --window-size=1920,1080 --disable-gpu --no-sandbox --disable-dev-shm-usage"
|
|
41
|
+
|
|
42
|
+
# Run single Test Case (Debug Mode):
|
|
43
|
+
katalonc \
|
|
44
|
+
-noSplash \
|
|
45
|
+
-runMode=console \
|
|
46
|
+
-projectPath="$(pwd)/project.prj" \
|
|
47
|
+
-testCasePath="Test Cases/TC-1 Kiểm tra tạo mới thành công" \
|
|
48
|
+
-browserType="Chrome (headless)" \
|
|
49
|
+
-apiKey="$KATALON_API_KEY"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## 3. Standard Enterprise Test Suite Registry
|
|
55
|
+
|
|
56
|
+
| Test Suite Name | Scale | Target Functional Module |
|
|
57
|
+
| :--- | :---: | :--- |
|
|
58
|
+
| `Test Suites/All_Tests` | Full Suite | All functional modules |
|
|
59
|
+
| `Test Suites/01_QuanLyChiTieu` | 7 TCs | Target Planning |
|
|
60
|
+
| `Test Suites/02_XacThucNguoiDung` | 5 TCs | User Authentication & Profiles |
|
|
61
|
+
| `Test Suites/03_QuanTriHeThong` | 4 TCs | System Administration & Users |
|
|
62
|
+
| `Test Suites/04_DanhMucDungChung` | 12 TCs | Common Categories (Departments, Roles) |
|
|
63
|
+
| `Test Suites/05_DanhMucNganhCongThuong` | 64 TCs | 16 Industry Sub-Categories |
|
|
64
|
+
| `Test Suites/06_QuyHoachCongThuong` | 30 TCs | Sector Planning |
|
|
65
|
+
| `Test Suites/07_QuanTriDuLieu` | 125 TCs | Data Mining & GIS Maps |
|
|
66
|
+
| `Test Suites/08_BaoCaoThongKe` | 2 TCs | Statistical Reports (Data & Permits) |
|
|
67
|
+
| `Test Suites/09_ChiaSeDuLieu` | 10 TCs | Data Sharing & API Token Lifecycle |
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: lam-script-generator
|
|
3
|
+
description: >-
|
|
4
|
+
Large Action Model (LAM) script generator inspired by LaVague. Transforms natural language user stories and acceptance criteria into 100% Clean POM automation scripts with zero token replayability.
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# LAM Script Generator — Large Action Model for Test Automation
|
|
8
|
+
|
|
9
|
+
Inspired by the **LaVague AI Web Agent & Large Action Model (LAM)** framework, this skill bridges the gap between natural language requirements (User Stories, Acceptance Criteria) and durable, deterministic automation code conforming to Clean POM Flat Architecture.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 1. The Dual-Engine LAM Architecture
|
|
14
|
+
|
|
15
|
+
```mermaid
|
|
16
|
+
flowchart TD
|
|
17
|
+
UserStory["<b>Natural Language User Story</b><br/>'Add new record with dynamic code and verify success'"] --> WorldModel["<b>1. World Model (Reasoning Engine)</b><br/>• Analyzes business goal<br/>• Decomposes into atomic user action sequence<br/>• Determines preconditions & expected assertions"]
|
|
18
|
+
|
|
19
|
+
WorldModel --> ActionEngine["<b>2. Action Engine (Code Generator)</b><br/>• Queries Page Classes via Knowledge Graph<br/>• Maps action to existing methods: LoginPage.login(), TablePage.openAddModal()<br/>• Injects dynamic uniqueCode timestamp"]
|
|
20
|
+
|
|
21
|
+
ActionEngine --> CodeGen["<b>3. Durable Clean POM Script (.groovy / .ts)</b><br/>• 100% Zero raw XPath in scripts<br/>• Infinite CI/CD replays with 0 LLM Tokens"]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
1. **World Model (Reasoning Engine):**
|
|
25
|
+
- Parses natural language requirements or QA/BA Acceptance Criteria.
|
|
26
|
+
- Infers the step sequence: `Login` $\rightarrow$ `Navigate to Menu` $\rightarrow$ `Open Add Modal` $\rightarrow$ `Input Dynamic Data` $\rightarrow$ `Save & Assert Toast`.
|
|
27
|
+
2. **Action Engine (Code Generator):**
|
|
28
|
+
- Instead of speculative coordinates, Action Engine queries the project Knowledge Graph to select existing Page Classes and standardized methods.
|
|
29
|
+
- Generates clean, robust test scripts adhering strictly to Clean POM.
|
|
30
|
+
3. **Zero-Token Replayability:**
|
|
31
|
+
- Once verified, the generated script is committed to the test suite on disk.
|
|
32
|
+
- All subsequent CI/CD pipeline runs execute deterministically without consuming any LLM tokens.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 2. Transformation Workflow: User Story to Clean POM
|
|
37
|
+
|
|
38
|
+
### Input (User Story):
|
|
39
|
+
```text
|
|
40
|
+
"Verify adding a new Industry record:
|
|
41
|
+
1. Login as system administrator.
|
|
42
|
+
2. Navigate to Industry Data menu.
|
|
43
|
+
3. Click Add New button.
|
|
44
|
+
4. Fill required fields with dynamic code 'IND_' and valid name.
|
|
45
|
+
5. Save and assert green success notification.
|
|
46
|
+
6. Verify the new record appears in the data table."
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Output (Clean POM Groovy Script):
|
|
50
|
+
```groovy
|
|
51
|
+
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
|
|
52
|
+
import internal.GlobalVariable as GlobalVariable
|
|
53
|
+
import pages.LoginPage
|
|
54
|
+
import pages.IndustryDataPage
|
|
55
|
+
import common.BasePage
|
|
56
|
+
|
|
57
|
+
// 1. Arrange & Preconditions
|
|
58
|
+
LoginPage.login(GlobalVariable.ADMIN_USER, GlobalVariable.ADMIN_PASS)
|
|
59
|
+
IndustryDataPage.navigate()
|
|
60
|
+
|
|
61
|
+
// 2. Dynamic Test Data Generation
|
|
62
|
+
String uniqueCode = BasePage.uniqueCode("IND_")
|
|
63
|
+
String entityName = "Automated Test Industry " + uniqueCode
|
|
64
|
+
|
|
65
|
+
// 3. Act
|
|
66
|
+
IndustryDataPage.clickAddNew()
|
|
67
|
+
IndustryDataPage.inputDetails(uniqueCode, entityName)
|
|
68
|
+
IndustryDataPage.clickSave()
|
|
69
|
+
|
|
70
|
+
// 4. Assert
|
|
71
|
+
IndustryDataPage.assertSuccessToast()
|
|
72
|
+
IndustryDataPage.searchAndVerifyRecord(uniqueCode, entityName)
|
|
73
|
+
|
|
74
|
+
// 5. Teardown Cleanup
|
|
75
|
+
IndustryDataPage.deleteRecordByCode(uniqueCode)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 3. Mandatory Generation Constraints
|
|
81
|
+
- Zero raw XPaths, CSS selectors, or `findTestObject` in the generated script.
|
|
82
|
+
- Always generate dynamic identifiers with prefixes via `BasePage.uniqueCode()`.
|
|
83
|
+
- Always generate mandatory teardown cleanup for created entities.
|