mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-13 06:20:24 +00:00
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>
170 lines
4 KiB
Go
170 lines
4 KiB
Go
// Copyright The Forgejo Authors.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package forgejo
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"os/signal"
|
|
"syscall"
|
|
|
|
"forgejo.org/models/db"
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/modules/private"
|
|
"forgejo.org/modules/setting"
|
|
|
|
"github.com/urfave/cli/v3"
|
|
)
|
|
|
|
type key int
|
|
|
|
const (
|
|
noInitKey key = iota + 1
|
|
noExitKey
|
|
stdoutKey
|
|
stderrKey
|
|
stdinKey
|
|
)
|
|
|
|
func CmdForgejo(ctx context.Context) *cli.Command {
|
|
return &cli.Command{
|
|
Name: "forgejo-cli",
|
|
Usage: "Forgejo CLI",
|
|
Flags: []cli.Flag{},
|
|
Commands: []*cli.Command{
|
|
CmdActions(ctx),
|
|
CmdF3(ctx),
|
|
},
|
|
}
|
|
}
|
|
|
|
func ContextSetNoInit(ctx context.Context, value bool) context.Context {
|
|
return context.WithValue(ctx, noInitKey, value)
|
|
}
|
|
|
|
func ContextGetNoInit(ctx context.Context) bool {
|
|
value, ok := ctx.Value(noInitKey).(bool)
|
|
return ok && value
|
|
}
|
|
|
|
func ContextSetNoExit(ctx context.Context, value bool) context.Context {
|
|
return context.WithValue(ctx, noExitKey, value)
|
|
}
|
|
|
|
func ContextGetNoExit(ctx context.Context) bool {
|
|
value, ok := ctx.Value(noExitKey).(bool)
|
|
return ok && value
|
|
}
|
|
|
|
func ContextSetStderr(ctx context.Context, value io.Writer) context.Context {
|
|
return context.WithValue(ctx, stderrKey, value)
|
|
}
|
|
|
|
func ContextGetStderr(ctx context.Context) io.Writer {
|
|
value, ok := ctx.Value(stderrKey).(io.Writer)
|
|
if !ok {
|
|
return os.Stderr
|
|
}
|
|
return value
|
|
}
|
|
|
|
func ContextSetStdout(ctx context.Context, value io.Writer) context.Context {
|
|
return context.WithValue(ctx, stdoutKey, value)
|
|
}
|
|
|
|
func ContextGetStdout(ctx context.Context) io.Writer {
|
|
value, ok := ctx.Value(stderrKey).(io.Writer)
|
|
if !ok {
|
|
return os.Stdout
|
|
}
|
|
return value
|
|
}
|
|
|
|
func ContextSetStdin(ctx context.Context, value io.Reader) context.Context {
|
|
return context.WithValue(ctx, stdinKey, value)
|
|
}
|
|
|
|
func ContextGetStdin(ctx context.Context) io.Reader {
|
|
value, ok := ctx.Value(stdinKey).(io.Reader)
|
|
if !ok {
|
|
return os.Stdin
|
|
}
|
|
return value
|
|
}
|
|
|
|
// copied from ../cmd.go
|
|
func initDB(ctx context.Context) error {
|
|
setting.MustInstalled()
|
|
setting.LoadDBSetting()
|
|
setting.InitSQLLoggersForCli(log.INFO)
|
|
|
|
if setting.Database.Type == "" {
|
|
log.Fatal(`Database settings are missing from the configuration file: %q.
|
|
Ensure you are running in the correct environment or set the correct configuration file with -c.
|
|
If this is the intended configuration file complete the [database] section.`, setting.CustomConf)
|
|
}
|
|
if err := db.InitEngine(ctx); err != nil {
|
|
return fmt.Errorf("unable to initialize the database using the configuration in %q. Error: %w", setting.CustomConf, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// copied from ../cmd.go
|
|
func installSignals(ctx context.Context) (context.Context, context.CancelFunc) {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
go func() {
|
|
// install notify
|
|
signalChannel := make(chan os.Signal, 1)
|
|
|
|
signal.Notify(
|
|
signalChannel,
|
|
syscall.SIGINT,
|
|
syscall.SIGTERM,
|
|
)
|
|
select {
|
|
case <-signalChannel:
|
|
case <-ctx.Done():
|
|
}
|
|
cancel()
|
|
signal.Reset()
|
|
}()
|
|
|
|
return ctx, cancel
|
|
}
|
|
|
|
func handleCliResponseExtra(ctx context.Context, extra private.ResponseExtra) error {
|
|
if false && extra.UserMsg != "" {
|
|
if _, err := fmt.Fprintf(ContextGetStdout(ctx), "%s", extra.UserMsg); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
if ContextGetNoExit(ctx) {
|
|
return extra.Error
|
|
}
|
|
return cli.Exit(extra.Error, 1)
|
|
}
|
|
|
|
func prepareWorkPathAndCustomConf(ctx context.Context) func(ctx context.Context, cli *cli.Command) (context.Context, error) {
|
|
return func(ctx context.Context, cli *cli.Command) (context.Context, error) {
|
|
if !ContextGetNoInit(ctx) {
|
|
var args setting.ArgWorkPathAndCustomConf
|
|
// from children to parent, check the global flags
|
|
for _, curCtx := range cli.Lineage() {
|
|
if curCtx.IsSet("work-path") && args.WorkPath == "" {
|
|
args.WorkPath = curCtx.String("work-path")
|
|
}
|
|
if curCtx.IsSet("custom-path") && args.CustomPath == "" {
|
|
args.CustomPath = curCtx.String("custom-path")
|
|
}
|
|
if curCtx.IsSet("config") && args.CustomConf == "" {
|
|
args.CustomConf = curCtx.String("config")
|
|
}
|
|
}
|
|
setting.InitWorkPathAndCommonConfig(os.Getenv, args)
|
|
}
|
|
return ctx, nil
|
|
}
|
|
}
|