mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-03-11 20:59:57 +00:00
refactor: major codebase improvements and test framework overhaul
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.
This commit is contained in:
@@ -77,9 +77,7 @@ func (d *ProjectDetector) DetectProjectSettings() (*DetectedSettings, error) {
|
||||
}
|
||||
|
||||
// Detect project characteristics
|
||||
if err := d.detectProjectCharacteristics(settings); err != nil {
|
||||
d.output.Warning("Could not detect project characteristics: %v", err)
|
||||
}
|
||||
d.detectProjectCharacteristics(settings)
|
||||
|
||||
// Suggest configuration based on detection
|
||||
d.suggestConfiguration(settings)
|
||||
@@ -134,7 +132,7 @@ func (d *ProjectDetector) detectActionFiles(settings *DetectedSettings) error {
|
||||
}
|
||||
|
||||
// detectProjectCharacteristics detects project type, language, and framework.
|
||||
func (d *ProjectDetector) detectProjectCharacteristics(settings *DetectedSettings) error {
|
||||
func (d *ProjectDetector) detectProjectCharacteristics(settings *DetectedSettings) {
|
||||
// Check for common files and patterns
|
||||
characteristics := d.analyzeProjectFiles()
|
||||
|
||||
@@ -148,8 +146,6 @@ func (d *ProjectDetector) detectProjectCharacteristics(settings *DetectedSetting
|
||||
settings.HasDockerfile = true
|
||||
d.output.Success("Detected Dockerfile")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// detectVersion attempts to detect project version from various sources.
|
||||
@@ -175,7 +171,7 @@ func (d *ProjectDetector) detectVersion() string {
|
||||
// detectVersionFromPackageJSON detects version from package.json.
|
||||
func (d *ProjectDetector) detectVersionFromPackageJSON() string {
|
||||
packageJSONPath := filepath.Join(d.currentDir, "package.json")
|
||||
data, err := os.ReadFile(packageJSONPath)
|
||||
data, err := os.ReadFile(packageJSONPath) // #nosec G304 -- path is constructed from current directory
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
@@ -208,6 +204,7 @@ func (d *ProjectDetector) detectVersionFromFiles() string {
|
||||
|
||||
for _, filename := range versionFiles {
|
||||
versionPath := filepath.Join(d.currentDir, filename)
|
||||
// #nosec G304 -- path constructed from current dir
|
||||
if data, err := os.ReadFile(versionPath); err == nil {
|
||||
version := strings.TrimSpace(string(data))
|
||||
if version != "" {
|
||||
@@ -293,7 +290,7 @@ func (d *ProjectDetector) analyzeActionFile(actionFile string, settings *Detecte
|
||||
|
||||
// parseActionFile reads and parses an action YAML file.
|
||||
func (d *ProjectDetector) parseActionFile(actionFile string) (map[string]any, error) {
|
||||
data, err := os.ReadFile(actionFile)
|
||||
data, err := os.ReadFile(actionFile) // #nosec G304 -- action file path from function parameter
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read action file: %w", err)
|
||||
}
|
||||
|
||||
@@ -23,7 +23,7 @@ func TestProjectDetector_analyzeProjectFiles(t *testing.T) {
|
||||
|
||||
for filename, content := range testFiles {
|
||||
filePath := filepath.Join(tempDir, filename)
|
||||
if err := os.WriteFile(filePath, []byte(content), 0644); err != nil {
|
||||
if err := os.WriteFile(filePath, []byte(content), 0600); err != nil { // #nosec G306 -- test file permissions
|
||||
t.Fatalf("Failed to create test file %s: %v", filename, err)
|
||||
}
|
||||
}
|
||||
@@ -73,7 +73,7 @@ func TestProjectDetector_detectVersionFromPackageJSON(t *testing.T) {
|
||||
}`
|
||||
|
||||
packagePath := filepath.Join(tempDir, "package.json")
|
||||
if err := os.WriteFile(packagePath, []byte(packageJSON), 0644); err != nil {
|
||||
if err := os.WriteFile(packagePath, []byte(packageJSON), 0600); err != nil { // #nosec G306 -- test file permissions
|
||||
t.Fatalf("Failed to create package.json: %v", err)
|
||||
}
|
||||
|
||||
@@ -95,7 +95,7 @@ func TestProjectDetector_detectVersionFromFiles(t *testing.T) {
|
||||
// Create VERSION file
|
||||
versionContent := "3.2.1\n"
|
||||
versionPath := filepath.Join(tempDir, "VERSION")
|
||||
if err := os.WriteFile(versionPath, []byte(versionContent), 0644); err != nil {
|
||||
if err := os.WriteFile(versionPath, []byte(versionContent), 0600); err != nil { // #nosec G306 -- test file permissions
|
||||
t.Fatalf("Failed to create VERSION file: %v", err)
|
||||
}
|
||||
|
||||
@@ -116,18 +116,26 @@ func TestProjectDetector_findActionFiles(t *testing.T) {
|
||||
|
||||
// Create action files
|
||||
actionYML := filepath.Join(tempDir, "action.yml")
|
||||
if err := os.WriteFile(actionYML, []byte("name: Test Action"), 0644); err != nil {
|
||||
if err := os.WriteFile(
|
||||
actionYML,
|
||||
[]byte("name: Test Action"),
|
||||
0600, // #nosec G306 -- test file permissions
|
||||
); err != nil {
|
||||
t.Fatalf("Failed to create action.yml: %v", err)
|
||||
}
|
||||
|
||||
// Create subdirectory with another action file
|
||||
subDir := filepath.Join(tempDir, "subaction")
|
||||
if err := os.MkdirAll(subDir, 0755); err != nil {
|
||||
if err := os.MkdirAll(subDir, 0750); err != nil { // #nosec G301 -- test directory permissions
|
||||
t.Fatalf("Failed to create subdirectory: %v", err)
|
||||
}
|
||||
|
||||
subActionYAML := filepath.Join(subDir, "action.yaml")
|
||||
if err := os.WriteFile(subActionYAML, []byte("name: Sub Action"), 0644); err != nil {
|
||||
if err := os.WriteFile(
|
||||
subActionYAML,
|
||||
[]byte("name: Sub Action"),
|
||||
0600, // #nosec G306 -- test file permissions
|
||||
); err != nil {
|
||||
t.Fatalf("Failed to create sub action.yaml: %v", err)
|
||||
}
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ func NewConfigExporter(output *internal.ColoredOutput) *ConfigExporter {
|
||||
// ExportConfig exports the configuration to the specified format and path.
|
||||
func (e *ConfigExporter) ExportConfig(config *internal.AppConfig, format ExportFormat, outputPath string) error {
|
||||
// Create output directory if it doesn't exist
|
||||
if err := os.MkdirAll(filepath.Dir(outputPath), 0755); err != nil {
|
||||
if err := os.MkdirAll(filepath.Dir(outputPath), 0750); err != nil { // #nosec G301 -- output directory permissions
|
||||
return fmt.Errorf("failed to create output directory: %w", err)
|
||||
}
|
||||
|
||||
@@ -60,7 +60,7 @@ func (e *ConfigExporter) exportYAML(config *internal.AppConfig, outputPath strin
|
||||
// Create a clean config without sensitive data for export
|
||||
exportConfig := e.sanitizeConfig(config)
|
||||
|
||||
file, err := os.Create(outputPath)
|
||||
file, err := os.Create(outputPath) // #nosec G304 -- output path from function parameter
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create YAML file: %w", err)
|
||||
}
|
||||
@@ -88,7 +88,7 @@ func (e *ConfigExporter) exportJSON(config *internal.AppConfig, outputPath strin
|
||||
// Create a clean config without sensitive data for export
|
||||
exportConfig := e.sanitizeConfig(config)
|
||||
|
||||
file, err := os.Create(outputPath)
|
||||
file, err := os.Create(outputPath) // #nosec G304 -- output path from function parameter
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create JSON file: %w", err)
|
||||
}
|
||||
@@ -113,7 +113,7 @@ func (e *ConfigExporter) exportTOML(config *internal.AppConfig, outputPath strin
|
||||
// In a full implementation, you would use "github.com/BurntSushi/toml"
|
||||
exportConfig := e.sanitizeConfig(config)
|
||||
|
||||
file, err := os.Create(outputPath)
|
||||
file, err := os.Create(outputPath) // #nosec G304 -- output path from function parameter
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create TOML file: %w", err)
|
||||
}
|
||||
@@ -126,9 +126,7 @@ func (e *ConfigExporter) exportTOML(config *internal.AppConfig, outputPath strin
|
||||
_, _ = file.WriteString("# Generated by the interactive configuration wizard\n\n")
|
||||
|
||||
// Basic TOML export (simplified version)
|
||||
if err := e.writeTOMLConfig(file, exportConfig); err != nil {
|
||||
return fmt.Errorf("failed to write TOML: %w", err)
|
||||
}
|
||||
e.writeTOMLConfig(file, exportConfig)
|
||||
|
||||
e.output.Success("Configuration exported to: %s", outputPath)
|
||||
return nil
|
||||
@@ -173,7 +171,7 @@ func (e *ConfigExporter) sanitizeConfig(config *internal.AppConfig) *internal.Ap
|
||||
}
|
||||
|
||||
// writeTOMLConfig writes a basic TOML configuration.
|
||||
func (e *ConfigExporter) writeTOMLConfig(file *os.File, config *internal.AppConfig) error {
|
||||
func (e *ConfigExporter) writeTOMLConfig(file *os.File, config *internal.AppConfig) {
|
||||
e.writeRepositorySection(file, config)
|
||||
e.writeTemplateSection(file, config)
|
||||
e.writeFeaturesSection(file, config)
|
||||
@@ -181,8 +179,6 @@ func (e *ConfigExporter) writeTOMLConfig(file *os.File, config *internal.AppConf
|
||||
e.writeWorkflowSection(file, config)
|
||||
e.writePermissionsSection(file, config)
|
||||
e.writeVariablesSection(file, config)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// writeRepositorySection writes the repository information section.
|
||||
|
||||
@@ -103,7 +103,7 @@ func verifyFileExists(t *testing.T, outputPath string) {
|
||||
|
||||
// verifyYAMLContent verifies YAML content is valid and contains expected data.
|
||||
func verifyYAMLContent(t *testing.T, outputPath string, expected *internal.AppConfig) {
|
||||
data, err := os.ReadFile(outputPath)
|
||||
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to read output file: %v", err)
|
||||
}
|
||||
@@ -123,7 +123,7 @@ func verifyYAMLContent(t *testing.T, outputPath string, expected *internal.AppCo
|
||||
|
||||
// verifyJSONContent verifies JSON content is valid and contains expected data.
|
||||
func verifyJSONContent(t *testing.T, outputPath string, expected *internal.AppConfig) {
|
||||
data, err := os.ReadFile(outputPath)
|
||||
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to read output file: %v", err)
|
||||
}
|
||||
@@ -143,7 +143,7 @@ func verifyJSONContent(t *testing.T, outputPath string, expected *internal.AppCo
|
||||
|
||||
// verifyTOMLContent verifies TOML content contains expected fields.
|
||||
func verifyTOMLContent(t *testing.T, outputPath string) {
|
||||
data, err := os.ReadFile(outputPath)
|
||||
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to read output file: %v", err)
|
||||
}
|
||||
|
||||
@@ -43,24 +43,16 @@ func (w *ConfigWizard) Run() (*internal.AppConfig, error) {
|
||||
}
|
||||
|
||||
// Step 2: Configure basic settings
|
||||
if err := w.configureBasicSettings(); err != nil {
|
||||
return nil, fmt.Errorf("failed to configure basic settings: %w", err)
|
||||
}
|
||||
w.configureBasicSettings()
|
||||
|
||||
// Step 3: Configure template and output settings
|
||||
if err := w.configureTemplateSettings(); err != nil {
|
||||
return nil, fmt.Errorf("failed to configure template settings: %w", err)
|
||||
}
|
||||
w.configureTemplateSettings()
|
||||
|
||||
// Step 4: Configure features
|
||||
if err := w.configureFeatures(); err != nil {
|
||||
return nil, fmt.Errorf("failed to configure features: %w", err)
|
||||
}
|
||||
w.configureFeatures()
|
||||
|
||||
// Step 5: Configure GitHub integration
|
||||
if err := w.configureGitHubIntegration(); err != nil {
|
||||
return nil, fmt.Errorf("failed to configure GitHub integration: %w", err)
|
||||
}
|
||||
w.configureGitHubIntegration()
|
||||
|
||||
// Step 6: Summary and confirmation
|
||||
if err := w.showSummaryAndConfirm(); err != nil {
|
||||
@@ -96,8 +88,8 @@ func (w *ConfigWizard) detectProjectSettings() error {
|
||||
}
|
||||
|
||||
// Check for existing action files
|
||||
actionFiles, err := w.findActionFiles(currentDir)
|
||||
if err == nil && len(actionFiles) > 0 {
|
||||
actionFiles := w.findActionFiles(currentDir)
|
||||
if len(actionFiles) > 0 {
|
||||
w.output.Success(" 🎯 Found %d action file(s)", len(actionFiles))
|
||||
}
|
||||
|
||||
@@ -105,7 +97,7 @@ func (w *ConfigWizard) detectProjectSettings() error {
|
||||
}
|
||||
|
||||
// configureBasicSettings handles basic configuration prompts.
|
||||
func (w *ConfigWizard) configureBasicSettings() error {
|
||||
func (w *ConfigWizard) configureBasicSettings() {
|
||||
w.output.Bold("\n⚙️ Step 2: Basic Settings")
|
||||
|
||||
// Organization
|
||||
@@ -119,19 +111,15 @@ func (w *ConfigWizard) configureBasicSettings() error {
|
||||
if version != "" {
|
||||
w.config.Version = version
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// configureTemplateSettings handles template and output configuration.
|
||||
func (w *ConfigWizard) configureTemplateSettings() error {
|
||||
func (w *ConfigWizard) configureTemplateSettings() {
|
||||
w.output.Bold("\n🎨 Step 3: Template & Output Settings")
|
||||
|
||||
w.configureThemeSelection()
|
||||
w.configureOutputFormat()
|
||||
w.configureOutputDirectory()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// configureThemeSelection handles theme selection.
|
||||
@@ -208,7 +196,7 @@ func (w *ConfigWizard) displayFormatOptions(formats []string) {
|
||||
}
|
||||
|
||||
// configureFeatures handles feature configuration.
|
||||
func (w *ConfigWizard) configureFeatures() error {
|
||||
func (w *ConfigWizard) configureFeatures() {
|
||||
w.output.Bold("\n🚀 Step 4: Features")
|
||||
|
||||
// Dependency analysis
|
||||
@@ -220,19 +208,17 @@ func (w *ConfigWizard) configureFeatures() error {
|
||||
w.output.Info("Security information shows pinned vs floating versions and security recommendations.")
|
||||
showSecurity := w.promptYesNo("Show security information?", w.config.ShowSecurityInfo)
|
||||
w.config.ShowSecurityInfo = showSecurity
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// configureGitHubIntegration handles GitHub API configuration.
|
||||
func (w *ConfigWizard) configureGitHubIntegration() error {
|
||||
func (w *ConfigWizard) configureGitHubIntegration() {
|
||||
w.output.Bold("\n🐙 Step 5: GitHub Integration")
|
||||
|
||||
// Check for existing token
|
||||
existingToken := internal.GetGitHubToken(w.config)
|
||||
if existingToken != "" {
|
||||
w.output.Success("GitHub token already configured ✓")
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
w.output.Info("GitHub integration requires a personal access token for:")
|
||||
@@ -245,7 +231,7 @@ func (w *ConfigWizard) configureGitHubIntegration() error {
|
||||
if !setupToken {
|
||||
w.output.Info("You can set up the token later using environment variables:")
|
||||
w.output.Printf(" export GITHUB_TOKEN=your_personal_access_token")
|
||||
return nil
|
||||
return
|
||||
}
|
||||
|
||||
w.output.Info("\nTo create a personal access token:")
|
||||
@@ -265,8 +251,6 @@ func (w *ConfigWizard) configureGitHubIntegration() error {
|
||||
w.config.GitHubToken = token
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// showSummaryAndConfirm displays configuration summary and asks for confirmation.
|
||||
@@ -286,9 +270,9 @@ func (w *ConfigWizard) showSummaryAndConfirm() error {
|
||||
|
||||
tokenStatus := "Not configured"
|
||||
if w.config.GitHubToken != "" {
|
||||
tokenStatus = "Configured ✓"
|
||||
tokenStatus = "Configured ✓" // #nosec G101 -- status message, not actual token
|
||||
} else if internal.GetGitHubToken(w.config) != "" {
|
||||
tokenStatus = "Configured via environment ✓"
|
||||
tokenStatus = "Configured via environment ✓" // #nosec G101 -- status message, not actual token
|
||||
}
|
||||
w.output.Printf(" GitHub Token: %s", tokenStatus)
|
||||
|
||||
@@ -361,7 +345,7 @@ func (w *ConfigWizard) promptYesNo(prompt string, defaultValue bool) bool {
|
||||
}
|
||||
|
||||
// findActionFiles discovers action files in the given directory.
|
||||
func (w *ConfigWizard) findActionFiles(dir string) ([]string, error) {
|
||||
func (w *ConfigWizard) findActionFiles(dir string) []string {
|
||||
var actionFiles []string
|
||||
|
||||
// Check for action.yml and action.yaml
|
||||
@@ -372,5 +356,5 @@ func (w *ConfigWizard) findActionFiles(dir string) ([]string, error) {
|
||||
}
|
||||
}
|
||||
|
||||
return actionFiles, nil
|
||||
return actionFiles
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user