mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-26 21:54:19 -04:00
Replace #10912 And there are many new tests to cover the CLI behavior There were some concerns about the "option order in hook scripts" (https://github.com/go-gitea/gitea/pull/10912#issuecomment-1137543314), it's not a problem now. Because the hook script uses `/gitea hook --config=/app.ini pre-receive` format. The "config" is a global option, it can appear anywhere. ---- ## ⚠️ BREAKING ⚠️ This PR does it best to avoid breaking anything. The major changes are: * `gitea` itself won't accept web's options: `--install-port` / `--pid` / `--port` / `--quiet` / `--verbose` .... They are `web` sub-command's options. * Use `./gitea web --pid ....` instead * `./gitea` can still run the `web` sub-command as shorthand, with default options * The sub-command's options must follow the sub-command * Before: `./gitea --sub-opt subcmd` might equal to `./gitea subcmd --sub-opt` (well, might not ...) * After: only `./gitea subcmd --sub-opt` could be used * The global options like `--config` are not affected
155 lines
3.5 KiB
Go
155 lines
3.5 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"os"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/modules/private"
|
|
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
var (
|
|
// CmdManager represents the manager command
|
|
CmdManager = &cli.Command{
|
|
Name: "manager",
|
|
Usage: "Manage the running gitea process",
|
|
Description: "This is a command for managing the running gitea process",
|
|
Subcommands: []*cli.Command{
|
|
subcmdShutdown,
|
|
subcmdRestart,
|
|
subcmdReloadTemplates,
|
|
subcmdFlushQueues,
|
|
subcmdLogging,
|
|
subCmdProcesses,
|
|
},
|
|
}
|
|
subcmdShutdown = &cli.Command{
|
|
Name: "shutdown",
|
|
Usage: "Gracefully shutdown the running process",
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
},
|
|
Action: runShutdown,
|
|
}
|
|
subcmdRestart = &cli.Command{
|
|
Name: "restart",
|
|
Usage: "Gracefully restart the running process - (not implemented for windows servers)",
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
},
|
|
Action: runRestart,
|
|
}
|
|
subcmdReloadTemplates = &cli.Command{
|
|
Name: "reload-templates",
|
|
Usage: "Reload template files in the running process",
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
},
|
|
Action: runReloadTemplates,
|
|
}
|
|
subcmdFlushQueues = &cli.Command{
|
|
Name: "flush-queues",
|
|
Usage: "Flush queues in the running process",
|
|
Action: runFlushQueues,
|
|
Flags: []cli.Flag{
|
|
&cli.DurationFlag{
|
|
Name: "timeout",
|
|
Value: 60 * time.Second,
|
|
Usage: "Timeout for the flushing process",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "non-blocking",
|
|
Usage: "Set to true to not wait for flush to complete before returning",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
},
|
|
}
|
|
subCmdProcesses = &cli.Command{
|
|
Name: "processes",
|
|
Usage: "Display running processes within the current process",
|
|
Action: runProcesses,
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "flat",
|
|
Usage: "Show processes as flat table rather than as tree",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "no-system",
|
|
Usage: "Do not show system processes",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "stacktraces",
|
|
Usage: "Show stacktraces",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "json",
|
|
Usage: "Output as json",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "cancel",
|
|
Usage: "Process PID to cancel. (Only available for non-system processes.)",
|
|
},
|
|
},
|
|
}
|
|
)
|
|
|
|
func runShutdown(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
setup(ctx, c.Bool("debug"))
|
|
extra := private.Shutdown(ctx)
|
|
return handleCliResponseExtra(extra)
|
|
}
|
|
|
|
func runRestart(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
setup(ctx, c.Bool("debug"))
|
|
extra := private.Restart(ctx)
|
|
return handleCliResponseExtra(extra)
|
|
}
|
|
|
|
func runReloadTemplates(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
setup(ctx, c.Bool("debug"))
|
|
extra := private.ReloadTemplates(ctx)
|
|
return handleCliResponseExtra(extra)
|
|
}
|
|
|
|
func runFlushQueues(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
setup(ctx, c.Bool("debug"))
|
|
extra := private.FlushQueues(ctx, c.Duration("timeout"), c.Bool("non-blocking"))
|
|
return handleCliResponseExtra(extra)
|
|
}
|
|
|
|
func runProcesses(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
setup(ctx, c.Bool("debug"))
|
|
extra := private.Processes(ctx, os.Stdout, c.Bool("flat"), c.Bool("no-system"), c.Bool("stacktraces"), c.Bool("json"), c.String("cancel"))
|
|
return handleCliResponseExtra(extra)
|
|
}
|