mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-01-26 11:34:03 +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:
217
interfaces.go
Normal file
217
interfaces.go
Normal file
@@ -0,0 +1,217 @@
|
||||
// Package main provides core interfaces for the gibidify application.
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
"github.com/ivuorinen/gibidify/shared"
|
||||
)
|
||||
|
||||
// Processor defines the interface for file processors.
|
||||
// This interface allows for easier testing and mocking of the main processing logic.
|
||||
type Processor interface {
|
||||
// Process starts the file processing workflow with the given context.
|
||||
// It returns an error if processing fails at any stage.
|
||||
Process(ctx context.Context) error
|
||||
}
|
||||
|
||||
// FileProcessorInterface defines the interface for individual file processing.
|
||||
// This abstracts the file processing logic for better testability.
|
||||
type FileProcessorInterface interface {
|
||||
// ProcessFile processes a single file and sends the result to the output channel.
|
||||
ProcessFile(ctx context.Context, filePath string, outCh chan<- WriteRequest)
|
||||
|
||||
// ProcessWithContext processes a file and returns the content directly.
|
||||
ProcessWithContext(ctx context.Context, filePath string) (string, error)
|
||||
}
|
||||
|
||||
// ResourceMonitorInterface defines the interface for resource monitoring.
|
||||
// This allows for mocking and testing of resource management functionality.
|
||||
type ResourceMonitorInterface interface {
|
||||
// Start begins resource monitoring.
|
||||
Start() error
|
||||
|
||||
// Stop stops resource monitoring and cleanup.
|
||||
Stop() error
|
||||
|
||||
// CheckResourceLimits validates current resource usage against limits.
|
||||
CheckResourceLimits() error
|
||||
|
||||
// Metrics returns current resource usage metrics.
|
||||
Metrics() ResourceMetrics
|
||||
}
|
||||
|
||||
// MetricsCollectorInterface defines the interface for metrics collection.
|
||||
// This enables easier testing and different metrics backend implementations.
|
||||
type MetricsCollectorInterface interface {
|
||||
// RecordFileProcessed records the processing of a single file.
|
||||
RecordFileProcessed(result FileProcessingResult)
|
||||
|
||||
// IncrementConcurrency increments the current concurrency counter.
|
||||
IncrementConcurrency()
|
||||
|
||||
// DecrementConcurrency decrements the current concurrency counter.
|
||||
DecrementConcurrency()
|
||||
|
||||
// CurrentMetrics returns the current processing metrics.
|
||||
CurrentMetrics() ProcessingMetrics
|
||||
|
||||
// GenerateReport generates a comprehensive processing report.
|
||||
GenerateReport() ProfileReport
|
||||
|
||||
// Reset resets all metrics to initial state.
|
||||
Reset()
|
||||
}
|
||||
|
||||
// UIManagerInterface defines the interface for user interface management.
|
||||
// This abstracts UI operations for better testing and different UI implementations.
|
||||
type UIManagerInterface interface {
|
||||
// PrintInfo prints an informational message.
|
||||
PrintInfo(message string)
|
||||
|
||||
// PrintWarning prints a warning message.
|
||||
PrintWarning(message string)
|
||||
|
||||
// PrintError prints an error message.
|
||||
PrintError(message string)
|
||||
|
||||
// PrintSuccess prints a success message.
|
||||
PrintSuccess(message string)
|
||||
|
||||
// SetColorOutput enables or disables colored output.
|
||||
SetColorOutput(enabled bool)
|
||||
|
||||
// SetProgressOutput enables or disables progress indicators.
|
||||
SetProgressOutput(enabled bool)
|
||||
}
|
||||
|
||||
// WriterInterface defines the interface for output writers.
|
||||
// This allows for different output formats and destinations.
|
||||
type WriterInterface interface {
|
||||
// Write writes the processed content to the destination.
|
||||
Write(req WriteRequest) error
|
||||
|
||||
// Close finalizes the output and closes any resources.
|
||||
Close() error
|
||||
|
||||
// GetFormat returns the output format supported by this writer.
|
||||
GetFormat() string
|
||||
}
|
||||
|
||||
// BackpressureManagerInterface defines the interface for backpressure management.
|
||||
// This abstracts memory and flow control for better testing.
|
||||
type BackpressureManagerInterface interface {
|
||||
// CheckBackpressure returns true if backpressure should be applied.
|
||||
CheckBackpressure() bool
|
||||
|
||||
// UpdateMemoryUsage updates the current memory usage tracking.
|
||||
UpdateMemoryUsage(bytes int64)
|
||||
|
||||
// GetMemoryUsage returns current memory usage statistics.
|
||||
GetMemoryUsage() int64
|
||||
|
||||
// Reset resets backpressure state to initial values.
|
||||
Reset()
|
||||
}
|
||||
|
||||
// TemplateEngineInterface defines the interface for template processing.
|
||||
// This allows for different templating systems and easier testing.
|
||||
type TemplateEngineInterface interface {
|
||||
// RenderHeader renders the document header using the configured template.
|
||||
RenderHeader(ctx TemplateContext) (string, error)
|
||||
|
||||
// RenderFooter renders the document footer using the configured template.
|
||||
RenderFooter(ctx TemplateContext) (string, error)
|
||||
|
||||
// RenderFileContent renders individual file content with formatting.
|
||||
RenderFileContent(ctx FileContext) (string, error)
|
||||
|
||||
// RenderMetadata renders metadata section if enabled.
|
||||
RenderMetadata(ctx TemplateContext) (string, error)
|
||||
}
|
||||
|
||||
// ConfigLoaderInterface defines the interface for configuration management.
|
||||
// This enables different configuration sources and easier testing.
|
||||
type ConfigLoaderInterface interface {
|
||||
// LoadConfig loads configuration from the appropriate source.
|
||||
LoadConfig() error
|
||||
|
||||
// GetString returns a string configuration value.
|
||||
GetString(key string) string
|
||||
|
||||
// GetInt returns an integer configuration value.
|
||||
GetInt(key string) int
|
||||
|
||||
// GetBool returns a boolean configuration value.
|
||||
GetBool(key string) bool
|
||||
|
||||
// GetStringSlice returns a string slice configuration value.
|
||||
GetStringSlice(key string) []string
|
||||
}
|
||||
|
||||
// LoggerInterface defines the interface for logging operations.
|
||||
// This abstracts logging for better testing and different log backends.
|
||||
type LoggerInterface = shared.Logger
|
||||
|
||||
// These types are referenced by the interfaces but need to be defined
|
||||
// elsewhere in the codebase. They are included here for documentation.
|
||||
|
||||
type WriteRequest struct {
|
||||
Path string
|
||||
Content string
|
||||
IsStream bool
|
||||
Reader io.Reader
|
||||
Size int64
|
||||
}
|
||||
|
||||
type ResourceMetrics struct {
|
||||
FilesProcessed int64
|
||||
TotalSizeProcessed int64
|
||||
ConcurrentReads int64
|
||||
MaxConcurrentReads int64
|
||||
}
|
||||
|
||||
type FileProcessingResult struct {
|
||||
FilePath string
|
||||
FileSize int64
|
||||
Format string
|
||||
Success bool
|
||||
Error error
|
||||
Skipped bool
|
||||
SkipReason string
|
||||
}
|
||||
|
||||
type ProcessingMetrics struct {
|
||||
TotalFiles int64
|
||||
ProcessedFiles int64
|
||||
ErrorFiles int64
|
||||
SkippedFiles int64
|
||||
TotalSize int64
|
||||
ProcessedSize int64
|
||||
}
|
||||
|
||||
type ProfileReport struct {
|
||||
Summary ProcessingMetrics
|
||||
// Additional report fields would be defined in the metrics package
|
||||
}
|
||||
|
||||
type TemplateContext struct {
|
||||
Files []FileContext
|
||||
// Additional context fields would be defined in the templates package
|
||||
}
|
||||
|
||||
type FileContext struct {
|
||||
Path string
|
||||
Content string
|
||||
// Additional file context fields would be defined in the templates package
|
||||
}
|
||||
|
||||
type LogLevel int
|
||||
|
||||
const (
|
||||
LogLevelDebug LogLevel = iota
|
||||
LogLevelInfo
|
||||
LogLevelWarn
|
||||
LogLevelError
|
||||
)
|
||||
Reference in New Issue
Block a user