Some checks failed
CI / build-and-test (push) Has been cancelled
Release / build (arm64, darwin) (push) Has been cancelled
Release / build (amd64, windows) (push) Has been cancelled
Release / build (arm64, linux) (push) Has been cancelled
Release / build (amd64, darwin) (push) Has been cancelled
Release / build (amd64, linux) (push) Has been cancelled
Release / release (push) Has been cancelled
Adds package-level documentation comments across cmd and internal packages. Marks unused function parameters with underscore prefix to satisfy linter requirements. Replaces if-else chains with switch statements for better readability. Explicitly ignores os.Setenv return value where error handling is not needed.
116 lines
2.8 KiB
Go
116 lines
2.8 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// Package labels provides utilities for parsing and managing runner labels.
|
|
package labels
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
// Label scheme constants define the execution environments.
|
|
const (
|
|
SchemeHost = "host"
|
|
SchemeDocker = "docker"
|
|
)
|
|
|
|
// Label represents a parsed runner label with name, schema, and optional argument.
|
|
type Label struct {
|
|
Name string
|
|
Schema string
|
|
Arg string
|
|
}
|
|
|
|
// Parse parses a label string in the format "name:schema:arg" and returns a Label.
|
|
func Parse(str string) (*Label, error) {
|
|
splits := strings.SplitN(str, ":", 3)
|
|
label := &Label{
|
|
Name: splits[0],
|
|
Schema: "host",
|
|
Arg: "",
|
|
}
|
|
if len(splits) >= 2 {
|
|
label.Schema = splits[1]
|
|
}
|
|
if len(splits) >= 3 {
|
|
label.Arg = splits[2]
|
|
}
|
|
if label.Schema != SchemeHost && label.Schema != SchemeDocker {
|
|
return nil, fmt.Errorf("unsupported schema: %s", label.Schema)
|
|
}
|
|
return label, nil
|
|
}
|
|
|
|
// Labels is a slice of Label pointers.
|
|
type Labels []*Label
|
|
|
|
// RequireDocker returns true if any label uses the docker schema.
|
|
func (l Labels) RequireDocker() bool {
|
|
for _, label := range l {
|
|
if label.Schema == SchemeDocker {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// PickPlatform selects the appropriate platform based on the runsOn requirements.
|
|
func (l Labels) PickPlatform(runsOn []string) string {
|
|
platforms := make(map[string]string, len(l))
|
|
for _, label := range l {
|
|
switch label.Schema {
|
|
case SchemeDocker:
|
|
// "//" will be ignored
|
|
platforms[label.Name] = strings.TrimPrefix(label.Arg, "//")
|
|
case SchemeHost:
|
|
platforms[label.Name] = "-self-hosted"
|
|
default:
|
|
// It should not happen, because Parse has checked it.
|
|
continue
|
|
}
|
|
}
|
|
for _, v := range runsOn {
|
|
if v, ok := platforms[v]; ok {
|
|
return v
|
|
}
|
|
}
|
|
|
|
// TODO: support multiple labels
|
|
// like:
|
|
// ["ubuntu-22.04"] => "ubuntu:22.04"
|
|
// ["with-gpu"] => "linux:with-gpu"
|
|
// ["ubuntu-22.04", "with-gpu"] => "ubuntu:22.04_with-gpu"
|
|
|
|
// return default.
|
|
// So the runner receives a task with a label that the runner doesn't have,
|
|
// it happens when the user have edited the label of the runner in the web UI.
|
|
// TODO: it may be not correct, what if the runner is used as host mode only?
|
|
return "docker.gitea.com/runner-images:ubuntu-latest"
|
|
}
|
|
|
|
// Names returns the names of all labels.
|
|
func (l Labels) Names() []string {
|
|
names := make([]string, 0, len(l))
|
|
for _, label := range l {
|
|
names = append(names, label.Name)
|
|
}
|
|
return names
|
|
}
|
|
|
|
// ToStrings converts labels back to their string representation.
|
|
func (l Labels) ToStrings() []string {
|
|
ls := make([]string, 0, len(l))
|
|
for _, label := range l {
|
|
lbl := label.Name
|
|
if label.Schema != "" {
|
|
lbl += ":" + label.Schema
|
|
if label.Arg != "" {
|
|
lbl += ":" + label.Arg
|
|
}
|
|
}
|
|
ls = append(ls, lbl)
|
|
}
|
|
return ls
|
|
}
|