refactor: "edit-ini --in-place --config-keep-keys ..."

Author: wxiaoguang

cmd/config_update.go renamed to cmd/config.go

@@ -10,14 +10,12 @@ import (
 	"os"
 
 	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/util"
-
 	"github.com/urfave/cli/v3"
 )
 
 func cmdConfig() *cli.Command {
-	subcmdConfigUpdateIni := &cli.Command{
-		Name:  "update-ini",
+	subcmdConfigEditIni := &cli.Command{
+		Name:  "edit-ini",
 		Usage: "Load an existing INI file, apply environment variables, keep specified keys, and output to a new INI file.",
 		Description: `
 Help users to update the gitea configuration INI file:
@@ -27,14 +25,14 @@ Help users to update the gitea configuration INI file:
 # Keep Specified Keys
 
 If you need to re-create the configuration file with only a subset of keys,
-you can provide an INI template file and use the "--config-key-template" flag.
+you can provide an INI template file and use the "--config-keep-keys" flag.
 For example, if a helm chart needs to reset the settings and only keep SECRET_KEY,
-it can use a template file like:
+it can use a template file (only keys take effect, values are ignored):
 
   [security]
   SECRET_KEY=
 
-$ ./gitea config update-ini --config app-old.ini --config-key-template app-template.ini --out app-new.ini
+$ ./gitea config edit-ini --config app-old.ini --config-keep-keys app-template.ini --out app-new.ini
 
 # Map Environment Variables to INI Configuration
 
@@ -57,18 +55,22 @@ $ export GITEA__git_0x2E_config__foo_0x2E_bar=val
 
 # Put All Together
 
-$ ./gitea config update-ini --config app.ini --config-key-template app-template.ini --apply-env
+$ ./gitea config edit-ini --config app.ini --config-keep-keys app-template.ini --apply-env
 `,
 		Flags: []cli.Flag{
 			// "--config" flag is provided by global flags, and this flag is also used by "environment-to-ini" script wrapper
 			&cli.StringFlag{
-				Name:  "config-key-template",
+				Name:  "config-keep-keys",
 				Usage: "An INI template file containing keys for keeping. Only the keys defined in the INI template will be kept from old config. If not set, all keys will be kept.",
 			},
 			&cli.BoolFlag{
 				Name:  "apply-env",
 				Usage: "Apply all GITEA__* variables from the environment to the config.",
 			},
+			&cli.BoolFlag{
+				Name:  "in-place",
+				Usage: "Output to the same config file as input.",
+			},
 			&cli.StringFlag{
 				Name:  "out",
 				Usage: "Destination config file to write to. If not set, will overwrite the source config file.",
@@ -81,7 +83,7 @@ $ ./gitea config update-ini --config app.ini --config-key-template app-template.
 		Name:  "config",
 		Usage: "Manage Gitea configuration",
 		Commands: []*cli.Command{
-			subcmdConfigUpdateIni,
+			subcmdConfigEditIni,
 		},
 	}
 }
@@ -99,14 +101,25 @@ func runConfigUpdateIni(_ context.Context, c *cli.Command) error {
 		return fmt.Errorf("failed to load config file %q: %v", configFileIn, err)
 	}
 
+	inPlace := c.Bool("in-place")
 	configFileOut := c.String("out")
-	configFileOut = util.IfZero(configFileOut, configFileIn)
+	if inPlace {
+		if configFileOut != "" {
+			return errors.New("cannot use --in-place and --out together")
+		}
+		configFileOut = configFileIn
+	} else {
+		if configFileOut == "" {
+			return errors.New("either --in-place or --out must be specified")
+		}
+	}
+
 	needWriteOut := configFileOut != configFileIn
 
 	cfgOut := cfgIn
-	if c.IsSet("config-key-template") {
+	if c.IsSet("config-keep-keys") {
 		needWriteOut = true
-		configKeepTemplate := c.String("config-key-template")
+		configKeepTemplate := c.String("config-keep-keys")
 		cfgOut, err = setting.NewConfigProviderFromFile(configKeepTemplate)
 		if err != nil {
 			return fmt.Errorf("failed to load config keep template file %q: %v", configKeepTemplate, err)

cmd/config_update_test.go renamed to cmd/config_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestConfigUpdate(t *testing.T) {
+func TestConfigEdit(t *testing.T) {
 	tmpDir := t.TempDir()
 	configOld := tmpDir + "/app-old.ini"
 	configTemplate := tmpDir + "/app-template.ini"
@@ -33,9 +33,10 @@ k3=v3
 	t.Run("OutputToNewWithEnv", func(t *testing.T) {
 		configNew := tmpDir + "/app-new.ini"
 		err := NewMainApp(AppVersion{}).Run(t.Context(), []string{
-			"./gitea", "--config", configOld, "config", "update-ini",
+			"./gitea", "--config", configOld,
+			"config", "edit-ini",
 			"--apply-env",
-			"--config-key-template", configTemplate,
+			"--config-keep-keys", configTemplate,
 			"--out", configNew,
 		})
 		require.NoError(t, err)
@@ -54,8 +55,18 @@ KeY = val
 	})
 
 	t.Run("OutputToExisting(environment-to-ini)", func(t *testing.T) {
+		// the legacy "environment-to-ini" (now a wrapper script) behavior:
+		// if no "--out", then "--in-place" must be used to overwrite the existing "--config" file
 		err := NewMainApp(AppVersion{}).Run(t.Context(), []string{
-			"./gitea", "config", "update-ini",
+			"./gitea", "config", "edit-ini",
+			"--apply-env",
+			"--config", configOld,
+		})
+		require.ErrorContains(t, err, "either --in-place or --out must be specified")
+
+		err = NewMainApp(AppVersion{}).Run(t.Context(), []string{
+			"./gitea", "config", "edit-ini",
+			"--in-place",
 			"--apply-env",
 			"--config", configOld,
 		})

docker/root/usr/local/bin/environment-to-ini

@@ -1,2 +1,2 @@
 #!/bin/bash
-exec /app/gitea/gitea config update-ini --apply-env "$@"
+exec /app/gitea/gitea config edit-ini --in-place --apply-env "$@"

docker/rootless/usr/local/bin/environment-to-ini

@@ -1,2 +1,2 @@
 #!/bin/bash
-exec /app/gitea/gitea config update-ini --apply-env "$@"
+exec /app/gitea/gitea config edit-ini --in-place --apply-env "$@"