mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-02-14 00:49:39 +00:00
chore: modernize workflows, security scanning, and linting configuration (#50)
* build: update Go 1.25, CI workflows, and build tooling - Upgrade to Go 1.25 - Add benchmark targets to Makefile - Implement parallel gosec execution - Lock tool versions for reproducibility - Add shellcheck directives to scripts - Update CI workflows with improved caching * refactor: migrate from golangci-lint to revive - Replace golangci-lint with revive for linting - Configure comprehensive revive rules - Fix all EditorConfig violations - Add yamllint and yamlfmt support - Remove deprecated .golangci.yml * refactor: rename utils to shared and deduplicate code - Rename utils package to shared - Add shared constants package - Deduplicate constants across packages - Address CodeRabbit review feedback * fix: resolve SonarQube issues and add safety guards - Fix all 73 SonarQube OPEN issues - Add nil guards for resourceMonitor, backpressure, metricsCollector - Implement io.Closer for headerFileReader - Propagate errors from processing helpers - Add metrics and templates packages - Improve error handling across codebase * test: improve test infrastructure and coverage - Add benchmarks for cli, fileproc, metrics - Improve test coverage for cli, fileproc, config - Refactor tests with helper functions - Add shared test constants - Fix test function naming conventions - Reduce cognitive complexity in benchmark tests * docs: update documentation and configuration examples - Update CLAUDE.md with current project state - Refresh README with new features - Add usage and configuration examples - Add SonarQube project configuration - Consolidate config.example.yaml * fix: resolve shellcheck warnings in scripts - Use ./*.go instead of *.go to prevent dash-prefixed filenames from being interpreted as options (SC2035) - Remove unreachable return statement after exit (SC2317) - Remove obsolete gibidiutils/ directory reference * chore(deps): upgrade go dependencies * chore(lint): megalinter fixes * fix: improve test coverage and fix file descriptor leaks - Add defer r.Close() to fix pipe file descriptor leaks in benchmark tests - Refactor TestProcessorConfigureFileTypes with helper functions and assertions - Refactor TestProcessorLogFinalStats with output capture and keyword verification - Use shared constants instead of literal strings (TestFilePNG, FormatMarkdown, etc.) - Reduce cognitive complexity by extracting helper functions * fix: align test comments with function names Remove underscores from test comments to match actual function names: - benchmark/benchmark_test.go (2 fixes) - fileproc/filetypes_config_test.go (4 fixes) - fileproc/filetypes_registry_test.go (6 fixes) - fileproc/processor_test.go (6 fixes) - fileproc/resource_monitor_types_test.go (4 fixes) - fileproc/writer_test.go (3 fixes) * fix: various test improvements and bug fixes - Remove duplicate maxCacheSize check in filetypes_registry_test.go - Shorten long comment in processor_test.go to stay under 120 chars - Remove flaky time.Sleep in collector_test.go, use >= 0 assertion - Close pipe reader in benchmark_test.go to fix file descriptor leak - Use ContinueOnError in flags_test.go to match ResetFlags behavior - Add nil check for p.ui in processor_workers.go before UpdateProgress - Fix resource_monitor_validation_test.go by setting hardMemoryLimitBytes directly * chore(yaml): add missing document start markers Add --- document start to YAML files to satisfy yamllint: - .github/workflows/codeql.yml - .github/workflows/build-test-publish.yml - .github/workflows/security.yml - .github/actions/setup/action.yml * fix: guard nil resourceMonitor and fix test deadlock - Guard resourceMonitor before CreateFileProcessingContext call - Add ui.UpdateProgress on emergency stop and path error returns - Fix potential deadlock in TestProcessFile using wg.Go with defer close
This commit is contained in:
@@ -2,19 +2,46 @@ package fileproc
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/viper"
|
||||
|
||||
"github.com/ivuorinen/gibidify/gibidiutils"
|
||||
"github.com/ivuorinen/gibidify/shared"
|
||||
"github.com/ivuorinen/gibidify/testutil"
|
||||
)
|
||||
|
||||
func TestResourceMonitor_FileCountLimit(t *testing.T) {
|
||||
// assertStructuredError verifies that an error is a StructuredError with the expected code.
|
||||
func assertStructuredError(t *testing.T, err error, expectedCode string) {
|
||||
t.Helper()
|
||||
structErr := &shared.StructuredError{}
|
||||
ok := errors.As(err, &structErr)
|
||||
if !ok {
|
||||
t.Errorf("Expected StructuredError, got %T", err)
|
||||
} else if structErr.Code != expectedCode {
|
||||
t.Errorf("Expected error code %s, got %s", expectedCode, structErr.Code)
|
||||
}
|
||||
}
|
||||
|
||||
// validateMemoryLimitError validates that an error is a proper memory limit StructuredError.
|
||||
func validateMemoryLimitError(t *testing.T, err error) {
|
||||
t.Helper()
|
||||
|
||||
structErr := &shared.StructuredError{}
|
||||
if errors.As(err, &structErr) {
|
||||
if structErr.Code != shared.CodeResourceLimitMemory {
|
||||
t.Errorf("Expected memory limit error code, got %s", structErr.Code)
|
||||
}
|
||||
} else {
|
||||
t.Errorf("Expected StructuredError, got %T", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResourceMonitorFileCountLimit(t *testing.T) {
|
||||
testutil.ResetViperConfig(t, "")
|
||||
|
||||
// Set a very low file count limit for testing
|
||||
viper.Set("resourceLimits.enabled", true)
|
||||
viper.Set(shared.TestCfgResourceLimitsEnabled, true)
|
||||
viper.Set("resourceLimits.maxFiles", 2)
|
||||
|
||||
rm := NewResourceMonitor()
|
||||
@@ -41,20 +68,14 @@ func TestResourceMonitor_FileCountLimit(t *testing.T) {
|
||||
}
|
||||
|
||||
// Verify it's the correct error type
|
||||
var structErr *gibidiutils.StructuredError
|
||||
ok := errors.As(err, &structErr)
|
||||
if !ok {
|
||||
t.Errorf("Expected StructuredError, got %T", err)
|
||||
} else if structErr.Code != gibidiutils.CodeResourceLimitFiles {
|
||||
t.Errorf("Expected error code %s, got %s", gibidiutils.CodeResourceLimitFiles, structErr.Code)
|
||||
}
|
||||
assertStructuredError(t, err, shared.CodeResourceLimitFiles)
|
||||
}
|
||||
|
||||
func TestResourceMonitor_TotalSizeLimit(t *testing.T) {
|
||||
func TestResourceMonitorTotalSizeLimit(t *testing.T) {
|
||||
testutil.ResetViperConfig(t, "")
|
||||
|
||||
// Set a low total size limit for testing (1KB)
|
||||
viper.Set("resourceLimits.enabled", true)
|
||||
viper.Set(shared.TestCfgResourceLimitsEnabled, true)
|
||||
viper.Set("resourceLimits.maxTotalSize", 1024)
|
||||
|
||||
rm := NewResourceMonitor()
|
||||
@@ -81,11 +102,103 @@ func TestResourceMonitor_TotalSizeLimit(t *testing.T) {
|
||||
}
|
||||
|
||||
// Verify it's the correct error type
|
||||
var structErr *gibidiutils.StructuredError
|
||||
ok := errors.As(err, &structErr)
|
||||
if !ok {
|
||||
t.Errorf("Expected StructuredError, got %T", err)
|
||||
} else if structErr.Code != gibidiutils.CodeResourceLimitTotalSize {
|
||||
t.Errorf("Expected error code %s, got %s", gibidiutils.CodeResourceLimitTotalSize, structErr.Code)
|
||||
assertStructuredError(t, err, shared.CodeResourceLimitTotalSize)
|
||||
}
|
||||
|
||||
// TestResourceMonitor_MemoryLimitExceeded tests memory limit violation scenarios.
|
||||
func TestResourceMonitorMemoryLimitExceeded(t *testing.T) {
|
||||
testutil.ResetViperConfig(t, "")
|
||||
|
||||
// Set very low memory limit to try to force violations
|
||||
viper.Set(shared.TestCfgResourceLimitsEnabled, true)
|
||||
viper.Set("resourceLimits.hardMemoryLimitMB", 0.001) // 1KB - extremely low
|
||||
|
||||
rm := NewResourceMonitor()
|
||||
defer rm.Close()
|
||||
|
||||
// Allocate large buffer to increase memory usage before check
|
||||
largeBuffer := make([]byte, 10*1024*1024) // 10MB allocation
|
||||
_ = largeBuffer[0] // Use the buffer to prevent optimization
|
||||
|
||||
// Check hard memory limit - might trigger if actual memory is high enough
|
||||
err := rm.CheckHardMemoryLimit()
|
||||
|
||||
// Note: This test might not always fail since it depends on actual runtime memory
|
||||
// But if it does fail, verify it's the correct error type
|
||||
if err != nil {
|
||||
validateMemoryLimitError(t, err)
|
||||
t.Log("Successfully triggered memory limit violation")
|
||||
} else {
|
||||
t.Log("Memory limit check passed - actual memory usage may be within limits")
|
||||
}
|
||||
}
|
||||
|
||||
// TestResourceMonitor_MemoryLimitHandling tests the memory violation detection.
|
||||
func TestResourceMonitorMemoryLimitHandling(t *testing.T) {
|
||||
testutil.ResetViperConfig(t, "")
|
||||
|
||||
// Enable resource limits with very small hard limit
|
||||
viper.Set(shared.TestCfgResourceLimitsEnabled, true)
|
||||
viper.Set("resourceLimits.hardMemoryLimitMB", 0.0001) // Very tiny limit
|
||||
viper.Set("resourceLimits.enableGracefulDegradation", true)
|
||||
|
||||
rm := NewResourceMonitor()
|
||||
defer rm.Close()
|
||||
|
||||
// Allocate more memory to increase chances of triggering limit
|
||||
buffers := make([][]byte, 0, 100) // Pre-allocate capacity
|
||||
for i := 0; i < 100; i++ {
|
||||
buffer := make([]byte, 1024*1024) // 1MB each
|
||||
buffers = append(buffers, buffer)
|
||||
_ = buffer[0] // Use buffer
|
||||
_ = buffers // Use the slice to prevent unused variable warning
|
||||
|
||||
// Check periodically
|
||||
if i%10 == 0 {
|
||||
err := rm.CheckHardMemoryLimit()
|
||||
if err != nil {
|
||||
// Successfully triggered memory limit
|
||||
if !strings.Contains(err.Error(), "memory limit") {
|
||||
t.Errorf("Expected error message to mention memory limit, got: %v", err)
|
||||
}
|
||||
t.Log("Successfully triggered memory limit handling")
|
||||
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
t.Log("Could not trigger memory limit - actual memory usage may be lower than limit")
|
||||
}
|
||||
|
||||
// TestResourceMonitorGracefulRecovery tests graceful recovery attempts.
|
||||
func TestResourceMonitorGracefulRecovery(t *testing.T) {
|
||||
testutil.ResetViperConfig(t, "")
|
||||
|
||||
// Set memory limits that will trigger recovery
|
||||
viper.Set(shared.TestCfgResourceLimitsEnabled, true)
|
||||
|
||||
rm := NewResourceMonitor()
|
||||
defer rm.Close()
|
||||
|
||||
// Force a deterministic 1-byte hard memory limit to trigger recovery
|
||||
rm.hardMemoryLimitBytes = 1
|
||||
|
||||
// Process multiple files to accumulate memory usage
|
||||
for i := 0; i < 3; i++ {
|
||||
filePath := "/tmp/test" + string(rune('1'+i)) + ".txt"
|
||||
fileSize := int64(400) // Each file is 400 bytes
|
||||
|
||||
// First few might pass, but eventually should trigger recovery mechanisms
|
||||
err := rm.ValidateFileProcessing(filePath, fileSize)
|
||||
if err != nil {
|
||||
// Once we hit the limit, test that the error is appropriate
|
||||
if !strings.Contains(err.Error(), "resource") && !strings.Contains(err.Error(), "limit") {
|
||||
t.Errorf("Expected resource limit error, got: %v", err)
|
||||
}
|
||||
|
||||
break
|
||||
}
|
||||
rm.RecordFileProcessed(fileSize)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user