mirror of
https://code.forgejo.org/forgejo/runner.git
synced 2025-08-16 18:01:34 +00:00
[Raised on Forgejo](https://codeberg.org/forgejo/forgejo/issues/8803): when a runner is registered with spaces in the comma-separated label list, eg. ` "docker:docker://node:22-bookworm, self-hosted:host, lxc:lxc://debian:bookworm"`, the runner will currently get the labels `"docker"`, `" self-hosted"`, and `" lxc"` which causes unexpected confusion. Forgejo doesn't display the labels usefully, and targeting the runner with `runs-on` in an action would require an unexpected quoting (eg. `runs-on: " lxc"`). As an alternative to fixing this in Forgejo's label display, two changes are present here: - When registering labels via the CLI `--labels` option, or the interactive registering, automatically strip spaces around the commas in the comma-separated list. - **Breaking**: During startup of the runner, label names that start/end with a space will be considered invalid, resulting in a logged error and the label being ignored: ``` WARN[2025-08-08T21:00:13-06:00] ignored invalid label " debian-latest:docker://node:current-bookworm" error="invalid label \" debian-latest\": starting or ending with a space is invalid" ``` This is a breaking change in behavior in the case that someone has registered a runner with spaces and modified their activities to use them after recognizing the problem. But I tend to think it's more likely that this change will *highlight* a misconfiguration and help someone fix it. <!--start release-notes-assistant--> <!--URL:https://code.forgejo.org/forgejo/runner--> - bug fixes - [PR](https://code.forgejo.org/forgejo/runner/pulls/829): <!--number 829 --><!--line 0 --><!--description Zml4OiBwcmV2ZW50IHNwYWNlIHByZWZpeC9zdWZmaXggaW4gcnVubmVyIGxhYmVscw==-->fix: prevent space prefix/suffix in runner labels<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/829 Reviewed-by: Gusted <gusted@noreply.code.forgejo.org> Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
107 lines
1.7 KiB
Go
107 lines
1.7 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package labels
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"gotest.tools/v3/assert"
|
|
)
|
|
|
|
func TestParse(t *testing.T) {
|
|
tests := []struct {
|
|
args string
|
|
want *Label
|
|
wantErr bool
|
|
}{
|
|
{
|
|
args: "label1",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: SchemeDocker,
|
|
Arg: ArgDocker,
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
args: "label1:docker",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: SchemeDocker,
|
|
Arg: ArgDocker,
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
args: "label1:docker://node:18",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: SchemeDocker,
|
|
Arg: "//node:18",
|
|
},
|
|
wantErr: false,
|
|
},
|
|
|
|
{
|
|
args: "label1:lxc",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: SchemeLXC,
|
|
Arg: ArgLXC,
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
args: "label1:lxc://debian:buster",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: SchemeLXC,
|
|
Arg: "//debian:buster",
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
args: "label1:host",
|
|
want: &Label{
|
|
Name: "label1",
|
|
Schema: "host",
|
|
Arg: "",
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
args: "label1:host:something",
|
|
want: nil,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
args: "label1:invalidscheme",
|
|
want: nil,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
args: " label1:lxc://debian:buster",
|
|
want: nil,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
args: "label1 :lxc://debian:buster",
|
|
want: nil,
|
|
wantErr: true,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.args, func(t *testing.T) {
|
|
got, err := Parse(tt.args)
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
assert.DeepEqual(t, got, tt.want)
|
|
})
|
|
}
|
|
}
|