mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-01-26 11:14:04 +00:00
Ismo Vuorinen
f94967713a
This commit represents a comprehensive refactoring of the codebase focused on improving code quality, testability, and maintainability. Key improvements: - Implement dependency injection and interface-based architecture - Add comprehensive test framework with fixtures and test suites - Fix all linting issues (errcheck, gosec, staticcheck, goconst, etc.) - Achieve full EditorConfig compliance across all files - Replace hardcoded test data with proper fixture files - Add configuration loader with hierarchical config support - Improve error handling with contextual information - Add progress indicators for better user feedback - Enhance Makefile with help system and improved editorconfig commands - Consolidate constants and remove deprecated code - Strengthen validation logic for GitHub Actions - Add focused consumer interfaces for better separation of concerns Testing improvements: - Add comprehensive integration tests - Implement test executor pattern for better test organization - Create extensive YAML fixture library for testing - Fix all failing tests and improve test coverage - Add validation test fixtures to avoid embedded YAML in Go files Build and tooling: - Update Makefile to show help by default - Fix editorconfig commands to use eclint properly - Add comprehensive help documentation to all make targets - Improve file selection patterns to avoid glob errors This refactoring maintains backward compatibility while significantly improving the internal architecture and developer experience.
100 lines
2.8 KiB
Go
100 lines
2.8 KiB
Go
// Package internal provides centralized error handling utilities.
|
|
package internal
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/ivuorinen/gh-action-readme/internal/errors"
|
|
)
|
|
|
|
// Error detection constants for automatic error code determination.
|
|
const (
|
|
// File system error patterns.
|
|
errorPatternFileNotFound = "no such file or directory"
|
|
errorPatternPermission = "permission denied"
|
|
|
|
// Content format error patterns.
|
|
errorPatternYAML = "yaml"
|
|
|
|
// Service-specific error patterns.
|
|
errorPatternGitHub = "github"
|
|
errorPatternConfig = "config"
|
|
|
|
// Exit code constants.
|
|
exitCodeError = 1
|
|
)
|
|
|
|
// ErrorHandler provides centralized error handling and exit management.
|
|
type ErrorHandler struct {
|
|
output *ColoredOutput
|
|
}
|
|
|
|
// NewErrorHandler creates a new error handler.
|
|
func NewErrorHandler(output *ColoredOutput) *ErrorHandler {
|
|
return &ErrorHandler{
|
|
output: output,
|
|
}
|
|
}
|
|
|
|
// HandleError handles contextual errors and exits with appropriate code.
|
|
func (eh *ErrorHandler) HandleError(err *errors.ContextualError) {
|
|
eh.output.ErrorWithSuggestions(err)
|
|
os.Exit(exitCodeError)
|
|
}
|
|
|
|
// HandleFatalError handles fatal errors with contextual information.
|
|
func (eh *ErrorHandler) HandleFatalError(code errors.ErrorCode, message string, context map[string]string) {
|
|
suggestions := errors.GetSuggestions(code, context)
|
|
helpURL := errors.GetHelpURL(code)
|
|
|
|
contextualErr := errors.New(code, message).
|
|
WithSuggestions(suggestions...).
|
|
WithHelpURL(helpURL)
|
|
|
|
if len(context) > 0 {
|
|
contextualErr = contextualErr.WithDetails(context)
|
|
}
|
|
|
|
eh.HandleError(contextualErr)
|
|
}
|
|
|
|
// HandleSimpleError handles simple errors with automatic context detection.
|
|
func (eh *ErrorHandler) HandleSimpleError(message string, err error) {
|
|
code := errors.ErrCodeUnknown
|
|
context := make(map[string]string)
|
|
|
|
// Try to determine appropriate error code based on error content
|
|
if err != nil {
|
|
context[ContextKeyError] = err.Error()
|
|
code = eh.determineErrorCode(err)
|
|
}
|
|
|
|
eh.HandleFatalError(code, message, context)
|
|
}
|
|
|
|
// determineErrorCode attempts to determine appropriate error code from error content.
|
|
func (eh *ErrorHandler) determineErrorCode(err error) errors.ErrorCode {
|
|
errStr := err.Error()
|
|
|
|
switch {
|
|
case contains(errStr, errorPatternFileNotFound):
|
|
return errors.ErrCodeFileNotFound
|
|
case contains(errStr, errorPatternPermission):
|
|
return errors.ErrCodePermission
|
|
case contains(errStr, errorPatternYAML):
|
|
return errors.ErrCodeInvalidYAML
|
|
case contains(errStr, errorPatternGitHub):
|
|
return errors.ErrCodeGitHubAPI
|
|
case contains(errStr, errorPatternConfig):
|
|
return errors.ErrCodeConfiguration
|
|
default:
|
|
return errors.ErrCodeUnknown
|
|
}
|
|
}
|
|
|
|
// contains checks if a string contains a substring (case-insensitive).
|
|
func contains(s, substr string) bool {
|
|
return strings.Contains(strings.ToLower(s), strings.ToLower(substr))
|
|
}
|