feat: Add Testing Infrastructure Enhancements and Generic Type Utilities #133
Conversation
WalkthroughThis update introduces new generic type conversion helpers ( Changes
Sequence Diagram(s)sequenceDiagram
participant Test as Test Function
participant MockT as MockT
participant Assert as AssertMustFoo
Test->>MockT: Run(testFn)
MockT->>Test: Call testFn(MockT)
Test->>Assert: AssertMustEqual(MockT, expected, actual)
Assert->>MockT: (on failure) FailNow()
MockT-->>Assert: Panic (errMockTFailNow)
Assert-->>Test: Panic propagates
MockT->>MockT: Recover panic, return failure
Estimated code review effort🎯 4 (Complex) | ⏱️ ~40 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Here's the code health analysis summary for commits Analysis Summary
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
TESTING.md (1)
968-968: Fix grammar issue.Consider using "to" with "prefer" for better grammar.
-* Prefer table-driven tests over individual test functions. +* Prefer to use table-driven tests over individual test functions.testing.go (1)
615-816: Comprehensive set of fatal assertion helpers!The AssertMust* functions provide a clean, consistent API for fail-fast testing scenarios. Each function:
- Properly delegates to its non-fatal counterpart
- Calls FailNow only on assertion failure
- Includes clear documentation with examples
- Maintains consistent naming and behavior
Consider reducing code duplication in the future by generating these functions or using a common helper pattern, as they all follow the same structure:
func AssertMustFoo(...) { t.Helper() if !AssertFoo(...) { t.FailNow() } }This could be addressed in a future PR to keep this one focused.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
README.md(4 hunks)TESTING.md(7 hunks)TESTING_core.md(2 hunks)internal/build/cspell.json(1 hunks)panic.go(1 hunks)panic_test.go(2 hunks)testing.go(6 hunks)testing_test.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.md
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.md: Enforce Markdown formatting rules, including 80-character line limits and strict formatting, using markdownlint with configuration in internal/build/markdownlint.json.
Check Markdown files for grammar and style issues using LanguageTool with configuration in internal/build/languagetool.cfg.
When editing Markdown files, ensure compliance with LanguageTool, CSpell, and Markdownlint.
End all bullet points in Markdown files with periods for consistency.
Capitalize proper nouns correctly (JavaScript, TypeScript, Markdown) in documentation.
Use consistent punctuation in examples and lists in documentation.
Provide context and 'why' explanations in documentation, not just 'what' descriptions.
Add examples for complex concepts or common pitfalls in documentation.
Update documentation when adding new tools or changing workflows.
Keep the pre-commit checklist current with project practices.
Review documentation changes for missing articles, punctuation, and compound modifiers.
Files:
TESTING_core.mdTESTING.mdREADME.md
**/*.{md,go}
📄 CodeRabbit Inference Engine (AGENT.md)
Check spelling in both Markdown and Go source files using CSpell with configuration in internal/build/cspell.json.
Files:
TESTING_core.mdpanic.goTESTING.mdpanic_test.gotesting.gotesting_test.goREADME.md
**/*.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.go: Use Go 1.23+ generics for type-safe utilities.
Enforce strict linting rules via revive as configured in internal/build/revive.toml: max function length 40 lines, max function results 3, max arguments 5, cognitive complexity 7, cyclomatic complexity 10.
Enforce struct field alignment optimization for memory efficiency using the fieldalignment tool.
Use golangci-lint with configuration in .golangci.yml for comprehensive Go code linting.
Files:
panic.gopanic_test.gotesting.gotesting_test.go
**/*_test.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*_test.go: Prefer table-driven tests for Go code.
Use helper functions like ST, AssertEqualT, AssertSliceEqualT, AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Provide comprehensive coverage for generic functions.
Files:
panic_test.gotesting_test.go
README.md
📄 CodeRabbit Inference Engine (AGENT.md)
Update README.md to reflect significant changes in functionality or API.
Files:
README.md
🧠 Learnings (18)
📓 Common learnings
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Prefer table-driven tests for Go code.
📚 Learning: add technical terms to internal/build/cspell.json for spelling and grammar tools....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Add technical terms to internal/build/cspell.json for spelling and grammar tools.
Applied to files:
internal/build/cspell.json
📚 Learning: applies to **/*.{md,go} : check spelling in both markdown and go source files using cspell with conf...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*.{md,go} : Check spelling in both Markdown and Go source files using CSpell with configuration in internal/build/cspell.json.
Applied to files:
internal/build/cspell.json
📚 Learning: use only the go standard library and minimal golang.org/x packages; zero external dependencies....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Use only the Go standard library and minimal golang.org/x packages; zero external dependencies.
Applied to files:
internal/build/cspell.jsonTESTING.md
📚 Learning: applies to **/*_test.go : provide comprehensive coverage for generic functions....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Applied to files:
internal/build/cspell.jsonTESTING_core.mdpanic.goTESTING.mdpanic_test.gotesting.gotesting_test.goREADME.md
📚 Learning: applies to **/*.go : enforce struct field alignment optimization for memory efficiency using the fie...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*.go : Enforce struct field alignment optimization for memory efficiency using the fieldalignment tool.
Applied to files:
internal/build/cspell.json
📚 Learning: applies to **/*_test.go : use helper functions like s[t](), assertequal[t](), assertsliceequal[t](),...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Applied to files:
internal/build/cspell.jsonTESTING_core.mdpanic.goTESTING.mdpanic_test.gotesting.gotesting_test.goREADME.md
📚 Learning: applies to **/*.go : max function results: 3....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to **/*.go : Max function results: 3.
Applied to files:
internal/build/cspell.jsonTESTING.md
📚 Learning: applies to **/*.go : use go 1.23+ generics for type-safe utilities....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
Applied to files:
internal/build/cspell.jsonpanic.gopanic_test.goREADME.md
📚 Learning: applies to readme.md : update readme.md to reflect significant changes in functionality or api....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Applies to README.md : Update README.md to reflect significant changes in functionality or API.
Applied to files:
TESTING_core.mdTESTING.mdREADME.md
📚 Learning: applies to **/*_test.go : prefer table-driven tests for go code....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.106Z
Learning: Applies to **/*_test.go : Prefer table-driven tests for Go code.
Applied to files:
TESTING_core.mdTESTING.mdpanic_test.gotesting.gotesting_test.goREADME.md
📚 Learning: applies to **/*.md : review documentation changes for missing articles, punctuation, and compound mo...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Applies to **/*.md : Review documentation changes for missing articles, punctuation, and compound modifiers.
Applied to files:
TESTING.md
📚 Learning: always run make tidy first before committing: go code formatting and whitespace clean-up, markdown f...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: ALWAYS run make tidy first before committing: Go code formatting and whitespace clean-up, Markdown files checked with CSpell and markdownlint, Shell scripts checked with shellcheck.
Applied to files:
TESTING.md
📚 Learning: always run make tidy which includes golangci-lint checks....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Always run make tidy which includes golangci-lint checks.
Applied to files:
TESTING.md
📚 Learning: verify all tests pass with make test before committing....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Verify all tests pass with make test before committing.
Applied to files:
TESTING.md
📚 Learning: always run `make tidy` first before committing: fix all issues (go formatting, whitespace, cspell, m...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: ALWAYS run `make tidy` first before committing: fix all issues (Go formatting, whitespace, CSpell, markdownlint, shellcheck).
Applied to files:
TESTING.md
📚 Learning: applies to agent.md : update `agent.md` to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to AGENT.md : Update `AGENT.md` to reflect any changes in development workflow or standards.
Applied to files:
README.md
📚 Learning: applies to agent.md : update agent.md to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.107Z
Learning: Applies to AGENT.md : Update AGENT.md to reflect any changes in development workflow or standards.
Applied to files:
README.md
🪛 LanguageTool
TESTING.md
[grammar] ~968-~968: Consider using “to” with “prefer”.
Context: ...t.Helper() in all helper functions. * Prefer table-driven tests over individual test functions. * Keep setup and clean-...
(PREFER_OVER_TO)
README.md
[locale-violation] ~304-~304: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... value or panics with PanicError if ok is false. Useful for operations that sh...
(OK)
[locale-violation] ~306-~306: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... always returns the value, ignoring the ok flag. When ok is false, the returned ...
(OK)
[locale-violation] ~307-~307: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...the value, ignoring the ok flag. When ok is false, the returned value is typical...
(OK)
[uncategorized] ~312-~312: Possible missing article found.
Context: ...MaybeOK(As[any, T](value)). Returns converted value on success, or the zero value of ...
(AI_HYDRA_LEO_MISSING_THE)
[locale-violation] ~314-~314: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...he As[any, T] function, which returns (value, ok) for type conversion, allowing custom ...
(OK)
🔇 Additional comments (18)
internal/build/cspell.json (1)
27-27: LGTM!The addition of "Fatalf" to the spell checker dictionary is necessary and correctly positioned alphabetically to support the new fatal assertion methods introduced in this PR.
panic.go (2)
158-176: LGTM!
MustTis well-implemented with proper generics usage, comprehensive documentation, and follows the established Must* pattern. The panic message includes both source and target types, which aids debugging.
178-193: LGTM!
MaybeTcorrectly implements graceful type conversion with zero value fallback. The revive disable comment for unchecked-type-assertion is appropriate here since the function intentionally ignores conversion failures.TESTING_core.md (2)
131-134: LGTM!Clear and concise documentation of the new Fatal/FailNow support in MockT, properly integrated with the existing feature list.
159-200: Excellent documentation for Fatal/FailNow testing patterns.This new section provides comprehensive guidance on testing fatal assertion scenarios with clear examples and practical usage patterns. The example demonstrates both AssertMust* usage and manual FailNow patterns effectively.
TESTING.md (2)
115-135: Excellent documentation for fatal assertions.Clear distinction between standard and fatal assertions with practical examples. The explanation of
AssertMust*functions callingt.FailNow()on failure is well-documented.
858-878: LGTM!Good practical example demonstrating how to test functions that call Fatal/FailNow methods using MockT.Run() with proper verification patterns.
panic_test.go (5)
21-23: LGTM!Proper TestCase interface validation declarations following the mandatory compliance requirements.
811-867: Excellent test coverage for MustT success scenarios.Comprehensive test implementation covering multiple types with proper factory functions, TestCase interface usage, and type-safe generic testing patterns.
869-923: LGTM!Well-implemented panic tests using AssertPanic to verify MustT correctly panics on invalid type conversions across various scenarios.
925-1036: Comprehensive MaybeT test coverage.Excellent testing of both successful conversions and graceful fallback to zero values, with proper nil handling for interface types and good separation of test logic by target type.
1038-1045: LGTM!Simple and appropriate mockStringer helper type for testing fmt.Stringer interface conversions.
testing_test.go (1)
634-1183: Excellent test coverage for the new testing infrastructure!The tests comprehensively cover all new functionality including:
- MockT's Fatal, Fatalf, and FailNow methods with proper panic recovery
- The Run method's behavior with various edge cases
- Early abort patterns demonstrating the use case for AssertMust* functions
- All 14 AssertMust* variants with both success and failure scenarios
The tests follow best practices with clear test names, proper use of helper functions, and thorough verification of all behaviors.
README.md (1)
301-349: Documentation updates are clear and comprehensive!The README effectively documents:
- The new generic type conversion utilities (MustT/MaybeT) with clear explanations of their relationship to the As function
- Fatal assertion helpers with proper context about their behavior and use cases
- MockT's enhanced capabilities for Fatal/FailNow support
The examples are practical and help users understand the usage patterns.
Also applies to: 472-473, 510-560
testing.go (4)
12-12: Good use of sentinel error pattern!Using a sentinel error for MockT.FailNow panic recovery is a clean approach that allows distinguishing between FailNow panics and other panics.
63-94: Smart refactoring to reduce lock contention!Pre-computing formatted messages before acquiring the lock is a good optimization that reduces the time the mutex is held. This improves concurrent performance when multiple goroutines are logging.
96-129: Well-implemented Fatal methods with proper panic behavior!The Fatal and Fatalf methods correctly combine error recording with immediate termination via panic. The FailNow method properly marks the test as failed before panicking, maintaining consistency with the testing.T interface behavior.
182-211: Excellent implementation of the Run method!The Run method provides a clean way to test functions that call Fatal/FailNow:
- Proper nil checks for defensive programming
- Correct panic recovery that only catches errMockTFailNow
- Re-panics other panics to maintain expected behavior
- Clear documentation with usage example
This enables comprehensive testing of assertion functions without terminating the test runner.
|
rebased |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
TESTING.md (1)
968-968: Address grammar issue identified by static analysis.The phrase should use "to" rather than "over" with "prefer" for correct grammar.
-* Prefer table-driven tests over individual test functions. +* Prefer table-driven tests to individual test functions.README.md (3)
472-474: Line-length exceeds markdown-lint 80-character limit.The two wrapped lines describing
MockTreach ~120 chars. Re-wrap at ≤ 80 chars to satisfyinternal/build/markdownlint.json.- `LastError()`, `LastLog()`), reset capabilities, and full Fatal/FailNow - support with panic recovery via the `Run()` method. + `LastError()`, `LastLog()`), reset capabilities, and full Fatal/FailNow + support (with panic recovery) via the `Run()` method.
525-543: Ensure each bullet terminates with a period for markdown consistency.A few multi-line bullets (e.g. Lines 528, 534, 542) end without a trailing
full stop once the continuation line is joined. Add a period at the end of
each bullet to follow the doc-style convention used elsewhere in the file.
314-316: Capitalise “OK” when not used as the Go boolean variable.LanguageTool flags the lower-case “ok”. Here it is plain English, not the
code identifier, so prefer “OK”.- `(value, ok)` for type conversion, allowing custom handling of conversion + `(value, OK)` for type conversion, allowing custom handling of conversion
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
README.md(4 hunks)TESTING.md(7 hunks)TESTING_core.md(2 hunks)internal/build/cspell.json(1 hunks)panic.go(1 hunks)panic_test.go(2 hunks)testing.go(6 hunks)testing_test.go(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- internal/build/cspell.json
🚧 Files skipped from review as they are similar to previous changes (3)
- TESTING_core.md
- panic.go
- panic_test.go
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{md,go}
📄 CodeRabbit Inference Engine (AGENT.md)
Check spelling in both Markdown and Go source files using CSpell with configuration in internal/build/cspell.json.
Files:
testing_test.gotesting.goREADME.mdTESTING.md
**/*.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.go: Use Go 1.23+ generics for type-safe utilities.
Enforce strict linting rules via revive as configured in internal/build/revive.toml: max function length 40 lines, max function results 3, max arguments 5, cognitive complexity 7, cyclomatic complexity 10.
Enforce struct field alignment optimization for memory efficiency using the fieldalignment tool.
Use golangci-lint with configuration in .golangci.yml for comprehensive Go code linting.
Files:
testing_test.gotesting.go
**/*_test.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*_test.go: Prefer table-driven tests for Go code.
Use helper functions like ST, AssertEqualT, AssertSliceEqualT, AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Provide comprehensive coverage for generic functions.
Files:
testing_test.go
**/*.md
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.md: Enforce Markdown formatting rules, including 80-character line limits and strict formatting, using markdownlint with configuration in internal/build/markdownlint.json.
Check Markdown files for grammar and style issues using LanguageTool with configuration in internal/build/languagetool.cfg.
When editing Markdown files, ensure compliance with LanguageTool, CSpell, and Markdownlint.
End all bullet points in Markdown files with periods for consistency.
Capitalize proper nouns correctly (JavaScript, TypeScript, Markdown) in documentation.
Use consistent punctuation in examples and lists in documentation.
Provide context and 'why' explanations in documentation, not just 'what' descriptions.
Add examples for complex concepts or common pitfalls in documentation.
Update documentation when adding new tools or changing workflows.
Keep the pre-commit checklist current with project practices.
Review documentation changes for missing articles, punctuation, and compound modifiers.
Files:
README.mdTESTING.md
README.md
📄 CodeRabbit Inference Engine (AGENT.md)
Update README.md to reflect significant changes in functionality or API.
Files:
README.md
🧠 Learnings (15)
📓 Common learnings
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Prefer table-driven tests for Go code.
📚 Learning: applies to **/*_test.go : use helper functions like s[t](), assertequal[t](), assertsliceequal[t](),...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to **/*_test.go : provide comprehensive coverage for generic functions....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to **/*_test.go : prefer table-driven tests for go code....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Prefer table-driven tests for Go code.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to readme.md : update readme.md to reflect significant changes in functionality or api....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to README.md : Update README.md to reflect significant changes in functionality or API.
Applied to files:
README.mdTESTING.md
📚 Learning: applies to **/*.go : use go 1.23+ generics for type-safe utilities....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
Applied to files:
README.md
📚 Learning: applies to agent.md : update `agent.md` to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to AGENT.md : Update `AGENT.md` to reflect any changes in development workflow or standards.
Applied to files:
README.md
📚 Learning: applies to agent.md : update agent.md to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to AGENT.md : Update AGENT.md to reflect any changes in development workflow or standards.
Applied to files:
README.mdTESTING.md
📚 Learning: applies to **/*.md : review documentation changes for missing articles, punctuation, and compound mo...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.md : Review documentation changes for missing articles, punctuation, and compound modifiers.
Applied to files:
TESTING.md
📚 Learning: use only the go standard library and minimal golang.org/x packages; zero external dependencies....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Use only the Go standard library and minimal golang.org/x packages; zero external dependencies.
Applied to files:
TESTING.md
📚 Learning: always run make tidy first before committing: go code formatting and whitespace clean-up, markdown f...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: ALWAYS run make tidy first before committing: Go code formatting and whitespace clean-up, Markdown files checked with CSpell and markdownlint, Shell scripts checked with shellcheck.
Applied to files:
TESTING.md
📚 Learning: always run make tidy which includes golangci-lint checks....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Always run make tidy which includes golangci-lint checks.
Applied to files:
TESTING.md
📚 Learning: applies to **/*.go : max function results: 3....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to **/*.go : Max function results: 3.
Applied to files:
TESTING.md
📚 Learning: verify all tests pass with make test before committing....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Verify all tests pass with make test before committing.
Applied to files:
TESTING.md
📚 Learning: always run `make tidy` first before committing: fix all issues (go formatting, whitespace, cspell, m...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: ALWAYS run `make tidy` first before committing: fix all issues (Go formatting, whitespace, CSpell, markdownlint, shellcheck).
Applied to files:
TESTING.md
🪛 LanguageTool
README.md
[locale-violation] ~304-~304: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... value or panics with PanicError if ok is false. Useful for operations that sh...
(OK)
[locale-violation] ~306-~306: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... always returns the value, ignoring the ok flag. When ok is false, the returned ...
(OK)
[locale-violation] ~307-~307: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...the value, ignoring the ok flag. When ok is false, the returned value is typical...
(OK)
[uncategorized] ~312-~312: Possible missing article found.
Context: ...MaybeOK(As[any, T](value)). Returns converted value on success, or the zero value of ...
(AI_HYDRA_LEO_MISSING_THE)
[locale-violation] ~314-~314: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...he As[any, T] function, which returns (value, ok) for type conversion, allowing custom ...
(OK)
TESTING.md
[grammar] ~968-~968: Consider using “to” with “prefer”.
Context: ...t.Helper() in all helper functions. * Prefer table-driven tests over individual test functions. * Keep setup and clean-...
(PREFER_OVER_TO)
🔇 Additional comments (15)
testing.go (8)
12-33: LGTM! Excellent use of sentinel error pattern.The addition of
errMockTFailNowas a sentinel error for panic recovery is a clean implementation of the fail-fast pattern. The interface extensions maintain backwards compatibility whilst adding the necessary fatal methods.
37-51: Excellent documentation for the enhanced MockT capabilities.The comprehensive documentation clearly explains the Fatal/FailNow panic mechanism and provides practical examples of using the Run() method for testing assertion functions. This will be invaluable for users implementing fail-fast test patterns.
63-94: Good performance optimisation for thread safety.Pre-computing the formatted messages before acquiring mutex locks reduces lock contention time. This optimisation is applied consistently across all message methods without changing behaviour.
96-116: Solid implementation of fatal assertion methods.The Fatal and Fatalf methods correctly combine error recording with fail-fast behavior. The thread-safe implementation follows the established pattern of existing methods whilst adding the sentinel panic for recovery.
125-129: Correct implementation of FailNow semantics.The method properly calls Fail() before panicking with the sentinel error, matching the behavior of
testing.T.FailNow()whilst enabling recovery via the Run() method.
182-211: Excellent implementation of panic recovery for fatal assertions.The Run() method is well-designed with comprehensive nil checks, proper panic recovery that distinguishes FailNow panics from other panics, and clear documentation explaining its purpose. This enables robust testing of fatal assertion functions.
615-689: Consistent implementation of fail-fast assertion pattern.The AssertMust* functions correctly implement the fail-fast pattern by calling the underlying assertion functions and only invoking FailNow() on failure. The consistent documentation, proper Helper() usage, and maintained generic constraints ensure these will integrate seamlessly with existing test code.
690-816: Comprehensive completion of the fail-fast assertion framework.The remaining AssertMust* functions maintain the consistent fail-fast pattern. The special handling in AssertMustTypeIs to return the cast value on success is correctly implemented. This provides a complete toolkit for fail-fast assertions covering all testing scenarios.
TESTING.md (2)
115-135: Excellent documentation explaining fail-fast assertion behaviour.The clear distinction between
AssertFoo()(continue on failure) andAssertMustFoo()(terminate on failure) is well-explained with practical examples. The key difference summary effectively reinforces the concept for users.
858-878: Valuable addition explaining how to test fatal assertion scenarios.The new section provides essential guidance for testing functions that call Fatal/FailNow methods. The practical example clearly demonstrates how to use MockT.Run() to recover from panics and verify expected failure behaviour.
testing_test.go (4)
635-713: Comprehensive testing of fatal assertion functionality.The test suite thoroughly covers all aspects of the new Fatal/Fatalf/FailNow methods and the MockT.Run() recovery mechanism. Edge cases including nil checks and panic propagation are properly tested, providing confidence in the implementation's robustness.
715-831: Excellent validation of early abort patterns.The test suite effectively validates the common
if !Assert() { FailNow() }pattern, covering both successful continuation and proper abort scenarios. The mixed pattern testing demonstrates real-world usage and ensures the fail-fast behaviour works correctly in complex test scenarios.
833-849: Well-organised comprehensive test coverage for AssertMust functions.The systematic testing of all 14 AssertMust* functions with consistent naming and organisation ensures complete coverage of the fail-fast assertion helpers.
851-1182: Thorough and consistent testing of all AssertMust functions.Each AssertMust* function is comprehensively tested with both success (execution continues) and failure (execution aborts) scenarios. The consistent pattern across all tests and verification that post-failure code is unreachable confirms the correct implementation of fail-fast semantics.
README.md (1)
510-516: Minor wording & punctuation clean-up in the “Fatal Assertions” intro.
- Line-length is > 80 chars.
- Missing full stop after Line 515.
- “similar to
t.Error()vst.Fatal()” reads more fluently.[ suggest_nitpick ]
- methods terminate execution, similar to `t.Error()` vs `t.Fatal()`. + methods terminate execution — similar to `t.Error()` vs `t.Fatal()`.
…t tests
Add Fatal, Fatalf, and FailNow methods to T interface for complete
testing.T compatibility. Implement thread-safe versions in MockT with
proper panic behaviour using special errMockTFailNow error.
Add Run() method to MockT for panic recovery, enabling testing of
assertion functions that may call Fatal/FailNow methods. The Run method
executes test functions and recovers from FailNow panics whilst
propagating other panics.
Optimise MockT performance by assembling formatted messages before
acquiring mutex locks in Fatal/Fatalf methods, reducing contention in
concurrent scenarios.
Add comprehensive test coverage for early abort pattern
(if !Assert() { FailNow() }) demonstrating proper behaviour with MockT.
Tests verify successful assertions continue execution whilst failed
assertions abort immediately.
Update documentation in README.md, TESTING.md, and TESTING_core.md to
reflect new Fatal/FailNow capabilities and provide usage examples.
All tests pass with 97.0% coverage.
Signed-off-by: Alejandro Mery <amery@apptly.co>
Add MustT[T] and MaybeT[T] functions for type conversion, building on the existing As[any, T] function: * MustT[T](value any) T - equivalent to MustOK(As[any, T](value)). Returns converted value or panics with PanicError if type conversion fails. * MaybeT[T](value any) T - equivalent to MaybeOK(As[any, T](value)). Returns converted value on success, or zero value of type T if conversion fails. These utilities follow the established pattern where Must* functions panic on failure whilst Maybe* functions return zero values, composing naturally with the existing As/MustOK/MaybeOK building blocks. The single generic parameter design provides a clean interface where you only specify the target type, accepting any value as input for maximum flexibility in type conversion scenarios. Add comprehensive test coverage with separate test cases for successful conversions, panic scenarios, and zero value handling. Tests demonstrate type conversion across basic types (string, int, float64), interfaces (error, fmt.Stringer), and failure cases. Update documentation in README.md to show the clear relationships between utilities and make explicit the role of zero values in Maybe* functions. Add examples demonstrating the composability: MustT = MustOK(As[any, T]) and MaybeT = MaybeOK(As[any, T]), with As[any, T] as the building block for custom handling of conversion failures. All tests pass with 97.1% coverage. Signed-off-by: Alejandro Mery <amery@apptly.co>
…failure
Add 14 new AssertMustFoo() functions that automatically call t.FailNow()
when assertions fail, providing a cleaner alternative to the manual
`if !AssertFoo() { t.FailNow() }` pattern.
New functions follow Go testing conventions where "Fatal" methods
terminate execution, similar to t.Error() vs t.Fatal():
- AssertMustEqual[T], AssertMustNotEqual[T], AssertMustSliceEqual[T]
- AssertMustTrue, AssertMustFalse, AssertMustNil, AssertMustNotNil
- AssertMustContains, AssertMustError, AssertMustNoError, AssertMustErrorIs
- AssertMustPanic, AssertMustNoPanic, AssertMustTypeIs[T]
All functions include comprehensive tests using MockT.Run() to verify
both success (execution continues) and failure (t.FailNow() called,
execution terminates) scenarios.
Documentation added to README.md with clear explanation of Error vs
Fatal patterns and usage examples.
Signed-off-by: Alejandro Mery <amery@apptly.co>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
TESTING.md (2)
117-120: Wrap long sentence to respect 80-character limitLine 118 runs past the markdownlint 80-character limit.
Re-flowing keeps the file compliant without changing semantics.- and automatically call `t.FailNow()` if the assertion fails, terminating test execution immediately: +and automatically call `t.FailNow()` if the assertion fails, +terminating test execution immediately:
858-878: Terminate descriptive paragraph with a full stop and keep lines shortThe introductory text at Lines 860-862 exceeds 80 characters and ends
without a period. Consider adding a full stop and wrapping:-MockT supports testing functions that call Fatal/FailNow methods via the `Run()` -method, which recovers from FailNow panics: +MockT supports testing functions that call **Fatal**/`FailNow` methods via +the `Run()` method, which recovers from `FailNow` panics.README.md (1)
301-314: Use “OK” instead of “ok” in prose and clarify the articleLanguageTool flags “ok” as American English. Capitalising also avoids
confusion with the back-ticked parameter name.-* `MustOK[T](value T, ok bool) T` - returns value or panics with `PanicError` if - ok is false. Useful for operations that should always succeed, such as map +* `MustOK[T](value T, ok bool) T` - returns value or panics with `PanicError` + if **OK** is false. Useful for operations that should always succeed, such as + map @@ -* `MaybeOK[T](value T, ok bool) T` - always returns the value, ignoring the ok - flag. When ok is false, the returned value is typically the zero value of - type T from the failed operation. +* `MaybeOK[T](value T, ok bool) T` - always returns the value, ignoring the + **OK** flag. When **OK** is false, the returned value is typically the zero + value of type T from the failed operation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
README.md(4 hunks)TESTING.md(7 hunks)TESTING_core.md(2 hunks)internal/build/cspell.json(1 hunks)panic.go(1 hunks)panic_test.go(2 hunks)testing.go(6 hunks)testing_test.go(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- panic.go
- internal/build/cspell.json
- TESTING_core.md
- panic_test.go
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{md,go}
📄 CodeRabbit Inference Engine (AGENT.md)
Check spelling in both Markdown and Go source files using CSpell with configuration in internal/build/cspell.json.
Files:
testing_test.gotesting.goREADME.mdTESTING.md
**/*.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.go: Use Go 1.23+ generics for type-safe utilities.
Enforce strict linting rules via revive as configured in internal/build/revive.toml: max function length 40 lines, max function results 3, max arguments 5, cognitive complexity 7, cyclomatic complexity 10.
Enforce struct field alignment optimization for memory efficiency using the fieldalignment tool.
Use golangci-lint with configuration in .golangci.yml for comprehensive Go code linting.
Files:
testing_test.gotesting.go
**/*_test.go
📄 CodeRabbit Inference Engine (AGENT.md)
**/*_test.go: Prefer table-driven tests for Go code.
Use helper functions like ST, AssertEqualT, AssertSliceEqualT, AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Provide comprehensive coverage for generic functions.
Files:
testing_test.go
**/*.md
📄 CodeRabbit Inference Engine (AGENT.md)
**/*.md: Enforce Markdown formatting rules, including 80-character line limits and strict formatting, using markdownlint with configuration in internal/build/markdownlint.json.
Check Markdown files for grammar and style issues using LanguageTool with configuration in internal/build/languagetool.cfg.
When editing Markdown files, ensure compliance with LanguageTool, CSpell, and Markdownlint.
End all bullet points in Markdown files with periods for consistency.
Capitalize proper nouns correctly (JavaScript, TypeScript, Markdown) in documentation.
Use consistent punctuation in examples and lists in documentation.
Provide context and 'why' explanations in documentation, not just 'what' descriptions.
Add examples for complex concepts or common pitfalls in documentation.
Update documentation when adding new tools or changing workflows.
Keep the pre-commit checklist current with project practices.
Review documentation changes for missing articles, punctuation, and compound modifiers.
Files:
README.mdTESTING.md
README.md
📄 CodeRabbit Inference Engine (AGENT.md)
Update README.md to reflect significant changes in functionality or API.
Files:
README.md
🧠 Learnings (17)
📓 Common learnings
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
📚 Learning: applies to **/*_test.go : use helper functions like s[t](), assertequal[t](), assertsliceequal[t](),...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Use helper functions like S[T](), AssertEqual[T](), AssertSliceEqual[T](), AssertError(), AssertBool(), AssertPanic(), AssertNoPanic(), RunConcurrentTest(), RunBenchmark(), and RunTestCases() in testutils_test.go to reduce boilerplate and improve test consistency.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to **/*_test.go : provide comprehensive coverage for generic functions....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Provide comprehensive coverage for generic functions.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to **/*_test.go : prefer table-driven tests for go code....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*_test.go : Prefer table-driven tests for Go code.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: in go test functions using assertion helpers like assertsame, assertequal, etc., early returns after...
Learnt from: amery
PR: darvaza-proxy/core#135
File: compounderror_test.go:201-201
Timestamp: 2025-08-05T22:27:53.946Z
Learning: In Go test functions using assertion helpers like AssertSame, AssertEqual, etc., early returns after assertion calls are only necessary when there is subsequent code that should be skipped if the assertion fails. At the end of a function or code block where no further operations follow, the early return pattern is redundant since the function will naturally return anyway.
Applied to files:
testing_test.gotesting.goREADME.mdTESTING.md
📚 Learning: applies to readme.md : update readme.md to reflect significant changes in functionality or api....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to README.md : Update README.md to reflect significant changes in functionality or API.
Applied to files:
README.mdTESTING.md
📚 Learning: applies to **/*.go : use go 1.23+ generics for type-safe utilities....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.go : Use Go 1.23+ generics for type-safe utilities.
Applied to files:
README.md
📚 Learning: applies to agent.md : update `agent.md` to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to AGENT.md : Update `AGENT.md` to reflect any changes in development workflow or standards.
Applied to files:
README.md
📚 Learning: applies to agent.md : update agent.md to reflect any changes in development workflow or standards....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to AGENT.md : Update AGENT.md to reflect any changes in development workflow or standards.
Applied to files:
README.md
📚 Learning: applies to **/*.md : add examples for complex concepts or common pitfalls in documentation....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.md : Add examples for complex concepts or common pitfalls in documentation.
Applied to files:
TESTING.md
📚 Learning: applies to **/*.md : review documentation changes for missing articles, punctuation, and compound mo...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Applies to **/*.md : Review documentation changes for missing articles, punctuation, and compound modifiers.
Applied to files:
TESTING.md
📚 Learning: use only the go standard library and minimal golang.org/x packages; zero external dependencies....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Use only the Go standard library and minimal golang.org/x packages; zero external dependencies.
Applied to files:
TESTING.md
📚 Learning: always run make tidy first before committing: go code formatting and whitespace clean-up, markdown f...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: ALWAYS run make tidy first before committing: Go code formatting and whitespace clean-up, Markdown files checked with CSpell and markdownlint, Shell scripts checked with shellcheck.
Applied to files:
TESTING.md
📚 Learning: applies to **/*.go : max function results: 3....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: Applies to **/*.go : Max function results: 3.
Applied to files:
TESTING.md
📚 Learning: always run make tidy which includes golangci-lint checks....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Always run make tidy which includes golangci-lint checks.
Applied to files:
TESTING.md
📚 Learning: verify all tests pass with make test before committing....
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-08-04T16:07:42.136Z
Learning: Verify all tests pass with make test before committing.
Applied to files:
TESTING.md
📚 Learning: always run `make tidy` first before committing: fix all issues (go formatting, whitespace, cspell, m...
Learnt from: CR
PR: darvaza-proxy/core#0
File: AGENT.md:0-0
Timestamp: 2025-07-18T16:39:19.390Z
Learning: ALWAYS run `make tidy` first before committing: fix all issues (Go formatting, whitespace, CSpell, markdownlint, shellcheck).
Applied to files:
TESTING.md
🧬 Code Graph Analysis (1)
testing_test.go (1)
testing.go (21)
T(22-33)MockT(45-51)AssertFalse(436-439)AssertTrue(421-424)AssertEqual(263-272)AssertPanic(368-385)AssertMustEqual(622-627)AssertMustNotEqual(636-641)AssertMustSliceEqual(650-655)S(225-230)AssertMustContains(664-669)AssertMustError(678-683)AssertMustNoError(692-697)AssertMustPanic(706-711)AssertMustNoPanic(720-725)AssertMustTrue(736-741)AssertMustFalse(752-757)AssertMustErrorIs(766-771)AssertMustTypeIs(781-788)AssertMustNil(797-802)AssertMustNotNil(811-816)
🪛 LanguageTool
README.md
[locale-violation] ~304-~304: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... value or panics with PanicError if ok is false. Useful for operations that sh...
(OK)
[locale-violation] ~306-~306: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ... always returns the value, ignoring the ok flag. When ok is false, the returned ...
(OK)
[locale-violation] ~307-~307: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...the value, ignoring the ok flag. When ok is false, the returned value is typical...
(OK)
[uncategorized] ~312-~312: Possible missing article found.
Context: ...MaybeOK(As[any, T](value)). Returns converted value on success, or the zero value of ...
(AI_HYDRA_LEO_MISSING_THE)
[locale-violation] ~314-~314: Lower-case ‘ok’ is American English. For British English use “OK”.
Context: ...he As[any, T] function, which returns (value, ok) for type conversion, allowing custom ...
(OK)
TESTING.md
[grammar] ~968-~968: Consider using “to” with “prefer”.
Context: ...t.Helper() in all helper functions. * Prefer table-driven tests over individual test functions. * Keep setup and clean-...
(PREFER_OVER_TO)
🔇 Additional comments (18)
testing.go (10)
12-12: Excellent sentinel error implementation.The sentinel error follows Go best practices and provides clear identification for FailNow panics in the panic recovery mechanism.
26-27: LGTM! Interface properly extended with fatal methods.The T interface now fully matches Go's testing.T interface with the addition of Fatal, Fatalf, and FailNow methods. This maintains compatibility whilst enabling full testing functionality.
Also applies to: 31-31
37-44: Comprehensive documentation for MockT enhancements.The documentation clearly explains the fatal method behaviour, panic recovery mechanism, and provides practical usage examples. This will help users understand how to test assertion functions that call Fatal methods.
63-63: Improved message formatting consistency.The change to use
fmt.Sprintandfmt.Sprintfensures consistent formatting of arguments across all MockT methods, which is more robust than direct string concatenation.Also applies to: 66-66, 73-73, 76-76, 82-82, 85-85, 90-90, 93-93
96-105: Excellent Fatal method implementation.The method correctly combines Error and FailNow functionality, maintains thread safety with proper mutex usage, and uses the sentinel error for controlled panic recovery. The implementation mirrors Go's testing.T.Fatal behaviour perfectly.
107-116: Consistent Fatalf implementation.The method follows the same pattern as Fatal whilst properly handling formatted messages. Thread safety and panic recovery are correctly implemented.
125-129: Clean FailNow implementation.The method correctly reuses the existing Fail() method and uses the sentinel error for panic recovery. Simple and effective implementation that mirrors testing.T.FailNow.
182-211: Robust Run method with excellent panic recovery.The implementation includes comprehensive nil checks, proper panic recovery that distinguishes between FailNow and other panics, and excellent documentation with practical examples. This enables effective testing of fatal assertion functions.
615-627: Well-implemented fatal assertion pattern.AssertMustEqual correctly follows the fail-fast pattern by calling the underlying assertion and then FailNow on failure. The generic type constraint and documentation are appropriate.
629-816: Comprehensive and consistent AssertMust function suite.*All 13 remaining AssertMust* functions follow the same reliable pattern: delegate to the underlying assertion, call FailNow() on failure, and include proper documentation. AssertMustTypeIs correctly returns the cast value on success. The implementation is consistent, well-documented, and provides the fail-fast semantics described in the PR objectives.
testing_test.go (6)
635-674: Comprehensive testing of MockT fatal methods.The tests properly use MockT.Run for panic recovery and verify correct behaviour: Fatal/Fatalf record error messages and mark tests as failed, whilst FailNow only marks as failed without recording errors. The test patterns are well-structured and comprehensive.
676-713: Thorough testing of MockT.Run method edge cases.The tests comprehensively cover successful execution, nil parameter handling, and proper panic propagation for non-FailNow panics. The use of AssertPanic to test panic propagation is appropriate and demonstrates the method's robustness.
715-831: Excellent demonstration of early abort patterns.The tests comprehensively demonstrate the early abort pattern with various scenarios: successful continuation, failed abortion, multiple assertions, and mixed patterns. The tests clearly show the difference between regular assertions and early abort patterns, with proper verification of execution flow.
833-849: Well-organised test structure for AssertMust functions.*The use of subtests provides clear organisation for testing all 14 AssertMust* functions. This structure makes it easy to run individual tests and understand test coverage.
851-1013: Consistent and thorough testing of AssertMust functions (first half).*All tests follow the same reliable pattern: test success cases that allow execution to continue and failure cases that abort execution via FailNow. The verification of log counts and error states properly demonstrates the fail-fast semantics.
1015-1182: Comprehensive completion of AssertMust function testing.*The remaining tests maintain the same high standard with consistent success/failure patterns. AssertMustTypeIs correctly tests both the return value on success and abort behaviour on failure. The comprehensive coverage aligns well with the coding guidelines for generic function testing.
README.md (2)
472-474: LGTM – clear description of the enhanced MockTThe added sentence accurately documents
MockT.Run()and its Fatal/FailNow
behaviour. No issues spotted.
510-558: LGTM – exhaustive fatal assertion listThe list is complete, consistently punctuated, and follows the documented
naming conventions.
karasz
left a comment
karasz
left a comment
There was a problem hiding this comment.
awesome, especially this:
func (m *MockT) Run(_ string, f func(T)) (ok bool) {
if m == nil || f == nil {
return false
}
defer func() {
if r := recover(); r != nil && r != errMockTFailNow {
panic(r) // Re-panic non-FailNow errors
}
}()
f(m)
return !m.Failed()
}
|
Released as v0.18.1. go get darvaza.org/core@v0.18.1 |
User description
feat: Add Testing Infrastructure Enhancements and Generic Type Utilities
Summary
This PR adds comprehensive testing infrastructure enhancements with Fatal/
FailNow support and introduces new generic type conversion utilities. The
changes focus on improving test reliability through early abort mechanisms
and providing robust type conversion patterns.
Key Changes
Testing Infrastructure Enhancements
the T interface with thread-safe MockT implementation using panic recovery.
t.FailNow()on failure, providing cleaner alternatives to manual errorhandling patterns.
on assertion failure rather than continuing with invalid state.
functions that may call Fatal/FailNow methods.
Generic Type Conversion Utilities
direct type assertions for consistent error handling.
messages including source and target type information.
graceful degradation for non-critical conversions.
specification, accepting any value as input.
Technical Details
Testing Framework Improvements
The enhanced testing infrastructure provides:
Type Conversion Design
The MustT/MaybeT utilities provide:
Coverage and Documentation
Breaking Changes
None. All changes are additive and maintain backward compatibility.
Files Modified
Core Functionality
panic.go: Added MustT/MaybeT generic type conversion utilities.testing.go: Enhanced with Fatal/FailNow support and AssertMustFoo variants.Documentation
README.md: Updated with new utility explanations and usage examples.TESTING.md: Enhanced with Fatal/FailNow testing patterns.TESTING_core.md: Updated with comprehensive testing guidelines.Test Coverage
panic_test.go: Comprehensive tests for type conversion utilities.testing_test.go: Enhanced tests for Fatal/FailNow functionality.internal/build/cspell.json: Updated dictionary for technical terms.PR Type
Enhancement, Tests
Description
Add comprehensive Fatal/FailNow support to testing infrastructure
Introduce MustT/MaybeT generic type conversion utilities
Add 14 AssertMustFoo functions for early test termination
Enhance MockT with panic recovery capabilities
Diagram Walkthrough
File Walkthrough
panic.go
Add generic type conversion utilitiespanic.go
MustT[T](value any) Tfunction for type conversion with panic onfailure
MaybeT[T](value any) Tfunction for type conversion with zerovalue fallback
testing.go
Add Fatal/FailNow support and early abort assertionstesting.go
Fatal,Fatalf, andFailNowmethods to T interfaceRun()method to MockT for testing functions that callFatal/FailNow
AssertMustFoofunctions that callFailNow()on assertionfailure
locks
panic_test.go
Add comprehensive tests for type conversion utilitiespanic_test.go
MustTsuccess and panic scenariosMaybeTwith successful and failed conversionsmockStringertype for interface testingtesting_test.go
Add comprehensive tests for Fatal/FailNow functionalitytesting_test.go
functions
README.md
Update documentation for new utilitiesREADME.md
TESTING.md
Add Fatal assertion documentation and patternsTESTING.md
TESTING_core.md
Update core testing documentationTESTING_core.md
cspell.json
Update spell check dictionaryinternal/build/cspell.json
Summary by CodeRabbit
New Features
Documentation
Tests
Chores