mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-02-18 00:50:58 +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:
GitHub
@@ -1,10 +1,54 @@
|
||||
package benchmark
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/ivuorinen/gibidify/shared"
|
||||
)
|
||||
|
||||
// capturedOutput captures stdout output from a function call.
|
||||
func capturedOutput(t *testing.T, fn func()) string {
|
||||
t.Helper()
|
||||
original := os.Stdout
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToCreatePipe, err)
|
||||
}
|
||||
defer r.Close()
|
||||
defer func() { os.Stdout = original }()
|
||||
os.Stdout = w
|
||||
|
||||
fn()
|
||||
|
||||
if err := w.Close(); err != nil {
|
||||
t.Logf(shared.TestMsgFailedToClose, err)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
if _, err := io.Copy(&buf, r); err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToReadOutput, err)
|
||||
}
|
||||
|
||||
return buf.String()
|
||||
}
|
||||
|
||||
// verifyOutputContains checks if output contains all expected strings.
|
||||
func verifyOutputContains(t *testing.T, testName, output string, expected []string) {
|
||||
t.Helper()
|
||||
for _, check := range expected {
|
||||
if !strings.Contains(output, check) {
|
||||
t.Errorf("Test %s: output missing expected content: %q\nFull output:\n%s", testName, check, output)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestFileCollectionBenchmark tests the file collection benchmark.
|
||||
func TestFileCollectionBenchmark(t *testing.T) {
|
||||
result, err := FileCollectionBenchmark("", 10)
|
||||
@@ -22,7 +66,7 @@ func TestFileCollectionBenchmark(t *testing.T) {
|
||||
t.Logf("Bytes processed: %d", result.BytesProcessed)
|
||||
|
||||
if result.FilesProcessed <= 0 {
|
||||
t.Errorf("Expected files processed > 0, got %d", result.FilesProcessed)
|
||||
t.Errorf(shared.TestFmtExpectedFilesProcessed, result.FilesProcessed)
|
||||
}
|
||||
|
||||
if result.Duration <= 0 {
|
||||
@@ -38,7 +82,7 @@ func TestFileProcessingBenchmark(t *testing.T) {
|
||||
}
|
||||
|
||||
if result.FilesProcessed <= 0 {
|
||||
t.Errorf("Expected files processed > 0, got %d", result.FilesProcessed)
|
||||
t.Errorf(shared.TestFmtExpectedFilesProcessed, result.FilesProcessed)
|
||||
}
|
||||
|
||||
if result.Duration <= 0 {
|
||||
@@ -59,12 +103,12 @@ func TestConcurrencyBenchmark(t *testing.T) {
|
||||
}
|
||||
|
||||
if len(suite.Results) != len(concurrencyLevels) {
|
||||
t.Errorf("Expected %d results, got %d", len(concurrencyLevels), len(suite.Results))
|
||||
t.Errorf(shared.TestFmtExpectedResults, len(concurrencyLevels), len(suite.Results))
|
||||
}
|
||||
|
||||
for i, result := range suite.Results {
|
||||
if result.FilesProcessed <= 0 {
|
||||
t.Errorf("Result %d: Expected files processed > 0, got %d", i, result.FilesProcessed)
|
||||
t.Errorf("Result %d: "+shared.TestFmtExpectedFilesProcessed, i, result.FilesProcessed)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -82,12 +126,12 @@ func TestFormatBenchmark(t *testing.T) {
|
||||
}
|
||||
|
||||
if len(suite.Results) != len(formats) {
|
||||
t.Errorf("Expected %d results, got %d", len(formats), len(suite.Results))
|
||||
t.Errorf(shared.TestFmtExpectedResults, len(formats), len(suite.Results))
|
||||
}
|
||||
|
||||
for i, result := range suite.Results {
|
||||
if result.FilesProcessed <= 0 {
|
||||
t.Errorf("Result %d: Expected files processed > 0, got %d", i, result.FilesProcessed)
|
||||
t.Errorf("Result %d: "+shared.TestFmtExpectedFilesProcessed, i, result.FilesProcessed)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -116,7 +160,7 @@ func BenchmarkFileCollection(b *testing.B) {
|
||||
b.Fatalf("FileCollectionBenchmark failed: %v", err)
|
||||
}
|
||||
if result.FilesProcessed <= 0 {
|
||||
b.Errorf("Expected files processed > 0, got %d", result.FilesProcessed)
|
||||
b.Errorf(shared.TestFmtExpectedFilesProcessed, result.FilesProcessed)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -129,7 +173,7 @@ func BenchmarkFileProcessing(b *testing.B) {
|
||||
b.Fatalf("FileProcessingBenchmark failed: %v", err)
|
||||
}
|
||||
if result.FilesProcessed <= 0 {
|
||||
b.Errorf("Expected files processed > 0, got %d", result.FilesProcessed)
|
||||
b.Errorf(shared.TestFmtExpectedFilesProcessed, result.FilesProcessed)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -144,7 +188,7 @@ func BenchmarkConcurrency(b *testing.B) {
|
||||
b.Fatalf("ConcurrencyBenchmark failed: %v", err)
|
||||
}
|
||||
if len(suite.Results) != len(concurrencyLevels) {
|
||||
b.Errorf("Expected %d results, got %d", len(concurrencyLevels), len(suite.Results))
|
||||
b.Errorf(shared.TestFmtExpectedResults, len(concurrencyLevels), len(suite.Results))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -159,7 +203,315 @@ func BenchmarkFormats(b *testing.B) {
|
||||
b.Fatalf("FormatBenchmark failed: %v", err)
|
||||
}
|
||||
if len(suite.Results) != len(formats) {
|
||||
b.Errorf("Expected %d results, got %d", len(formats), len(suite.Results))
|
||||
b.Errorf(shared.TestFmtExpectedResults, len(formats), len(suite.Results))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestPrintResult tests the PrintResult function.
|
||||
func TestPrintResult(t *testing.T) {
|
||||
// Create a test result
|
||||
result := &Result{
|
||||
Name: "Test Benchmark",
|
||||
Duration: 1 * time.Second,
|
||||
FilesProcessed: 100,
|
||||
BytesProcessed: 2048000, // ~2MB for easy calculation
|
||||
}
|
||||
|
||||
// Capture stdout
|
||||
original := os.Stdout
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToCreatePipe, err)
|
||||
}
|
||||
defer r.Close()
|
||||
defer func() { os.Stdout = original }()
|
||||
os.Stdout = w
|
||||
|
||||
// Call PrintResult
|
||||
PrintResult(result)
|
||||
|
||||
// Close writer and read captured output
|
||||
if err := w.Close(); err != nil {
|
||||
t.Logf(shared.TestMsgFailedToClose, err)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
if _, err := io.Copy(&buf, r); err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToReadOutput, err)
|
||||
}
|
||||
output := buf.String()
|
||||
|
||||
// Verify expected content
|
||||
expectedContents := []string{
|
||||
"=== Test Benchmark ===",
|
||||
"Duration: 1s",
|
||||
"Files Processed: 100",
|
||||
"Bytes Processed: 2048000",
|
||||
"1.95 MB", // 2048000 / 1024 / 1024 ≈ 1.95
|
||||
}
|
||||
|
||||
for _, expected := range expectedContents {
|
||||
if !strings.Contains(output, expected) {
|
||||
t.Errorf("PrintResult output missing expected content: %q\nFull output:\n%s", expected, output)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestPrintSuite tests the PrintSuite function.
|
||||
func TestPrintSuite(t *testing.T) {
|
||||
// Create a test suite with multiple results
|
||||
suite := &Suite{
|
||||
Name: "Test Suite",
|
||||
Results: []Result{
|
||||
{
|
||||
Name: "Benchmark 1",
|
||||
Duration: 500 * time.Millisecond,
|
||||
FilesProcessed: 50,
|
||||
BytesProcessed: 1024000, // 1MB
|
||||
},
|
||||
{
|
||||
Name: "Benchmark 2",
|
||||
Duration: 750 * time.Millisecond,
|
||||
FilesProcessed: 75,
|
||||
BytesProcessed: 1536000, // 1.5MB
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Capture stdout
|
||||
original := os.Stdout
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToCreatePipe, err)
|
||||
}
|
||||
defer r.Close()
|
||||
defer func() { os.Stdout = original }()
|
||||
os.Stdout = w
|
||||
|
||||
// Call PrintSuite
|
||||
PrintSuite(suite)
|
||||
|
||||
// Close writer and read captured output
|
||||
if err := w.Close(); err != nil {
|
||||
t.Logf(shared.TestMsgFailedToClose, err)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
if _, err := io.Copy(&buf, r); err != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToReadOutput, err)
|
||||
}
|
||||
output := buf.String()
|
||||
|
||||
// Verify expected content
|
||||
expectedContents := []string{
|
||||
"=== Test Suite ===",
|
||||
"=== Benchmark 1 ===",
|
||||
"Duration: 500ms",
|
||||
"Files Processed: 50",
|
||||
"=== Benchmark 2 ===",
|
||||
"Duration: 750ms",
|
||||
"Files Processed: 75",
|
||||
}
|
||||
|
||||
for _, expected := range expectedContents {
|
||||
if !strings.Contains(output, expected) {
|
||||
t.Errorf("PrintSuite output missing expected content: %q\nFull output:\n%s", expected, output)
|
||||
}
|
||||
}
|
||||
|
||||
// Verify both results are printed
|
||||
benchmark1Count := strings.Count(output, "=== Benchmark 1 ===")
|
||||
benchmark2Count := strings.Count(output, "=== Benchmark 2 ===")
|
||||
|
||||
if benchmark1Count != 1 {
|
||||
t.Errorf("Expected exactly 1 occurrence of 'Benchmark 1', got %d", benchmark1Count)
|
||||
}
|
||||
if benchmark2Count != 1 {
|
||||
t.Errorf("Expected exactly 1 occurrence of 'Benchmark 2', got %d", benchmark2Count)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPrintResultEdgeCases tests edge cases for PrintResult.
|
||||
func TestPrintResultEdgeCases(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
result *Result
|
||||
checks []string
|
||||
}{
|
||||
{
|
||||
name: "zero values",
|
||||
result: &Result{
|
||||
Name: "Zero Benchmark",
|
||||
Duration: 0,
|
||||
FilesProcessed: 0,
|
||||
BytesProcessed: 0,
|
||||
},
|
||||
checks: []string{
|
||||
"=== Zero Benchmark ===",
|
||||
"Duration: 0s",
|
||||
"Files Processed: 0",
|
||||
"Bytes Processed: 0",
|
||||
"0.00 MB",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "large values",
|
||||
result: &Result{
|
||||
Name: "Large Benchmark",
|
||||
Duration: 1 * time.Hour,
|
||||
FilesProcessed: 1000000,
|
||||
BytesProcessed: 1073741824, // 1GB
|
||||
},
|
||||
checks: []string{
|
||||
"=== Large Benchmark ===",
|
||||
"Duration: 1h0m0s",
|
||||
"Files Processed: 1000000",
|
||||
"Bytes Processed: 1073741824",
|
||||
"1024.00 MB",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "empty name",
|
||||
result: &Result{
|
||||
Name: "",
|
||||
Duration: 100 * time.Millisecond,
|
||||
FilesProcessed: 10,
|
||||
BytesProcessed: 1024,
|
||||
},
|
||||
checks: []string{
|
||||
"=== ===", // Empty name between === markers
|
||||
"Duration: 100ms",
|
||||
"Files Processed: 10",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := tt.result
|
||||
output := capturedOutput(t, func() { PrintResult(result) })
|
||||
verifyOutputContains(t, tt.name, output, tt.checks)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestPrintSuiteEdgeCases tests edge cases for PrintSuite.
|
||||
func TestPrintSuiteEdgeCases(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
suite *Suite
|
||||
checks []string
|
||||
}{
|
||||
{
|
||||
name: "empty suite",
|
||||
suite: &Suite{
|
||||
Name: "Empty Suite",
|
||||
Results: []Result{},
|
||||
},
|
||||
checks: []string{
|
||||
"=== Empty Suite ===",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "suite with empty name",
|
||||
suite: &Suite{
|
||||
Name: "",
|
||||
Results: []Result{
|
||||
{
|
||||
Name: "Single Benchmark",
|
||||
Duration: 200 * time.Millisecond,
|
||||
FilesProcessed: 20,
|
||||
BytesProcessed: 2048,
|
||||
},
|
||||
},
|
||||
},
|
||||
checks: []string{
|
||||
"=== ===", // Empty name
|
||||
"=== Single Benchmark ===",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
suite := tt.suite
|
||||
output := capturedOutput(t, func() { PrintSuite(suite) })
|
||||
verifyOutputContains(t, tt.name, output, tt.checks)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestRunAllBenchmarks tests the RunAllBenchmarks function.
|
||||
func TestRunAllBenchmarks(t *testing.T) {
|
||||
// Create a temporary directory with some test files
|
||||
srcDir := t.TempDir()
|
||||
|
||||
// Create a few test files
|
||||
testFiles := []struct {
|
||||
name string
|
||||
content string
|
||||
}{
|
||||
{shared.TestFileMainGo, "package main\nfunc main() {}"},
|
||||
{shared.TestFile2Name, "Hello World"},
|
||||
{shared.TestFile3Name, "# Test Markdown"},
|
||||
}
|
||||
|
||||
for _, file := range testFiles {
|
||||
filePath := filepath.Join(srcDir, file.name)
|
||||
err := os.WriteFile(filePath, []byte(file.content), 0o644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test file %s: %v", file.name, err)
|
||||
}
|
||||
}
|
||||
|
||||
// Capture stdout to verify output
|
||||
original := os.Stdout
|
||||
r, w, pipeErr := os.Pipe()
|
||||
if pipeErr != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToCreatePipe, pipeErr)
|
||||
}
|
||||
defer func() {
|
||||
if err := r.Close(); err != nil {
|
||||
t.Logf("Failed to close pipe reader: %v", err)
|
||||
}
|
||||
}()
|
||||
defer func() { os.Stdout = original }()
|
||||
os.Stdout = w
|
||||
|
||||
// Call RunAllBenchmarks
|
||||
err := RunAllBenchmarks(srcDir)
|
||||
|
||||
// Close writer and read captured output
|
||||
if closeErr := w.Close(); closeErr != nil {
|
||||
t.Logf(shared.TestMsgFailedToClose, closeErr)
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
if _, copyErr := io.Copy(&buf, r); copyErr != nil {
|
||||
t.Fatalf(shared.TestMsgFailedToReadOutput, copyErr)
|
||||
}
|
||||
output := buf.String()
|
||||
|
||||
// Check for error
|
||||
if err != nil {
|
||||
t.Errorf("RunAllBenchmarks failed: %v", err)
|
||||
}
|
||||
|
||||
// Verify expected output content
|
||||
expectedContents := []string{
|
||||
"Running gibidify benchmark suite...",
|
||||
"Running file collection benchmark...",
|
||||
"Running format benchmarks...",
|
||||
"Running concurrency benchmarks...",
|
||||
}
|
||||
|
||||
for _, expected := range expectedContents {
|
||||
if !strings.Contains(output, expected) {
|
||||
t.Errorf("RunAllBenchmarks output missing expected content: %q\nFull output:\n%s", expected, output)
|
||||
}
|
||||
}
|
||||
|
||||
// The function should not panic and should complete successfully
|
||||
t.Log("RunAllBenchmarks completed successfully with output captured")
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user