From fcb98c6d3c551de612331dcd54976339b14bbc85 Mon Sep 17 00:00:00 2001 From: Snoweuph Date: Sat, 21 Dec 2024 02:08:34 +0100 Subject: [PATCH] fix: template config path (#2836) --- services/repository/generate.go | 30 ++++++---- tests/integration/repo_generate_test.go | 80 +++++++++++++++++++++++-- 2 files changed, 94 insertions(+), 16 deletions(-) diff --git a/services/repository/generate.go b/services/repository/generate.go index 8bd14ace8d..4a312a33c3 100644 --- a/services/repository/generate.go +++ b/services/repository/generate.go @@ -126,24 +126,32 @@ func (gt *GiteaTemplate) Globs() []glob.Glob { } func checkGiteaTemplate(tmpDir string) (*GiteaTemplate, error) { - gtPath := filepath.Join(tmpDir, ".gitea", "template") - if _, err := os.Stat(gtPath); os.IsNotExist(err) { - return nil, nil - } else if err != nil { - return nil, err + configDirs := []string{".forgejo", ".gitea"} + var templateFilePath string + + for _, dir := range configDirs { + candidatePath := filepath.Join(tmpDir, dir, "template") + if _, err := os.Stat(candidatePath); err == nil { + templateFilePath = candidatePath + break + } else if !os.IsNotExist(err) { + return nil, err + } } - content, err := os.ReadFile(gtPath) + if templateFilePath == "" { + return nil, nil + } + + content, err := os.ReadFile(templateFilePath) if err != nil { return nil, err } - gt := &GiteaTemplate{ - Path: gtPath, + return &GiteaTemplate{ + Path: templateFilePath, Content: content, - } - - return gt, nil + }, nil } func generateRepoCommit(ctx context.Context, repo, templateRepo, generateRepo *repo_model.Repository, tmpDir string) error { diff --git a/tests/integration/repo_generate_test.go b/tests/integration/repo_generate_test.go index 0b2870ad56..4bd9f32119 100644 --- a/tests/integration/repo_generate_test.go +++ b/tests/integration/repo_generate_test.go @@ -7,6 +7,7 @@ package integration import ( "fmt" "net/http" + "net/url" "strconv" "strings" "testing" @@ -14,9 +15,11 @@ import ( repo_model "code.gitea.io/gitea/models/repo" "code.gitea.io/gitea/models/unittest" user_model "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/optional" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/test" "code.gitea.io/gitea/modules/translation" + files_service "code.gitea.io/gitea/services/repository/files" "code.gitea.io/gitea/tests" "github.com/stretchr/testify/assert" @@ -76,10 +79,14 @@ func testRepoGenerate(t *testing.T, session *TestSession, templateID, templateOw // Step4: check the existence of the generated repo req = NewRequestf(t, "GET", "/%s/%s", generateOwner.Name, generateRepoName) session.MakeRequest(t, req, http.StatusOK) +} - // Step5: check substituted values in Readme - req = NewRequestf(t, "GET", "/%s/%s/raw/branch/master/README.md", generateOwner.Name, generateRepoName) - resp = session.MakeRequest(t, req, http.StatusOK) +func testRepoGenerateWithFixture(t *testing.T, session *TestSession, templateID, templateOwnerName, templateRepoName string, user, generateOwner *user_model.User, generateRepoName string) { + testRepoGenerate(t, session, templateID, templateOwnerName, templateRepoName, user, generateOwner, generateRepoName) + + // check substituted values in Readme + req := NewRequestf(t, "GET", "/%s/%s/raw/branch/master/README.md", generateOwner.Name, generateRepoName) + resp := session.MakeRequest(t, req, http.StatusOK) body := fmt.Sprintf(`# %s Readme Owner: %s Link: /%s/%s @@ -125,7 +132,7 @@ func TestRepoGenerate(t *testing.T) { session := loginUser(t, userName) user := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: userName}) - testRepoGenerate(t, session, "44", "user27", "template1", user, user, "generated1") + testRepoGenerateWithFixture(t, session, "44", "user27", "template1", user, user, "generated1") } func TestRepoGenerateToOrg(t *testing.T) { @@ -135,7 +142,7 @@ func TestRepoGenerateToOrg(t *testing.T) { user := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: userName}) org := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "org3"}) - testRepoGenerate(t, session, "44", "user27", "template1", user, org, "generated2") + testRepoGenerateWithFixture(t, session, "44", "user27", "template1", user, org, "generated2") } func TestRepoCreateFormTrimSpace(t *testing.T) { @@ -153,3 +160,66 @@ func TestRepoCreateFormTrimSpace(t *testing.T) { assert.EqualValues(t, "/user2/spaced-name", test.RedirectURL(resp)) unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{OwnerID: 2, Name: "spaced-name"}) } + +func TestRepoGenerateTemplating(t *testing.T) { + onGiteaRun(t, func(t *testing.T, u *url.URL) { + input := `# $REPO_NAME + This is a Repo By $REPO_OWNER + ThisIsThe${REPO_NAME}InAnInlineWay` + expected := `# %s + This is a Repo By %s + ThisIsThe%sInAnInlineWay` + templateName := "my_template" + generatedName := "my_generated" + + userName := "user1" + session := loginUser(t, userName) + user := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: userName}) + + template, _, f := tests.CreateDeclarativeRepoWithOptions(t, user, tests.DeclarativeRepoOptions{ + Name: optional.Some(templateName), + IsTemplate: optional.Some(true), + Files: optional.Some([]*files_service.ChangeRepoFile{ + { + Operation: "create", + TreePath: ".forgejo/template", + ContentReader: strings.NewReader("Readme.md"), + }, + { + Operation: "create", + TreePath: "Readme.md", + ContentReader: strings.NewReader(input), + }, + }), + }) + defer f() + + // The repo.TemplateID field is not initalized. Luckly the ID field holds the expected value + templateID := strconv.FormatInt(template.ID, 10) + + testRepoGenerate( + t, + session, + templateID, + user.Name, + templateName, + user, + user, + generatedName, + ) + + req := NewRequestf( + t, + "GET", "/%s/%s/raw/branch/%s/Readme.md", + user.Name, + generatedName, + template.DefaultBranch, + ) + resp := session.MakeRequest(t, req, http.StatusOK) + body := fmt.Sprintf(expected, + generatedName, + user.Name, + generatedName) + assert.Equal(t, body, resp.Body.String()) + }) +}