mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-02-16 15:50:29 +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:
@@ -9,38 +9,60 @@ import (
|
||||
"strings"
|
||||
|
||||
"github.com/ivuorinen/gibidify/benchmark"
|
||||
"github.com/ivuorinen/gibidify/gibidiutils"
|
||||
"github.com/ivuorinen/gibidify/shared"
|
||||
)
|
||||
|
||||
var (
|
||||
sourceDir = flag.String("source", "", "Source directory to benchmark (uses temp files if empty)")
|
||||
benchmarkType = flag.String("type", "all", "Benchmark type: all, collection, processing, concurrency, format")
|
||||
format = flag.String("format", "json", "Output format for processing benchmarks")
|
||||
concurrency = flag.Int("concurrency", runtime.NumCPU(), "Concurrency level for processing benchmarks")
|
||||
concurrencyList = flag.String("concurrency-list", "1,2,4,8", "Comma-separated list of concurrency levels")
|
||||
formatList = flag.String("format-list", "json,yaml,markdown", "Comma-separated list of formats")
|
||||
numFiles = flag.Int("files", 100, "Number of files to create for benchmarks")
|
||||
sourceDir = flag.String(
|
||||
shared.CLIArgSource, "", "Source directory to benchmark (uses temp files if empty)",
|
||||
)
|
||||
benchmarkType = flag.String(
|
||||
"type", shared.CLIArgAll, "Benchmark type: all, collection, processing, concurrency, format",
|
||||
)
|
||||
format = flag.String(
|
||||
shared.CLIArgFormat, shared.FormatJSON, "Output format for processing benchmarks",
|
||||
)
|
||||
concurrency = flag.Int(
|
||||
shared.CLIArgConcurrency, runtime.NumCPU(), "Concurrency level for processing benchmarks",
|
||||
)
|
||||
concurrencyList = flag.String(
|
||||
"concurrency-list", shared.TestConcurrencyList, "Comma-separated list of concurrency levels",
|
||||
)
|
||||
formatList = flag.String(
|
||||
"format-list", shared.TestFormatList, "Comma-separated list of formats",
|
||||
)
|
||||
numFiles = flag.Int("files", shared.BenchmarkDefaultFileCount, "Number of files to create for benchmarks")
|
||||
)
|
||||
|
||||
func main() {
|
||||
flag.Parse()
|
||||
|
||||
if err := runBenchmarks(); err != nil {
|
||||
//goland:noinspection GoUnhandledErrorResult
|
||||
_, _ = fmt.Fprintf(os.Stderr, "Benchmark failed: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
func runBenchmarks() error {
|
||||
fmt.Printf("Running gibidify benchmarks...\n")
|
||||
fmt.Printf("Source: %s\n", getSourceDescription())
|
||||
fmt.Printf("Type: %s\n", *benchmarkType)
|
||||
fmt.Printf("CPU cores: %d\n", runtime.NumCPU())
|
||||
fmt.Println()
|
||||
//nolint:errcheck // Benchmark informational output, errors don't affect benchmark results
|
||||
_, _ = fmt.Println("Running gibidify benchmarks...")
|
||||
//nolint:errcheck // Benchmark informational output, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("Source: %s\n", getSourceDescription())
|
||||
//nolint:errcheck // Benchmark informational output, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("Type: %s\n", *benchmarkType)
|
||||
//nolint:errcheck // Benchmark informational output, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("CPU cores: %d\n", runtime.NumCPU())
|
||||
//nolint:errcheck // Benchmark informational output, errors don't affect benchmark results
|
||||
_, _ = fmt.Println()
|
||||
|
||||
switch *benchmarkType {
|
||||
case "all":
|
||||
return benchmark.RunAllBenchmarks(*sourceDir)
|
||||
case shared.CLIArgAll:
|
||||
if err := benchmark.RunAllBenchmarks(*sourceDir); err != nil {
|
||||
return fmt.Errorf("benchmark failed: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
case "collection":
|
||||
return runCollectionBenchmark()
|
||||
case "processing":
|
||||
@@ -50,81 +72,79 @@ func runBenchmarks() error {
|
||||
case "format":
|
||||
return runFormatBenchmark()
|
||||
default:
|
||||
return gibidiutils.NewValidationError(
|
||||
gibidiutils.CodeValidationFormat,
|
||||
"invalid benchmark type: "+*benchmarkType,
|
||||
)
|
||||
return shared.NewValidationError(shared.CodeValidationFormat, "invalid benchmark type: "+*benchmarkType)
|
||||
}
|
||||
}
|
||||
|
||||
func runCollectionBenchmark() error {
|
||||
fmt.Println("Running file collection benchmark...")
|
||||
//nolint:errcheck // Benchmark status message, errors don't affect benchmark results
|
||||
_, _ = fmt.Println(shared.BenchmarkMsgRunningCollection)
|
||||
result, err := benchmark.FileCollectionBenchmark(*sourceDir, *numFiles)
|
||||
if err != nil {
|
||||
return gibidiutils.WrapError(
|
||||
return shared.WrapError(
|
||||
err,
|
||||
gibidiutils.ErrorTypeProcessing,
|
||||
gibidiutils.CodeProcessingCollection,
|
||||
"file collection benchmark failed",
|
||||
shared.ErrorTypeProcessing,
|
||||
shared.CodeProcessingCollection,
|
||||
shared.BenchmarkMsgFileCollectionFailed,
|
||||
)
|
||||
}
|
||||
benchmark.PrintResult(result)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func runProcessingBenchmark() error {
|
||||
fmt.Printf("Running file processing benchmark (format: %s, concurrency: %d)...\n", *format, *concurrency)
|
||||
//nolint:errcheck // Benchmark status message, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("Running file processing benchmark (format: %s, concurrency: %d)...\n", *format, *concurrency)
|
||||
result, err := benchmark.FileProcessingBenchmark(*sourceDir, *format, *concurrency)
|
||||
if err != nil {
|
||||
return gibidiutils.WrapError(
|
||||
return shared.WrapError(
|
||||
err,
|
||||
gibidiutils.ErrorTypeProcessing,
|
||||
gibidiutils.CodeProcessingCollection,
|
||||
shared.ErrorTypeProcessing,
|
||||
shared.CodeProcessingCollection,
|
||||
"file processing benchmark failed",
|
||||
)
|
||||
}
|
||||
benchmark.PrintResult(result)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func runConcurrencyBenchmark() error {
|
||||
concurrencyLevels, err := parseConcurrencyList(*concurrencyList)
|
||||
if err != nil {
|
||||
return gibidiutils.WrapError(
|
||||
err,
|
||||
gibidiutils.ErrorTypeValidation,
|
||||
gibidiutils.CodeValidationFormat,
|
||||
"invalid concurrency list",
|
||||
)
|
||||
return shared.WrapError(
|
||||
err, shared.ErrorTypeValidation, shared.CodeValidationFormat, "invalid concurrency list")
|
||||
}
|
||||
|
||||
fmt.Printf("Running concurrency benchmark (format: %s, levels: %v)...\n", *format, concurrencyLevels)
|
||||
//nolint:errcheck // Benchmark status message, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("Running concurrency benchmark (format: %s, levels: %v)...\n", *format, concurrencyLevels)
|
||||
suite, err := benchmark.ConcurrencyBenchmark(*sourceDir, *format, concurrencyLevels)
|
||||
if err != nil {
|
||||
return gibidiutils.WrapError(
|
||||
return shared.WrapError(
|
||||
err,
|
||||
gibidiutils.ErrorTypeProcessing,
|
||||
gibidiutils.CodeProcessingCollection,
|
||||
"concurrency benchmark failed",
|
||||
shared.ErrorTypeProcessing,
|
||||
shared.CodeProcessingCollection,
|
||||
shared.BenchmarkMsgConcurrencyFailed,
|
||||
)
|
||||
}
|
||||
benchmark.PrintSuite(suite)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func runFormatBenchmark() error {
|
||||
formats := parseFormatList(*formatList)
|
||||
fmt.Printf("Running format benchmark (formats: %v)...\n", formats)
|
||||
//nolint:errcheck // Benchmark status message, errors don't affect benchmark results
|
||||
_, _ = fmt.Printf("Running format benchmark (formats: %v)...\n", formats)
|
||||
suite, err := benchmark.FormatBenchmark(*sourceDir, formats)
|
||||
if err != nil {
|
||||
return gibidiutils.WrapError(
|
||||
err,
|
||||
gibidiutils.ErrorTypeProcessing,
|
||||
gibidiutils.CodeProcessingCollection,
|
||||
"format benchmark failed",
|
||||
return shared.WrapError(
|
||||
err, shared.ErrorTypeProcessing, shared.CodeProcessingCollection, shared.BenchmarkMsgFormatFailed,
|
||||
)
|
||||
}
|
||||
benchmark.PrintSuite(suite)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -132,6 +152,7 @@ func getSourceDescription() string {
|
||||
if *sourceDir == "" {
|
||||
return fmt.Sprintf("temporary files (%d files)", *numFiles)
|
||||
}
|
||||
|
||||
return *sourceDir
|
||||
}
|
||||
|
||||
@@ -143,28 +164,24 @@ func parseConcurrencyList(list string) ([]int, error) {
|
||||
part = strings.TrimSpace(part)
|
||||
var level int
|
||||
if _, err := fmt.Sscanf(part, "%d", &level); err != nil {
|
||||
return nil, gibidiutils.WrapErrorf(
|
||||
return nil, shared.WrapErrorf(
|
||||
err,
|
||||
gibidiutils.ErrorTypeValidation,
|
||||
gibidiutils.CodeValidationFormat,
|
||||
shared.ErrorTypeValidation,
|
||||
shared.CodeValidationFormat,
|
||||
"invalid concurrency level: %s",
|
||||
part,
|
||||
)
|
||||
}
|
||||
if level <= 0 {
|
||||
return nil, gibidiutils.NewValidationError(
|
||||
gibidiutils.CodeValidationFormat,
|
||||
"concurrency level must be positive: "+part,
|
||||
return nil, shared.NewValidationError(
|
||||
shared.CodeValidationFormat, "concurrency level must be positive: "+part,
|
||||
)
|
||||
}
|
||||
levels = append(levels, level)
|
||||
}
|
||||
|
||||
if len(levels) == 0 {
|
||||
return nil, gibidiutils.NewValidationError(
|
||||
gibidiutils.CodeValidationFormat,
|
||||
"no valid concurrency levels found",
|
||||
)
|
||||
return nil, shared.NewValidationError(shared.CodeValidationFormat, "no valid concurrency levels found")
|
||||
}
|
||||
|
||||
return levels, nil
|
||||
|
||||
Reference in New Issue
Block a user