forgejo/tests/integration/editor_test.go

// Copyright 2017 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package integration

import (
	"fmt"
	"net/http"
	"net/http/httptest"
	"net/url"
	"path"
	"testing"

	repo_model "code.gitea.io/gitea/models/repo"
	"code.gitea.io/gitea/models/unittest"
	user_model "code.gitea.io/gitea/models/user"
	gitea_context "code.gitea.io/gitea/modules/context"
	"code.gitea.io/gitea/modules/git"
	"code.gitea.io/gitea/modules/json"
	"code.gitea.io/gitea/modules/translation"
	"code.gitea.io/gitea/tests"

	"github.com/stretchr/testify/assert"
)

func TestCreateFile(t *testing.T) {
	onGiteaRun(t, func(t *testing.T, u *url.URL) {
		session := loginUser(t, "user2")

		// Request editor page
		req := NewRequest(t, "GET", "/user2/repo1/_new/master/")
		resp := session.MakeRequest(t, req, http.StatusOK)

		doc := NewHTMLParser(t, resp.Body)
		lastCommit := doc.GetInputValueByName("last_commit")
		assert.NotEmpty(t, lastCommit)

		// Save new file to master branch
		req = NewRequestWithValues(t, "POST", "/user2/repo1/_new/master/", map[string]string{
			"_csrf":          doc.GetCSRF(),
			"last_commit":    lastCommit,
			"tree_path":      "test.txt",
			"content":        "Content",
			"commit_choice":  "direct",
			"commit_mail_id": "3",
		})
		session.MakeRequest(t, req, http.StatusSeeOther)
	})
}

func TestCreateFileOnProtectedBranch(t *testing.T) {
	onGiteaRun(t, func(t *testing.T, u *url.URL) {
		session := loginUser(t, "user2")

		csrf := GetCSRF(t, session, "/user2/repo1/settings/branches")
		// Change master branch to protected
		req := NewRequestWithValues(t, "POST", "/user2/repo1/settings/branches/edit", map[string]string{
			"_csrf":       csrf,
			"rule_name":   "master",
			"enable_push": "true",
		})
		session.MakeRequest(t, req, http.StatusSeeOther)
		// Check if master branch has been locked successfully
		flashCookie := session.GetCookie(gitea_context.CookieNameFlash)
		assert.NotNil(t, flashCookie)
		assert.EqualValues(t, "success%3DBranch%2Bprotection%2Bfor%2Brule%2B%2522master%2522%2Bhas%2Bbeen%2Bupdated.", flashCookie.Value)

		// Request editor page
		req = NewRequest(t, "GET", "/user2/repo1/_new/master/")
		resp := session.MakeRequest(t, req, http.StatusOK)

		doc := NewHTMLParser(t, resp.Body)
		lastCommit := doc.GetInputValueByName("last_commit")
		assert.NotEmpty(t, lastCommit)

		// Save new file to master branch
		req = NewRequestWithValues(t, "POST", "/user2/repo1/_new/master/", map[string]string{
			"_csrf":          doc.GetCSRF(),
			"last_commit":    lastCommit,
			"tree_path":      "test.txt",
			"content":        "Content",
			"commit_choice":  "direct",
			"commit_mail_id": "3",
		})

		resp = session.MakeRequest(t, req, http.StatusOK)
		// Check body for error message
		assert.Contains(t, resp.Body.String(), "Cannot commit to protected branch "master".")

		// remove the protected branch
		csrf = GetCSRF(t, session, "/user2/repo1/settings/branches")

		// Change master branch to protected
		req = NewRequestWithValues(t, "POST", "/user2/repo1/settings/branches/1/delete", map[string]string{
			"_csrf": csrf,
		})

		resp = session.MakeRequest(t, req, http.StatusOK)

		res := make(map[string]string)
		assert.NoError(t, json.NewDecoder(resp.Body).Decode(&res))
		assert.EqualValues(t, "/user2/repo1/settings/branches", res["redirect"])

		// Check if master branch has been locked successfully
		flashCookie = session.GetCookie(gitea_context.CookieNameFlash)
		assert.NotNil(t, flashCookie)
		assert.EqualValues(t, "error%3DRemoving%2Bbranch%2Bprotection%2Brule%2B%25221%2522%2Bfailed.", flashCookie.Value)
	})
}

