mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-01-26 11:34:03 +00:00
* 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
218 lines
5.8 KiB
Go
218 lines
5.8 KiB
Go
// Package shared provides common utility functions.
|
|
package shared
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
)
|
|
|
|
// AbsolutePath returns the absolute path for the given path.
|
|
// It wraps filepath.Abs with consistent error handling.
|
|
func AbsolutePath(path string) (string, error) {
|
|
abs, err := filepath.Abs(path)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to get absolute path for %s: %w", path, err)
|
|
}
|
|
|
|
return abs, nil
|
|
}
|
|
|
|
// BaseName returns the base name for the given path, handling special cases.
|
|
func BaseName(absPath string) string {
|
|
baseName := filepath.Base(absPath)
|
|
if baseName == "." || baseName == "" {
|
|
return "output"
|
|
}
|
|
|
|
return baseName
|
|
}
|
|
|
|
// ValidateSourcePath validates a source directory path for security.
|
|
// It ensures the path exists, is a directory, and doesn't contain path traversal attempts.
|
|
func ValidateSourcePath(path string) error {
|
|
if path == "" {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation,
|
|
CodeValidationRequired,
|
|
TestMsgSourcePath+" is required",
|
|
"",
|
|
nil,
|
|
)
|
|
}
|
|
|
|
// Check for path traversal patterns before cleaning
|
|
if strings.Contains(path, "..") {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation, CodeValidationPath,
|
|
"path traversal attempt detected in "+TestMsgSourcePath, path, map[string]any{
|
|
"original_path": path,
|
|
},
|
|
)
|
|
}
|
|
|
|
// Clean and get absolute path
|
|
cleaned := filepath.Clean(path)
|
|
abs, err := filepath.Abs(cleaned)
|
|
if err != nil {
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSPathResolution, "cannot resolve "+TestMsgSourcePath, path, map[string]any{
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
}
|
|
|
|
// Get current working directory to ensure we're not escaping it for relative paths
|
|
if !filepath.IsAbs(path) {
|
|
cwd, err := os.Getwd()
|
|
if err != nil {
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSPathResolution, "cannot get current working directory", path, map[string]any{
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
}
|
|
|
|
// Ensure the resolved path is within or below the current working directory
|
|
cwdAbs, err := filepath.Abs(cwd)
|
|
if err != nil {
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSPathResolution,
|
|
"cannot resolve current working directory", path, map[string]any{
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
}
|
|
|
|
// Check if the absolute path tries to escape the current working directory
|
|
if !strings.HasPrefix(abs, cwdAbs) {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation,
|
|
CodeValidationPath,
|
|
"source path attempts to access directories outside current working directory",
|
|
path,
|
|
map[string]any{
|
|
"resolved_path": abs,
|
|
"working_dir": cwdAbs,
|
|
},
|
|
)
|
|
}
|
|
}
|
|
|
|
// Check if path exists and is a directory
|
|
info, err := os.Stat(cleaned)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return NewStructuredError(ErrorTypeFileSystem, CodeFSNotFound, "source directory does not exist", path, nil)
|
|
}
|
|
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSAccess, "cannot access source directory", path, map[string]any{
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
}
|
|
|
|
if !info.IsDir() {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation, CodeValidationPath, "source path must be a directory", path, map[string]any{
|
|
"is_file": true,
|
|
},
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ValidateDestinationPath validates a destination file path for security.
|
|
// It ensures the path doesn't contain path traversal attempts and the parent directory exists.
|
|
func ValidateDestinationPath(path string) error {
|
|
if path == "" {
|
|
return NewStructuredError(ErrorTypeValidation, CodeValidationRequired, "destination path is required", "", nil)
|
|
}
|
|
|
|
// Check for path traversal patterns before cleaning
|
|
if strings.Contains(path, "..") {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation,
|
|
CodeValidationPath,
|
|
"path traversal attempt detected in destination path",
|
|
path,
|
|
map[string]any{
|
|
"original_path": path,
|
|
},
|
|
)
|
|
}
|
|
|
|
// Clean and validate the path
|
|
cleaned := filepath.Clean(path)
|
|
|
|
// Get absolute path to ensure it's not trying to escape current working directory
|
|
abs, err := filepath.Abs(cleaned)
|
|
if err != nil {
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSPathResolution, "cannot resolve destination path", path, map[string]any{
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
}
|
|
|
|
// Ensure the destination is not a directory
|
|
if info, err := os.Stat(abs); err == nil && info.IsDir() {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation, CodeValidationPath, "destination cannot be a directory", path, map[string]any{
|
|
"is_directory": true,
|
|
},
|
|
)
|
|
}
|
|
|
|
// Check if parent directory exists and is writable
|
|
parentDir := filepath.Dir(abs)
|
|
if parentInfo, err := os.Stat(parentDir); err != nil {
|
|
if os.IsNotExist(err) {
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSNotFound,
|
|
"destination parent directory does not exist", path, map[string]any{
|
|
"parent_dir": parentDir,
|
|
},
|
|
)
|
|
}
|
|
|
|
return NewStructuredError(
|
|
ErrorTypeFileSystem, CodeFSAccess, "cannot access destination parent directory", path, map[string]any{
|
|
"parent_dir": parentDir,
|
|
"error": err.Error(),
|
|
},
|
|
)
|
|
} else if !parentInfo.IsDir() {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation, CodeValidationPath, "destination parent is not a directory", path, map[string]any{
|
|
"parent_dir": parentDir,
|
|
},
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ValidateConfigPath validates a configuration file path for security.
|
|
// It ensures the path doesn't contain path traversal attempts.
|
|
func ValidateConfigPath(path string) error {
|
|
if path == "" {
|
|
return nil // Empty path is allowed for config
|
|
}
|
|
|
|
// Check for path traversal patterns before cleaning
|
|
if strings.Contains(path, "..") {
|
|
return NewStructuredError(
|
|
ErrorTypeValidation, CodeValidationPath,
|
|
"path traversal attempt detected in config path", path, map[string]any{
|
|
"original_path": path,
|
|
},
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|