mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-06-07 23:27:41 +00:00
Some checks failed
/ release (push) Waiting to run
testing / backend-checks (push) Waiting to run
testing / frontend-checks (push) Waiting to run
testing / test-unit (push) Blocked by required conditions
testing / test-e2e (push) Blocked by required conditions
testing / test-remote-cacher (redis) (push) Blocked by required conditions
testing / test-remote-cacher (valkey) (push) Blocked by required conditions
testing / test-remote-cacher (garnet) (push) Blocked by required conditions
testing / test-remote-cacher (redict) (push) Blocked by required conditions
testing / test-mysql (push) Blocked by required conditions
testing / test-pgsql (push) Blocked by required conditions
testing / test-sqlite (push) Blocked by required conditions
testing / security-check (push) Blocked by required conditions
Integration tests for the release process / release-simulation (push) Has been cancelled
urfave/cli v2 will eventually become unmaintained, switch over to v3 which is the latest supported version. Note: the `docs` command would be a lot of work to restore with v3 ([the package is still in alpha](https://github.com/urfave/cli-docs)) An alternative to avoid a breaking change would be to not upgrade from v2 to v3 for that reason alone. Note: these commits were cherry-picked from https://code.forgejo.org/forgefriends/forgefriends Note: it is best reviewed side by side with no display of whitespace changes (there are a lot of those when converting vars to func). - a few functional changes were necessary and are noted in context in the file changes tab - https://cli.urfave.org/migrate-v2-to-v3/ upgrade instructions were followed in the most minimal way possible - upgrade gof3 to v3.10.8 which includes and upgrade from urfave/cli v2 to urfave/cli v3 - upgrade gitlab.com/gitlab-org/api/client-go v0.129.0 because it is an indirect dependency of gof3 and requires a change because of a deprecated field that otherwise triggers a lint error but nothing else otherwise - verified that the [script](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) that generates the [CLI documentation](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) still works. There are cosmetic differences and the **help** subcommand is no longer advertised (although it is still supported) but the `--help` option is advertised as expected so it is fine. - end-to-end tests [passed](https://code.forgejo.org/forgejo/end-to-end/pulls/667) (they use the Forgejo CLI to some extent) ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [x] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Breaking features - [PR](https://codeberg.org/forgejo/forgejo/pulls/8035): <!--number 8035 --><!--line 0 --><!--description VGhlIGBmb3JnZWpvIGRvY3NgIGNvbW1hbmQgaXMgZGVwcmVjYXRlZCBhbmQgQ0xJIGVycm9ycyBhcmUgbm93IGRpc3BsYXllZCBvbiBzdGRlcnIgaW5zdGVhZCBvZiBzdGRvdXQuIFRoZXNlIGJyZWFraW5nIGNoYW5nZXMgaGFwcGVuZWQgYmVjYXVzZSB0aGUgcGFja2FnZSB1c2VkIHRvIHBhcnNlIHRoZSBjb21tYW5kIGxpbmUgYXJndW1lbnRzIHdhcyBbdXBncmFkZWQgZnJvbSB2MiB0byB2M10oaHR0cHM6Ly9jbGkudXJmYXZlLm9yZy9taWdyYXRlLXYyLXRvLXYzLykuIEEgW3NlcGFyYXRlIHByb2plY3Qgd2FzIGluaXRpYXRlZF0oaHR0cHM6Ly9naXRodWIuY29tL3VyZmF2ZS9jbGktZG9jcykgdG8gcmUtaW1wbGVtZW50IHRoZSBgZG9jc2AgY29tbWFuZCwgYnV0IGl0IGlzIG5vdCB5ZXQgcHJvZHVjdGlvbiByZWFkeS4=-->The `forgejo docs` command is deprecated and CLI errors are now displayed on stderr instead of stdout. These breaking changes happened because the package used to parse the command line arguments was [upgraded from v2 to v3](https://cli.urfave.org/migrate-v2-to-v3/). A [separate project was initiated](https://github.com/urfave/cli-docs) to re-implement the `docs` command, but it is not yet production ready.<!--description--> <!--end release-notes-assistant--> Co-authored-by: limiting-factor <limiting-factor@posteo.com> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8035 Reviewed-by: Gusted <gusted@noreply.codeberg.org>
137 lines
4 KiB
Go
137 lines
4 KiB
Go
// Copyright Earl Warren <contact@earl-warren.org>
|
|
// Copyright Loïc Dachary <loic@dachary.org>
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"forgejo.org/cmd/forgejo"
|
|
"forgejo.org/modules/setting"
|
|
"forgejo.org/modules/test"
|
|
"forgejo.org/services/f3/driver/options"
|
|
"forgejo.org/tests"
|
|
|
|
_ "forgejo.org/services/f3/driver"
|
|
_ "forgejo.org/services/f3/driver/tests"
|
|
|
|
f3_filesystem_options "code.forgejo.org/f3/gof3/v3/forges/filesystem/options"
|
|
f3_logger "code.forgejo.org/f3/gof3/v3/logger"
|
|
f3_options "code.forgejo.org/f3/gof3/v3/options"
|
|
f3_generic "code.forgejo.org/f3/gof3/v3/tree/generic"
|
|
f3_tests "code.forgejo.org/f3/gof3/v3/tree/tests/f3"
|
|
f3_tests_forge "code.forgejo.org/f3/gof3/v3/tree/tests/f3/forge"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/urfave/cli/v3"
|
|
)
|
|
|
|
func runApp(ctx context.Context, args ...string) (string, error) {
|
|
l := f3_logger.NewCaptureLogger()
|
|
ctx = f3_logger.ContextSetLogger(ctx, l)
|
|
ctx = forgejo.ContextSetNoInit(ctx, true)
|
|
|
|
app := cli.Command{}
|
|
|
|
app.Root().Writer = l.GetBuffer()
|
|
app.Root().ErrWriter = l.GetBuffer()
|
|
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
fmt.Println(l.String())
|
|
panic(r)
|
|
}
|
|
}()
|
|
|
|
app.Commands = []*cli.Command{
|
|
forgejo.SubcmdF3Mirror(ctx),
|
|
}
|
|
err := app.Run(ctx, args)
|
|
|
|
fmt.Println(l.String())
|
|
|
|
return l.String(), err
|
|
}
|
|
|
|
func TestF3_CmdMirror_LocalForgejo(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
defer test.MockVariableValue(&setting.F3.Enabled, true)()
|
|
|
|
ctx := t.Context()
|
|
|
|
mirrorOptions := f3_tests_forge.GetFactory(options.Name)().NewOptions(t)
|
|
mirrorTree := f3_generic.GetFactory("f3")(ctx, mirrorOptions)
|
|
|
|
fixtureOptions := f3_tests_forge.GetFactory(f3_filesystem_options.Name)().NewOptions(t)
|
|
fixtureTree := f3_generic.GetFactory("f3")(ctx, fixtureOptions)
|
|
|
|
log := fixtureTree.GetLogger()
|
|
creator := f3_tests.NewCreator(t, "CmdMirrorLocalForgejo", log)
|
|
|
|
log.Trace("======= build fixture")
|
|
|
|
var fromPath string
|
|
{
|
|
fixtureUserID := "userID01"
|
|
fixtureProjectID := "projectID01"
|
|
|
|
userFormat := creator.GenerateUser()
|
|
userFormat.SetID(fixtureUserID)
|
|
users := fixtureTree.MustFind(f3_generic.NewPathFromString("/forge/users"))
|
|
user := users.CreateChild(ctx)
|
|
user.FromFormat(userFormat)
|
|
user.Upsert(ctx)
|
|
require.Equal(t, user.GetID(), users.GetIDFromName(ctx, userFormat.UserName))
|
|
|
|
projectFormat := creator.GenerateProject()
|
|
projectFormat.SetID(fixtureProjectID)
|
|
projects := user.MustFind(f3_generic.NewPathFromString("projects"))
|
|
project := projects.CreateChild(ctx)
|
|
project.FromFormat(projectFormat)
|
|
project.Upsert(ctx)
|
|
require.Equal(t, project.GetID(), projects.GetIDFromName(ctx, projectFormat.Name))
|
|
|
|
fromPath = fmt.Sprintf("/forge/users/%s/projects/%s", userFormat.UserName, projectFormat.Name)
|
|
}
|
|
|
|
log.Trace("======= create mirror")
|
|
|
|
var toPath string
|
|
var projects f3_generic.NodeInterface
|
|
{
|
|
userFormat := creator.GenerateUser()
|
|
users := mirrorTree.MustFind(f3_generic.NewPathFromString("/forge/users"))
|
|
user := users.CreateChild(ctx)
|
|
user.FromFormat(userFormat)
|
|
user.Upsert(ctx)
|
|
require.Equal(t, user.GetID(), users.GetIDFromName(ctx, userFormat.UserName))
|
|
|
|
projectFormat := creator.GenerateProject()
|
|
projects = user.MustFind(f3_generic.NewPathFromString("projects"))
|
|
project := projects.CreateChild(ctx)
|
|
project.FromFormat(projectFormat)
|
|
project.Upsert(ctx)
|
|
require.Equal(t, project.GetID(), projects.GetIDFromName(ctx, projectFormat.Name))
|
|
|
|
toPath = fmt.Sprintf("/forge/users/%s/projects/%s", userFormat.UserName, projectFormat.Name)
|
|
}
|
|
|
|
log.Trace("======= mirror %s => %s", fromPath, toPath)
|
|
output, err := runApp(ctx,
|
|
"f3", "mirror",
|
|
"--from-type", f3_filesystem_options.Name,
|
|
"--from-path", fromPath,
|
|
"--from-filesystem-directory", fixtureOptions.(f3_options.URLInterface).GetURL(),
|
|
|
|
"--to-type", options.Name,
|
|
"--to-path", toPath,
|
|
)
|
|
require.NoError(t, err)
|
|
log.Trace("======= assert")
|
|
require.Contains(t, output, fmt.Sprintf("mirror %s", fromPath))
|
|
projects.List(ctx)
|
|
require.NotEmpty(t, projects.GetChildren())
|
|
log.Trace("======= project %s", projects.GetChildren()[0])
|
|
}
|