func testEditFile(t *testing.T, session *TestSession, user, repo, branch, filePath, newContent string) *httptest.ResponseRecorder {
	// Get to the 'edit this file' page
	req := NewRequest(t, "GET", path.Join(user, repo, "_edit", branch, filePath))
	resp := session.MakeRequest(t, req, http.StatusOK)

	htmlDoc := NewHTMLParser(t, resp.Body)
	lastCommit := htmlDoc.GetInputValueByName("last_commit")
	assert.NotEmpty(t, lastCommit)

	// Submit the edits
	req = NewRequestWithValues(t, "POST", path.Join(user, repo, "_edit", branch, filePath),
		map[string]string{
			"_csrf":          htmlDoc.GetCSRF(),
			"last_commit":    lastCommit,
			"tree_path":      filePath,
			"content":        newContent,
			"commit_choice":  "direct",
			"commit_mail_id": "-1",
		},
	)
	session.MakeRequest(t, req, http.StatusSeeOther)

	// Verify the change
	req = NewRequest(t, "GET", path.Join(user, repo, "raw/branch", branch, filePath))
	resp = session.MakeRequest(t, req, http.StatusOK)
	assert.EqualValues(t, newContent, resp.Body.String())

	return resp
}

func testEditFileToNewBranch(t *testing.T, session *TestSession, user, repo, branch, targetBranch, filePath, newContent string) *httptest.ResponseRecorder {
	// Get to the 'edit this file' page
	req := NewRequest(t, "GET", path.Join(user, repo, "_edit", branch, filePath))
	resp := session.MakeRequest(t, req, http.StatusOK)

	htmlDoc := NewHTMLParser(t, resp.Body)
	lastCommit := htmlDoc.GetInputValueByName("last_commit")
	assert.NotEmpty(t, lastCommit)

	// Submit the edits
	req = NewRequestWithValues(t, "POST", path.Join(user, repo, "_edit", branch, filePath),
		map[string]string{
			"_csrf":           htmlDoc.GetCSRF(),
			"last_commit":     lastCommit,
			"tree_path":       filePath,
			"content":         newContent,
			"commit_choice":   "commit-to-new-branch",
			"new_branch_name": targetBranch,
			"commit_mail_id":  "-1",
		},
	)
	session.MakeRequest(t, req, http.StatusSeeOther)

	// Verify the change
	req = NewRequest(t, "GET", path.Join(user, repo, "raw/branch", targetBranch, filePath))
	resp = session.MakeRequest(t, req, http.StatusOK)
	assert.EqualValues(t, newContent, resp.Body.String())

	return resp
}

func TestEditFile(t *testing.T) {
	onGiteaRun(t, func(t *testing.T, u *url.URL) {
		session := loginUser(t, "user2")
		testEditFile(t, session, "user2", "repo1", "master", "README.md", "Hello, World (Edited)\n")
	})
}

func TestEditFileToNewBranch(t *testing.T) {
	onGiteaRun(t, func(t *testing.T, u *url.URL) {
		session := loginUser(t, "user2")
		testEditFileToNewBranch(t, session, "user2", "repo1", "master", "feature/test", "README.md", "Hello, World (Edited)\n")
	})
}

