mirror of
https://gitea.com/gitea/runner.git
synced 2026-11-16 04:43:42 +00:00
feat: config command to edit config files (#1140)
Changing a setting after `generate-config` meant hand-editing YAML, which is awkward in provisioning scripts. `config` now edits an existing file in place: ```bash ./gitea-runner -c config.yaml config set runner.capacity 4 ./gitea-runner -c config.yaml config set runner.envs.MY_VAR value ./gitea-runner -c config.yaml config add runner.labels 'ubuntu:docker://node:22' ./gitea-runner -c config.yaml config remove runner.labels 'ubuntu:docker://node:22' ./gitea-runner -c config.yaml config get runner.labels ``` Edits go through the YAML node tree, so comments, key order and the blank lines between top-level sections survive — a test asserts that appending a label to `config.example.yaml` changes nothing but the added line. Keys are resolved by reflecting over the `Config` struct's yaml tags, so an unknown key or a value of the wrong type is rejected before the file is touched. The write is atomic and keeps the file's symlink, owner, mode and line endings. --------- Co-authored-by: silverwind <[email protected]> Co-authored-by: silverwind <[email protected]> Reviewed-on: https://gitea.com/gitea/runner/pulls/1140 Reviewed-by: silverwind <[email protected]> Reviewed-by: Lunny Xiao <[email protected]> Co-authored-by: bircni <[email protected]>
This commit is contained in:
1 parent
b70ff6893a
commit
8700adc933
11 files changed
+1060
-17
No files matched your search
@@ -132,9 +132,11 @@ Same idea as `dind`, but built on `docker:dind-rootless` so the bundled daemon a
|
|||||||
The runner is configured with a YAML file. Generate a starting point (this matches what ships in the tree):
|
The runner is configured with a YAML file. Generate a starting point (this matches what ships in the tree):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./gitea-runner generate-config > config.yaml
|
./gitea-runner config generate > config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The top-level `generate-config` command still does the same thing, but is deprecated in favour of `config generate`.
|
||||||
|
|
||||||
Pass it with `-c` / `--config` on any command that loads configuration (`register`, `daemon`, `cache-server`):
|
Pass it with `-c` / `--config` on any command that loads configuration (`register`, `daemon`, `cache-server`):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -143,7 +145,26 @@ Pass it with `-c` / `--config` on any command that loads configuration (`registe
|
|||||||
./gitea-runner -c config.yaml cache-server
|
./gitea-runner -c config.yaml cache-server
|
||||||
```
|
```
|
||||||
|
|
||||||
Every option is described in [config.example.yaml](internal/pkg/config/config.example.yaml) (the same content `generate-config` prints).
|
Every option is described in [config.example.yaml](internal/pkg/config/config.example.yaml) (the same content `config generate` prints).
|
||||||
|
|
||||||
|
#### Editing a config file
|
||||||
|
|
||||||
|
`config` changes an existing file in place, keeping its comments and key order, which is handy in provisioning scripts:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./gitea-runner -c config.yaml config set runner.capacity 4
|
||||||
|
./gitea-runner -c config.yaml config set runner.timeout 90m # written as 1h30m0s
|
||||||
|
./gitea-runner -c config.yaml config set runner.envs.MY_VAR value
|
||||||
|
./gitea-runner -c config.yaml config add runner.labels 'ubuntu:docker://node:22'
|
||||||
|
./gitea-runner -c config.yaml config remove runner.labels 'ubuntu:docker://node:22'
|
||||||
|
./gitea-runner -c config.yaml config get runner.labels
|
||||||
|
```
|
||||||
|
|
||||||
|
`-c` is optional for these subcommands: without it they use `config.yaml` (or `config.yml`) from the working directory, falling back to the directory of the `gitea-runner` binary, and print which file they picked to stderr.
|
||||||
|
|
||||||
|
Keys are the dotted YAML path and are validated against the known options, so a typo is rejected instead of being written. `add` and `remove` only work on list options such as `runner.labels` and `container.valid_volumes`, and fail if the value is already present or missing. `set` replaces the whole list when given several values.
|
||||||
|
|
||||||
|
The file is re-encoded on every edit, so indentation is normalised to two spaces and blank lines inside a section are dropped.
|
||||||
|
|
||||||
#### Without a config file
|
#### Without a config file
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ the runner as a background service on a systemd host.
|
|||||||
`.runner` file ends up in the working directory:
|
`.runner` file ends up in the working directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo -u gitea-runner gitea-runner generate-config > /etc/gitea-runner/config.yaml
|
sudo -u gitea-runner gitea-runner config generate > /etc/gitea-runner/config.yaml
|
||||||
cd /var/lib/gitea-runner
|
cd /var/lib/gitea-runner
|
||||||
sudo -u gitea-runner gitea-runner register --config /etc/gitea-runner/config.yaml
|
sudo -u gitea-runner gitea-runner register --config /etc/gitea-runner/config.yaml
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ export DOCKER_HOST=unix:///run/user/$(id -u)/docker.sock
|
|||||||
- Generate a `gitea-runner` configuration file in the data directory. Edit the file to adjust for the system.
|
- Generate a `gitea-runner` configuration file in the data directory. Edit the file to adjust for the system.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gitea-runner generate-config >/home/rootless/gitea-runner/config
|
gitea-runner config generate >/home/rootless/gitea-runner/config
|
||||||
```
|
```
|
||||||
|
|
||||||
- Create a new user-level`systemd` unit file as `/home/rootless/.config/systemd/user/gitea-runner.service` with the following contents:
|
- Create a new user-level`systemd` unit file as `/home/rootless/.config/systemd/user/gitea-runner.service` with the following contents:
|
||||||
|
|||||||
+7
-11
@@ -5,10 +5,8 @@ package cmd
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
"gitea.com/gitea/runner/internal/pkg/config"
|
|
||||||
"gitea.com/gitea/runner/internal/pkg/ver"
|
"gitea.com/gitea/runner/internal/pkg/ver"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
@@ -23,7 +21,7 @@ func Execute(ctx context.Context) {
|
|||||||
SilenceUsage: true,
|
SilenceUsage: true,
|
||||||
}
|
}
|
||||||
configFile := ""
|
configFile := ""
|
||||||
rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "", "Config file path")
|
rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "", "Config file path. `config` subcommands fall back to config.yaml in the working directory or next to the executable")
|
||||||
|
|
||||||
// ./gitea-runner register
|
// ./gitea-runner register
|
||||||
var regArgs registerArgs
|
var regArgs registerArgs
|
||||||
@@ -61,14 +59,12 @@ func Execute(ctx context.Context) {
|
|||||||
rootCmd.AddCommand(loadBugReportCmd())
|
rootCmd.AddCommand(loadBugReportCmd())
|
||||||
|
|
||||||
// ./gitea-runner config
|
// ./gitea-runner config
|
||||||
rootCmd.AddCommand(&cobra.Command{
|
rootCmd.AddCommand(loadConfigCmd(&configFile))
|
||||||
Use: "generate-config",
|
|
||||||
Short: "Generate an example config file",
|
// ./gitea-runner generate-config
|
||||||
Args: cobra.MaximumNArgs(0),
|
generateConfigCmd := loadGenerateConfigCmd("generate-config")
|
||||||
Run: func(_ *cobra.Command, _ []string) {
|
generateConfigCmd.Deprecated = "use `config generate` instead."
|
||||||
fmt.Printf("%s", config.Example)
|
rootCmd.AddCommand(generateConfigCmd)
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
// ./gitea-runner cache-server
|
// ./gitea-runner cache-server
|
||||||
var cacheArgs cacheServerArgs
|
var cacheArgs cacheServerArgs
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"gitea.com/gitea/runner/internal/pkg/config"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadConfigCmd(configFile *string) *cobra.Command {
|
||||||
|
configCmd := &cobra.Command{
|
||||||
|
Use: "config",
|
||||||
|
Short: "Generate, read and edit config files",
|
||||||
|
Args: cobra.MaximumNArgs(0),
|
||||||
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
|
return cmd.Help()
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
configCmd.AddCommand(loadGenerateConfigCmd("generate"))
|
||||||
|
|
||||||
|
configCmd.AddCommand(&cobra.Command{
|
||||||
|
Use: "get <key>",
|
||||||
|
Short: "Print the value of a config key",
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
file, err := resolveConfigFile(cmd, configFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
value, err := config.GetValue(file, args[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fmt.Fprintln(cmd.OutOrStdout(), value)
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
for _, sub := range []struct {
|
||||||
|
use string
|
||||||
|
short string
|
||||||
|
edit func(file, key string, values ...string) error
|
||||||
|
}{
|
||||||
|
{"set <key> <value>...", "Set the value of a config key", config.SetValue},
|
||||||
|
{"add <key> <value>...", "Append values to a list config key", config.AddValue},
|
||||||
|
{"remove <key> <value>...", "Remove values from a list config key", config.RemoveValue},
|
||||||
|
} {
|
||||||
|
valueCmd := &cobra.Command{
|
||||||
|
Use: sub.use,
|
||||||
|
Short: sub.short,
|
||||||
|
Args: cobra.MinimumNArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
file, err := resolveConfigFile(cmd, configFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return sub.edit(file, args[0], args[1:]...)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
valueCmd.Flags().SetInterspersed(false) // so a value such as `--cpus 2` is not parsed as a flag
|
||||||
|
configCmd.AddCommand(valueCmd)
|
||||||
|
}
|
||||||
|
|
||||||
|
return configCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadGenerateConfigCmd(use string) *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: use,
|
||||||
|
Short: "Generate an example config file",
|
||||||
|
Args: cobra.MaximumNArgs(0),
|
||||||
|
Run: func(cmd *cobra.Command, _ []string) {
|
||||||
|
fmt.Fprintf(cmd.OutOrStdout(), "%s", config.Example)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var defaultConfigFileNames = []string{"config.yaml", "config.yml"}
|
||||||
|
|
||||||
|
func resolveConfigFile(cmd *cobra.Command, configFile *string) (string, error) {
|
||||||
|
if *configFile != "" {
|
||||||
|
return *configFile, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var dirs []string
|
||||||
|
if wd, err := os.Getwd(); err == nil {
|
||||||
|
dirs = append(dirs, wd)
|
||||||
|
}
|
||||||
|
if exe, err := os.Executable(); err == nil {
|
||||||
|
if dir := filepath.Dir(exe); !slices.Contains(dirs, dir) {
|
||||||
|
dirs = append(dirs, dir)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, dir := range dirs {
|
||||||
|
for _, name := range defaultConfigFileNames {
|
||||||
|
candidate := filepath.Join(dir, name)
|
||||||
|
if stat, err := os.Stat(candidate); err == nil && !stat.IsDir() {
|
||||||
|
fmt.Fprintf(cmd.ErrOrStderr(), "using config file %q\n", candidate)
|
||||||
|
return candidate, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", fmt.Errorf("no %s found in %s, pass one with --config",
|
||||||
|
strings.Join(defaultConfigFileNames, " or "), strings.Join(dirs, " or "))
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.com/gitea/runner/internal/pkg/config"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func runConfigCmd(t *testing.T, configFile string, args ...string) (string, string, error) {
|
||||||
|
t.Helper()
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
cmd := loadConfigCmd(&configFile)
|
||||||
|
cmd.SetOut(out)
|
||||||
|
cmd.SetErr(errOut)
|
||||||
|
cmd.SetArgs(args)
|
||||||
|
err := cmd.Execute()
|
||||||
|
return out.String(), errOut.String(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigCmdGeneratePrintsTheExample(t *testing.T) {
|
||||||
|
out, _, err := runConfigCmd(t, "", "generate")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, string(config.Example), out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The subcommands only wire arguments through, so one pass over all of them is enough.
|
||||||
|
func TestConfigCmdEditsTheFile(t *testing.T) {
|
||||||
|
file := filepath.Join(t.TempDir(), "config.yaml")
|
||||||
|
require.NoError(t, os.WriteFile(file, []byte("runner:\n labels:\n - self-hosted\n"), 0o600))
|
||||||
|
|
||||||
|
_, _, err := runConfigCmd(t, file, "set", "container.options", "--cpus 2")
|
||||||
|
require.NoError(t, err)
|
||||||
|
_, _, err = runConfigCmd(t, file, "add", "runner.labels", "ubuntu:docker://node:22")
|
||||||
|
require.NoError(t, err)
|
||||||
|
_, _, err = runConfigCmd(t, file, "remove", "runner.labels", "self-hosted")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
out, _, err := runConfigCmd(t, file, "get", "runner.labels")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "ubuntu:docker://node:22\n", out)
|
||||||
|
|
||||||
|
out, _, err = runConfigCmd(t, file, "get", "container.options")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "--cpus 2\n", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigCmdResolvesTheConfigFile(t *testing.T) {
|
||||||
|
t.Run("falls back to the working directory", func(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "config.yaml"), []byte("runner:\n capacity: 2\n"), 0o600))
|
||||||
|
t.Chdir(dir)
|
||||||
|
|
||||||
|
out, errOut, err := runConfigCmd(t, "", "get", "runner.capacity")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "2\n", out)
|
||||||
|
assert.Contains(t, errOut, "using config file")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("reports that none was found", func(t *testing.T) {
|
||||||
|
t.Chdir(t.TempDir())
|
||||||
|
|
||||||
|
_, _, err := runConfigCmd(t, "", "set", "runner.capacity", "4")
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "--config")
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
# Example configuration file, it's safe to copy this as the default config file without any modification.
|
# Example configuration file, it's safe to copy this as the default config file without any modification.
|
||||||
|
|
||||||
# You don't have to copy this file to your instance,
|
# You don't have to copy this file to your instance,
|
||||||
# just run `./gitea-runner generate-config > config.yaml` to generate a config file.
|
# just run `./gitea-runner config generate > config.yaml` to generate a config file.
|
||||||
|
|
||||||
# Logging for the runner process itself (messages printed to stderr).
|
# Logging for the runner process itself (messages printed to stderr).
|
||||||
# This does not control how workflow step output is streamed to the Gitea UI;
|
# This does not control how workflow step output is streamed to the Gitea UI;
|
||||||
@@ -176,7 +176,7 @@ container:
|
|||||||
# network is labelled com.gitea.runner.uuid=<this runner's uuid>, which is how the idle
|
# network is labelled com.gitea.runner.uuid=<this runner's uuid>, which is how the idle
|
||||||
# cleanup tells its own leftovers apart from those of other runners on the same daemon.
|
# cleanup tells its own leftovers apart from those of other runners on the same daemon.
|
||||||
network_create_options:
|
network_create_options:
|
||||||
enable_ipv4: true # Omit to use Docker's default (IPv4 enabled). Set false to disable IPv4.
|
enable_ipv4: true # Omit to use Docker's default (IPv4 enabled). Set false to disable IPv4.
|
||||||
enable_ipv6: false # Omit to use Docker's default (IPv6 disabled). Enabling it requires dockerd started with --ipv6.
|
enable_ipv6: false # Omit to use Docker's default (IPv6 disabled). Enabling it requires dockerd started with --ipv6.
|
||||||
# Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker).
|
# Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker).
|
||||||
privileged: false
|
privileged: false
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,13 @@
|
|||||||
|
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
//go:build windows || plan9
|
||||||
|
|
||||||
|
package config
|
||||||
|
|
||||||
|
import "os"
|
||||||
|
|
||||||
|
// preserveOwner is a no-op where a new file inherits its ownership from the directory.
|
||||||
|
func preserveOwner(_ string, _ os.FileInfo) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,267 @@
|
|||||||
|
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
const editFixture = `# A leading comment.
|
||||||
|
log:
|
||||||
|
# The logging level.
|
||||||
|
level: info
|
||||||
|
|
||||||
|
runner:
|
||||||
|
capacity: 1
|
||||||
|
envs:
|
||||||
|
EXISTING: value
|
||||||
|
timeout: 3h
|
||||||
|
labels:
|
||||||
|
- ubuntu-latest:docker://node:20
|
||||||
|
- self-hosted
|
||||||
|
`
|
||||||
|
|
||||||
|
func writeEditFixture(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
path := filepath.Join(t.TempDir(), "config.yaml")
|
||||||
|
require.NoError(t, os.WriteFile(path, []byte(editFixture), 0o600))
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEditValues(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
edit func(file string) error
|
||||||
|
assert func(t *testing.T, cfg *Config, content string)
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "set scalar",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.capacity", "4") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
assert.Equal(t, 4, cfg.Runner.Capacity)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set duration",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.timeout", "90m") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, content string) {
|
||||||
|
assert.Equal(t, 90*time.Minute, cfg.Runner.Timeout)
|
||||||
|
assert.Contains(t, content, "timeout: 1h30m0s")
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set a pointer field in a missing section",
|
||||||
|
edit: func(file string) error {
|
||||||
|
return SetValue(file, "container.network_create_options.enable_ipv4", "false")
|
||||||
|
},
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
require.NotNil(t, cfg.Container.NetworkCreateOptions.EnableIPv4)
|
||||||
|
assert.False(t, *cfg.Container.NetworkCreateOptions.EnableIPv4)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set map entry",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.envs.ADDED", "yes") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
assert.Equal(t, map[string]string{"EXISTING": "value", "ADDED": "yes"}, cfg.Runner.Envs)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set replaces a list",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.labels", "one", "two") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
assert.Equal(t, []string{"one", "two"}, cfg.Runner.Labels)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "add appends to a list",
|
||||||
|
edit: func(file string) error { return AddValue(file, "runner.labels", "ubuntu:docker://node:22") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
assert.Equal(t, []string{"ubuntu-latest:docker://node:20", "self-hosted", "ubuntu:docker://node:22"}, cfg.Runner.Labels)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "remove drops a list entry",
|
||||||
|
edit: func(file string) error { return RemoveValue(file, "runner.labels", "self-hosted") },
|
||||||
|
assert: func(t *testing.T, cfg *Config, _ string) {
|
||||||
|
assert.Equal(t, []string{"ubuntu-latest:docker://node:20"}, cfg.Runner.Labels)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
file := writeEditFixture(t)
|
||||||
|
require.NoError(t, tt.edit(file))
|
||||||
|
|
||||||
|
raw, err := os.ReadFile(file)
|
||||||
|
require.NoError(t, err)
|
||||||
|
content := string(raw)
|
||||||
|
cfg, err := LoadDefault(file)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
tt.assert(t, cfg, content)
|
||||||
|
|
||||||
|
assert.Contains(t, content, "# A leading comment.")
|
||||||
|
assert.Contains(t, content, " # The logging level.")
|
||||||
|
assert.Contains(t, content, "\n\nrunner:")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEditValuesRejectsBadInput(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
edit func(file string) error
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "unknown key",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.labl", "x") },
|
||||||
|
wantErr: `unknown config key "runner.labl"`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "value is not a number",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.capacity", "many") },
|
||||||
|
wantErr: `"many" is not a valid int`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "value is not a duration",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.timeout", "soon") },
|
||||||
|
wantErr: `"soon" is not a duration`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "value is not a boolean",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.insecure", "maybe") },
|
||||||
|
wantErr: `"maybe" is not a boolean`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set needs a single value",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.capacity", "1", "2") },
|
||||||
|
wantErr: "takes exactly one value",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "set on a section",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner", "x") },
|
||||||
|
wantErr: "is a section",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "add on a scalar",
|
||||||
|
edit: func(file string) error { return AddValue(file, "runner.capacity", "4") },
|
||||||
|
wantErr: "is not a list",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "add a duplicate",
|
||||||
|
edit: func(file string) error { return AddValue(file, "runner.labels", "self-hosted") },
|
||||||
|
wantErr: `already contains "self-hosted"`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "remove a missing entry",
|
||||||
|
edit: func(file string) error { return RemoveValue(file, "runner.labels", "absent") },
|
||||||
|
wantErr: `does not contain "absent"`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "sub-key of a free-form map entry",
|
||||||
|
edit: func(file string) error { return SetValue(file, "runner.envs.A.B", "x") },
|
||||||
|
wantErr: "has no sub-keys",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
file := writeEditFixture(t)
|
||||||
|
err := tt.edit(file)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), tt.wantErr)
|
||||||
|
|
||||||
|
content, err := os.ReadFile(file)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, editFixture, string(content), "a rejected edit must leave the file untouched")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetValue(t *testing.T) {
|
||||||
|
file := writeEditFixture(t)
|
||||||
|
|
||||||
|
value, err := GetValue(file, "runner.capacity")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "1", value)
|
||||||
|
|
||||||
|
value, err = GetValue(file, "runner.labels")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "ubuntu-latest:docker://node:20\nself-hosted", value)
|
||||||
|
|
||||||
|
value, err = GetValue(file, "runner.envs")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "EXISTING=value", value)
|
||||||
|
|
||||||
|
// A section has no single-line rendering.
|
||||||
|
value, err = GetValue(file, "runner")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, value, "labels:\n - ubuntu-latest:docker://node:20")
|
||||||
|
|
||||||
|
_, err = GetValue(file, "metrics.addr")
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "is not set")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEditValuesFileHandling(t *testing.T) {
|
||||||
|
t.Run("reports a missing file", func(t *testing.T) {
|
||||||
|
err := SetValue(filepath.Join(t.TempDir(), "absent.yaml"), "runner.capacity", "4")
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "does not exist")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("writes through a symlink", func(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
target := filepath.Join(dir, "real.yaml")
|
||||||
|
link := filepath.Join(dir, "config.yaml")
|
||||||
|
require.NoError(t, os.WriteFile(target, []byte(editFixture), 0o600))
|
||||||
|
require.NoError(t, os.Symlink(target, link))
|
||||||
|
|
||||||
|
require.NoError(t, SetValue(link, "runner.capacity", "4"))
|
||||||
|
|
||||||
|
info, err := os.Lstat(link)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.NotZero(t, info.Mode()&os.ModeSymlink, "the symlink must not be replaced by a regular file")
|
||||||
|
|
||||||
|
content, err := os.ReadFile(target)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(content), "capacity: 4")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("keeps CRLF line endings", func(t *testing.T) {
|
||||||
|
file := filepath.Join(t.TempDir(), "config.yaml")
|
||||||
|
require.NoError(t, os.WriteFile(file, []byte(strings.ReplaceAll(editFixture, "\n", "\r\n")), 0o600))
|
||||||
|
|
||||||
|
require.NoError(t, SetValue(file, "runner.capacity", "4"))
|
||||||
|
|
||||||
|
content, err := os.ReadFile(file)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(content), "capacity: 4\r\n")
|
||||||
|
assert.NotContains(t, strings.ReplaceAll(string(content), "\r\n", ""), "\n")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// The example config is the file users edit, so it has to stay written the way
|
||||||
|
// the encoder emits it, down to the single space before a trailing comment.
|
||||||
|
func TestEditValuesKeepsExampleConfigIntact(t *testing.T) {
|
||||||
|
file := filepath.Join(t.TempDir(), "config.yaml")
|
||||||
|
require.NoError(t, os.WriteFile(file, Example, 0o600))
|
||||||
|
|
||||||
|
require.NoError(t, AddValue(file, "runner.labels", "ubuntu:docker://node:22"))
|
||||||
|
|
||||||
|
content, err := os.ReadFile(file)
|
||||||
|
require.NoError(t, err)
|
||||||
|
withoutAdded := strings.Replace(string(content), " - ubuntu:docker://node:22\n", "", 1)
|
||||||
|
assert.Equal(t, string(Example), withoutAdded, "only the appended label may differ")
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2026 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
//go:build !windows && !plan9
|
||||||
|
|
||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"syscall"
|
||||||
|
)
|
||||||
|
|
||||||
|
// preserveOwner keeps a config that root edits owned by the service user it was created for.
|
||||||
|
func preserveOwner(file string, info os.FileInfo) error {
|
||||||
|
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||||
|
if !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// A caller that may replace the file but not chown it is no worse off than before.
|
||||||
|
if err := os.Chown(file, int(stat.Uid), int(stat.Gid)); err != nil && !errors.Is(err, os.ErrPermission) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
Reference in new issue
Block a user