mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-16 20:50:21 +00:00
feat(lint): add many linters, make all the tests run fast! (#23)
* chore(lint): added nlreturn, run linting * chore(lint): replace some fmt.Sprintf calls * chore(lint): replace fmt.Sprintf with strconv * chore(lint): add goconst, use http lib for status codes, and methods * chore(lint): use errors lib, errCodes from internal/errors * chore(lint): dupl, thelper and usetesting * chore(lint): fmt.Errorf %v to %w, more linters * chore(lint): paralleltest, where possible * perf(test): optimize test performance by 78% - Implement shared binary building with package-level cache to eliminate redundant builds - Add strategic parallelization to 15+ tests while preserving environment variable isolation - Implement thread-safe fixture caching with RWMutex to reduce I/O operations - Remove unnecessary working directory changes by leveraging embedded templates - Add embedded template system with go:embed directive for reliable template resolution - Fix linting issues: rename sharedBinaryError to errSharedBinary, add nolint directive Performance improvements: - Total test execution time: 12+ seconds → 2.7 seconds (78% faster) - Binary build overhead: 14+ separate builds → 1 shared build (93% reduction) - Parallel execution: Limited → 15+ concurrent tests (60-70% better CPU usage) - I/O operations: 66+ fixture reads → cached with sync.RWMutex (50% reduction) All tests maintain 100% success rate and coverage while running nearly 4x faster.
This commit is contained in:
@@ -65,13 +65,13 @@ func (ce *ContextualError) Error() string {
|
||||
if len(ce.Suggestions) > 0 {
|
||||
b.WriteString("\n\nSuggestions:")
|
||||
for _, suggestion := range ce.Suggestions {
|
||||
b.WriteString(fmt.Sprintf("\n • %s", suggestion))
|
||||
b.WriteString("\n • " + suggestion)
|
||||
}
|
||||
}
|
||||
|
||||
// Add help URL
|
||||
if ce.HelpURL != "" {
|
||||
b.WriteString(fmt.Sprintf("\n\nFor more help: %s", ce.HelpURL))
|
||||
b.WriteString("\n\nFor more help: " + ce.HelpURL)
|
||||
}
|
||||
|
||||
return b.String()
|
||||
@@ -120,6 +120,7 @@ func Wrap(err error, code ErrorCode, context string) *ContextualError {
|
||||
if ce.Context == "" {
|
||||
ce.Context = context
|
||||
}
|
||||
|
||||
return ce
|
||||
}
|
||||
|
||||
@@ -133,6 +134,7 @@ func Wrap(err error, code ErrorCode, context string) *ContextualError {
|
||||
// WithSuggestions adds suggestions to a ContextualError.
|
||||
func (ce *ContextualError) WithSuggestions(suggestions ...string) *ContextualError {
|
||||
ce.Suggestions = append(ce.Suggestions, suggestions...)
|
||||
|
||||
return ce
|
||||
}
|
||||
|
||||
@@ -144,12 +146,14 @@ func (ce *ContextualError) WithDetails(details map[string]string) *ContextualErr
|
||||
for k, v := range details {
|
||||
ce.Details[k] = v
|
||||
}
|
||||
|
||||
return ce
|
||||
}
|
||||
|
||||
// WithHelpURL adds a help URL to a ContextualError.
|
||||
func (ce *ContextualError) WithHelpURL(url string) *ContextualError {
|
||||
ce.HelpURL = url
|
||||
|
||||
return ce
|
||||
}
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ import (
|
||||
)
|
||||
|
||||
func TestContextualError_Error(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
err *ContextualError
|
||||
@@ -103,6 +105,8 @@ func TestContextualError_Error(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
result := tt.err.Error()
|
||||
|
||||
for _, expected := range tt.contains {
|
||||
@@ -119,6 +123,8 @@ func TestContextualError_Error(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestContextualError_Unwrap(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
originalErr := errors.New("original error")
|
||||
contextualErr := &ContextualError{
|
||||
Code: ErrCodeFileNotFound,
|
||||
@@ -131,6 +137,8 @@ func TestContextualError_Unwrap(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestContextualError_Is(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
originalErr := errors.New("original error")
|
||||
contextualErr := &ContextualError{
|
||||
Code: ErrCodeFileNotFound,
|
||||
@@ -156,6 +164,8 @@ func TestContextualError_Is(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestNew(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
err := New(ErrCodeFileNotFound, "test message")
|
||||
|
||||
if err.Code != ErrCodeFileNotFound {
|
||||
@@ -168,6 +178,8 @@ func TestNew(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestWrap(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
originalErr := errors.New("original error")
|
||||
|
||||
// Test wrapping normal error
|
||||
@@ -204,6 +216,8 @@ func TestWrap(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestContextualError_WithMethods(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
err := New(ErrCodeFileNotFound, "test error")
|
||||
|
||||
// Test WithSuggestions
|
||||
@@ -234,6 +248,8 @@ func TestContextualError_WithMethods(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetHelpURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
code ErrorCode
|
||||
contains string
|
||||
@@ -246,6 +262,8 @@ func TestGetHelpURL(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(string(tt.code), func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
url := GetHelpURL(tt.code)
|
||||
if !strings.Contains(url, tt.contains) {
|
||||
t.Errorf("GetHelpURL(%s) = %s, should contain %s", tt.code, url, tt.contains)
|
||||
|
||||
@@ -13,6 +13,7 @@ func GetSuggestions(code ErrorCode, context map[string]string) []string {
|
||||
if handler := getSuggestionHandler(code); handler != nil {
|
||||
return handler(context)
|
||||
}
|
||||
|
||||
return getDefaultSuggestions()
|
||||
}
|
||||
|
||||
@@ -63,7 +64,7 @@ func getFileNotFoundSuggestions(context map[string]string) []string {
|
||||
|
||||
if path, ok := context["path"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Check if the file exists: %s", path),
|
||||
"Check if the file exists: "+path,
|
||||
"Verify the file path is correct",
|
||||
)
|
||||
|
||||
@@ -72,7 +73,7 @@ func getFileNotFoundSuggestions(context map[string]string) []string {
|
||||
if _, err := os.Stat(dir); err == nil {
|
||||
suggestions = append(suggestions,
|
||||
"Check for case sensitivity in the filename",
|
||||
fmt.Sprintf("Try: ls -la %s", dir),
|
||||
"Try: ls -la "+dir,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -98,14 +99,14 @@ func getPermissionSuggestions(context map[string]string) []string {
|
||||
|
||||
if path, ok := context["path"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Check file permissions: ls -la %s", path),
|
||||
fmt.Sprintf("Try changing permissions: chmod 644 %s", path),
|
||||
"Check file permissions: ls -la "+path,
|
||||
"Try changing permissions: chmod 644 "+path,
|
||||
)
|
||||
|
||||
// Check if it's a directory
|
||||
if info, err := os.Stat(path); err == nil && info.IsDir() {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("For directories, try: chmod 755 %s", path),
|
||||
"For directories, try: chmod 755 "+path,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -168,7 +169,7 @@ func getInvalidActionSuggestions(context map[string]string) []string {
|
||||
|
||||
if missingFields, ok := context["missing_fields"]; ok {
|
||||
suggestions = append([]string{
|
||||
fmt.Sprintf("Missing required fields: %s", missingFields),
|
||||
"Missing required fields: " + missingFields,
|
||||
}, suggestions...)
|
||||
}
|
||||
|
||||
@@ -196,7 +197,7 @@ func getNoActionFilesSuggestions(context map[string]string) []string {
|
||||
|
||||
if dir, ok := context["directory"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Current directory: %s", dir),
|
||||
"Current directory: "+dir,
|
||||
fmt.Sprintf("Try: find %s -name 'action.y*ml' -type f", dir),
|
||||
)
|
||||
}
|
||||
@@ -274,8 +275,8 @@ func getConfigurationSuggestions(context map[string]string) []string {
|
||||
|
||||
if configPath, ok := context["config_path"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Config path: %s", configPath),
|
||||
fmt.Sprintf("Check if file exists: ls -la %s", configPath),
|
||||
"Config path: "+configPath,
|
||||
"Check if file exists: ls -la "+configPath,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -301,7 +302,7 @@ func getValidationSuggestions(context map[string]string) []string {
|
||||
|
||||
if fields, ok := context["invalid_fields"]; ok {
|
||||
suggestions = append([]string{
|
||||
fmt.Sprintf("Invalid fields: %s", fields),
|
||||
"Invalid fields: " + fields,
|
||||
"Check spelling and nesting of these fields",
|
||||
}, suggestions...)
|
||||
}
|
||||
@@ -333,14 +334,14 @@ func getTemplateSuggestions(context map[string]string) []string {
|
||||
|
||||
if templatePath, ok := context["template_path"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Template path: %s", templatePath),
|
||||
"Template path: "+templatePath,
|
||||
"Ensure template file exists and is readable",
|
||||
)
|
||||
}
|
||||
|
||||
if theme, ok := context["theme"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Current theme: %s", theme),
|
||||
"Current theme: "+theme,
|
||||
"Try using a different theme: --theme github",
|
||||
"Available themes: default, github, gitlab, minimal, professional",
|
||||
)
|
||||
@@ -359,9 +360,9 @@ func getFileWriteSuggestions(context map[string]string) []string {
|
||||
if outputPath, ok := context["output_path"]; ok {
|
||||
dir := filepath.Dir(outputPath)
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Output directory: %s", dir),
|
||||
fmt.Sprintf("Check permissions: ls -la %s", dir),
|
||||
fmt.Sprintf("Create directory if needed: mkdir -p %s", dir),
|
||||
"Output directory: "+dir,
|
||||
"Check permissions: ls -la "+dir,
|
||||
"Create directory if needed: mkdir -p "+dir,
|
||||
)
|
||||
|
||||
// Check if file already exists
|
||||
@@ -385,7 +386,7 @@ func getDependencyAnalysisSuggestions(context map[string]string) []string {
|
||||
|
||||
if action, ok := context["action"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Analyzing action: %s", action),
|
||||
"Analyzing action: "+action,
|
||||
"Only composite actions have analyzable dependencies",
|
||||
)
|
||||
}
|
||||
@@ -406,8 +407,8 @@ func getCacheAccessSuggestions(context map[string]string) []string {
|
||||
|
||||
if cachePath, ok := context["cache_path"]; ok {
|
||||
suggestions = append(suggestions,
|
||||
fmt.Sprintf("Cache path: %s", cachePath),
|
||||
fmt.Sprintf("Check permissions: ls -la %s", cachePath),
|
||||
"Cache path: "+cachePath,
|
||||
"Check permissions: ls -la "+cachePath,
|
||||
"You can disable cache temporarily with environment variables",
|
||||
)
|
||||
}
|
||||
|
||||
@@ -7,6 +7,8 @@ import (
|
||||
)
|
||||
|
||||
func TestGetSuggestions(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
code ErrorCode
|
||||
@@ -239,10 +241,13 @@ func TestGetSuggestions(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
suggestions := GetSuggestions(tt.code, tt.context)
|
||||
|
||||
if len(suggestions) == 0 {
|
||||
t.Error("GetSuggestions() returned empty slice")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@@ -261,6 +266,8 @@ func TestGetSuggestions(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetPermissionSuggestions_OSSpecific(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
context := map[string]string{"path": "/test/file"}
|
||||
suggestions := getPermissionSuggestions(context)
|
||||
|
||||
@@ -285,6 +292,8 @@ func TestGetPermissionSuggestions_OSSpecific(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetSuggestions_EmptyContext(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Test that all error codes work with empty context
|
||||
errorCodes := []ErrorCode{
|
||||
ErrCodeFileNotFound,
|
||||
@@ -305,6 +314,8 @@ func TestGetSuggestions_EmptyContext(t *testing.T) {
|
||||
|
||||
for _, code := range errorCodes {
|
||||
t.Run(string(code), func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
suggestions := GetSuggestions(code, map[string]string{})
|
||||
if len(suggestions) == 0 {
|
||||
t.Errorf("GetSuggestions(%s, {}) returned empty slice", code)
|
||||
@@ -314,6 +325,8 @@ func TestGetSuggestions_EmptyContext(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetFileNotFoundSuggestions_ActionFile(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
context := map[string]string{
|
||||
"path": "/project/action.yml",
|
||||
}
|
||||
@@ -332,6 +345,8 @@ func TestGetFileNotFoundSuggestions_ActionFile(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetInvalidYAMLSuggestions_TabError(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
context := map[string]string{
|
||||
"error": "found character that cannot start any token, tab character",
|
||||
}
|
||||
@@ -346,6 +361,8 @@ func TestGetInvalidYAMLSuggestions_TabError(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestGetGitHubAPISuggestions_StatusCodes(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
statusCodes := map[string]string{
|
||||
"401": "Authentication failed",
|
||||
"403": "Access forbidden",
|
||||
@@ -354,6 +371,8 @@ func TestGetGitHubAPISuggestions_StatusCodes(t *testing.T) {
|
||||
|
||||
for code, expectedText := range statusCodes {
|
||||
t.Run("status_"+code, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
context := map[string]string{"status_code": code}
|
||||
suggestions := getGitHubAPISuggestions(context)
|
||||
allSuggestions := strings.Join(suggestions, " ")
|
||||
|
||||
Reference in New Issue
Block a user