2021-11-12 09:36:47 -05:00
|
|
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2021-11-12 09:36:47 -05:00
|
|
|
|
|
|
|
package unittest
|
|
|
|
|
|
|
|
import (
|
2021-12-01 02:50:01 -05:00
|
|
|
"context"
|
2021-11-12 09:36:47 -05:00
|
|
|
"fmt"
|
2023-05-03 23:55:35 -04:00
|
|
|
"log"
|
2021-11-12 09:36:47 -05:00
|
|
|
"os"
|
|
|
|
"path/filepath"
|
2023-05-03 23:55:35 -04:00
|
|
|
"strings"
|
2021-11-12 09:36:47 -05:00
|
|
|
"testing"
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-10-16 19:29:26 -04:00
|
|
|
system_model "code.gitea.io/gitea/models/system"
|
2023-05-03 23:55:35 -04:00
|
|
|
"code.gitea.io/gitea/modules/auth/password/hash"
|
2021-11-12 09:36:47 -05:00
|
|
|
"code.gitea.io/gitea/modules/base"
|
2022-06-09 21:57:49 -04:00
|
|
|
"code.gitea.io/gitea/modules/git"
|
2021-11-12 09:36:47 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
"code.gitea.io/gitea/modules/storage"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"xorm.io/xorm"
|
|
|
|
"xorm.io/xorm/names"
|
|
|
|
)
|
|
|
|
|
|
|
|
// giteaRoot a path to the gitea root
|
|
|
|
var (
|
|
|
|
giteaRoot string
|
|
|
|
fixturesDir string
|
|
|
|
)
|
|
|
|
|
|
|
|
// FixturesDir returns the fixture directory
|
|
|
|
func FixturesDir() string {
|
|
|
|
return fixturesDir
|
|
|
|
}
|
|
|
|
|
|
|
|
func fatalTestError(fmtStr string, args ...interface{}) {
|
|
|
|
_, _ = fmt.Fprintf(os.Stderr, fmtStr, args...)
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2023-05-03 23:55:35 -04:00
|
|
|
// InitSettings initializes config provider and load common setttings for tests
|
|
|
|
func InitSettings(extraConfigs ...string) {
|
|
|
|
setting.Init(&setting.Options{
|
|
|
|
AllowEmpty: true,
|
|
|
|
ExtraConfig: strings.Join(extraConfigs, "\n"),
|
|
|
|
})
|
|
|
|
|
|
|
|
if err := setting.PrepareAppDataPath(); err != nil {
|
|
|
|
log.Fatalf("Can not prepare APP_DATA_PATH: %v", err)
|
|
|
|
}
|
|
|
|
// register the dummy hash algorithm function used in the test fixtures
|
|
|
|
_ = hash.Register("dummy", hash.NewDummyHasher)
|
|
|
|
|
|
|
|
setting.PasswordHashAlgo, _ = hash.SetDefaultPasswordHashAlgorithm("dummy")
|
|
|
|
}
|
|
|
|
|
2022-04-14 09:58:21 -04:00
|
|
|
// TestOptions represents test options
|
|
|
|
type TestOptions struct {
|
|
|
|
GiteaRootPath string
|
|
|
|
FixtureFiles []string
|
|
|
|
SetUp func() error // SetUp will be executed before all tests in this package
|
|
|
|
TearDown func() error // TearDown will be executed after all tests in this package
|
|
|
|
}
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
// MainTest a reusable TestMain(..) function for unit tests that need to use a
|
|
|
|
// test database. Creates the test database, and sets necessary settings.
|
2022-04-14 09:58:21 -04:00
|
|
|
func MainTest(m *testing.M, testOpts *TestOptions) {
|
2023-05-03 23:55:35 -04:00
|
|
|
setting.SetCustomPathAndConf("", "", "")
|
|
|
|
InitSettings()
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
var err error
|
2021-11-16 03:53:21 -05:00
|
|
|
|
2022-04-14 09:58:21 -04:00
|
|
|
giteaRoot = testOpts.GiteaRootPath
|
|
|
|
fixturesDir = filepath.Join(testOpts.GiteaRootPath, "models", "fixtures")
|
2021-11-12 09:36:47 -05:00
|
|
|
|
|
|
|
var opts FixturesOptions
|
2022-04-14 09:58:21 -04:00
|
|
|
if len(testOpts.FixtureFiles) == 0 {
|
2021-11-12 09:36:47 -05:00
|
|
|
opts.Dir = fixturesDir
|
|
|
|
} else {
|
2022-04-14 09:58:21 -04:00
|
|
|
for _, f := range testOpts.FixtureFiles {
|
2021-11-12 09:36:47 -05:00
|
|
|
if len(f) != 0 {
|
|
|
|
opts.Files = append(opts.Files, filepath.Join(fixturesDir, f))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if err = CreateTestEngine(opts); err != nil {
|
|
|
|
fatalTestError("Error creating test engine: %v\n", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
setting.AppURL = "https://try.gitea.io/"
|
|
|
|
setting.RunUser = "runuser"
|
2022-02-07 16:56:45 -05:00
|
|
|
setting.SSH.User = "sshuser"
|
|
|
|
setting.SSH.BuiltinServerUser = "builtinuser"
|
2021-11-12 09:36:47 -05:00
|
|
|
setting.SSH.Port = 3000
|
|
|
|
setting.SSH.Domain = "try.gitea.io"
|
2023-03-07 05:51:06 -05:00
|
|
|
setting.Database.Type = "sqlite3"
|
2022-04-09 00:26:48 -04:00
|
|
|
setting.Repository.DefaultBranch = "master" // many test code still assume that default branch is called "master"
|
2021-12-10 14:43:28 -05:00
|
|
|
repoRootPath, err := os.MkdirTemp(os.TempDir(), "repos")
|
2021-11-12 09:36:47 -05:00
|
|
|
if err != nil {
|
|
|
|
fatalTestError("TempDir: %v\n", err)
|
|
|
|
}
|
2021-12-10 14:43:28 -05:00
|
|
|
setting.RepoRootPath = repoRootPath
|
|
|
|
appDataPath, err := os.MkdirTemp(os.TempDir(), "appdata")
|
2021-11-12 09:36:47 -05:00
|
|
|
if err != nil {
|
|
|
|
fatalTestError("TempDir: %v\n", err)
|
|
|
|
}
|
2021-12-10 14:43:28 -05:00
|
|
|
setting.AppDataPath = appDataPath
|
2022-04-14 09:58:21 -04:00
|
|
|
setting.AppWorkPath = testOpts.GiteaRootPath
|
|
|
|
setting.StaticRootPath = testOpts.GiteaRootPath
|
2022-10-16 19:29:26 -04:00
|
|
|
setting.GravatarSource = "https://secure.gravatar.com/avatar/"
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
setting.Attachment.Storage.Path = filepath.Join(setting.AppDataPath, "attachments")
|
|
|
|
|
|
|
|
setting.LFS.Storage.Path = filepath.Join(setting.AppDataPath, "lfs")
|
|
|
|
|
|
|
|
setting.Avatar.Storage.Path = filepath.Join(setting.AppDataPath, "avatars")
|
|
|
|
|
|
|
|
setting.RepoAvatar.Storage.Path = filepath.Join(setting.AppDataPath, "repo-avatars")
|
|
|
|
|
|
|
|
setting.RepoArchive.Storage.Path = filepath.Join(setting.AppDataPath, "repo-archive")
|
|
|
|
|
2022-03-30 04:42:47 -04:00
|
|
|
setting.Packages.Storage.Path = filepath.Join(setting.AppDataPath, "packages")
|
|
|
|
|
Implement actions (#21937)
Close #13539.
Co-authored by: @lunny @appleboy @fuxiaohei and others.
Related projects:
- https://gitea.com/gitea/actions-proto-def
- https://gitea.com/gitea/actions-proto-go
- https://gitea.com/gitea/act
- https://gitea.com/gitea/act_runner
### Summary
The target of this PR is to bring a basic implementation of "Actions",
an internal CI/CD system of Gitea. That means even though it has been
merged, the state of the feature is **EXPERIMENTAL**, and please note
that:
- It is disabled by default;
- It shouldn't be used in a production environment currently;
- It shouldn't be used in a public Gitea instance currently;
- Breaking changes may be made before it's stable.
**Please comment on #13539 if you have any different product design
ideas**, all decisions reached there will be adopted here. But in this
PR, we don't talk about **naming, feature-creep or alternatives**.
### ⚠️ Breaking
`gitea-actions` will become a reserved user name. If a user with the
name already exists in the database, it is recommended to rename it.
### Some important reviews
- What is `DEFAULT_ACTIONS_URL` in `app.ini` for?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1055954954
- Why the api for runners is not under the normal `/api/v1` prefix?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061173592
- Why DBFS?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061301178
- Why ignore events triggered by `gitea-actions` bot?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1063254103
- Why there's no permission control for actions?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1090229868
### What it looks like
<details>
#### Manage runners
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205870657-c72f590e-2e08-4cd4-be7f-2e0abb299bbf.png">
#### List runs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872794-50fde990-2b45-48c1-a178-908e4ec5b627.png">
#### View logs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872501-9b7b9000-9542-4991-8f55-18ccdada77c3.png">
</details>
### How to try it
<details>
#### 1. Start Gitea
Clone this branch and [install from
source](https://docs.gitea.io/en-us/install-from-source).
Add additional configurations in `app.ini` to enable Actions:
```ini
[actions]
ENABLED = true
```
Start it.
If all is well, you'll see the management page of runners:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205877365-8e30a780-9b10-4154-b3e8-ee6c3cb35a59.png">
#### 2. Start runner
Clone the [act_runner](https://gitea.com/gitea/act_runner), and follow
the
[README](https://gitea.com/gitea/act_runner/src/branch/main/README.md)
to start it.
If all is well, you'll see a new runner has been added:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205878000-216f5937-e696-470d-b66c-8473987d91c3.png">
#### 3. Enable actions for a repo
Create a new repo or open an existing one, check the `Actions` checkbox
in settings and submit.
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879705-53e09208-73c0-4b3e-a123-2dcf9aba4b9c.png">
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879383-23f3d08f-1a85-41dd-a8b3-54e2ee6453e8.png">
If all is well, you'll see a new tab "Actions":
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205881648-a8072d8c-5803-4d76-b8a8-9b2fb49516c1.png">
#### 4. Upload workflow files
Upload some workflow files to `.gitea/workflows/xxx.yaml`, you can
follow the [quickstart](https://docs.github.com/en/actions/quickstart)
of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions
in most cases, you can use the same demo:
```yaml
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."
```
If all is well, you'll see a new run in `Actions` tab:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884473-79a874bc-171b-4aaf-acd5-0241a45c3b53.png">
#### 5. Check the logs of jobs
Click a run and you'll see the logs:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884800-994b0374-67f7-48ff-be9a-4c53f3141547.png">
#### 6. Go on
You can try more examples in [the
documents](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
of GitHub Actions, then you might find a lot of bugs.
Come on, PRs are welcome.
</details>
See also: [Feature Preview: Gitea
Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/)
---------
Co-authored-by: a1012112796 <1012112796@qq.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: ChristopherHX <christopher.homberger@web.de>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-01-30 20:45:19 -05:00
|
|
|
setting.Actions.Storage.Path = filepath.Join(setting.AppDataPath, "actions_log")
|
|
|
|
|
2022-07-08 04:09:07 -04:00
|
|
|
setting.Git.HomePath = filepath.Join(setting.AppDataPath, "home")
|
|
|
|
|
2023-01-14 10:57:10 -05:00
|
|
|
setting.IncomingEmail.ReplyToAddress = "incoming+%{token}@localhost"
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
if err = storage.Init(); err != nil {
|
|
|
|
fatalTestError("storage.Init: %v\n", err)
|
|
|
|
}
|
2023-02-24 05:23:13 -05:00
|
|
|
if err = system_model.Init(db.DefaultContext); err != nil {
|
2022-10-16 19:29:26 -04:00
|
|
|
fatalTestError("models.Init: %v\n", err)
|
|
|
|
}
|
2021-11-12 09:36:47 -05:00
|
|
|
|
2021-12-10 14:43:28 -05:00
|
|
|
if err = util.RemoveAll(repoRootPath); err != nil {
|
2021-11-12 09:36:47 -05:00
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
|
|
|
}
|
2022-09-02 15:18:23 -04:00
|
|
|
if err = CopyDir(filepath.Join(testOpts.GiteaRootPath, "tests", "gitea-repositories-meta"), setting.RepoRootPath); err != nil {
|
2021-11-12 09:36:47 -05:00
|
|
|
fatalTestError("util.CopyDir: %v\n", err)
|
|
|
|
}
|
2022-06-16 11:47:44 -04:00
|
|
|
|
2022-08-08 23:22:24 -04:00
|
|
|
if err = git.InitFull(context.Background()); err != nil {
|
2022-06-09 21:57:49 -04:00
|
|
|
fatalTestError("git.Init: %v\n", err)
|
|
|
|
}
|
2021-12-16 14:01:14 -05:00
|
|
|
ownerDirs, err := os.ReadDir(setting.RepoRootPath)
|
|
|
|
if err != nil {
|
|
|
|
fatalTestError("unable to read the new repo root: %v\n", err)
|
|
|
|
}
|
|
|
|
for _, ownerDir := range ownerDirs {
|
|
|
|
if !ownerDir.Type().IsDir() {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
repoDirs, err := os.ReadDir(filepath.Join(setting.RepoRootPath, ownerDir.Name()))
|
|
|
|
if err != nil {
|
|
|
|
fatalTestError("unable to read the new repo root: %v\n", err)
|
|
|
|
}
|
|
|
|
for _, repoDir := range repoDirs {
|
2022-01-20 12:46:10 -05:00
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "objects", "pack"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "objects", "info"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "refs", "heads"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "refs", "tag"), 0o755)
|
2021-12-16 14:01:14 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-04-14 09:58:21 -04:00
|
|
|
if testOpts.SetUp != nil {
|
|
|
|
if err := testOpts.SetUp(); err != nil {
|
|
|
|
fatalTestError("set up failed: %v\n", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
exitStatus := m.Run()
|
2022-04-14 09:58:21 -04:00
|
|
|
|
|
|
|
if testOpts.TearDown != nil {
|
|
|
|
if err := testOpts.TearDown(); err != nil {
|
|
|
|
fatalTestError("tear down failed: %v\n", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-12-10 14:43:28 -05:00
|
|
|
if err = util.RemoveAll(repoRootPath); err != nil {
|
2021-11-12 09:36:47 -05:00
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
|
|
|
}
|
2021-12-10 14:43:28 -05:00
|
|
|
if err = util.RemoveAll(appDataPath); err != nil {
|
2021-11-12 09:36:47 -05:00
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
|
|
|
}
|
|
|
|
os.Exit(exitStatus)
|
|
|
|
}
|
|
|
|
|
|
|
|
// FixturesOptions fixtures needs to be loaded options
|
|
|
|
type FixturesOptions struct {
|
|
|
|
Dir string
|
|
|
|
Files []string
|
|
|
|
}
|
|
|
|
|
|
|
|
// CreateTestEngine creates a memory database and loads the fixture data from fixturesDir
|
|
|
|
func CreateTestEngine(opts FixturesOptions) error {
|
|
|
|
x, err := xorm.NewEngine("sqlite3", "file::memory:?cache=shared&_txlock=immediate")
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
x.SetMapper(names.GonicMapper{})
|
2021-12-01 02:50:01 -05:00
|
|
|
db.SetDefaultEngine(context.Background(), x)
|
2021-11-12 09:36:47 -05:00
|
|
|
|
|
|
|
if err = db.SyncAllTables(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2021-12-31 22:31:24 -05:00
|
|
|
switch os.Getenv("GITEA_UNIT_TESTS_LOG_SQL") {
|
2021-11-12 09:36:47 -05:00
|
|
|
case "true", "1":
|
|
|
|
x.ShowSQL(true)
|
|
|
|
}
|
|
|
|
|
|
|
|
return InitFixtures(opts)
|
|
|
|
}
|
|
|
|
|
|
|
|
// PrepareTestDatabase load test fixtures into test database
|
|
|
|
func PrepareTestDatabase() error {
|
|
|
|
return LoadFixtures()
|
|
|
|
}
|
|
|
|
|
|
|
|
// PrepareTestEnv prepares the environment for unit tests. Can only be called
|
|
|
|
// by tests that use the above MainTest(..) function.
|
|
|
|
func PrepareTestEnv(t testing.TB) {
|
|
|
|
assert.NoError(t, PrepareTestDatabase())
|
|
|
|
assert.NoError(t, util.RemoveAll(setting.RepoRootPath))
|
2022-09-02 15:18:23 -04:00
|
|
|
metaPath := filepath.Join(giteaRoot, "tests", "gitea-repositories-meta")
|
2022-04-01 12:34:57 -04:00
|
|
|
assert.NoError(t, CopyDir(metaPath, setting.RepoRootPath))
|
2021-12-16 14:01:14 -05:00
|
|
|
ownerDirs, err := os.ReadDir(setting.RepoRootPath)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
for _, ownerDir := range ownerDirs {
|
|
|
|
if !ownerDir.Type().IsDir() {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
repoDirs, err := os.ReadDir(filepath.Join(setting.RepoRootPath, ownerDir.Name()))
|
|
|
|
assert.NoError(t, err)
|
|
|
|
for _, repoDir := range repoDirs {
|
2022-01-20 12:46:10 -05:00
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "objects", "pack"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "objects", "info"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "refs", "heads"), 0o755)
|
|
|
|
_ = os.MkdirAll(filepath.Join(setting.RepoRootPath, ownerDir.Name(), repoDir.Name(), "refs", "tag"), 0o755)
|
2021-12-16 14:01:14 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-11-12 09:36:47 -05:00
|
|
|
base.SetupGiteaRoot() // Makes sure GITEA_ROOT is set
|
|
|
|
}
|