Files
f2b/fail2ban/fail2ban_concurrency_test.go
Ismo Vuorinen 605f2b9580 refactor: linting, simplification and fixes (#119)
* 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.
2026-01-25 19:07:45 +02:00

290 lines
7.3 KiB
Go

package fail2ban
import (
"runtime"
"sync"
"testing"
"time"
)
// TestRunnerConcurrentAccess tests that concurrent access to the runner
// is safe and doesn't cause race conditions.
func TestRunnerConcurrentAccess(t *testing.T) {
defer WithTestRunner(t, GetRunner())()
const numGoroutines = 100
const numOperations = 50
var wg sync.WaitGroup
// Test concurrent SetRunner/GetRunner operations
for i := 0; i < numGoroutines; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
// Alternate between different mock runners
if (id+j)%2 == 0 {
mockRunner := NewMockRunner()
mockRunner.SetResponse("test", []byte("response"))
SetRunner(mockRunner)
} else {
SetRunner(&OSRunner{})
}
// Get runner and verify it's not nil
runner := GetRunner()
if runner == nil {
t.Errorf("GetRunner() returned nil")
return
}
// Force small delay to increase chances of race condition
runtime.Gosched()
}
}(i)
}
wg.Wait()
}
// TestRunnerCombinedOutputConcurrency tests that concurrent calls to
// RunnerCombinedOutput are safe.
func TestRunnerCombinedOutputConcurrency(t *testing.T) {
mockRunner := NewMockRunner()
defer WithTestRunner(t, mockRunner)()
mockRunner.SetResponse("echo test", []byte("test output"))
const numGoroutines = 50
var wg sync.WaitGroup
for i := 0; i < numGoroutines; i++ {
wg.Add(1)
go func() {
defer wg.Done()
output, err := RunnerCombinedOutput("echo", "test")
if err != nil {
t.Errorf("RunnerCombinedOutput failed: %v", err)
return
}
if string(output) != "test output" {
t.Errorf("Expected 'test output', got '%s'", string(output))
}
}()
}
wg.Wait()
}
// TestRunnerCombinedOutputWithSudoConcurrency tests concurrent calls to
// RunnerCombinedOutputWithSudo.
func TestRunnerCombinedOutputWithSudoConcurrency(t *testing.T) {
// Set up mock environment with root privileges to avoid sudo prefix
_, cleanup := SetupMockEnvironment(t)
defer cleanup()
// Get the mock runner and configure additional responses
mockRunner := GetRunner().(*MockRunner)
mockRunner.SetResponse("fail2ban-client status", []byte("status output"))
const numGoroutines = 50
var wg sync.WaitGroup
for i := 0; i < numGoroutines; i++ {
wg.Add(1)
go func() {
defer wg.Done()
output, err := RunnerCombinedOutputWithSudo("fail2ban-client", "status")
if err != nil {
t.Errorf("RunnerCombinedOutputWithSudo failed: %v", err)
return
}
if string(output) != "status output" {
t.Errorf("Expected 'status output', got '%s'", string(output))
}
}()
}
wg.Wait()
}
// TestMixedConcurrentOperations tests mixed concurrent operations including
// setting runners and executing commands.
func TestMixedConcurrentOperations(t *testing.T) {
// Set up a single shared MockRunner with all required responses
// This avoids race conditions from multiple goroutines setting different runners
sharedMockRunner := NewMockRunner()
defer WithTestRunner(t, sharedMockRunner)()
// Set up responses for valid fail2ban commands to avoid validation errors
sharedMockRunner.SetResponse("fail2ban-client status", []byte("Status: OK"))
sharedMockRunner.SetResponse("fail2ban-client -V", []byte("Version: 1.0.0"))
// Set up both sudo and non-sudo versions to handle different execution paths
sharedMockRunner.SetResponse("sudo fail2ban-client status", []byte("Status: OK"))
sharedMockRunner.SetResponse("sudo fail2ban-client -V", []byte("Version: 1.0.0"))
const numGoroutines = 30
var wg sync.WaitGroup
// Group 1: Set runners (now just validates that setting runners works concurrently)
for i := 0; i < numGoroutines/3; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 20; j++ {
// Create a new runner with the same responses to test concurrent setting
mockRunner := NewMockRunner()
mockRunner.SetResponse("fail2ban-client status", []byte("Status: OK"))
mockRunner.SetResponse("fail2ban-client -V", []byte("Version: 1.0.0"))
mockRunner.SetResponse("sudo fail2ban-client status", []byte("Status: OK"))
mockRunner.SetResponse("sudo fail2ban-client -V", []byte("Version: 1.0.0"))
SetRunner(mockRunner)
time.Sleep(time.Millisecond)
}
}()
}
// Group 2: Execute regular commands (using valid fail2ban commands)
for i := 0; i < numGoroutines/3; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 20; j++ {
output, err := RunnerCombinedOutput("fail2ban-client", "status")
if err != nil {
t.Errorf("RunnerCombinedOutput failed: %v", err)
}
if len(output) == 0 {
t.Error("RunnerCombinedOutput returned empty output")
}
time.Sleep(time.Millisecond)
}
}()
}
// Group 3: Execute sudo commands (using valid fail2ban commands)
for i := 0; i < numGoroutines/3; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 20; j++ {
output, err := RunnerCombinedOutputWithSudo("fail2ban-client", "-V")
if err != nil {
t.Errorf("RunnerCombinedOutputWithSudo failed: %v", err)
}
if len(output) == 0 {
t.Error("RunnerCombinedOutputWithSudo returned empty output")
}
time.Sleep(time.Millisecond)
}
}()
}
wg.Wait()
}
// TestRunnerManagerLockOrdering verifies there are no deadlocks in the
// runner manager's lock ordering.
func TestRunnerManagerLockOrdering(t *testing.T) {
defer WithTestRunner(t, GetRunner())()
// This test specifically looks for deadlocks by creating scenarios
// where multiple goroutines could potentially deadlock if locks
// are not acquired/released properly.
done := make(chan bool, 1)
timeout := time.After(5 * time.Second)
go func() {
var wg sync.WaitGroup
// Multiple goroutines doing mixed operations
for i := 0; i < 20; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 100; j++ {
SetRunner(NewMockRunner())
GetRunner()
_, _ = RunnerCombinedOutput("test")
_, _ = RunnerCombinedOutputWithSudo("test")
}
}()
}
wg.Wait()
done <- true
}()
select {
case <-done:
// Test completed successfully
case <-timeout:
t.Fatal("Test timed out - potential deadlock detected")
}
}
// TestRunnerStateConsistency verifies that the runner state remains
// consistent across concurrent operations.
func TestRunnerStateConsistency(t *testing.T) {
// Set initial state
initialRunner := NewMockRunner()
initialRunner.SetResponse("initial", []byte("initial response"))
defer WithTestRunner(t, initialRunner)()
const numReaders = 50
const numWriters = 10
var wg sync.WaitGroup
// Multiple readers
for i := 0; i < numReaders; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 100; j++ {
runner := GetRunner()
if runner == nil {
t.Errorf("GetRunner() returned nil")
return
}
runtime.Gosched()
}
}()
}
// Fewer writers
for i := 0; i < numWriters; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 10; j++ {
mockRunner := NewMockRunner()
mockRunner.SetResponse("test", []byte("test response"))
mockRunner.SetResponse("echo test", []byte("test response"))
mockRunner.SetResponse("fail2ban-client status", []byte("test response"))
SetRunner(mockRunner)
time.Sleep(time.Microsecond)
}
}()
}
wg.Wait()
// Verify final state is consistent
finalRunner := GetRunner()
if finalRunner == nil {
t.Fatal("Final runner state is nil")
}
}