mirror of
https://github.com/ivuorinen/f2b.git
synced 2026-01-26 03:13:58 +00:00
Ismo Vuorinen
605f2b9580
* refactor: consolidate test helpers and reduce code duplication
- Fix prealloc lint issue in cmd_logswatch_test.go
- Add validateIPAndJails helper to consolidate IP/jail validation
- Add WithTestRunner/WithTestSudoChecker helpers for cleaner test setup
- Replace setupBasicMockResponses duplicates with StandardMockSetup
- Add SetupStandardResponses/SetupJailResponses to MockRunner
- Delegate cmd context helpers to fail2ban implementations
- Document context wrapper pattern in context_helpers.go
* refactor: consolidate duplicate code patterns across cmd and fail2ban packages
Add helper functions to reduce code duplication found by dupl:
- safeCloseFile/safeCloseReader: centralize file close error logging
- createTimeoutContext: consolidate timeout context creation pattern
- withContextCheck: wrap context cancellation checks
- recordOperationMetrics: unify metrics recording for commands/clients
Also includes Phase 1 consolidations:
- copyBuckets helper for metrics snapshots
- Table-driven context extraction in logging
- processWithValidation helper for IP processors
* refactor: consolidate LoggerInterface by embedding LoggerEntry
Both interfaces had identical method signatures. LoggerInterface now
embeds LoggerEntry to eliminate code duplication.
* refactor: consolidate test framework helpers and fix test patterns
- Add checkJSONFieldValue and failMissingJSONField helpers to reduce
duplication in JSON assertion methods
- Add ParallelTimeout to default test config
- Fix test to use WithTestRunner inside test loop for proper mock scoping
* refactor: unify ban/unban operations with OperationType pattern
Introduce OperationType struct to consolidate duplicate ban/unban logic:
- Add ProcessOperation and ProcessOperationWithContext generic functions
- Add ProcessOperationParallel and ProcessOperationParallelWithContext
- Existing ProcessBan*/ProcessUnban* functions now delegate to generic versions
- Reduces ~120 lines of duplicate code between ban and unban operations
* refactor: consolidate time parsing cache pattern
Add ParseWithLayout method to BoundedTimeCache that consolidates the
cache-lookup-parse-store pattern. FastTimeCache and TimeParsingCache
now delegate to this method instead of duplicating the logic.
* refactor: consolidate command execution patterns in fail2ban
- Add validateCommandExecution helper for command/argument validation
- Add runWithTimerContext helper for timed runner operations
- Add executeIPActionWithContext to unify BanIP/UnbanIP implementations
- Reduces duplicate validation and execution boilerplate
* refactor: consolidate logrus adapter with embedded loggerCore
Introduce loggerCore type that provides the 8 standard logging methods
(Debug, Info, Warn, Error, Debugf, Infof, Warnf, Errorf). Both
logrusAdapter and logrusEntryAdapter now embed this type, eliminating
16 duplicate method implementations.
* refactor: consolidate path validation patterns
- Add validateConfigPathWithFallback helper in cmd/config_utils.go
for the validate-or-fallback-with-logging pattern
- Add validateClientPath helper in fail2ban/helpers.go for client
path validation delegation
* fix: add context cancellation checks to wrapper functions
- wrapWithContext0/1/2 now check ctx.Err() before invoking wrapped function
- WithCommand now validates and trims empty command strings
* refactor: extract formatLatencyBuckets for deterministic metrics output
Add formatLatencyBuckets helper that writes latency bucket distribution
with sorted keys for deterministic output, eliminating duplicate
formatting code for command and client latency buckets.
* refactor: add generic setNestedMapValue helper for mock configuration
Add setNestedMapValue[T] generic helper that consolidates the repeated
pattern of mutex-protected nested map initialization and value setting
used by SetBanError, SetBanResult, SetUnbanError, and SetUnbanResult.
* fix: use cmd.Context() for signal propagation and correct mock status
- ExecuteIPCommand now uses cmd.Context() instead of context.Background()
to inherit Cobra's signal cancellation
- MockRunner.SetupJailResponses uses shared.Fail2BanStatusSuccess ("0")
instead of literal "1" for proper success path simulation
* fix: restore operation-specific log messages in ProcessOperationWithContext
Add back Logger.WithFields().Info(opType.Message) call that was lost
during refactoring. This restores the distinction between ban and unban
operation messages (shared.MsgBanResult vs shared.MsgUnbanResult).
* fix: return aggregated errors from parallel operations
Previously, errors from individual parallel operations were silently
swallowed - converted to status strings but never returned to callers.
Now processOperations collects all errors and returns them aggregated
via errors.Join, allowing callers to distinguish partial failures from
complete success while still receiving all results.
* fix: add input validation to processOperations before parallel execution
Validate IP and jail inputs at the start of processOperations() using
fail2ban.CachedValidateIP and CachedValidateJail. This prevents invalid
or malicious inputs (empty values, path traversal attempts, malformed
IPs) from reaching the operation functions. All validation errors are
aggregated and returned before any operations execute.
62 lines
2.2 KiB
Go
62 lines
2.2 KiB
Go
package fail2ban
|
|
|
|
import "context"
|
|
|
|
// Context Wrapper Pattern
|
|
//
|
|
// This package provides generic helper functions for creating WithContext method wrappers.
|
|
// These helpers eliminate boilerplate for methods that simply need context propagation
|
|
// without additional logic.
|
|
//
|
|
// For simple methods (no validation, direct delegation to non-context version):
|
|
//
|
|
// func (c *Client) ListJailsWithContext(ctx context.Context) ([]string, error) {
|
|
// return wrapWithContext0(c.ListJails)(ctx)
|
|
// }
|
|
//
|
|
// For complex methods (validation, custom logic, different execution paths):
|
|
// Implement the WithContext version directly with the required logic.
|
|
//
|
|
// Note: Code generation was evaluated but determined unnecessary because:
|
|
// - Only 2 methods use the simple wrapper pattern
|
|
// - Most WithContext methods require custom validation/logic
|
|
// - The generic helpers below already solve the simple cases cleanly
|
|
|
|
// Helper functions to reduce boilerplate in WithContext implementations
|
|
|
|
// wrapWithContext0 wraps a function with no parameters to accept a context parameter.
|
|
// It checks for context cancellation before invoking the underlying function.
|
|
func wrapWithContext0[T any](fn func() (T, error)) func(context.Context) (T, error) {
|
|
return func(ctx context.Context) (T, error) {
|
|
if err := ctx.Err(); err != nil {
|
|
var zero T
|
|
return zero, err
|
|
}
|
|
return fn()
|
|
}
|
|
}
|
|
|
|
// wrapWithContext1 wraps a function with one parameter to accept a context parameter.
|
|
// It checks for context cancellation before invoking the underlying function.
|
|
func wrapWithContext1[T any, A any](fn func(A) (T, error)) func(context.Context, A) (T, error) {
|
|
return func(ctx context.Context, a A) (T, error) {
|
|
if err := ctx.Err(); err != nil {
|
|
var zero T
|
|
return zero, err
|
|
}
|
|
return fn(a)
|
|
}
|
|
}
|
|
|
|
// wrapWithContext2 wraps a function with two parameters to accept a context parameter.
|
|
// It checks for context cancellation before invoking the underlying function.
|
|
func wrapWithContext2[T any, A any, B any](fn func(A, B) (T, error)) func(context.Context, A, B) (T, error) {
|
|
return func(ctx context.Context, a A, b B) (T, error) {
|
|
if err := ctx.Err(); err != nil {
|
|
var zero T
|
|
return zero, err
|
|
}
|
|
return fn(a, b)
|
|
}
|
|
}
|