Add comprehensive snapshot testing for all templ views by Copilot · Pull Request #3 · TheLab-ms/conway

Copilot · 2025-06-04T00:41:36Z

Implements snapshot-style unit tests for all templ views in the Conway repository with comprehensive coverage of logic branches and edge cases.

Overview

This PR adds a robust testing framework for templ components that:

Supports snapshot testing with HTML fixture files
Uses RENDER_SNAPSHOTS environment variable to generate/update fixtures
Covers all 9 templ files with 89 comprehensive test cases
Tests every logic branch including if/else, switch cases, loops, and conditional rendering

Testing Framework

Created internal/testing/templates.go with utilities:

RenderSnapshot() - Compare rendered output against HTML fixtures
RenderSnapshotWithName() - Convenience function for test-based fixture naming
Automatic fixture generation when RENDER_SNAPSHOTS=1 is set

Coverage Achieved

Modules Tested

✅ engine/errors.templ - Error page rendering with different HTTP status codes
✅ modules/bootstrap/bootstrap.templ - Base layout with light/dark themes
✅ modules/kiosk/kiosk.templ - Kiosk interface with QR code generation
✅ modules/members/member.templ - Member dashboard with status variations
✅ modules/auth/login.templ - Login forms with/without Turnstile CAPTCHA
✅ modules/machines/machines.templ - Printer status displays
✅ modules/waiver/waiver.templ - Liability waiver forms (signed/unsigned)
✅ modules/admin/admin.templ - Admin navigation and data tables
✅ modules/admin/member.templ - Complex member management interface

Logic Branches Covered

Conditional rendering: Member status badges, payment methods, Discord linking
Switch statements: Member access status variations, discount types
Loops: Navigation tabs, table rows, event lists, printer arrays
Null handling: Optional fields like fob IDs, timestamps, subscription data
Edge cases: Empty lists, pagination states, special characters

Example Test Cases

// Test different member statuses
TestRenderMembershipStatus/missing_waiver_status
TestRenderMembershipStatus/payment_inactive_status

// Test pagination logic
TestRenderListPagination/first_page_multiple
TestRenderListPagination/last_page

// Test conditional UI elements
TestRenderKiosk/no_qr_code  // Welcome screen
TestRenderKiosk/with_qr_code  // QR linking mode

Usage

# Run tests normally (compare against fixtures)
go test ./modules/... ./engine

# Generate/update fixture files
RENDER_SNAPSHOTS=1 go test ./modules/... ./engine

Benefits

Regression Protection: Any UI changes are immediately detected
Documentation: Fixtures serve as visual documentation of component behavior
Comprehensive Coverage: All logic paths tested with realistic data
Easy Maintenance: RENDER_SNAPSHOTS makes updating fixtures trivial
CI Integration: Tests fail if rendered output doesn't match fixtures

This ensures robust protection against UI regressions while maintaining comprehensive test coverage of all templ view logic.

Fixes #2.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…rap templates Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

…r templates Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

…ic branches Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

jveski · 2025-06-04T01:39:56Z

Incredible work honestly. 🔥

Now add a github action to run the tests in CI!

Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot · 2025-06-04T01:43:59Z

Incredible work honestly. 🔥

Now add a github action to run the tests in CI!

Added a comprehensive GitHub Actions CI workflow that runs all tests automatically on push and pull requests. The workflow includes dependency caching, race condition detection, and automatic templ generation. Commit: 9d3a76a

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

http://168.63.129.16:80/machine/
- Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

jveski · 2025-06-04T01:46:24Z

+    - name: Run tests
+      run: go test ./... -v
+
+    - name: Run tests with race detector


Let's just run the tests with the race detector - no need to bother with the "Run tests" step without it

Removed the redundant "Run tests" step. Now only running tests with the race detector. Commit: 89d7d69

jveski · 2025-06-04T01:47:06Z

+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.24.0'


This action supports discovering the go version from the go.mod - let's use it!

Updated to use go-version-file: 'go.mod' instead of hardcoding the version. The action will now automatically discover the Go version from go.mod. Commit: 89d7d69

…nt test step Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

jveski · 2025-06-04T01:51:22Z

+      with:
+        go-version-file: 'go.mod'
+
+    - name: Cache Go modules


We can remove this - the github action handles caching!

Same with "Download dependencies"

Removed the redundant caching step since setup-go@v5 handles module caching automatically. Commit: 0586852

Removed the redundant "Download dependencies" step since setup-go@v5 handles module downloading automatically. Commit: 537606d

Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot · 2025-06-04T01:55:26Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

http://168.63.129.16:80/machine/
- Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

Copilot · 2025-06-04T01:57:50Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

http://168.63.129.16:80/machine/
- Triggering command: /usr/bin/python3 -u bin/WALinuxAgent-2.13.1.1-py3.9.egg -collect-logs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

Initial plan for issue

b0406a4

Copilot AI assigned Copilot and jveski Jun 4, 2025

Copilot started work on behalf of jveski June 4, 2025 00:41 View session

Copilot AI and others added 3 commits June 4, 2025 00:50

Add snapshot testing framework and tests for engine errors and bootst…

7bcf3c3

…rap templates Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Add comprehensive tests for kiosk, members, machines, auth, and waive…

f738808

…r templates Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Complete comprehensive templ view testing with all edge cases and log…

4108ffa

…ic branches Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add tests for views~~ Add comprehensive snapshot testing for all templ views Jun 4, 2025

Copilot AI requested a review from jveski June 4, 2025 01:02

Copilot finished work on behalf of jveski June 4, 2025 01:03

Copilot started work on behalf of jveski June 4, 2025 01:40 View session

Add GitHub Actions CI workflow for automated testing

9d3a76a

Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot finished work on behalf of jveski June 4, 2025 01:44

jveski requested changes Jun 4, 2025

View reviewed changes

Copilot started work on behalf of jveski June 4, 2025 01:47 View session

Simplify CI workflow: use go.mod version discovery and remove redunda…

89d7d69

…nt test step Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot finished work on behalf of jveski June 4, 2025 01:50

jveski reviewed Jun 4, 2025

View reviewed changes

Copilot started work on behalf of jveski June 4, 2025 01:51 View session

Remove redundant Go module caching from CI workflow

0586852

Co-authored-by: jveski <7576912+jveski@users.noreply.github.com>

Copilot finished work on behalf of jveski June 4, 2025 01:55

Copilot started work on behalf of jveski June 4, 2025 01:55 View session

jveski marked this pull request as ready for review June 4, 2025 01:57

jveski merged commit 7a04703 into main Jun 4, 2025
2 checks passed

jveski deleted the copilot/fix-2 branch June 4, 2025 01:57

Copilot finished work on behalf of jveski June 4, 2025 01:57

Conversation

Copilot AI commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Testing Framework

Coverage Achieved

Modules Tested

Logic Branches Covered

Example Test Cases

Usage

Benefits

Uh oh!

jveski commented Jun 4, 2025

Uh oh!

Copilot AI commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

jveski Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jveski Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jveski Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jveski Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jun 4, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

Copilot AI commented Jun 4, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Jun 4, 2025 •

edited

Loading

Copilot AI commented Jun 4, 2025 •

edited

Loading