Skip to content

Commit e7a0c2f

Browse files
committed
Remove unused generate_test_badge.py utility and all references
The badge generation utility was not used in the actual implementation: - Workflows generate JSON directly (no Python utility needed) - Hugo template reads JSON directly (no utility needed) - SVG/text badge generation not required Removed: - build_steps/generate_test_badge.py (160 lines) Updated documentation to remove references: - tests/COMPLETE_GUIDE.md (removed 'Badge Generation Utility' section) - SMOKE_TESTS_BRANCH_SUMMARY.md (removed utility from file list) - EXECUTIVE_SUMMARY.md (removed from utilities section) This simplifies the codebase and removes confusion about how badges work. Badges are generated entirely through: Workflows → JSON → Hugo template.
1 parent cb1310e commit e7a0c2f

4 files changed

Lines changed: 13 additions & 211 deletions

File tree

EXECUTIVE_SUMMARY.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,14 @@ A fully automated testing system for Arm Ecosystem Dashboard packages that:
3838
- `reusable-package-test.yml` - **Template for any package**
3939
- `test-all-packages.yml` - **Orchestrator** (runs all tests)
4040

41-
### Utilities
42-
- `generate_test_badge.py` - Badge generation CLI tool
43-
4441
### Data
4542
- `data/test-results/nginx.json` - Auto-generated test results
4643
- `data/test-results/envoy.json` - Auto-generated test results
4744

48-
### Documentation (8 guides)
49-
- Complete setup, scaling, and troubleshooting guides
45+
### Documentation (3 guides)
46+
- `tests/README.md` - Navigation hub and quick start
47+
- `tests/COMPLETE_GUIDE.md` - Comprehensive documentation
48+
- `tests/PIPELINE_REFERENCE.md` - Advanced technical reference
5049

5150
---
5251

SMOKE_TESTS_BRANCH_SUMMARY.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,44 +54,30 @@ This branch adds a comprehensive automated testing infrastructure to the Arm Eco
5454
- Scheduled daily at 2 AM UTC
5555
- Manual trigger support
5656

57-
### Python Utilities (`build_steps/`)
58-
59-
5. **`generate_test_badge.py`** (93 lines)
60-
- CLI tool for badge generation from test results
61-
- Supports SVG and text output formats
62-
- Color-coded: green (passing), red (failing), gray (unknown)
63-
- Usage: `python generate_test_badge.py nginx [--format svg|text]`
64-
6557
### Test Results Data (`data/test-results/`)
6658

67-
6. **`nginx.json`** (30 lines)
59+
5. **`nginx.json`** (30 lines)
6860
- JSON schema v1.0 format
6961
- Contains: package info, test results, run metadata
7062
- Auto-generated by workflow
7163
- Used by Hugo to display badges
7264

73-
7. **`envoy.json`** (30 lines)
65+
6. **`envoy.json`** (30 lines)
7466
- Same schema as nginx
7567
- Demonstrates multi-package support
7668

7769
### Hugo Theme Integration (`themes/arm-design-system-hugo-theme/`)
7870

79-
8. **`layouts/shortcodes/test-badge.html`** (30 lines)
80-
- Hugo shortcode for embedding badges
81-
- Not currently used (integrated directly in template instead)
82-
- Available for future use in markdown content
71+
7. **`layouts/partials/package-display/row-sub.html`** (modified)
72+
- Integrated badge display directly in template
73+
- Reads test data from JSON files
74+
- Color-coded badges with expandable test details
8375

8476
### Documentation (`tests/`)
8577

86-
9. **`README.md`** - Main documentation entry point
87-
10. **`OVERVIEW.md`** - System architecture and workflow explanation
88-
11. **`QUICKSTART.md`** - Step-by-step guide for adding tests
89-
12. **`SCALABLE-ARCHITECTURE.md`** - Guide to scaling to multiple packages
90-
13. **`QUICK-ADD-PACKAGE.md`** - Fast reference for adding new packages
91-
14. **`PIPELINE-WALKTHROUGH.md`** - Detailed pipeline flow explanation
92-
15. **`TEST-RESULTS-SCHEMA.md`** - JSON schema documentation
93-
16. **`DEPLOYMENT.md`** - Deployment and rollout guide
94-
17. **`BADGE-INTEGRATION-FIX.md`** - Troubleshooting badge display
78+
8. **`README.md`** - Navigation hub and quick start guide
79+
9. **`COMPLETE_GUIDE.md`** - Comprehensive all-in-one documentation
80+
10. **`PIPELINE_REFERENCE.md`** - Advanced topics and technical reference
9581

9682
---
9783

build_steps/generate_test_badge.py

Lines changed: 0 additions & 159 deletions
This file was deleted.

tests/COMPLETE_GUIDE.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -662,27 +662,6 @@ When you need more control than the reusable template provides:
662662
3. Detailed error handling
663663
4. Service lifecycle management
664664

665-
### Badge Generation Utility
666-
667-
**Tool:** `build_steps/generate_test_badge.py`
668-
669-
**Usage:**
670-
```bash
671-
# Generate SVG badge
672-
python build_steps/generate_test_badge.py nginx --format svg
673-
674-
# Generate text summary
675-
python build_steps/generate_test_badge.py nginx --format text
676-
```
677-
678-
**Output:**
679-
```
680-
Package: nginx
681-
Version: 1.24.0
682-
Status: passing
683-
Tests: 5 passed, 0 failed
684-
```
685-
686665
### Matrix Testing (Future)
687666

688667
Test multiple versions of the same package:
@@ -715,9 +694,6 @@ data/test-results/
715694
├── nginx.json # nginx results
716695
└── envoy.json # Envoy results
717696

718-
build_steps/
719-
└── generate_test_badge.py # Badge utility
720-
721697
themes/arm-design-system-hugo-theme/layouts/
722698
└── partials/package-display/row-sub.html # Badge display template
723699
```

0 commit comments

Comments
 (0)