ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-03-01 11:55:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: major codebase improvements and test framework overhaul

Browse Source 
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:
Ismo Vuorinen
2025-08-05 23:20:58 +03:00
parent f9823eef3e
commit f94967713a
93 changed files with 8845 additions and 1224 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
internal/validation/validation_test.go
View File

@@ -19,7 +19,7 @@ func TestValidateActionYMLPath(t *testing.T) {
name: "valid action.yml file",
setupFunc: func(t *testing.T, tmpDir string) string {
actionPath := filepath.Join(tmpDir, "action.yml")
testutil.WriteTestFile(t, actionPath, testutil.SimpleActionYML)
testutil.WriteTestFile(t, actionPath, testutil.MustReadFixture("actions/javascript/simple.yml"))
return actionPath
},
expectError: false,
@@ -28,7 +28,7 @@ func TestValidateActionYMLPath(t *testing.T) {
name: "valid action.yaml file",
setupFunc: func(t *testing.T, tmpDir string) string {
actionPath := filepath.Join(tmpDir, "action.yaml")
testutil.WriteTestFile(t, actionPath, testutil.MinimalActionYML)
testutil.WriteTestFile(t, actionPath, testutil.MustReadFixture("minimal-action.yml"))
return actionPath
},
expectError: false,
@@ -44,7 +44,7 @@ func TestValidateActionYMLPath(t *testing.T) {
name: "file with wrong extension",
setupFunc: func(t *testing.T, tmpDir string) string {
actionPath := filepath.Join(tmpDir, "action.txt")
testutil.WriteTestFile(t, actionPath, testutil.SimpleActionYML)
testutil.WriteTestFile(t, actionPath, testutil.MustReadFixture("actions/javascript/simple.yml"))
return actionPath
},
expectError: true,
@@ -240,7 +240,7 @@ func TestValidateGitBranch(t *testing.T) {
setupFunc: func(_ *testing.T, tmpDir string) (string, string) {
// Create a simple git repository
gitDir := filepath.Join(tmpDir, ".git")
_ = os.MkdirAll(gitDir, 0755)
_ = os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
// Create a basic git config
configContent := `[core]
@@ -297,7 +297,7 @@ func TestIsGitRepository(t *testing.T) {
name: "directory with .git folder",
setupFunc: func(_ *testing.T, tmpDir string) string {
gitDir := filepath.Join(tmpDir, ".git")
_ = os.MkdirAll(gitDir, 0755)
_ = os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
return tmpDir
},
expected: true,