func TestEditFileCommitMail(t *testing.T) {
	onGiteaRun(t, func(t *testing.T, _ *url.URL) {
		user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})

		session := loginUser(t, user.Name)
		link := path.Join("user2", "repo1", "_edit", "master", "README.md")

		lastCommitAndCSRF := func() (string, string) {
			req := NewRequest(t, "GET", link)
			resp := session.MakeRequest(t, req, http.StatusOK)

			htmlDoc := NewHTMLParser(t, resp.Body)
			lastCommit := htmlDoc.GetInputValueByName("last_commit")
			assert.NotEmpty(t, lastCommit)

			return lastCommit, htmlDoc.GetCSRF()
		}

		t.Run("Not activated", func(t *testing.T) {
			defer tests.PrintCurrentTest(t)()

			email := unittest.AssertExistsAndLoadBean(t, &user_model.EmailAddress{ID: 35, UID: user.ID})
			assert.False(t, email.IsActivated)

			lastCommit, csrf := lastCommitAndCSRF()
			req := NewRequestWithValues(t, "POST", link, map[string]string{
				"_csrf":          csrf,
				"last_commit":    lastCommit,
				"tree_path":      "README.md",
				"content":        "new_content",
				"commit_choice":  "direct",
				"commit_mail_id": fmt.Sprintf("%d", email.ID),
			})
			resp := session.MakeRequest(t, req, http.StatusOK)

			htmlDoc := NewHTMLParser(t, resp.Body)
			assert.Contains(t,
				htmlDoc.doc.Find(".ui.negative.message").Text(),
				translation.NewLocale("en-US").Tr("repo.editor.invalid_commit_mail"),
			)
		})

		t.Run("Not belong to user", func(t *testing.T) {
			defer tests.PrintCurrentTest(t)()

			email := unittest.AssertExistsAndLoadBean(t, &user_model.EmailAddress{ID: 1, IsActivated: true})
			assert.NotEqualValues(t, email.UID, user.ID)

			lastCommit, csrf := lastCommitAndCSRF()
			req := NewRequestWithValues(t, "POST", link, map[string]string{
				"_csrf":          csrf,
				"last_commit":    lastCommit,
				"tree_path":      "README.md",
				"content":        "new_content",
				"commit_choice":  "direct",
				"commit_mail_id": fmt.Sprintf("%d", email.ID),
			})
			resp := session.MakeRequest(t, req, http.StatusOK)

			htmlDoc := NewHTMLParser(t, resp.Body)
			assert.Contains(t,
				htmlDoc.doc.Find(".ui.negative.message").Text(),
				translation.NewLocale("en-US").Tr("repo.editor.invalid_commit_mail"),
			)
		})

		repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
		gitRepo, _ := git.OpenRepository(git.DefaultContext, repo1.RepoPath())
		defer gitRepo.Close()

		t.Run("Placeholder mail", func(t *testing.T) {
			defer tests.PrintCurrentTest(t)()

			lastCommit, csrf := lastCommitAndCSRF()
			req := NewRequestWithValues(t, "POST", link, map[string]string{
				"_csrf":          csrf,
				"last_commit":    lastCommit,
				"tree_path":      "README.md",
				"content":        "authored by placeholder mail",
				"commit_choice":  "direct",
				"commit_mail_id": "-1",
			})
			session.MakeRequest(t, req, http.StatusSeeOther)

			commit, err := gitRepo.GetCommitByPath("README.md")
			assert.NoError(t, err)

			fileContent, err := commit.GetFileContent("README.md", 64)
			assert.NoError(t, err)
			assert.EqualValues(t, "authored by placeholder mail", fileContent)

			assert.EqualValues(t, "user2", commit.Author.Name)
			assert.EqualValues(t, "user2@noreply.example.org", commit.Author.Email)
			assert.EqualValues(t, "user2", commit.Committer.Name)
			assert.EqualValues(t, "user2@noreply.example.org", commit.Committer.Email)
		})

		t.Run("Normal", func(t *testing.T) {
			defer tests.PrintCurrentTest(t)()

			// Require that the user has KeepEmailPrivate enabled, because it needs
			// to be tested that even with this setting enabled, it will use the
			// provided mail and not revert to the placeholder one.
			assert.True(t, user.KeepEmailPrivate)

			email := unittest.AssertExistsAndLoadBean(t, &user_model.EmailAddress{ID: 3, UID: user.ID, IsActivated: true})

			lastCommit, csrf := lastCommitAndCSRF()
			req := NewRequestWithValues(t, "POST", link, map[string]string{
				"_csrf":          csrf,
				"last_commit":    lastCommit,
				"tree_path":      "README.md",
				"content":        "authored by activated mail",
				"commit_choice":  "direct",
				"commit_mail_id": fmt.Sprintf("%d", email.ID),
			})
			session.MakeRequest(t, req, http.StatusSeeOther)

			commit, err := gitRepo.GetCommitByPath("README.md")
			assert.NoError(t, err)

			fileContent, err := commit.GetFileContent("README.md", 64)
			assert.NoError(t, err)
			assert.EqualValues(t, "authored by activated mail", fileContent)

			assert.EqualValues(t, "user2", commit.Author.Name)
			assert.EqualValues(t, email.Email, commit.Author.Email)
			assert.EqualValues(t, "user2", commit.Committer.Name)
			assert.EqualValues(t, email.Email, commit.Committer.Email)
		})
	})
}