Files
f2b/cmd/test_framework_additional_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

256 lines
6.6 KiB
Go

package cmd
import (
"bytes"
"context"
"testing"
"time"
"github.com/spf13/cobra"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/ivuorinen/f2b/fail2ban"
)
// TestOutputOperationResults tests the outputOperationResults function
func TestOutputOperationResults(t *testing.T) {
tests := []struct {
name string
results []OperationResult
config *Config
format string
expectOut string
}{
{
name: "json format output",
results: []OperationResult{
{IP: "192.168.1.1", Jail: "sshd", Status: "Banned"},
},
config: &Config{Format: JSONFormat},
format: JSONFormat,
expectOut: "192.168.1.1",
},
{
name: "plain format output",
results: []OperationResult{
{IP: "192.168.1.1", Jail: "sshd", Status: "Banned"},
},
config: &Config{Format: PlainFormat},
format: PlainFormat,
expectOut: "192.168.1.1",
},
{
name: "multiple results",
results: []OperationResult{
{IP: "192.168.1.1", Jail: "sshd", Status: "Banned"},
{IP: "192.168.1.2", Jail: "apache", Status: "Banned"},
},
config: &Config{Format: PlainFormat},
format: PlainFormat,
expectOut: "192.168.1.1",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cmd := &cobra.Command{}
var buf bytes.Buffer
cmd.SetOut(&buf)
err := outputOperationResults(cmd, tt.results, tt.config, tt.format)
assert.NoError(t, err)
output := buf.String()
assert.Contains(t, output, tt.expectOut)
})
}
}
// TestValidateConfigPath tests the validateConfigPath function
func TestValidateConfigPath(t *testing.T) {
tests := []struct {
name string
path string
pathType string
expectError bool
}{
{
name: "valid absolute path",
path: "/etc/fail2ban",
pathType: "log",
expectError: false,
},
{
name: "empty path",
path: "",
pathType: "log",
expectError: true,
},
{
name: "relative path",
path: "config/fail2ban",
pathType: "filter",
expectError: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := validateConfigPath(tt.path, tt.pathType)
if tt.expectError {
assert.Error(t, err)
} else {
// Path validation might fail for non-existent paths
_ = err
}
})
}
}
// TestLogsWatchCmdCreation tests LogsWatchCmd creation
func TestLogsWatchCmdCreation(t *testing.T) {
mockRunner := fail2ban.NewMockRunner()
defer fail2ban.WithTestRunner(t, mockRunner)()
mockRunner.SetResponse("fail2ban-client -V", []byte("Fail2Ban v0.11.0"))
mockRunner.SetResponse("sudo fail2ban-client -V", []byte("Fail2Ban v0.11.0"))
mockRunner.SetResponse("fail2ban-client ping", []byte("Server replied: pong"))
mockRunner.SetResponse("sudo fail2ban-client ping", []byte("Server replied: pong"))
mockRunner.SetResponse("fail2ban-client status", []byte("Status\n|- Number of jail: 1\n`- Jail list: sshd"))
mockRunner.SetResponse("sudo fail2ban-client status", []byte("Status\n|- Number of jail: 1\n`- Jail list: sshd"))
client, err := fail2ban.NewClient("/var/log/fail2ban", "/etc/fail2ban/filter.d")
require.NoError(t, err)
ctx := context.Background()
config := &Config{Format: PlainFormat}
cmd := LogsWatchCmd(ctx, client, config)
require.NotNil(t, cmd)
assert.Equal(t, "logs-watch [jail] [ip]", cmd.Use)
assert.NotEmpty(t, cmd.Short)
assert.NotNil(t, cmd.RunE)
// Test flags exist (jail and ip are positional args, not flags)
assert.NotNil(t, cmd.Flags().Lookup("limit"))
assert.NotNil(t, cmd.Flags().Lookup("interval"))
}
// TestGetLogLinesWithLimitAndContext_Function tests the function
func TestGetLogLinesWithLimitAndContext_Function(t *testing.T) {
mockRunner := fail2ban.NewMockRunner()
defer fail2ban.WithTestRunner(t, mockRunner)()
mockRunner.SetResponse("fail2ban-client -V", []byte("Fail2Ban v0.11.0"))
mockRunner.SetResponse("sudo fail2ban-client -V", []byte("Fail2Ban v0.11.0"))
mockRunner.SetResponse("fail2ban-client ping", []byte("Server replied: pong"))
mockRunner.SetResponse("sudo fail2ban-client ping", []byte("Server replied: pong"))
mockRunner.SetResponse("fail2ban-client status", []byte("Status\n|- Number of jail: 1\n`- Jail list: sshd"))
mockRunner.SetResponse("sudo fail2ban-client status", []byte("Status\n|- Number of jail: 1\n`- Jail list: sshd"))
tmpDir := t.TempDir()
oldLogDir := fail2ban.GetLogDir()
fail2ban.SetLogDir(tmpDir)
defer fail2ban.SetLogDir(oldLogDir)
client, err := fail2ban.NewClient("/var/log/fail2ban", "/etc/fail2ban/filter.d")
require.NoError(t, err)
ctx := context.Background()
timeout := 5 * time.Second
tests := []struct {
name string
jail string
ip string
maxLines int
}{
{
name: "with no filters",
jail: "",
ip: "",
maxLines: 10,
},
{
name: "with jail filter",
jail: "sshd",
ip: "",
maxLines: 10,
},
{
name: "with ip filter",
jail: "",
ip: "192.168.1.1",
maxLines: 10,
},
}
for _, tt := range tests {
t.Run(tt.name, func(_ *testing.T) {
_, err := getLogLinesWithLimitAndContext(ctx, client, tt.jail, tt.ip, tt.maxLines, timeout)
// May return error if no log files exist, which is ok
_ = err
})
}
}
// TestOutputResults_DifferentFormats tests OutputResults with various data types
func TestOutputResults_DifferentFormats(t *testing.T) {
tests := []struct {
name string
results interface{}
config *Config
}{
{
name: "json format with array",
results: []string{"result1", "result2"},
config: &Config{Format: JSONFormat},
},
{
name: "plain format with string",
results: "plain text output",
config: &Config{Format: PlainFormat},
},
{
name: "nil config uses default",
results: "test output",
config: nil,
},
{
name: "json format with map",
results: map[string]interface{}{"key": "value", "count": 5},
config: &Config{Format: JSONFormat},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cmd := &cobra.Command{}
var buf bytes.Buffer
cmd.SetOut(&buf)
// Should not panic
OutputResults(cmd, tt.results, tt.config)
// Verify output was written
output := buf.String()
assert.NotEmpty(t, output)
})
}
}
// TestPrintOutput_NoError tests that PrintOutput doesn't panic
func TestPrintOutput_NoError(t *testing.T) {
// Test that various data types don't cause panics
assert.NotPanics(t, func() {
PrintOutput("test string", PlainFormat)
})
assert.NotPanics(t, func() {
PrintOutput(map[string]string{"key": "value"}, JSONFormat)
})
assert.NotPanics(t, func() {
PrintOutput([]int{1, 2, 3}, JSONFormat)
})
}