mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-01-26 11:14:04 +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:
@@ -3,6 +3,7 @@ package git
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
@@ -30,6 +31,7 @@ func (r *RepoInfo) GetRepositoryName() string {
|
||||
if r.Organization != "" && r.Repository != "" {
|
||||
return fmt.Sprintf("%s/%s", r.Organization, r.Repository)
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
@@ -50,7 +52,7 @@ func FindRepositoryRoot(startPath string) (string, error) {
|
||||
parent := filepath.Dir(absPath)
|
||||
if parent == absPath {
|
||||
// Reached root without finding .git
|
||||
return "", fmt.Errorf("not a git repository")
|
||||
return "", errors.New("not a git repository")
|
||||
}
|
||||
absPath = parent
|
||||
}
|
||||
@@ -129,12 +131,14 @@ func getRemoteURLFromConfig(repoRoot string) (string, error) {
|
||||
// Check for [remote "origin"] section
|
||||
if strings.Contains(line, `[remote "origin"]`) {
|
||||
inOriginSection = true
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
// Check for new section
|
||||
if strings.HasPrefix(line, "[") && inOriginSection {
|
||||
inOriginSection = false
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
@@ -144,7 +148,7 @@ func getRemoteURLFromConfig(repoRoot string) (string, error) {
|
||||
}
|
||||
}
|
||||
|
||||
return "", fmt.Errorf("no origin remote URL found in git config")
|
||||
return "", errors.New("no origin remote URL found in git config")
|
||||
}
|
||||
|
||||
// getDefaultBranch gets the default branch name.
|
||||
@@ -160,6 +164,7 @@ func getDefaultBranch(repoRoot string) string {
|
||||
return branch
|
||||
}
|
||||
}
|
||||
|
||||
return DefaultBranch // Default fallback
|
||||
}
|
||||
|
||||
@@ -182,6 +187,7 @@ func branchExists(repoRoot, branch string) bool {
|
||||
"refs/heads/"+branch,
|
||||
) // #nosec G204 -- branch name validated by git
|
||||
cmd.Dir = repoRoot
|
||||
|
||||
return cmd.Run() == nil
|
||||
}
|
||||
|
||||
@@ -225,5 +231,6 @@ func (r *RepoInfo) GenerateUsesStatement(actionName, version string) string {
|
||||
if actionName != "" {
|
||||
return fmt.Sprintf("your-org/%s@%s", actionName, version)
|
||||
}
|
||||
|
||||
return "your-org/your-action@v1"
|
||||
}
|
||||
|
||||
@@ -9,6 +9,8 @@ import (
|
||||
)
|
||||
|
||||
func TestFindRepositoryRoot(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
setupFunc func(t *testing.T, tmpDir string) string
|
||||
@@ -18,6 +20,7 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
{
|
||||
name: "git repository with .git directory",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
// Create .git directory
|
||||
gitDir := filepath.Join(tmpDir, ".git")
|
||||
err := os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
|
||||
@@ -40,6 +43,7 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
{
|
||||
name: "git repository with .git file",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
// Create .git file (for git worktrees)
|
||||
gitFile := filepath.Join(tmpDir, ".git")
|
||||
testutil.WriteTestFile(t, gitFile, "gitdir: /path/to/git/dir")
|
||||
@@ -52,12 +56,14 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
{
|
||||
name: "no git repository",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
// Create subdirectory without .git
|
||||
subDir := filepath.Join(tmpDir, "subdir")
|
||||
err := os.MkdirAll(subDir, 0750) // #nosec G301 -- test directory permissions
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create subdirectory: %v", err)
|
||||
}
|
||||
|
||||
return subDir
|
||||
},
|
||||
expectError: true,
|
||||
@@ -65,6 +71,8 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
{
|
||||
name: "nonexistent directory",
|
||||
setupFunc: func(_ *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
|
||||
return filepath.Join(tmpDir, "nonexistent")
|
||||
},
|
||||
expectError: true,
|
||||
@@ -73,6 +81,8 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir, cleanup := testutil.TempDir(t)
|
||||
defer cleanup()
|
||||
|
||||
@@ -82,6 +92,7 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
|
||||
if tt.expectError {
|
||||
testutil.AssertError(t, err)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@@ -107,6 +118,8 @@ func TestFindRepositoryRoot(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestDetectGitRepository(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
setupFunc func(t *testing.T, tmpDir string) string
|
||||
@@ -115,6 +128,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
{
|
||||
name: "GitHub repository",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
// Create .git directory
|
||||
gitDir := filepath.Join(tmpDir, ".git")
|
||||
err := os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
|
||||
@@ -141,6 +155,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
return tmpDir
|
||||
},
|
||||
checkFunc: func(t *testing.T, info *RepoInfo) {
|
||||
t.Helper()
|
||||
testutil.AssertEqual(t, "owner", info.Organization)
|
||||
testutil.AssertEqual(t, "repo", info.Repository)
|
||||
testutil.AssertEqual(t, "https://github.com/owner/repo.git", info.RemoteURL)
|
||||
@@ -149,6 +164,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
{
|
||||
name: "SSH remote URL",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
gitDir := filepath.Join(tmpDir, ".git")
|
||||
err := os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
|
||||
if err != nil {
|
||||
@@ -165,6 +181,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
return tmpDir
|
||||
},
|
||||
checkFunc: func(t *testing.T, info *RepoInfo) {
|
||||
t.Helper()
|
||||
testutil.AssertEqual(t, "owner", info.Organization)
|
||||
testutil.AssertEqual(t, "repo", info.Repository)
|
||||
testutil.AssertEqual(t, "git@github.com:owner/repo.git", info.RemoteURL)
|
||||
@@ -176,6 +193,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
return tmpDir
|
||||
},
|
||||
checkFunc: func(t *testing.T, info *RepoInfo) {
|
||||
t.Helper()
|
||||
testutil.AssertEqual(t, false, info.IsGitRepo)
|
||||
testutil.AssertEqual(t, "", info.Organization)
|
||||
testutil.AssertEqual(t, "", info.Repository)
|
||||
@@ -184,6 +202,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
{
|
||||
name: "git repository without origin remote",
|
||||
setupFunc: func(t *testing.T, tmpDir string) string {
|
||||
t.Helper()
|
||||
gitDir := filepath.Join(tmpDir, ".git")
|
||||
err := os.MkdirAll(gitDir, 0750) // #nosec G301 -- test directory permissions
|
||||
if err != nil {
|
||||
@@ -201,6 +220,7 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
return tmpDir
|
||||
},
|
||||
checkFunc: func(t *testing.T, info *RepoInfo) {
|
||||
t.Helper()
|
||||
testutil.AssertEqual(t, true, info.IsGitRepo)
|
||||
testutil.AssertEqual(t, "", info.Organization)
|
||||
testutil.AssertEqual(t, "", info.Repository)
|
||||
@@ -210,6 +230,8 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tmpDir, cleanup := testutil.TempDir(t)
|
||||
defer cleanup()
|
||||
|
||||
@@ -226,6 +248,8 @@ func TestDetectGitRepository(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestParseGitHubURL(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
remoteURL string
|
||||
@@ -266,6 +290,8 @@ func TestParseGitHubURL(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
org, repo := parseGitHubURL(tt.remoteURL)
|
||||
|
||||
testutil.AssertEqual(t, tt.expectedOrg, org)
|
||||
@@ -275,6 +301,8 @@ func TestParseGitHubURL(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestRepoInfo_GetRepositoryName(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
repoInfo RepoInfo
|
||||
@@ -311,6 +339,8 @@ func TestRepoInfo_GetRepositoryName(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
result := tt.repoInfo.GetRepositoryName()
|
||||
testutil.AssertEqual(t, tt.expected, result)
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user