mirror of
https://github.com/openobserve/openobserve.git
synced 2026-11-06 08:09:24 +00:00
### **User description**
This PR adds unit test cases for reports module and the coverage as of
now
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-----------------------------------------------|---------|----------|---------|---------|----------------------------------------------------------
All files | 34.41 | 70.18 | 29.47 | 34.41 |
___
### **PR Type**
Tests
___
### **Description**
- Add comprehensive CreateReport tests
- Add comprehensive ReportList tests
- Mock services and dependencies
- Validate form flows and error handling
___
<details> <summary><h3> File Walkthrough</h3></summary>
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Tests</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>CreateReport.spec.js</strong><dd><code>Add CreateReport
component tests</code>
</dd></summary>
<hr>
web/src/components/reports/CreateReport.spec.js
<ul><li>Mock dashboardService and reports service<br> <li> Test
component initialization and rendering<br> <li> Test form navigation and
validation steps<br> <li> Test report creation, editing, and
cancellation</ul>
</details>
</td>
<td><a
href="https://github.com/openobserve/openobserve/pull/7882/files#diff-8a0f39751d08a258c4997c5e68edaf167ea01477528beee2295dd9f992310cc6">+1793/-0</a></td>
</tr>
<tr>
<td>
<details>
<summary><strong>ReportList.spec.js</strong><dd><code>Add ReportList
component tests</code>
</dd></summary>
<hr>
web/src/components/reports/ReportList.spec.js
<ul><li>Mock reports service and router<br> <li> Test listing,
pagination, and filtering<br> <li> Test report state toggle and
deletion<br> <li> Test navigation to create and edit pages</ul>
</details>
</td>
<td><a
href="https://github.com/openobserve/openobserve/pull/7882/files#diff-c3de3f1590ac7b4401cf5570a52f0dcf6471898e4ffc7ccbc19166ba600a181f">+633/-0</a>
</td>
</tr>
</table></td></tr></tr></tbody></table>
</details>
___
140 lines
3.6 KiB
Bash
Executable File
140 lines
3.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -eu -o pipefail
|
|
|
|
# Default coverage thresholds - you can override these with environment variables
|
|
export FRONTEND_COVERAGE_LINES=${FRONTEND_COVERAGE_LINES:-34}
|
|
export FRONTEND_COVERAGE_FUNCTIONS=${FRONTEND_COVERAGE_FUNCTIONS:-29}
|
|
export FRONTEND_COVERAGE_BRANCHES=${FRONTEND_COVERAGE_BRANCHES:-64}
|
|
export FRONTEND_COVERAGE_STATEMENTS=${FRONTEND_COVERAGE_STATEMENTS:-34}
|
|
|
|
usage() {
|
|
cat <<EOF
|
|
Usage: $0 [-h | --help] [<command>]
|
|
|
|
Commands:
|
|
check Run frontend tests with coverage and verify thresholds
|
|
html Generate coverage report in HTML format
|
|
show-env Show the coverage thresholds
|
|
test Run tests with coverage
|
|
help Show this help and exit
|
|
|
|
Omitted <command> defaults to 'check'.
|
|
EOF
|
|
}
|
|
|
|
cmd_test() {
|
|
npm run test:unit:coverage
|
|
}
|
|
|
|
cmd_html() {
|
|
npm run test:unit:coverage
|
|
echo "Coverage report generated in coverage/ directory"
|
|
if command -v open >/dev/null 2>&1; then
|
|
open coverage/index.html
|
|
elif command -v xdg-open >/dev/null 2>&1; then
|
|
xdg-open coverage/index.html
|
|
else
|
|
echo "Open coverage/index.html in your browser to view the report"
|
|
fi
|
|
}
|
|
|
|
cmd_show_env() {
|
|
cat <<EOF
|
|
FRONTEND_COVERAGE_LINES=$FRONTEND_COVERAGE_LINES
|
|
FRONTEND_COVERAGE_FUNCTIONS=$FRONTEND_COVERAGE_FUNCTIONS
|
|
FRONTEND_COVERAGE_BRANCHES=$FRONTEND_COVERAGE_BRANCHES
|
|
FRONTEND_COVERAGE_STATEMENTS=$FRONTEND_COVERAGE_STATEMENTS
|
|
EOF
|
|
}
|
|
|
|
cmd_check() {
|
|
echo "Running frontend tests with coverage..."
|
|
npm run test:unit:coverage
|
|
|
|
if [ -f "coverage/coverage-summary.json" ]; then
|
|
echo "Checking coverage thresholds..."
|
|
python3 <(
|
|
cat <<'EOF'
|
|
import json
|
|
import os
|
|
import sys
|
|
|
|
thresholds = {
|
|
'lines': float(os.environ['FRONTEND_COVERAGE_LINES']),
|
|
'functions': float(os.environ['FRONTEND_COVERAGE_FUNCTIONS']),
|
|
'branches': float(os.environ['FRONTEND_COVERAGE_BRANCHES']),
|
|
'statements': float(os.environ['FRONTEND_COVERAGE_STATEMENTS']),
|
|
}
|
|
|
|
try:
|
|
with open('coverage/coverage-summary.json') as f:
|
|
report = json.load(f)
|
|
|
|
totals = report['total']
|
|
|
|
exit_status = 0
|
|
for metric, threshold in thresholds.items():
|
|
actual = totals[metric]['pct']
|
|
metric_name = metric.capitalize()
|
|
if actual >= threshold:
|
|
print(f'✅ {metric_name} coverage: {actual:.2f}%', file=sys.stderr)
|
|
else:
|
|
print(
|
|
f'❌ {metric_name} coverage is below threshold: {actual:.2f}% < {threshold}%',
|
|
file=sys.stderr,
|
|
)
|
|
exit_status = 1
|
|
|
|
if exit_status == 0:
|
|
print('🎉 All coverage thresholds met!', file=sys.stderr)
|
|
else:
|
|
print('💥 Some coverage thresholds not met. Please add more tests.', file=sys.stderr)
|
|
|
|
sys.exit(exit_status)
|
|
|
|
except FileNotFoundError:
|
|
print('❌ Coverage summary file not found. Make sure tests ran successfully.', file=sys.stderr)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
print(f'❌ Error checking coverage: {e}', file=sys.stderr)
|
|
sys.exit(1)
|
|
EOF
|
|
)
|
|
else
|
|
echo "❌ Coverage summary not found. Tests may have failed."
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
main() {
|
|
case "${1:-}" in
|
|
'')
|
|
cmd_check
|
|
;;
|
|
check)
|
|
shift
|
|
cmd_check "$@"
|
|
;;
|
|
test)
|
|
shift
|
|
cmd_test "$@"
|
|
;;
|
|
html)
|
|
shift
|
|
cmd_html "$@"
|
|
;;
|
|
show-env)
|
|
cmd_show_env
|
|
;;
|
|
-h | --help | help)
|
|
usage
|
|
;;
|
|
*)
|
|
echo >&2 "Invalid argument: $1"
|
|
echo >&2 "Type '$0 --help' for usage"
|
|
exit 1
|
|
;;
|
|
esac
|
|
}
|
|
|
|
main "$@" |