mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-09 11:47:35 +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.
33 lines
738 B
Go
33 lines
738 B
Go
package internal
|
|
|
|
import (
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/ivuorinen/gh-action-readme/testutil"
|
|
)
|
|
|
|
func TestRenderReadme(t *testing.T) {
|
|
// Set up test templates
|
|
tmpDir, cleanup := testutil.TempDir(t)
|
|
defer cleanup()
|
|
testutil.SetupTestTemplates(t, tmpDir)
|
|
|
|
action := &ActionYML{
|
|
Name: "MyAction",
|
|
Description: "desc",
|
|
Inputs: map[string]ActionInput{
|
|
"foo": {Description: "Foo input", Required: true},
|
|
},
|
|
}
|
|
tmpl := filepath.Join(tmpDir, "templates", "readme.tmpl")
|
|
opts := TemplateOptions{TemplatePath: tmpl, Format: "md"}
|
|
out, err := RenderReadme(action, opts)
|
|
if err != nil {
|
|
t.Fatalf("render failed: %v", err)
|
|
}
|
|
if len(out) < 10 || out[0:1] != "#" {
|
|
t.Error("unexpected output content")
|
|
}
|
|
}
|